software.amazon.awscdk.services.s3.assets

Class Asset

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.services.s3.assets.Asset

All Implemented Interfaces:

IAsset, IConstruct, IDependable

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-25T18:29:02.410Z")
public class Asset
extends Construct
implements 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 software.amazon.awscdk.services.s3.assets.*;
 Cluster cluster;
 Asset chartAsset = Asset.Builder.create(this, "ChartAsset")
         .path("/path/to/asset")
         .build();
 cluster.addHelmChart("test-chart", HelmChartOptions.builder()
         .chartAsset(chartAsset)
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Asset.Builder A fluent builder for Asset.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IAsset

IAsset.Jsii$Default, IAsset.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default, IConstruct.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Asset(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Asset(software.amazon.jsii.JsiiObjectRef objRef)
	Asset(software.constructs.Construct scope, java.lang.String id, AssetProps props)

Method Summary

Modifier and Type	Method and Description
void	addResourceMetadata(CfnResource resource, java.lang.String resourceProperty) Adds CloudFormation template metadata to the specified resource with information that indicates which resource property is mapped to this local asset.
java.lang.String	getAssetHash() A hash of this asset, which is available at construction time.
java.lang.String	getAssetPath() The path to the asset, relative to the current Cloud Assembly.
IBucket	getBucket() The S3 bucket in which this asset resides.
java.lang.String	getHttpUrl() Attribute which represents the S3 HTTP URL of this asset.
java.lang.Boolean	getIsFile() Indicates if this asset is a single file.
java.lang.Boolean	getIsZipArchive() Indicates if this asset is a zip archive.
java.lang.String	getS3BucketName() Attribute that represents the name of the bucket this asset exists in.
java.lang.String	getS3ObjectKey() Attribute which represents the S3 object key of this asset.
java.lang.String	getS3ObjectUrl() Attribute which represents the S3 URL of this asset.
java.lang.String	getS3Url() Deprecated. use `httpUrl`
java.lang.String	getSourceHash() Deprecated. see `assetHash`
void	grantRead(IGrantable grantee) Grants read permissions to the principal on the assets bucket.

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Asset

protected Asset(software.amazon.jsii.JsiiObjectRef objRef)

Asset

protected Asset(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Asset

public Asset(software.constructs.Construct scope,
             java.lang.String id,
             AssetProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

addResourceMetadata

public void addResourceMetadata(CfnResource resource,
                                java.lang.String resourceProperty)

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.

Parameters:

resource - The CloudFormation resource which is using this asset [disable-awslint:ref-via-interface]. This parameter is required.

resourceProperty - The property name where this asset is referenced (e.g. "Code" for AWS::Lambda::Function). This parameter is required.

See Also:

https://github.com/aws/aws-cdk/issues/1432

grantRead

public void grantRead(IGrantable grantee)

Grants read permissions to the principal on the assets bucket.

Parameters:

grantee - This parameter is required.

getAssetHash

public java.lang.String getAssetHash()

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.

Specified by:

getAssetHash in interface IAsset

getAssetPath

public java.lang.String getAssetPath()

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.

getBucket

public IBucket getBucket()

The S3 bucket in which this asset resides.

getHttpUrl

public java.lang.String getHttpUrl()

Attribute which represents the S3 HTTP URL of this asset.

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

getIsFile

public java.lang.Boolean getIsFile()

Indicates if this asset is a single file.

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

getIsZipArchive

public java.lang.Boolean getIsZipArchive()

Indicates if this asset is a zip archive.

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

getS3BucketName

public java.lang.String getS3BucketName()

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

getS3ObjectKey

public java.lang.String getS3ObjectKey()

Attribute which represents the S3 object key of this asset.

getS3ObjectUrl

public java.lang.String getS3ObjectUrl()

Attribute which represents the S3 URL of this asset.

For example, s3://bucket/key

getS3Url

@Deprecated
public java.lang.String getS3Url()

Deprecated. use `httpUrl`

(deprecated) Attribute which represents the S3 URL of this asset.

getSourceHash

@Deprecated
public java.lang.String getSourceHash()

Deprecated. see `assetHash`

(deprecated) A cryptographic hash of the asset.