software.amazon.awscdk.pipelines

Interface StandardNpmSynthOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, SimpleSynthOptions

All Known Implementing Classes:

StandardNpmSynthOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.26.0 (build 7d76e02)",
           date="2021-03-25T11:30:29.088Z")
 @Stability(value=Experimental)
public interface StandardNpmSynthOptions
extends software.amazon.jsii.JsiiSerializable, SimpleSynthOptions

(experimental) Options for a convention-based synth using NPM.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	StandardNpmSynthOptions.Builder A builder for StandardNpmSynthOptions
static class	StandardNpmSynthOptions.Jsii$Proxy An implementation for StandardNpmSynthOptions

Method Summary

Modifier and Type	Method and Description
static StandardNpmSynthOptions.Builder	builder()
default String	getBuildCommand() (experimental) The build command.
default String	getInstallCommand() (experimental) The install command.
default String	getSynthCommand() (experimental) The synth command.

Methods inherited from interface software.amazon.awscdk.pipelines.SimpleSynthOptions

getActionName, getAdditionalArtifacts, getCloudAssemblyArtifact, getCopyEnvironmentVariables, getEnvironment, getEnvironmentVariables, getProjectName, getRolePolicyStatements, getSourceArtifact, getSubdirectory, getSubnetSelection, getVpc

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getBuildCommand

@Stability(value=Experimental)
 @Nullable
default String getBuildCommand()

(experimental) 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.

Default: - No build required

getInstallCommand

@Stability(value=Experimental)
 @Nullable
default String getInstallCommand()

(experimental) The install command.

Default: 'npm ci'

getSynthCommand

@Stability(value=Experimental)
 @Nullable
default String getSynthCommand()

(experimental) The synth command.

Default: 'npx cdk synth'

builder

@Stability(value=Experimental)
static StandardNpmSynthOptions.Builder builder()

Specified by:

builder in interface SimpleSynthOptions

Returns:

a StandardNpmSynthOptions.Builder of StandardNpmSynthOptions