AssetProps
- class aws_cdk.aws_s3_assets.AssetProps(*, exclude=None, follow=None, ignore_mode=None, follow_symlinks=None, asset_hash=None, asset_hash_type=None, bundling=None, readers=None, source_hash=None, path)
Bases:
AssetOptions
- Parameters:
exclude (
Optional
[Sequence
[str
]]) – 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
]) – The ignore behavior to use for exclude patterns. Default: IgnoreMode.GLOBfollow_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 (
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 otherwisereaders (
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.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.
- ExampleMetadata:
lit=test/integ.assets.bundling.lit.ts infused
Example:
asset = assets.Asset(self, "BundledAsset", path=path.join(__dirname, "markdown-asset"), # /asset-input and working directory in the container bundling=BundlingOptions( image=DockerImage.from_build(path.join(__dirname, "alpine-markdown")), # Build an image command=["sh", "-c", """ markdown index.md > /asset-output/index.html """ ] ) )
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
- 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
.
- bundling
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
- exclude
Glob patterns to exclude from the copy.
- Default:
nothing is excluded
- follow
(deprecated) A strategy for how to handle symlinks.
- Default:
Never
- Deprecated:
use
followSymlinks
instead- Stability:
deprecated
- follow_symlinks
A strategy for how to handle symlinks.
- Default:
SymlinkFollowMode.NEVER
- ignore_mode
The ignore behavior to use for exclude patterns.
- Default:
IgnoreMode.GLOB
- path
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
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
(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.
- Deprecated:
see
assetHash
andassetHashType
- Stability:
deprecated