software.amazon.awscdk.services.s3.assets

Class AssetOptions.Builder

java.lang.Object

software.amazon.awscdk.services.s3.assets.AssetOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<AssetOptions>

Enclosing interface:

AssetOptions

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

A builder for AssetOptions

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
AssetOptions.Builder	assetHash(String assetHash) Sets the value of AssetOptions.getAssetHash()
AssetOptions.Builder	assetHashType(AssetHashType assetHashType) Sets the value of AssetOptions.getAssetHashType()
AssetOptions	build() Builds the configured instance.
AssetOptions.Builder	bundling(BundlingOptions bundling) Sets the value of AssetOptions.getBundling()
AssetOptions.Builder	exclude(List<String> exclude) Sets the value of FileCopyOptions.getExclude()
AssetOptions.Builder	followSymlinks(SymlinkFollowMode followSymlinks) Sets the value of FileCopyOptions.getFollowSymlinks()
AssetOptions.Builder	ignoreMode(IgnoreMode ignoreMode) Sets the value of FileCopyOptions.getIgnoreMode()
AssetOptions.Builder	readers(List<? extends IGrantable> readers) Sets the value of AssetOptions.getReaders()

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

readers

@Stability(value=Experimental)
public AssetOptions.Builder readers(List<? extends IGrantable> readers)

Sets the value of AssetOptions.getReaders()

Parameters:

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

Returns:

this

assetHash

@Stability(value=Experimental)
public AssetOptions.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=Experimental)
public AssetOptions.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=Experimental)
public AssetOptions.Builder bundling(BundlingOptions bundling)

Sets the value of AssetOptions.getBundling()

Parameters:

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

Returns:

this

exclude

@Stability(value=Experimental)
public AssetOptions.Builder exclude(List<String> exclude)

Sets the value of FileCopyOptions.getExclude()

Parameters:

exclude - Glob patterns to exclude from the copy.

Returns:

this

followSymlinks

@Stability(value=Experimental)
public AssetOptions.Builder followSymlinks(SymlinkFollowMode followSymlinks)

Sets the value of FileCopyOptions.getFollowSymlinks()

Parameters:

followSymlinks - A strategy for how to handle symlinks.

Returns:

this

ignoreMode

@Stability(value=Experimental)
public AssetOptions.Builder ignoreMode(IgnoreMode ignoreMode)

Sets the value of FileCopyOptions.getIgnoreMode()

Parameters:

ignoreMode - The ignore behavior to use for exclude patterns.

Returns:

this

build

@Stability(value=Experimental)
public AssetOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of AssetOptions

Throws:

NullPointerException - if any required attribute was not provided