Class DeployTimeSubstitutedFile.Builder
java.lang.Object
software.amazon.awscdk.services.s3.deployment.DeployTimeSubstitutedFile.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<DeployTimeSubstitutedFile>
- Enclosing class:
DeployTimeSubstitutedFile
@Stability(Stable)
public static final class DeployTimeSubstitutedFile.Builder
extends Object
implements software.amazon.jsii.Builder<DeployTimeSubstitutedFile>
A fluent builder for
DeployTimeSubstitutedFile
.-
Method Summary
Modifier and TypeMethodDescriptionbuild()
destinationBucket
(IBucket destinationBucket) The S3 bucket to sync the contents of the zip file to.destinationKey
(String destinationKey) The object key in the destination bucket where the processed file would be written to.Execution role associated with this function.Path to the user's local file.substitutions
(Map<String, String> substitutions) User-defined substitutions to make in the file.
-
Method Details
-
create
@Stability(Stable) public static DeployTimeSubstitutedFile.Builder create(software.constructs.Construct scope, String id) - Parameters:
scope
- This parameter is required.id
- This parameter is required.- Returns:
- a new instance of
DeployTimeSubstitutedFile.Builder
.
-
destinationBucket
@Stability(Stable) public DeployTimeSubstitutedFile.Builder destinationBucket(IBucket destinationBucket) The S3 bucket to sync the contents of the zip file to.- Parameters:
destinationBucket
- The S3 bucket to sync the contents of the zip file to. This parameter is required.- Returns:
this
-
source
Path to the user's local file.- Parameters:
source
- Path to the user's local file. This parameter is required.- Returns:
this
-
substitutions
@Stability(Stable) public DeployTimeSubstitutedFile.Builder substitutions(Map<String, String> substitutions) User-defined substitutions to make in the file.Placeholders in the user's local file must be specified with double curly brackets and spaces. For example, if you use the key 'xxxx' in the file, it must be written as: {{ xxxx }} to be recognized by the construct as a substitution.
- Parameters:
substitutions
- User-defined substitutions to make in the file. This parameter is required.- Returns:
this
-
destinationKey
The object key in the destination bucket where the processed file would be written to.Default: - Fingerprint of the file content would be used as object key
- Parameters:
destinationKey
- The object key in the destination bucket where the processed file would be written to. This parameter is required.- Returns:
this
-
role
Execution role associated with this function.Default: - A role is automatically created
- Parameters:
role
- Execution role associated with this function. This parameter is required.- Returns:
this
-
build
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<DeployTimeSubstitutedFile>
- Returns:
- a newly built instance of
DeployTimeSubstitutedFile
.
-