software.amazon.awscdk.core

Class AssetStaging.Builder

java.lang.Object

software.amazon.awscdk.core.AssetStaging.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<AssetStaging>

Enclosing class:

AssetStaging

@Stability(value=Stable)
public static final class AssetStaging.Builder
extends Object
implements software.amazon.jsii.Builder<AssetStaging>

A fluent builder for AssetStaging.

Method Summary

Modifier and Type	Method and Description
AssetStaging.Builder	assetHash(String assetHash) Specify a custom hash for this asset.
AssetStaging.Builder	assetHashType(AssetHashType assetHashType) Specifies the type of hash to calculate for this asset.
AssetStaging	build()
AssetStaging.Builder	bundling(BundlingOptions bundling) Bundle the asset by executing a command in a Docker container or a custom bundling provider.
static AssetStaging.Builder	create(software.constructs.Construct scope, String id)
AssetStaging.Builder	exclude(List<String> exclude) Glob patterns to exclude from the copy.
AssetStaging.Builder	extraHash(String extraHash) Extra information to encode into the fingerprint (e.g.
AssetStaging.Builder	follow(SymlinkFollowMode follow) A strategy for how to handle symlinks.
AssetStaging.Builder	ignoreMode(IgnoreMode ignoreMode) The ignore behavior to use for exclude patterns.
AssetStaging.Builder	sourcePath(String sourcePath) The source file or directory to copy from.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Stable)
public static AssetStaging.Builder create(software.constructs.Construct scope,
                                                                   String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of AssetStaging.Builder.

exclude

@Stability(value=Stable)
public AssetStaging.Builder exclude(List<String> exclude)

Glob patterns to exclude from the copy.

Default: - nothing is excluded

Parameters:

exclude - Glob patterns to exclude from the copy. This parameter is required.

Returns:

this

follow

@Stability(value=Stable)
public AssetStaging.Builder follow(SymlinkFollowMode follow)

A strategy for how to handle symlinks.

Default: SymlinkFollowMode.NEVER

Parameters:

follow - A strategy for how to handle symlinks. This parameter is required.

Returns:

this

ignoreMode

@Stability(value=Stable)
public AssetStaging.Builder ignoreMode(IgnoreMode ignoreMode)

The ignore behavior to use for exclude patterns.

Default: IgnoreMode.GLOB

Parameters:

ignoreMode - The ignore behavior to use for exclude patterns. This parameter is required.

Returns:

this

extraHash

@Stability(value=Stable)
public AssetStaging.Builder extraHash(String extraHash)

Extra information to encode into the fingerprint (e.g. build instructions and other inputs).

Default: - hash is only based on source content

Parameters:

extraHash - Extra information to encode into the fingerprint (e.g. build instructions and other inputs). This parameter is required.

Returns:

this

assetHash

@Stability(value=Stable)
public AssetStaging.Builder assetHash(String assetHash)

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`

Parameters:

assetHash - Specify a custom hash for this asset. This parameter is required.

Returns:

this

assetHashType

@Stability(value=Stable)
public AssetStaging.Builder assetHashType(AssetHashType assetHashType)

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

Parameters:

assetHashType - Specifies the type of hash to calculate for this asset. This parameter is required.

Returns:

this

bundling

@Stability(value=Stable)
public AssetStaging.Builder bundling(BundlingOptions bundling)

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.

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

Parameters:

bundling - Bundle the asset by executing a command in a Docker container or a custom bundling provider. This parameter is required.

Returns:

this

sourcePath

@Stability(value=Stable)
public AssetStaging.Builder sourcePath(String sourcePath)

The source file or directory to copy from.

Parameters:

sourcePath - The source file or directory to copy from. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public AssetStaging build()

Specified by:

build in interface software.amazon.jsii.Builder<AssetStaging>