Asset
- class aws_cdk.aws_s3_assets.Asset(scope, id, *, path, deploy_time=None, readers=None, source_kms_key=None, asset_hash=None, asset_hash_type=None, bundling=None, exclude=None, follow_symlinks=None, ignore_mode=None)
Bases:
Construct
An asset represents a local file or directory, which is automatically uploaded to S3 and then can be referenced within a CDK application.
- ExampleMetadata:
infused
Example:
import aws_cdk as cdk asset = Asset(self, "BundledAsset", path="/path/to/asset", bundling=cdk.BundlingOptions( image=cdk.DockerImage.from_registry("alpine"), command=["command-that-produces-an-archive.sh"], output_type=cdk.BundlingOutput.NOT_ARCHIVED ) )
- Parameters:
scope (
Construct
) –id (
str
) –path (
str
) – The disk location of the asset. The path should refer to one of the following: - A regular file or a .zip file, in which case the file will be uploaded as-is to S3. - A directory, in which case it will be archived into a .zip file and uploaded to S3.deploy_time (
Optional
[bool
]) – Whether or not the asset needs to exist beyond deployment time; i.e. are copied over to a different location and not needed afterwards. Setting this property to true has an impact on the lifecycle of the asset, because we will assume that it is safe to delete after the CloudFormation deployment succeeds. For example, Lambda Function assets are copied over to Lambda during deployment. Therefore, it is not necessary to store the asset in S3, so we consider those deployTime assets. Default: falsereaders (
Optional
[Sequence
[IGrantable
]]) – A list of principals that should be able to read this asset from S3. You can useasset.grantRead(principal)
to grant read permissions later. Default: - No principals that can read file asset.source_kms_key (
Optional
[IKey
]) – The ARN of the KMS key used to encrypt the handler code. Default: - the default server-side encryption with Amazon S3 managed keys(SSE-S3) key will be used.asset_hash (
Optional
[str
]) – Specify a custom hash for this asset. IfassetHashType
is set it must be set toAssetHashType.CUSTOM
. For consistency, this custom hash will be SHA256 hashed and encoded as hex. The resulting hash will be the asset hash. NOTE: the hash is used in order to identify a specific revision of the asset, and used for optimizing and caching deployment activities related to this asset such as packaging, uploading to Amazon S3, etc. If you chose to customize the hash, you will need to make sure it is updated every time the asset changes, or otherwise it is possible that some deployments will not be invalidated. Default: - based onassetHashType
asset_hash_type (
Optional
[AssetHashType
]) – Specifies the type of hash to calculate for this asset. IfassetHash
is configured, this option must beundefined
orAssetHashType.CUSTOM
. Default: - the default isAssetHashType.SOURCE
, but ifassetHash
is explicitly specified this value defaults toAssetHashType.CUSTOM
.bundling (
Union
[BundlingOptions
,Dict
[str
,Any
],None
]) – Bundle the asset by executing a command in a Docker container or a custom bundling provider. The asset path will be mounted at/asset-input
. The Docker container is responsible for putting content at/asset-output
. The content at/asset-output
will be zipped and used as the final asset. Default: - uploaded as-is to S3 if the asset is a regular file or a .zip file, archived into a .zip file and uploaded to S3 otherwiseexclude (
Optional
[Sequence
[str
]]) – File paths matching the patterns will be excluded. SeeignoreMode
to set the matching behavior. Has no effect on Assets bundled using thebundling
property. Default: - nothing is excludedfollow_symlinks (
Optional
[SymlinkFollowMode
]) – A strategy for how to handle symlinks. Default: SymlinkFollowMode.NEVERignore_mode (
Optional
[IgnoreMode
]) – The ignore behavior to use forexclude
patterns. Default: IgnoreMode.GLOB
Methods
- add_resource_metadata(resource, resource_property)
Adds CloudFormation template metadata to the specified resource with information that indicates which resource property is mapped to this local asset.
This can be used by tools such as SAM CLI to provide local experience such as local invocation and debugging of Lambda functions.
Asset metadata will only be included if the stack is synthesized with the “aws:cdk:enable-asset-metadata” context key defined, which is the default behavior when synthesizing via the CDK Toolkit.
- Parameters:
resource (
CfnResource
) – The CloudFormation resource which is using this asset [disable-awslint:ref-via-interface].resource_property (
str
) – The property name where this asset is referenced (e.g. “Code” for AWS::Lambda::Function).
- See:
- Return type:
None
- grant_read(grantee)
Grants read permissions to the principal on the assets bucket.
- Parameters:
grantee (
IGrantable
) –- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str
Attributes
- asset_hash
A hash of this asset, which is available at construction time.
As this is a plain string, it can be used in construct IDs in order to enforce creation of a new resource when the content hash has changed.
- asset_path
The path to the asset, relative to the current Cloud Assembly.
If asset staging is disabled, this will just be the original path. If asset staging is enabled it will be the staged path.
- bucket
The S3 bucket in which this asset resides.
- http_url
Attribute which represents the S3 HTTP URL of this asset.
For example,
https://s3.us-west-1.amazonaws.com/bucket/key
- is_file
Indicates if this asset is a single file.
Allows constructs to ensure that the correct file type was used.
- is_zip_archive
Indicates if this asset is a zip archive.
Allows constructs to ensure that the correct file type was used.
- node
The tree node.
- s3_bucket_name
Attribute that represents the name of the bucket this asset exists in.
- s3_object_key
Attribute which represents the S3 object key of this asset.
- s3_object_url
Attribute which represents the S3 URL of this asset.
For example,
s3://bucket/key
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
.