Class FileDefinitionBody.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<FileDefinitionBody>
- Enclosing class:
- FileDefinitionBody
FileDefinitionBody
.-
Method Summary
Modifier and TypeMethodDescriptionSpecify a custom hash for this asset.assetHashType
(AssetHashType assetHashType) Specifies the type of hash to calculate for this asset.build()
bundling
(BundlingOptions bundling) Bundle the asset by executing a command in a Docker container or a custom bundling provider.static FileDefinitionBody.Builder
deployTime
(Boolean deployTime) Whether or not the asset needs to exist beyond deployment time;File paths matching the patterns will be excluded.followSymlinks
(SymlinkFollowMode followSymlinks) A strategy for how to handle symlinks.ignoreMode
(IgnoreMode ignoreMode) The ignore behavior to use forexclude
patterns.readers
(List<? extends IGrantable> readers) A list of principals that should be able to read this asset from S3.sourceKmsKey
(IKey sourceKmsKey) The ARN of the KMS key used to encrypt the handler code.
-
Method Details
-
create
- Parameters:
path
- This parameter is required.- Returns:
- a new instance of
FileDefinitionBody.Builder
.
-
assetHash
Specify a custom hash for this asset.If
assetHashType
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.
Default: - based on `assetHashType`
- Parameters:
assetHash
- Specify a custom hash for this asset. This parameter is required.- Returns:
this
-
assetHashType
Specifies the type of hash to calculate for this asset.If
assetHash
is configured, this option must beundefined
orAssetHashType.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
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
File paths matching the patterns will be excluded.See
ignoreMode
to set the matching behavior. Has no effect on Assets bundled using thebundling
property.Default: - nothing is excluded
- Parameters:
exclude
- File paths matching the patterns will be excluded. This parameter is required.- Returns:
this
-
followSymlinks
@Stability(Stable) public FileDefinitionBody.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
The ignore behavior to use forexclude
patterns.Default: IgnoreMode.GLOB
- Parameters:
ignoreMode
- The ignore behavior to use forexclude
patterns. This parameter is required.- Returns:
this
-
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.
Default: false
- Parameters:
deployTime
- Whether or not the asset needs to exist beyond deployment time;. This parameter is required.- Returns:
this
-
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
-
sourceKmsKey
The ARN of the KMS key used to encrypt the handler code.Default: - the default server-side encryption with Amazon S3 managed keys(SSE-S3) key will be used.
- Parameters:
sourceKmsKey
- The ARN of the KMS key used to encrypt the handler code. This parameter is required.- Returns:
this
-
build
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<FileDefinitionBody>
- Returns:
- a newly built instance of
FileDefinitionBody
.
-