software.amazon.awscdk.pipelines

Class StandardNpmSynthOptions.Builder

java.lang.Object

software.amazon.awscdk.pipelines.StandardNpmSynthOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<StandardNpmSynthOptions>

Enclosing interface:

StandardNpmSynthOptions

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

A builder for StandardNpmSynthOptions

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

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

buildCommand

@Stability(value=Experimental)
public StandardNpmSynthOptions.Builder buildCommand(String buildCommand)

Sets the value of StandardNpmSynthOptions.getBuildCommand()

Parameters:

buildCommand - The build command. By default, we assume NPM projects are either written in JavaScript or are using ts-node, so don't need a build command.

Otherwise, put the build command here, for example npm run build.

Returns:

this

installCommand

@Stability(value=Experimental)
public StandardNpmSynthOptions.Builder installCommand(String installCommand)

Sets the value of StandardNpmSynthOptions.getInstallCommand()

Parameters:

installCommand - The install command.

Returns:

this

synthCommand

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

Sets the value of StandardNpmSynthOptions.getSynthCommand()

Parameters:

synthCommand - The synth command.

Returns:

this

cloudAssemblyArtifact

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

Sets the value of SimpleSynthOptions.getActionName()

Parameters:

actionName - Name of the build action.

Returns:

this

additionalArtifacts

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

Sets the value of SimpleSynthOptions.getProjectName()

Parameters:

projectName - Name of the CodeBuild project.

Returns:

this

rolePolicyStatements

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of StandardNpmSynthOptions

Throws:

NullPointerException - if any required attribute was not provided