Asset¶
-
class
aws_cdk.aws_s3_assets.
Asset
(scope, id, *, path, readers=None, source_hash=None, exclude=None, follow=None, ignore_mode=None, follow_symlinks=None, asset_hash=None, asset_hash_type=None, bundling=None)¶ Bases:
aws_cdk.core.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.aws_s3_assets as s3_assets # cluster: eks.Cluster chart_asset = s3_assets.Asset(self, "ChartAsset", path="/path/to/asset" ) cluster.add_helm_chart("test-chart", chart_asset=chart_asset )
- 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.readers (
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_hash (
Optional
[str
]) – (deprecated) Custom hash to use when identifying the specific version of the asset. For consistency, this custom hash will be SHA256 hashed and encoded as hex. The resulting hash will be the asset hash. NOTE: the source 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 source hash, you will need to make sure it is updated every time the source changes, or otherwise it is possible that some deployments will not be invalidated. Default: - automatically calculate source hash based on the contents of the source file or directory.exclude (
Optional
[Sequence
[str
]]) – (deprecated) Glob patterns to exclude from the copy. Default: nothing is excludedfollow (
Optional
[FollowMode
]) – (deprecated) A strategy for how to handle symlinks. Default: Neverignore_mode (
Optional
[IgnoreMode
]) – (deprecated) The ignore behavior to use for exclude patterns. Default: - GLOB for file assets, DOCKER or GLOB for docker assets depending on whether the ‘follow_symlinks (
Optional
[SymlinkFollowMode
]) – A strategy for how to handle symlinks. Default: SymlinkFollowMode.NEVERasset_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 (
Optional
[BundlingOptions
]) – 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 otherwise
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.
- Return type
str
-
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.
- Return type
str
-
http_url
¶ Attribute which represents the S3 HTTP URL of this asset.
For example,
https://s3.us-west-1.amazonaws.com/bucket/key
- Return type
str
-
is_file
¶ Indicates if this asset is a single file.
Allows constructs to ensure that the correct file type was used.
- Return type
bool
-
is_zip_archive
¶ Indicates if this asset is a zip archive.
Allows constructs to ensure that the correct file type was used.
- Return type
bool
-
node
¶ The construct tree node associated with this construct.
- Return type
-
s3_bucket_name
¶ Attribute that represents the name of the bucket this asset exists in.
- Return type
str
-
s3_object_key
¶ Attribute which represents the S3 object key of this asset.
- Return type
str
-
s3_object_url
¶ Attribute which represents the S3 URL of this asset.
For example,
s3://bucket/key
- Return type
str
-
s3_url
¶ (deprecated) Attribute which represents the S3 URL of this asset.
- Deprecated
use
httpUrl
- Stability
deprecated
- Return type
str
-
source_hash
¶ (deprecated) A cryptographic hash of the asset.
- Deprecated
see
assetHash
- Stability
deprecated
- Return type
str
Static Methods
-
classmethod
is_construct
(x)¶ Return whether the given object is a Construct.
- Parameters
x (
Any
) –- Return type
bool