Asset
An asset represents a local file or directory, which is automatically uploaded to S3 and then can be referenced within a CDK application.
Import
import { Asset } from 'aws-cdk-lib/aws-s3-assets';Or use the module namespace:
import * as s3_assets from 'aws-cdk-lib/aws-s3-assets';
// s3_assets.AssetProperties
Configuration passed to the constructor as AssetProps.
pathRequiredstringThe 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.
7 properties inherited from AssetOptions
deployTimeOptionalinherited from AssetOptionsbooleanWhether or not the asset needs to exist beyond deployment time; i.e. are copied over to a different location and not needed afterwards. Setting this property to true has an impact on the lifecycle of the asset, because we will assume that it is safe to delete after the CloudFormation deployment succeeds. For example, Lambda Function assets are copied over to Lambda during deployment. Therefore, it is not necessary to store the asset in S3, so we consider those deployTime assets.
Default: false
displayNameOptionalinherited from AssetOptionsstringA display name for this asset. If supplied, the display name will be used in locations where the asset identifier is printed, like in the CLI progress information. If the same asset is added multiple times, the display name of the first occurrence is used. The default is the construct path of the Asset construct, with respect to the enclosing stack. If the asset is produced by a construct helper function (such as `lambda.Code.fromAsset()`), this will look like `MyFunction/Code`. We use the stack-relative construct path so that in the common case where you have multiple stacks with the same asset, we won't show something like `/MyBetaStack/MyFunction/Code` when you are actually deploying to production.
Default: - Stack-relative construct path
readersOptionalinherited from AssetOptionsIGrantable[]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.
sourceKMSKeyOptionalinherited from AssetOptionsIKeyRefThe ARN of the KMS key used to encrypt the handler code.
Default: - the default server-side encryption with Amazon S3 managed keys(SSE-S3) key will be used.
assetHashOptionalinherited from AssetOptionsstringSpecify 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`
assetHashTypeOptionalinherited from AssetOptionsAssetHashTypeSpecifies 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`.
bundlingOptionalinherited from AssetOptionsBundlingOptionsBundle 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
3 properties inherited from FileCopyOptions
excludeOptionalinherited from FileCopyOptionsstring[]File paths matching the patterns will be excluded. See `ignoreMode` to set the matching behavior. Has no effect on Assets bundled using the `bundling` property.
Default: - nothing is excluded
followSymlinksOptionalinherited from FileCopyOptionsSymlinkFollowModeA strategy for how to handle symlinks.
Default: SymlinkFollowMode.NEVER
ignoreModeOptionalinherited from FileCopyOptionsIgnoreModeThe ignore behavior to use for `exclude` patterns.
Default: IgnoreMode.GLOB
Learn AWS the Practical Way
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterQuick Facts
aws-s3-assets