software.amazon.awscdk.pipelines

Interface StandardNpmSynthOptions

All Superinterfaces:

SimpleSynthOptions

All Known Implementing Classes:

StandardNpmSynthOptions.Jsii$Proxy

Deprecated.

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

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-28T21:34:31.139Z")
 @Deprecated
public interface StandardNpmSynthOptions
extends SimpleSynthOptions

(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 and Description
static class	StandardNpmSynthOptions.Builder Deprecated.
static class	StandardNpmSynthOptions.Jsii$Proxy Deprecated.

Method Summary

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

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

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

Method Detail

getBuildCommand

@Deprecated
default java.lang.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

@Deprecated
default java.lang.String getInstallCommand()

Deprecated.

(deprecated) The install command.

Default: 'npm ci'

getSynthCommand

@Deprecated
default java.lang.String getSynthCommand()

Deprecated.

(deprecated) The synth command.

Default: 'npx cdk synth'

getTestCommands

@Deprecated
default java.util.List<java.lang.String> getTestCommands()

Deprecated.

(deprecated) Test commands.

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

Default: - No test commands

builder

@Deprecated
static StandardNpmSynthOptions.Builder builder()

Deprecated.

Specified by:

builder in interface SimpleSynthOptions

Returns:

a StandardNpmSynthOptions.Builder of StandardNpmSynthOptions