AssetOptions¶
-
class
aws_cdk.core.
AssetOptions
(*, asset_hash=None, asset_hash_type=None, bundling=None)¶ Bases:
object
Asset hash options.
- Parameters
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 (
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
Attributes
-
asset_hash
¶ Specify a custom hash for this asset.
If
assetHashType
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 on
assetHashType
- Return type
Optional
[str
]
-
asset_hash_type
¶ Specifies the type of hash to calculate for this asset.
If
assetHash
is configured, this option must beundefined
orAssetHashType.CUSTOM
.- Default
the default is
AssetHashType.SOURCE
, but ifassetHash
is
explicitly specified this value defaults to
AssetHashType.CUSTOM
.- Return type
Optional
[AssetHashType
]
-
bundling
¶ (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
- Return type
Optional
[BundlingOptions
]