Package 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.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:49.899Z")
@Stability(Deprecated)
@Deprecated
public interface StandardNpmSynthOptions
extends software.amazon.jsii.JsiiSerializable, SimpleSynthOptions

Deprecated.

This class is part of the old API. Use the API based on the CodePipeline class instead

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

Example:

 Artifact sourceArtifact = new Artifact();
 Artifact cloudAssemblyArtifact = new Artifact();
 CdkPipeline pipeline = CdkPipeline.Builder.create(this, "MyPipeline")
         .cloudAssemblyArtifact(cloudAssemblyArtifact)
         .synthAction(SimpleSynthAction.standardNpmSynth(StandardNpmSynthOptions.builder()
                 .sourceArtifact(sourceArtifact)
                 .cloudAssemblyArtifact(cloudAssemblyArtifact)
                 .environment(BuildEnvironment.builder()
                         .privileged(true)
                         .build())
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	StandardNpmSynthOptions.Builder	Deprecated.
static final class	StandardNpmSynthOptions.Jsii$Proxy	Deprecated.

Method Summary

Modifier and Type	Method	Description
static StandardNpmSynthOptions.Builder	builder()	Deprecated.
default String	getBuildCommand()	Deprecated.
default String	getInstallCommand()	Deprecated.
default String	getSynthCommand()	Deprecated.
default List<String>	getTestCommands()	Deprecated.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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

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

Method Details

getBuildCommand

@Stability(Deprecated)
@Deprecated
@Nullable
default String getBuildCommand()

Deprecated.

(deprecated) 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(Deprecated)
@Deprecated
@Nullable
default String getInstallCommand()

Deprecated.

(deprecated) The install command.

Default: 'npm ci'

getSynthCommand

@Stability(Deprecated)
@Deprecated
@Nullable
default String getSynthCommand()

Deprecated.

(deprecated) The synth command.

Default: 'npx cdk synth'

getTestCommands

@Stability(Deprecated)
@Deprecated
@Nullable
default List<String> getTestCommands()

Deprecated.

(deprecated) Test commands.

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

Default: - No test commands

builder

@Stability(Deprecated)
@Deprecated
static StandardNpmSynthOptions.Builder builder()

Deprecated.

Returns:

a StandardNpmSynthOptions.Builder of StandardNpmSynthOptions