DeployTimeSubstitutedFile
- class aws_cdk.aws_s3_deployment.DeployTimeSubstitutedFile(scope, id, *, destination_bucket, source, substitutions, destination_key=None, role=None)
Bases:
BucketDeployment
DeployTimeSubstitutedFile
is an extension ofBucketDeployment
that allows users to upload individual files and specify to make substitutions in the file.- ExampleMetadata:
infused
Example:
import aws_cdk.aws_lambda as lambda_ # my_lambda_function: lambda.Function # destination_bucket: s3.Bucket # (Optional) if provided, the resulting processed file would be uploaded to the destinationBucket under the destinationKey name. # destination_key: str # role: iam.Role s3deploy.DeployTimeSubstitutedFile(self, "MyFile", source="my-file.yaml", destination_key=destination_key, destination_bucket=destination_bucket, substitutions={ "variable_name": my_lambda_function.function_name }, role=role )
- Parameters:
scope (
Construct
) –id (
str
) –destination_bucket (
IBucket
) – The S3 bucket to sync the contents of the zip file to.source (
str
) – Path to the user’s local file.substitutions (
Mapping
[str
,str
]) – User-defined substitutions to make in the file. Placeholders in the user’s local file must be specified with double curly brackets and spaces. For example, if you use the key ‘xxxx’ in the file, it must be written as: {{ xxxx }} to be recognized by the construct as a substitution.destination_key (
Optional
[str
]) – The object key in the destination bucket where the processed file would be written to. Default: - Fingerprint of the file content would be used as object keyrole (
Optional
[IRole
]) – Execution role associated with this function. Default: - A role is automatically created
Methods
- add_source(source)
Add an additional source to the bucket deployment.
- Parameters:
source (
ISource
) –- Return type:
None
Example:
# website_bucket: s3.IBucket deployment = s3deploy.BucketDeployment(self, "Deployment", sources=[s3deploy.Source.asset("./website-dist")], destination_bucket=website_bucket ) deployment.add_source(s3deploy.Source.asset("./another-asset"))
- to_string()
Returns a string representation of this construct.
- Return type:
str
Attributes
- bucket
- deployed_bucket
The bucket after the deployment.
If you want to reference the destination bucket in another construct and make sure the bucket deployment has happened before the next operation is started, pass the other construct a reference to
deployment.deployedBucket
.Note that this only returns an immutable reference to the destination bucket. If sequenced access to the original destination bucket is required, you may add a dependency on the bucket deployment instead:
otherResource.node.addDependency(deployment)
- handler_role
Execution role of the Lambda function behind the custom CloudFormation resource of type
Custom::CDKBucketDeployment
.
- node
The tree node.
- object_key
- object_keys
The object keys for the sources deployed to the S3 bucket.
This returns a list of tokenized object keys for source files that are deployed to the bucket.
This can be useful when using
BucketDeployment
withextract
set tofalse
and you need to reference the object key that resides in the bucket for that zip source file somewhere else in your CDK application, such as in a CFN output.For example, use
Fn.select(0, myBucketDeployment.objectKeys)
to reference the object key of the first source file in your bucket deployment.
Static Methods
- classmethod is_construct(x)
Checks if
x
is a construct.Use this method instead of
instanceof
to properly detectConstruct
instances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
constructs
library on disk are seen as independent, completely different libraries. As a consequence, the classConstruct
in each copy of theconstructs
library is seen as a different class, and an instance of one class will not test asinstanceof
the other class.npm install
will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of theconstructs
library can be accidentally installed, andinstanceof
will behave unpredictably. It is safest to avoid usinginstanceof
, and using this type-testing method instead.- Parameters:
x (
Any
) – Any object.- Return type:
bool
- Returns:
true if
x
is an object created from a class which extendsConstruct
.