software.amazon.awscdk

Class AssetStagingProps.Builder

java.lang.Object

software.amazon.awscdk.AssetStagingProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<AssetStagingProps>

Enclosing interface:

AssetStagingProps

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

A builder for AssetStagingProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
AssetStagingProps.Builder	assetHash(String assetHash) Sets the value of AssetOptions.getAssetHash()
AssetStagingProps.Builder	assetHashType(AssetHashType assetHashType) Sets the value of AssetOptions.getAssetHashType()
AssetStagingProps	build() Builds the configured instance.
AssetStagingProps.Builder	bundling(BundlingOptions bundling) Sets the value of AssetOptions.getBundling()
AssetStagingProps.Builder	exclude(List<String> exclude) Sets the value of CopyOptions.getExclude()
AssetStagingProps.Builder	extraHash(String extraHash) Sets the value of FingerprintOptions.getExtraHash()
AssetStagingProps.Builder	follow(SymlinkFollowMode follow) Sets the value of CopyOptions.getFollow()
AssetStagingProps.Builder	ignoreMode(IgnoreMode ignoreMode) Sets the value of CopyOptions.getIgnoreMode()
AssetStagingProps.Builder	sourcePath(String sourcePath) Sets the value of AssetStagingProps.getSourcePath()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

sourcePath

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

Sets the value of AssetStagingProps.getSourcePath()

Parameters:

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

Returns:

this

extraHash

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

Sets the value of FingerprintOptions.getExtraHash()

Parameters:

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

Returns:

this

exclude

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

Sets the value of CopyOptions.getExclude()

Parameters:

exclude - Glob patterns to exclude from the copy.

Returns:

this

follow

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

Sets the value of CopyOptions.getFollow()

Parameters:

follow - A strategy for how to handle symlinks.

Returns:

this

ignoreMode

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

Sets the value of CopyOptions.getIgnoreMode()

Parameters:

ignoreMode - The ignore behavior to use for exclude patterns.

Returns:

this

assetHash

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

Sets the value of AssetOptions.getAssetHash()

Parameters:

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.

Returns:

this

assetHashType

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

Sets the value of AssetOptions.getAssetHashType()

Parameters:

assetHashType - Specifies the type of hash to calculate for this asset. If assetHash is configured, this option must be undefined or AssetHashType.CUSTOM.

Returns:

this

bundling

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

Sets the value of AssetOptions.getBundling()

Parameters:

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.

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of AssetStagingProps

Throws:

NullPointerException - if any required attribute was not provided