Package software.amazon.awscdk.services.s3.deployment

Class DeployTimeSubstitutedFileProps.Builder

java.lang.Object

software.amazon.awscdk.services.s3.deployment.DeployTimeSubstitutedFileProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<DeployTimeSubstitutedFileProps>

Enclosing interface:

DeployTimeSubstitutedFileProps

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

A builder for DeployTimeSubstitutedFileProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DeployTimeSubstitutedFileProps	build()	Builds the configured instance.
DeployTimeSubstitutedFileProps.Builder	destinationBucket(IBucket destinationBucket)	Sets the value of DeployTimeSubstitutedFileProps.getDestinationBucket()
DeployTimeSubstitutedFileProps.Builder	destinationKey(String destinationKey)	Sets the value of DeployTimeSubstitutedFileProps.getDestinationKey()
DeployTimeSubstitutedFileProps.Builder	role(IRole role)	Sets the value of DeployTimeSubstitutedFileProps.getRole()
DeployTimeSubstitutedFileProps.Builder	source(String source)	Sets the value of DeployTimeSubstitutedFileProps.getSource()
DeployTimeSubstitutedFileProps.Builder	substitutions(Map<String,String> substitutions)	Sets the value of DeployTimeSubstitutedFileProps.getSubstitutions()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

destinationBucket

@Stability(Stable)
public DeployTimeSubstitutedFileProps.Builder destinationBucket(IBucket destinationBucket)

Sets the value of DeployTimeSubstitutedFileProps.getDestinationBucket()

Parameters:

destinationBucket - The S3 bucket to sync the contents of the zip file to. This parameter is required.

Returns:

this

source

@Stability(Stable)
public DeployTimeSubstitutedFileProps.Builder source(String source)

Sets the value of DeployTimeSubstitutedFileProps.getSource()

Parameters:

source - Path to the user's local file. This parameter is required.

Returns:

this

substitutions

@Stability(Stable)
public DeployTimeSubstitutedFileProps.Builder substitutions(Map<String,String> substitutions)

Sets the value of DeployTimeSubstitutedFileProps.getSubstitutions()

Parameters:

substitutions - User-defined substitutions to make in the file. This parameter is required. 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.

Returns:

this

destinationKey

@Stability(Stable)
public DeployTimeSubstitutedFileProps.Builder destinationKey(String destinationKey)

Sets the value of DeployTimeSubstitutedFileProps.getDestinationKey()

Parameters:

destinationKey - The object key in the destination bucket where the processed file would be written to.

Returns:

this

role

@Stability(Stable)
public DeployTimeSubstitutedFileProps.Builder role(IRole role)

Sets the value of DeployTimeSubstitutedFileProps.getRole()

Parameters:

role - Execution role associated with this function.

Returns:

this

build

@Stability(Stable)
public DeployTimeSubstitutedFileProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of DeployTimeSubstitutedFileProps

Throws:

NullPointerException - if any required attribute was not provided