interface AssetOptions

Language	Type name
.NET	`Amazon.CDK.AWS.S3.Assets.AssetOptions`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awss3assets#AssetOptions`
Java	`software.amazon.awscdk.services.s3.assets.AssetOptions`
Python	`aws_cdk.aws_s3_assets.AssetOptions`
TypeScript (source)	`aws-cdk-lib` » `aws_s3_assets` » `AssetOptions`

Example

new lambda.Function(this, 'Function', {
  code: lambda.Code.fromAsset(path.join(__dirname, 'my-python-handler'), {
    bundling: {
      image: lambda.Runtime.PYTHON_3_9.bundlingImage,
      command: [
        'bash', '-c',
        'pip install -r requirements.txt -t /asset-output && cp -au . /asset-output'
      ],
    },
  }),
  runtime: lambda.Runtime.PYTHON_3_9,
  handler: 'index.handler',
});

Properties

Name	Type	Description
assetHash?	`string`	Specify a custom hash for this asset.
assetHashType?	`AssetHashType`	Specifies the type of hash to calculate for this asset.
bundling?	`BundlingOptions`	Bundle the asset by executing a command in a Docker container or a custom bundling provider.
deployTime?	`boolean`	Whether or not the asset needs to exist beyond deployment time;
exclude?	`string[]`	File paths matching the patterns will be excluded.
followSymlinks?	`SymlinkFollowMode`	A strategy for how to handle symlinks.
ignoreMode?	`IgnoreMode`	The ignore behavior to use for `exclude` patterns.
readers?	`IGrantable[]`	A list of principals that should be able to read this asset from S3.
sourceKMSKey?	`IKey`	The ARN of the KMS key used to encrypt the handler code.

assetHash?

Type: string (optional, default: based on assetHashType)

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.

assetHashType?

Type: AssetHashType (optional, default: the default is AssetHashType.SOURCE, but if assetHash is explicitly specified this value defaults to AssetHashType.CUSTOM.)

Specifies the type of hash to calculate for this asset.

If assetHash is configured, this option must be undefined or AssetHashType.CUSTOM.

bundling?

Type: BundlingOptions (optional, 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)

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.

deployTime?

Type: boolean (optional, default: false)

Whether 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.

exclude?

Type: string[] (optional, default: nothing is excluded)

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.

followSymlinks?

Type: SymlinkFollowMode (optional, default: SymlinkFollowMode.NEVER)

A strategy for how to handle symlinks.

ignoreMode?

Type: IgnoreMode (optional, default: IgnoreMode.GLOB)

The ignore behavior to use for exclude patterns.

readers?

Type: IGrantable[] (optional, default: No principals that can read file asset.)

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.

sourceKMSKey?

Type: IKey (optional, default: the default server-side encryption with Amazon S3 managed keys(SSE-S3) key will be used.)

The ARN of the KMS key used to encrypt the handler code.