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

(experimental) An asset represents a local file or directory, which is automatically uploaded to S3 and then can be referenced within a CDK application.

Stability

experimental

Parameters
  • scope (Construct) –

  • id (str) –

  • path (str) – (experimental) 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]]) – (experimental) A list of principals that should be able to read this asset from S3. You can use asset.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 excluded

  • follow (Optional[FollowMode]) – (deprecated) A strategy for how to handle symlinks. Default: Never

  • ignore_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.NEVER

  • asset_hash (Optional[str]) – Specify a custom hash for this asset. If assetHashType is set it must be set to AssetHashType.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 on assetHashType

  • asset_hash_type (Optional[AssetHashType]) – Specifies the type of hash to calculate for this asset. If assetHash is configured, this option must be undefined or AssetHashType.CUSTOM. Default: - the default is AssetHashType.SOURCE, but if assetHash is explicitly specified this value defaults to AssetHashType.CUSTOM.

  • bundling (Optional[BundlingOptions]) – (experimental) Bundle the asset by executing a command in a Docker container. 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

Stability

experimental

Methods

add_resource_metadata(resource, resource_property)

(experimental) 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

https://github.com/aws/aws-cdk/issues/1432

Stability

experimental

Return type

None

grant_read(grantee)

(experimental) Grants read permissions to the principal on the assets bucket.

Parameters

grantee (IGrantable) –

Stability

experimental

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

asset_hash

(experimental) 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.

Stability

experimental

Return type

str

asset_path

(experimental) 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.

Stability

experimental

Return type

str

bucket

(experimental) The S3 bucket in which this asset resides.

Stability

experimental

Return type

IBucket

http_url

(experimental) Attribute which represents the S3 HTTP URL of this asset.

Stability

experimental

Example:

# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
https:
Return type

str

is_file

(experimental) Indicates if this asset is a single file.

Allows constructs to ensure that the correct file type was used.

Stability

experimental

Return type

bool

is_zip_archive

(experimental) Indicates if this asset is a zip archive.

Allows constructs to ensure that the correct file type was used.

Stability

experimental

Return type

bool

node

The construct tree node associated with this construct.

Return type

ConstructNode

s3_bucket_name

(experimental) Attribute that represents the name of the bucket this asset exists in.

Stability

experimental

Return type

str

s3_object_key

(experimental) Attribute which represents the S3 object key of this asset.

Stability

experimental

Return type

str

s3_object_url

(experimental) Attribute which represents the S3 URL of this asset.

Stability

experimental

Example:

# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
s3:
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