software.amazon.awscdk.services.ec2

Class InitFileAssetOptions.Builder

java.lang.Object

software.amazon.awscdk.services.ec2.InitFileAssetOptions.Builder

Enclosing interface:

InitFileAssetOptions

public static final class InitFileAssetOptions.Builder
extends java.lang.Object

A builder for InitFileAssetOptions

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
InitFileAssetOptions.Builder	assetHash(java.lang.String assetHash) Sets the value of AssetOptions.getAssetHash()
InitFileAssetOptions.Builder	assetHashType(AssetHashType assetHashType) Sets the value of AssetOptions.getAssetHashType()
InitFileAssetOptions.Builder	base64Encoded(java.lang.Boolean base64Encoded) Sets the value of InitFileOptions.getBase64Encoded()
InitFileAssetOptions	build() Builds the configured instance.
InitFileAssetOptions.Builder	bundling(BundlingOptions bundling) Sets the value of AssetOptions.getBundling()
InitFileAssetOptions.Builder	exclude(java.util.List<java.lang.String> exclude) Sets the value of AssetOptions.getExclude()
InitFileAssetOptions.Builder	follow(FollowMode follow) Deprecated. use `followSymlinks` instead
InitFileAssetOptions.Builder	followSymlinks(SymlinkFollowMode followSymlinks) Sets the value of FileCopyOptions.getFollowSymlinks()
InitFileAssetOptions.Builder	group(java.lang.String group) Sets the value of InitFileOptions.getGroup()
InitFileAssetOptions.Builder	ignoreMode(IgnoreMode ignoreMode) Sets the value of AssetOptions.getIgnoreMode()
InitFileAssetOptions.Builder	mode(java.lang.String mode) Sets the value of InitFileOptions.getMode()
InitFileAssetOptions.Builder	owner(java.lang.String owner) Sets the value of InitFileOptions.getOwner()
InitFileAssetOptions.Builder	readers(java.util.List<? extends IGrantable> readers) Sets the value of AssetOptions.getReaders()
InitFileAssetOptions.Builder	serviceRestartHandles(java.util.List<? extends InitServiceRestartHandle> serviceRestartHandles) Sets the value of InitFileOptions.getServiceRestartHandles()
InitFileAssetOptions.Builder	sourceHash(java.lang.String sourceHash) Deprecated. see `assetHash` and `assetHashType`

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

base64Encoded

public InitFileAssetOptions.Builder base64Encoded(java.lang.Boolean base64Encoded)

Sets the value of InitFileOptions.getBase64Encoded()

Parameters:

base64Encoded - True if the inlined content (from a string or file) should be treated as base64 encoded. Only applicable for inlined string and file content.

Returns:

this

group

public InitFileAssetOptions.Builder group(java.lang.String group)

Sets the value of InitFileOptions.getGroup()

Parameters:

group - The name of the owning group for this file. Not supported for Windows systems.

Returns:

this

mode

public InitFileAssetOptions.Builder mode(java.lang.String mode)

Sets the value of InitFileOptions.getMode()

Parameters:

mode - A six-digit octal value representing the mode for this file. Use the first three digits for symlinks and the last three digits for setting permissions. To create a symlink, specify 120xxx, where xxx defines the permissions of the target file. To specify permissions for a file, use the last three digits, such as 000644.

Not supported for Windows systems.

Returns:

this

owner

public InitFileAssetOptions.Builder owner(java.lang.String owner)

Sets the value of InitFileOptions.getOwner()

Parameters:

owner - The name of the owning user for this file. Not supported for Windows systems.

Returns:

this

serviceRestartHandles

public InitFileAssetOptions.Builder serviceRestartHandles(java.util.List<? extends InitServiceRestartHandle> serviceRestartHandles)

Sets the value of InitFileOptions.getServiceRestartHandles()

Parameters:

serviceRestartHandles - Restart the given service after this file has been written.

Returns:

this

readers

public InitFileAssetOptions.Builder readers(java.util.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

sourceHash

@Deprecated
public InitFileAssetOptions.Builder sourceHash(java.lang.String sourceHash)

Deprecated. see `assetHash` and `assetHashType`

Sets the value of AssetOptions.getSourceHash()

Parameters:

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

Returns:

this

exclude

public InitFileAssetOptions.Builder exclude(java.util.List<java.lang.String> exclude)

Sets the value of AssetOptions.getExclude()

Parameters:

exclude - Glob patterns to exclude from the copy.

Returns:

this

follow

@Deprecated
public InitFileAssetOptions.Builder follow(FollowMode follow)

Deprecated. use `followSymlinks` instead

Sets the value of CopyOptions.getFollow()

Parameters:

follow - A strategy for how to handle symlinks.

Returns:

this

ignoreMode

public InitFileAssetOptions.Builder ignoreMode(IgnoreMode ignoreMode)

Sets the value of AssetOptions.getIgnoreMode()

Parameters:

ignoreMode - The ignore behavior to use for exclude patterns.

Returns:

this

followSymlinks

public InitFileAssetOptions.Builder followSymlinks(SymlinkFollowMode followSymlinks)

Sets the value of FileCopyOptions.getFollowSymlinks()

Parameters:

followSymlinks - A strategy for how to handle symlinks.

Returns:

this

assetHash

public InitFileAssetOptions.Builder assetHash(java.lang.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

public InitFileAssetOptions.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

public InitFileAssetOptions.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

public InitFileAssetOptions build()

Builds the configured instance.

Returns:

a new instance of InitFileAssetOptions

Throws:

java.lang.NullPointerException - if any required attribute was not provided