2.169.0

interface AssetProps

LanguageType name
.NETAmazon.CDK.AWS.S3.Assets.AssetProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awss3assets#AssetProps
Javasoftware.amazon.awscdk.services.s3.assets.AssetProps
Pythonaws_cdk.aws_s3_assets.AssetProps
TypeScript (source)aws-cdk-lib » aws_s3_assets » AssetProps

Example

import * as cdk from 'aws-cdk-lib';

const asset = new Asset(this, 'BundledAsset', {
  path: '/path/to/asset',
  bundling: {
    image: cdk.DockerImage.fromRegistry('alpine'),
    command: ['command-that-produces-an-archive.sh'],
    outputType: cdk.BundlingOutput.NOT_ARCHIVED, // Bundling output will be zipped even though it produces a single archive file.
  },
});

Properties

NameTypeDescription
pathstringThe disk location of the asset.
assetHash?stringSpecify a custom hash for this asset.
assetHashType?AssetHashTypeSpecifies the type of hash to calculate for this asset.
bundling?BundlingOptionsBundle the asset by executing a command in a Docker container or a custom bundling provider.
deployTime?booleanWhether or not the asset needs to exist beyond deployment time;
exclude?string[]File paths matching the patterns will be excluded.
followSymlinks?SymlinkFollowModeA strategy for how to handle symlinks.
ignoreMode?IgnoreModeThe ignore behavior to use for exclude patterns.
readers?IGrantable[]A list of principals that should be able to read this asset from S3.
sourceKMSKey?IKeyThe ARN of the KMS key used to encrypt the handler code.

path

Type: string

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.

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.

← PreviousNext →