software.amazon.awscdk.services.apigateway

Class AssetApiDefinition.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.AssetApiDefinition.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<AssetApiDefinition>

Enclosing class:

AssetApiDefinition

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

A fluent builder for AssetApiDefinition.

Method Summary

Modifier and Type	Method and Description
AssetApiDefinition.Builder	assetHash(String assetHash) Specify a custom hash for this asset.
AssetApiDefinition.Builder	assetHashType(AssetHashType assetHashType) Specifies the type of hash to calculate for this asset.
AssetApiDefinition	build()
AssetApiDefinition.Builder	bundling(BundlingOptions bundling) Bundle the asset by executing a command in a Docker container or a custom bundling provider.
static AssetApiDefinition.Builder	create(String path)
AssetApiDefinition.Builder	exclude(List<String> exclude) File paths matching the patterns will be excluded.
AssetApiDefinition.Builder	followSymlinks(SymlinkFollowMode followSymlinks) A strategy for how to handle symlinks.
AssetApiDefinition.Builder	ignoreMode(IgnoreMode ignoreMode) The ignore behavior to use for `exclude` patterns.
AssetApiDefinition.Builder	readers(List<? extends IGrantable> readers) A list of principals that should be able to read this asset from S3.

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 AssetApiDefinition.Builder create(String path)

Parameters:

path - This parameter is required.

Returns:

a new instance of AssetApiDefinition.Builder.

assetHash

@Stability(value=Stable)
public AssetApiDefinition.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 AssetApiDefinition.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 AssetApiDefinition.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

exclude

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

File paths matching the patterns will be excluded.

See ignoreMode to set the matching behavior. Has no effect on Assets bundled using the bundling property.

Default: - nothing is excluded

Parameters:

exclude - File paths matching the patterns will be excluded. This parameter is required.

Returns:

this

followSymlinks

@Stability(value=Stable)
public AssetApiDefinition.Builder followSymlinks(SymlinkFollowMode followSymlinks)

A strategy for how to handle symlinks.

Default: SymlinkFollowMode.NEVER

Parameters:

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

Returns:

this

ignoreMode

@Stability(value=Stable)
public AssetApiDefinition.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

readers

@Stability(value=Stable)
public AssetApiDefinition.Builder readers(List<? extends IGrantable> 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.

Default: - No principals that can read file asset.

Parameters:

readers - A list of principals that should be able to read this asset from S3. This parameter is required.

Returns:

this

build

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

Specified by:

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