software.amazon.awscdk.pipelines

Class SimpleSynthActionProps.Builder

java.lang.Object

software.amazon.awscdk.pipelines.SimpleSynthActionProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<SimpleSynthActionProps>

Enclosing interface:

SimpleSynthActionProps

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

A builder for SimpleSynthActionProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
SimpleSynthActionProps.Builder	actionName(String actionName) Sets the value of SimpleSynthOptions.getActionName()
SimpleSynthActionProps.Builder	additionalArtifacts(List<? extends AdditionalArtifact> additionalArtifacts) Sets the value of SimpleSynthOptions.getAdditionalArtifacts()
SimpleSynthActionProps	build() Builds the configured instance.
SimpleSynthActionProps.Builder	buildCommands(List<String> buildCommands) Sets the value of SimpleSynthActionProps.getBuildCommands()
SimpleSynthActionProps.Builder	buildSpec(BuildSpec buildSpec) Sets the value of SimpleSynthOptions.getBuildSpec()
SimpleSynthActionProps.Builder	cloudAssemblyArtifact(Artifact cloudAssemblyArtifact) Sets the value of SimpleSynthOptions.getCloudAssemblyArtifact()
SimpleSynthActionProps.Builder	copyEnvironmentVariables(List<String> copyEnvironmentVariables) Sets the value of SimpleSynthOptions.getCopyEnvironmentVariables()
SimpleSynthActionProps.Builder	environment(BuildEnvironment environment) Sets the value of SimpleSynthOptions.getEnvironment()
SimpleSynthActionProps.Builder	environmentVariables(Map<String,? extends BuildEnvironmentVariable> environmentVariables) Sets the value of SimpleSynthOptions.getEnvironmentVariables()
SimpleSynthActionProps.Builder	installCommands(List<String> installCommands) Sets the value of SimpleSynthActionProps.getInstallCommands()
SimpleSynthActionProps.Builder	projectName(String projectName) Sets the value of SimpleSynthOptions.getProjectName()
SimpleSynthActionProps.Builder	rolePolicyStatements(List<? extends PolicyStatement> rolePolicyStatements) Sets the value of SimpleSynthOptions.getRolePolicyStatements()
SimpleSynthActionProps.Builder	sourceArtifact(Artifact sourceArtifact) Sets the value of SimpleSynthOptions.getSourceArtifact()
SimpleSynthActionProps.Builder	subdirectory(String subdirectory) Sets the value of SimpleSynthOptions.getSubdirectory()
SimpleSynthActionProps.Builder	subnetSelection(SubnetSelection subnetSelection) Sets the value of SimpleSynthOptions.getSubnetSelection()
SimpleSynthActionProps.Builder	synthCommand(String synthCommand) Sets the value of SimpleSynthActionProps.getSynthCommand()
SimpleSynthActionProps.Builder	testCommands(List<String> testCommands) Sets the value of SimpleSynthActionProps.getTestCommands()
SimpleSynthActionProps.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

synthCommand

@Stability(value=Experimental)
public SimpleSynthActionProps.Builder synthCommand(String synthCommand)

Sets the value of SimpleSynthActionProps.getSynthCommand()

Parameters:

synthCommand - The synth command. This parameter is required.

Returns:

this

buildCommands

@Stability(value=Experimental)
public SimpleSynthActionProps.Builder buildCommands(List<String> buildCommands)

Sets the value of SimpleSynthActionProps.getBuildCommands()

Parameters:

buildCommands - The build commands. If your programming language requires a compilation step, put the compilation command here.

Returns:

this

installCommands

@Stability(value=Experimental)
public SimpleSynthActionProps.Builder installCommands(List<String> installCommands)

Sets the value of SimpleSynthActionProps.getInstallCommands()

Parameters:

installCommands - Install commands. If not provided by the build image or another dependency management tool, at least install the CDK CLI here using npm install -g aws-cdk.

Returns:

this

testCommands

@Stability(value=Experimental)
public SimpleSynthActionProps.Builder testCommands(List<String> testCommands)

Sets the value of SimpleSynthActionProps.getTestCommands()

Parameters:

testCommands - Test commands. These commands are run after the build commands but before the synth command.

Returns:

this

cloudAssemblyArtifact

@Stability(value=Experimental)
public SimpleSynthActionProps.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 SimpleSynthActionProps.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 SimpleSynthActionProps.Builder actionName(String actionName)

Sets the value of SimpleSynthOptions.getActionName()

Parameters:

actionName - Name of the build action.

Returns:

this

additionalArtifacts

@Stability(value=Experimental)
public SimpleSynthActionProps.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

buildSpec

@Stability(value=Experimental)
public SimpleSynthActionProps.Builder buildSpec(BuildSpec buildSpec)

Sets the value of SimpleSynthOptions.getBuildSpec()

Parameters:

buildSpec - custom BuildSpec that is merged with the generated one.

Returns:

this

copyEnvironmentVariables

@Stability(value=Experimental)
public SimpleSynthActionProps.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 SimpleSynthActionProps.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 SimpleSynthActionProps.Builder environmentVariables(Map<String,? extends BuildEnvironmentVariable> environmentVariables)

Sets the value of SimpleSynthOptions.getEnvironmentVariables()

Parameters:

environmentVariables - Environment variables to send into build. NOTE: You may run into the 1000-character limit for the Action configuration if you have a large number of variables or if their names or values are very long. If you do, pass them to the underlying CodeBuild project directly in environment instead. However, you will not be able to use CodePipeline Variables in this case.

Returns:

this

projectName

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

Sets the value of SimpleSynthOptions.getProjectName()

Parameters:

projectName - Name of the CodeBuild project.

Returns:

this

rolePolicyStatements

@Stability(value=Experimental)
public SimpleSynthActionProps.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 SimpleSynthActionProps.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 SimpleSynthActionProps.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 SimpleSynthActionProps.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 SimpleSynthActionProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of SimpleSynthActionProps

Throws:

NullPointerException - if any required attribute was not provided