(experimental) Canary code from an inline string.
bind(_scope, handler, _family)¶
(experimental) Called when the canary is initialized to allow this object to bind to the stack, add resources and have fun.
from_asset(asset_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)¶
(experimental) Specify code from a local path.
Path must include the folder structure
str) – Either a directory or a .zip file.
IGrantable]]) – 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.
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.
str]]) – (deprecated) Glob patterns to exclude from the copy. Default: nothing is excluded
FollowMode]) – (deprecated) A strategy for how to handle symlinks. Default: Never
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 ‘
SymlinkFollowMode]) – A strategy for how to handle symlinks. Default: SymlinkFollowMode.NEVER
str]) – Specify a custom hash for this asset. If
assetHashTypeis 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]) – Specifies the type of hash to calculate for this asset. If
assetHashis configured, this option must be
AssetHashType.CUSTOM. Default: - the default is
AssetHashType.SOURCE, but if
assetHashis explicitly specified this value defaults to
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-outputwill 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
- Return type
AssetCodeassociated with the specified path.
from_bucket(bucket, key, object_version=None)¶
(experimental) Specify code from an s3 bucket.
The object in the s3 bucket must be a .zip file that contains the structure
IBucket) – The S3 bucket.
str) – The object key.
str]) – Optional S3 object version.
- Return type
S3Codeassociated with the specified S3 object.