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(Stable)
public static final class AssetOptions.Builder
extends Object
implements software.amazon.jsii.Builder<AssetOptions>
A builder for
AssetOptions
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionSets the value ofAssetOptions.getAssetHash()
assetHashType
(AssetHashType assetHashType) Sets the value ofAssetOptions.getAssetHashType()
build()
Builds the configured instance.bundling
(BundlingOptions bundling) Sets the value ofAssetOptions.getBundling()
deployTime
(Boolean deployTime) Sets the value ofAssetOptions.getDeployTime()
Sets the value ofFileCopyOptions.getExclude()
followSymlinks
(SymlinkFollowMode followSymlinks) Sets the value ofFileCopyOptions.getFollowSymlinks()
ignoreMode
(IgnoreMode ignoreMode) Sets the value ofFileCopyOptions.getIgnoreMode()
readers
(List<? extends IGrantable> readers) Sets the value ofAssetOptions.getReaders()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
deployTime
Sets the value ofAssetOptions.getDeployTime()
- Parameters:
deployTime
- Whether or not the asset needs to exist beyond deployment time;. i.e. are copied over to a different location and not needed afterwards. Setting this property to true has an impact on the lifecycle of the asset, because we will assume that it is safe to delete after the CloudFormation deployment succeeds.For example, Lambda Function assets are copied over to Lambda during deployment. Therefore, it is not necessary to store the asset in S3, so we consider those deployTime assets.
- Returns:
this
-
readers
Sets the value ofAssetOptions.getReaders()
- Parameters:
readers
- A list of principals that should be able to read this asset from S3. You can useasset.grantRead(principal)
to grant read permissions later.- Returns:
this
-
assetHash
Sets the value ofAssetOptions.getAssetHash()
- Parameters:
assetHash
- Specify a custom hash for this asset. IfassetHashType
is set it must be set toAssetHashType.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
Sets the value ofAssetOptions.getAssetHashType()
- Parameters:
assetHashType
- Specifies the type of hash to calculate for this asset. IfassetHash
is configured, this option must beundefined
orAssetHashType.CUSTOM
.- Returns:
this
-
bundling
Sets the value ofAssetOptions.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
-
exclude
Sets the value ofFileCopyOptions.getExclude()
- Parameters:
exclude
- File paths matching the patterns will be excluded. SeeignoreMode
to set the matching behavior. Has no effect on Assets bundled using thebundling
property.- Returns:
this
-
followSymlinks
Sets the value ofFileCopyOptions.getFollowSymlinks()
- Parameters:
followSymlinks
- A strategy for how to handle symlinks.- Returns:
this
-
ignoreMode
Sets the value ofFileCopyOptions.getIgnoreMode()
- Parameters:
ignoreMode
- The ignore behavior to use forexclude
patterns.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<AssetOptions>
- Returns:
- a new instance of
AssetOptions
- Throws:
NullPointerException
- if any required attribute was not provided
-