class Asset (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.S3.Assets.Asset`
Java	`software.amazon.awscdk.services.s3.assets.Asset`
Python	`aws_cdk.aws_s3_assets.Asset`
TypeScript (source)	`@aws-cdk/aws-s3-assets` » `Asset`

Implements IConstruct, IConstruct, IDependable, IAsset

An asset represents a local file or directory, which is automatically uploaded to S3 and then can be referenced within a CDK application.

Example

import * as s3Assets from '@aws-cdk/aws-s3-assets';

declare const cluster: eks.Cluster;
const chartAsset = new s3Assets.Asset(this, 'ChartAsset', {
  path: '/path/to/asset'
});

cluster.addHelmChart('test-chart', {
  chartAsset: chartAsset,
});

Initializer

new Asset(scope: Construct, id: string, props: AssetProps)

Parameters

scope Construct
id string
props AssetProps

Construct Props

Name	Type	Description
path	`string`	The disk location of the asset.
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.
exclude?	`string[]`	Glob patterns to exclude from the copy.
follow?⚠️	`FollowMode`	A strategy for how to handle symlinks.
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.
sourceHash?⚠️	`string`	Custom hash to use when identifying the specific version of the asset.

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.

exclude?

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

Glob patterns to exclude from the copy.

follow?⚠️

⚠️ Deprecated: use followSymlinks instead

Type: FollowMode (optional, default: Never)

A strategy for how to handle symlinks.

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.

sourceHash?⚠️

⚠️ Deprecated: see assetHash and assetHashType

Type: string (optional, default: automatically calculate source hash based on the contents of the source file or directory.)

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.

Properties

Name	Type	Description
assetHash	`string`	A hash of this asset, which is available at construction time.
assetPath	`string`	The path to the asset, relative to the current Cloud Assembly.
bucket	`IBucket`	The S3 bucket in which this asset resides.
httpUrl	`string`	Attribute which represents the S3 HTTP URL of this asset.
isFile	`boolean`	Indicates if this asset is a single file.
isZipArchive	`boolean`	Indicates if this asset is a zip archive.
node	`ConstructNode`	The construct tree node associated with this construct.
s3BucketName	`string`	Attribute that represents the name of the bucket this asset exists in.
s3ObjectKey	`string`	Attribute which represents the S3 object key of this asset.
s3ObjectUrl	`string`	Attribute which represents the S3 URL of this asset.
s3Url⚠️	`string`	Attribute which represents the S3 URL of this asset.
sourceHash⚠️	`string`	A cryptographic hash of the asset.

assetHash

Type: string

A hash of this asset, which is available at construction time.

As this is a plain string, it can be used in construct IDs in order to enforce creation of a new resource when the content hash has changed.

assetPath

Type: string

The path to the asset, relative to the current Cloud Assembly.

If asset staging is disabled, this will just be the original path. If asset staging is enabled it will be the staged path.

bucket

Type: IBucket

The S3 bucket in which this asset resides.

httpUrl

Type: string

Attribute which represents the S3 HTTP URL of this asset.

For example, https://s3.us-west-1.amazonaws.com/bucket/key

isFile

Type: boolean

Indicates if this asset is a single file.

Allows constructs to ensure that the correct file type was used.

isZipArchive

Type: boolean

Indicates if this asset is a zip archive.

Allows constructs to ensure that the correct file type was used.

node

Type: ConstructNode

The construct tree node associated with this construct.

s3BucketName

Type: string

Attribute that represents the name of the bucket this asset exists in.

s3ObjectKey

Type: string

Attribute which represents the S3 object key of this asset.

s3ObjectUrl

Type: string

Attribute which represents the S3 URL of this asset.

For example, s3://bucket/key

s3Url⚠️

⚠️ Deprecated: use httpUrl

Type: string

Attribute which represents the S3 URL of this asset.

sourceHash⚠️

⚠️ Deprecated: see assetHash

Type: string

A cryptographic hash of the asset.

Methods

Name	Description
addResourceMetadata(resource, resourceProperty)	Adds CloudFormation template metadata to the specified resource with information that indicates which resource property is mapped to this local asset.
grantRead(grantee)	Grants read permissions to the principal on the assets bucket.
toString()	Returns a string representation of this construct.

addResourceMetadata(resource, resourceProperty)

public addResourceMetadata(resource: CfnResource, resourceProperty: string): void

Parameters

resource CfnResource — The CloudFormation resource which is using this asset [disable-awslint:ref-via-interface].
resourceProperty string — The property name where this asset is referenced (e.g. "Code" for AWS::Lambda::Function).

Adds CloudFormation template metadata to the specified resource with information that indicates which resource property is mapped to this local asset.

This can be used by tools such as SAM CLI to provide local experience such as local invocation and debugging of Lambda functions.

Asset metadata will only be included if the stack is synthesized with the "aws:cdk:enable-asset-metadata" context key defined, which is the default behavior when synthesizing via the CDK Toolkit.

grantRead(grantee)

public grantRead(grantee: IGrantable): void

Parameters

grantee IGrantable

Grants read permissions to the principal on the assets bucket.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.