software.amazon.awscdk.services.s3.assets

Class AssetProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.s3.assets.AssetProps.Jsii$Proxy

All Implemented Interfaces:

CopyOptions, AssetOptions, AssetProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

AssetProps

@Stability(value=Experimental)
 @Internal
public static final class AssetProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements AssetProps

An implementation for AssetProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.s3.assets.AssetProps

AssetProps.Builder, AssetProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.
protected	Jsii$Proxy(String path, List<? extends IGrantable> readers, String sourceHash, List<String> exclude, FollowMode follow, IgnoreMode ignoreMode, String assetHash, AssetHashType assetHashType, BundlingOptions bundling) Constructor that initializes the object based on literal property values passed by the AssetProps.Builder.

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
boolean	equals(Object o)
String	getAssetHash() (experimental) Specify a custom hash for this asset.
AssetHashType	getAssetHashType() (experimental) Specifies the type of hash to calculate for this asset.
BundlingOptions	getBundling() (experimental) Bundle the asset by executing a command in a Docker container.
List<String>	getExclude() (deprecated) Glob patterns to exclude from the copy.
FollowMode	getFollow() (deprecated) A strategy for how to handle symlinks.
IgnoreMode	getIgnoreMode() (deprecated) The ignore behavior to use for exclude patterns.
String	getPath() (experimental) The disk location of the asset.
List<IGrantable>	getReaders() (experimental) A list of principals that should be able to read this asset from S3.
String	getSourceHash() (deprecated) Custom hash to use when identifying the specific version of the asset.
int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.services.s3.assets.AssetProps

builder

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(String path,
                     List<? extends IGrantable> readers,
                     String sourceHash,
                     List<String> exclude,
                     FollowMode follow,
                     IgnoreMode ignoreMode,
                     String assetHash,
                     AssetHashType assetHashType,
                     BundlingOptions bundling)

Constructor that initializes the object based on literal property values passed by the AssetProps.Builder.

Method Detail

getPath

public final String getPath()

Description copied from interface: AssetProps

(experimental) 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.

Specified by:

getPath in interface AssetProps

getReaders

public final List<IGrantable> getReaders()

Description copied from interface: AssetOptions

(experimental) 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.

getSourceHash

public final String getSourceHash()

Description copied from interface: AssetOptions

(deprecated) 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.

Default: - automatically calculate source hash based on the contents of the source file or directory.

getExclude

public final List<String> getExclude()

Description copied from interface: CopyOptions

(deprecated) Glob patterns to exclude from the copy.

Default: nothing is excluded

Specified by:

getExclude in interface CopyOptions

getFollow

public final FollowMode getFollow()

Description copied from interface: CopyOptions

(deprecated) A strategy for how to handle symlinks.

Default: Never

Specified by:

getFollow in interface CopyOptions

getIgnoreMode

public final IgnoreMode getIgnoreMode()

Description copied from interface: CopyOptions

(deprecated) The ignore behavior to use for exclude patterns.

Default: - GLOB for file assets, DOCKER or GLOB for docker assets depending on whether the '

Specified by:

getIgnoreMode in interface CopyOptions

getAssetHash

public final String getAssetHash()

Description copied from interface: AssetOptions

(experimental) 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.

Default: - based on `assetHashType`

Specified by:

getAssetHash in interface AssetOptions

getAssetHashType

public final AssetHashType getAssetHashType()

Description copied from interface: AssetOptions

(experimental) Specifies 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`.

Specified by:

getAssetHashType in interface AssetOptions

getBundling

public final BundlingOptions getBundling()

Description copied from interface: AssetOptions

(experimental) Bundle the asset by executing a command in a Docker container.

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

Specified by:

getBundling in interface AssetOptions

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object