software.amazon.awscdk.pipelines

Class SimpleSynthOptions.Builder

java.lang.Object

software.amazon.awscdk.pipelines.SimpleSynthOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<SimpleSynthOptions>

Enclosing interface:

SimpleSynthOptions

@Stability(value=Experimental)
public static final class SimpleSynthOptions.Builder
extends Object
implements software.amazon.jsii.Builder<SimpleSynthOptions>

A builder for SimpleSynthOptions

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
SimpleSynthOptions.Builder	actionName(String actionName) Sets the value of SimpleSynthOptions.getActionName()
SimpleSynthOptions.Builder	additionalArtifacts(List<? extends AdditionalArtifact> additionalArtifacts) Sets the value of SimpleSynthOptions.getAdditionalArtifacts()
SimpleSynthOptions	build() Builds the configured instance.
SimpleSynthOptions.Builder	cloudAssemblyArtifact(Artifact cloudAssemblyArtifact) Sets the value of SimpleSynthOptions.getCloudAssemblyArtifact()
SimpleSynthOptions.Builder	copyEnvironmentVariables(List<String> copyEnvironmentVariables) Sets the value of SimpleSynthOptions.getCopyEnvironmentVariables()
SimpleSynthOptions.Builder	environment(BuildEnvironment environment) Sets the value of SimpleSynthOptions.getEnvironment()
SimpleSynthOptions.Builder	environmentVariables(Map<String,? extends BuildEnvironmentVariable> environmentVariables) Sets the value of SimpleSynthOptions.getEnvironmentVariables()
SimpleSynthOptions.Builder	projectName(String projectName) Sets the value of SimpleSynthOptions.getProjectName()
SimpleSynthOptions.Builder	rolePolicyStatements(List<? extends PolicyStatement> rolePolicyStatements) Sets the value of SimpleSynthOptions.getRolePolicyStatements()
SimpleSynthOptions.Builder	sourceArtifact(Artifact sourceArtifact) Sets the value of SimpleSynthOptions.getSourceArtifact()
SimpleSynthOptions.Builder	subdirectory(String subdirectory) Sets the value of SimpleSynthOptions.getSubdirectory()
SimpleSynthOptions.Builder	subnetSelection(SubnetSelection subnetSelection) Sets the value of SimpleSynthOptions.getSubnetSelection()
SimpleSynthOptions.Builder	vpc(IVpc vpc) Sets the value of SimpleSynthOptions.getVpc()

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

cloudAssemblyArtifact

@Stability(value=Experimental)
public SimpleSynthOptions.Builder cloudAssemblyArtifact(Artifact cloudAssemblyArtifact)

Sets the value of SimpleSynthOptions.getCloudAssemblyArtifact()

Parameters:

cloudAssemblyArtifact - The artifact where the CloudAssembly should be emitted. This parameter is required.

Returns:

this

sourceArtifact

@Stability(value=Experimental)
public SimpleSynthOptions.Builder sourceArtifact(Artifact sourceArtifact)

Sets the value of SimpleSynthOptions.getSourceArtifact()

Parameters:

sourceArtifact - The source artifact of the CodePipeline. This parameter is required.

Returns:

this

actionName

@Stability(value=Experimental)
public SimpleSynthOptions.Builder actionName(String actionName)

Sets the value of SimpleSynthOptions.getActionName()

Parameters:

actionName - Name of the build action.

Returns:

this

additionalArtifacts

@Stability(value=Experimental)
public SimpleSynthOptions.Builder additionalArtifacts(List<? extends AdditionalArtifact> additionalArtifacts)

Sets the value of SimpleSynthOptions.getAdditionalArtifacts()

Parameters:

additionalArtifacts - Produce additional output artifacts after the build based on the given directories. Can be used to produce additional artifacts during the build step, separate from the cloud assembly, which can be used further on in the pipeline.

Directories are evaluated with respect to subdirectory.

Returns:

this

copyEnvironmentVariables

@Stability(value=Experimental)
public SimpleSynthOptions.Builder copyEnvironmentVariables(List<String> copyEnvironmentVariables)

Sets the value of SimpleSynthOptions.getCopyEnvironmentVariables()

Parameters:

copyEnvironmentVariables - Environment variables to copy over from parent env. These are environment variables that are being used by the build.

Returns:

this

environment

@Stability(value=Experimental)
public SimpleSynthOptions.Builder environment(BuildEnvironment environment)

Sets the value of SimpleSynthOptions.getEnvironment()

Parameters:

environment - Build environment to use for CodeBuild job.

Returns:

this

environmentVariables

@Stability(value=Experimental)
public SimpleSynthOptions.Builder environmentVariables(Map<String,? extends BuildEnvironmentVariable> environmentVariables)

Sets the value of SimpleSynthOptions.getEnvironmentVariables()

Parameters:

environmentVariables - Environment variables to send into build.

Returns:

this

projectName

@Stability(value=Experimental)
public SimpleSynthOptions.Builder projectName(String projectName)

Sets the value of SimpleSynthOptions.getProjectName()

Parameters:

projectName - Name of the CodeBuild project.

Returns:

this

rolePolicyStatements

@Stability(value=Experimental)
public SimpleSynthOptions.Builder rolePolicyStatements(List<? extends PolicyStatement> rolePolicyStatements)

Sets the value of SimpleSynthOptions.getRolePolicyStatements()

Parameters:

rolePolicyStatements - Policy statements to add to role used during the synth. Can be used to add acces to a CodeArtifact repository etc.

Returns:

this

subdirectory

@Stability(value=Experimental)
public SimpleSynthOptions.Builder subdirectory(String subdirectory)

Sets the value of SimpleSynthOptions.getSubdirectory()

Parameters:

subdirectory - Directory inside the source where package.json and cdk.json are located.

Returns:

this

subnetSelection

@Stability(value=Experimental)
public SimpleSynthOptions.Builder subnetSelection(SubnetSelection subnetSelection)

Sets the value of SimpleSynthOptions.getSubnetSelection()

Parameters:

subnetSelection - Which subnets to use. Only used if 'vpc' is supplied.

Returns:

this

vpc

@Stability(value=Experimental)
public SimpleSynthOptions.Builder vpc(IVpc vpc)

Sets the value of SimpleSynthOptions.getVpc()

Parameters:

vpc - The VPC where to execute the SimpleSynth.

Returns:

this

build

@Stability(value=Experimental)
public SimpleSynthOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of SimpleSynthOptions

Throws:

NullPointerException - if any required attribute was not provided