def _render_properties(
self,
props: typing.Mapping[builtins.str, typing.Any],
) -> typing.Mapping[builtins.str, typing.Any]:
'''
:param props: -
'''
return typing.cast(typing.Mapping[builtins.str, typing.Any], jsii.invoke(self, "renderProperties", [props]))
def add_info(self, message: str) -> None:
"""Adds a { "info": } metadata entry to this construct.
The toolkit will display the info message when apps are synthesized.
:param message: The info message.
"""
return jsii.invoke(self, "addInfo", [message])
def bind(
self, _record: aws_cdk.aws_route53.IRecordSet
) -> aws_cdk.aws_route53.AliasRecordTargetConfig:
"""Return hosted zone ID and DNS name, usable for Route53 alias targets.
:param _record: -
"""
return jsii.invoke(self, "bind", [_record])
def grant_encrypt_decrypt(
self,
grantee: aws_cdk.aws_iam.IGrantable) -> aws_cdk.aws_iam.Grant:
"""Grant encryption and decryption permisisons using this key to the given principal.
:param grantee: -
"""
return jsii.invoke(self, "grantEncryptDecrypt", [grantee])
def add_error(self, message: str) -> None:
"""Adds an { "error": } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
:param message: The error message.
"""
return jsii.invoke(self, "addError", [message])
def grant(self, grantee: aws_cdk.aws_iam.IGrantable,
*actions: str) -> aws_cdk.aws_iam.Grant:
"""Grant the indicated permissions on this key to the given principal.
:param grantee: -
:param actions: -
"""
return jsii.invoke(self, "grant", [grantee, *actions])
def tree(self) -> typing.Optional["TreeCloudArtifact"]:
'''Returns the tree metadata artifact from this assembly.
Throws if there is no metadata artifact by that name
Returns a 'TreeCloudArtifact' object if there is one defined in the manifest, 'undefined' otherwise.
'''
return typing.cast(typing.Optional["TreeCloudArtifact"],
jsii.invoke(self, "tree", []))
def inspect(self, inspector: aws_cdk.core.TreeInspector) -> None:
"""(experimental) Examines the CloudFormation resource and discloses attributes.
:param inspector: - tree inspector to collect and process attributes.
:stability: experimental
"""
return jsii.invoke(self, "inspect", [inspector])
def next_int(self, min: jsii.Number, max: jsii.Number) -> jsii.Number:
"""
:param min: -
:param max: -
:stability: experimental
"""
return jsii.invoke(self, "nextInt", [min, max])
def _render_properties(
self,
props: typing.Mapping[str,
typing.Any]) -> typing.Mapping[str, typing.Any]:
"""
:param props: -
"""
return jsii.invoke(self, "renderProperties", [props])
def repository_uri_for_tag(self, tag: typing.Optional[str]=None) -> str:
"""Returns the URI of the repository for a certain tag. Can be used in ``docker push/pull``.
ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[:TAG]
:param tag: Image tag to use (tools usually default to "latest" if omitted).
"""
return jsii.invoke(self, "repositoryUriForTag", [tag])
def repository_uri_for_tag(self, tag: typing.Optional[str]=None) -> str:
"""Returns the URL of the repository. Can be used in ``docker push/pull``.
ACCOUNT.dkr.ecr.REGION.amazonaws.com/REPOSITORY[:TAG]
:param tag: Optional image tag.
"""
return jsii.invoke(self, "repositoryUriForTag", [tag])
def grant(self, grantee: aws_cdk.aws_iam.IGrantable,
*actions: str) -> aws_cdk.aws_iam.Grant:
"""Grant the indicated permissions on this stream to the given IAM principal (Role/Group/User).
:param grantee: -
:param actions: -
"""
return jsii.invoke(self, "grant", [grantee, *actions])
def try_find_child(self, id: str) -> typing.Optional["IConstruct"]:
"""Return a direct child by id, or undefined.
:param id: Identifier of direct child.
return
:return: the child if found, or undefined
"""
return jsii.invoke(self, "tryFindChild", [id])
def add_warning(self, message: str) -> None:
"""Adds a { "warning": } metadata entry to this construct.
The toolkit will display the warning when an app is synthesized, or fail
if run in --strict mode.
:param message: The warning message.
"""
return jsii.invoke(self, "addWarning", [message])
def add_dependency(self, *dependencies: "IConstruct") -> None:
"""Add an ordering dependency on another Construct.
All constructs in the dependency's scope will be deployed before any
construct in this construct's scope.
:param dependencies: -
"""
return jsii.invoke(self, "addDependency", [*dependencies])
def find_all(
self,
order: typing.Optional[ConstructOrder] = None,
) -> typing.List[IConstruct]:
"""Return this construct and all of its children in the given order.
:param order: -
"""
return jsii.invoke(self, "findAll", [order])
def add_validation(self, validation: IValidation) -> None:
"""Adds a validation to this construct.
When ``node.validate()`` is called, the ``validate()`` method will be called on
all validations and all errors will be returned.
:param validation: -
"""
return jsii.invoke(self, "addValidation", [validation])
def validate(self) -> typing.List[builtins.str]:
"""Validate the current construct.
This method can be implemented by derived constructs in order to perform
validation logic. It is called on all constructs before synthesis.
:return: An array of validation error messages, or an empty array if there the construct is valid.
"""
return jsii.invoke(self, "validate", [])
def bind(
self,
_topic: aws_cdk.aws_sns.ITopic,
) -> aws_cdk.aws_sns.TopicSubscriptionConfig:
"""Returns a configuration for a URL to subscribe to an SNS topic.
:param _topic: -
"""
return jsii.invoke(self, "bind", [_topic])
def get_att(self, attribute_name: str) -> aws_cdk.cdk.IResolvable:
"""
Arguments:
attributeName: -
Stability:
experimental
"""
return jsii.invoke(self, "getAtt", [attribute_name])
def bind(self, _rule: aws_cdk.aws_events.IRule, _id: typing.Optional[str]=None) -> aws_cdk.aws_events.RuleTargetConfig:
"""Returns the rule target specification.
NOTE: Do not use the various ``inputXxx`` options. They can be set in a call to ``addTarget``.
:param _rule: -
:param _id: -
"""
return jsii.invoke(self, "bind", [_rule, _id])
def bind(self, context: aws_cdk.core.Construct) -> "SourceConfig":
"""Binds the source to a bucket deployment.
:param context: The construct tree context.
stability
:stability: experimental
"""
return jsii.invoke(self, "bind", [context])
def as_map(self,
reflectable: "IReflectable") -> typing.Mapping[str, typing.Any]:
"""
:param reflectable: -
stability
:stability: deprecated
"""
return jsii.invoke(self, "asMap", [reflectable])
def _on_synthesize(self, session: "ISynthesisSession") -> None:
"""Allows this construct to emit artifacts into the cloud assembly during synthesis.
This method is usually implemented by framework-level constructs such as ``Stack`` and ``Asset``
as they participate in synthesizing the cloud assembly.
:param session: The synthesis session.
"""
return jsii.invoke(self, "onSynthesize", [session])
def grant_read(self, grantee: aws_cdk.aws_iam.IGrantable) -> None:
"""Grants read permissions to the principal on the asset's S3 object.
:param grantee: -
stability
:stability: experimental
"""
return jsii.invoke(self, "grantRead", [grantee])
def service_principal(self, service: str) -> typing.Optional[str]:
"""The name of the service principal for a given service in this region.
:param service: the service name (e.g: s3.amazonaws.com).
stability
:stability: experimental
"""
return jsii.invoke(self, "servicePrincipal", [service])
def next_int(self, min: jsii.Number, max: jsii.Number) -> jsii.Number:
'''
:param min: -
:param max: -
:stability: experimental
'''
return typing.cast(jsii.Number, jsii.invoke(self, "nextInt",
[min, max]))
def _render_properties(self, props: typing.Mapping[str,typing.Any]) -> typing.Mapping[str,typing.Any]:
"""
Arguments:
props: -
Stability:
experimental
"""
return jsii.invoke(self, "renderProperties", [props])
def bind(
self, _scope: aws_cdk.core.Construct, bucket: aws_cdk.aws_s3.IBucket
) -> aws_cdk.aws_s3.BucketNotificationDestinationConfig:
"""Allows using SQS queues as destinations for bucket notifications. Use ``bucket.onEvent(event, queue)`` to subscribe.
:param _scope: -
:param bucket: -
"""
return jsii.invoke(self, "bind", [_scope, bucket])