Package software.amazon.awscdk.pipelines

Interface StandardYarnSynthOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, SimpleSynthOptions

All Known Implementing Classes:

StandardYarnSynthOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:49.902Z")
@Stability(Deprecated)
@Deprecated
public interface StandardYarnSynthOptions
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 Yarn.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.codebuild.*;
 import software.amazon.awscdk.services.codepipeline.*;
 import software.amazon.awscdk.services.ec2.*;
 import software.amazon.awscdk.services.iam.*;
 import software.amazon.awscdk.services.s3.*;
 import software.amazon.awscdk.pipelines.*;
 Artifact artifact;
 Bucket bucket;
 IBuildImage buildImage;
 BuildSpec buildSpec;
 PolicyStatement policyStatement;
 Subnet subnet;
 SubnetFilter subnetFilter;
 Object value;
 Vpc vpc;
 StandardYarnSynthOptions standardYarnSynthOptions = StandardYarnSynthOptions.builder()
         .cloudAssemblyArtifact(artifact)
         .sourceArtifact(artifact)
         // the properties below are optional
         .actionName("actionName")
         .additionalArtifacts(List.of(AdditionalArtifact.builder()
                 .artifact(artifact)
                 .directory("directory")
                 .build()))
         .buildCommand("buildCommand")
         .buildSpec(buildSpec)
         .copyEnvironmentVariables(List.of("copyEnvironmentVariables"))
         .environment(BuildEnvironment.builder()
                 .buildImage(buildImage)
                 .certificate(BuildEnvironmentCertificate.builder()
                         .bucket(bucket)
                         .objectKey("objectKey")
                         .build())
                 .computeType(ComputeType.SMALL)
                 .environmentVariables(Map.of(
                         "environmentVariablesKey", BuildEnvironmentVariable.builder()
                                 .value(value)
                                 // the properties below are optional
                                 .type(BuildEnvironmentVariableType.PLAINTEXT)
                                 .build()))
                 .privileged(false)
                 .build())
         .environmentVariables(Map.of(
                 "environmentVariablesKey", BuildEnvironmentVariable.builder()
                         .value(value)
                         // the properties below are optional
                         .type(BuildEnvironmentVariableType.PLAINTEXT)
                         .build()))
         .installCommand("installCommand")
         .projectName("projectName")
         .rolePolicyStatements(List.of(policyStatement))
         .subdirectory("subdirectory")
         .subnetSelection(SubnetSelection.builder()
                 .availabilityZones(List.of("availabilityZones"))
                 .onePerAz(false)
                 .subnetFilters(List.of(subnetFilter))
                 .subnetGroupName("subnetGroupName")
                 .subnetName("subnetName")
                 .subnets(List.of(subnet))
                 .subnetType(SubnetType.ISOLATED)
                 .build())
         .synthCommand("synthCommand")
         .testCommands(List.of("testCommands"))
         .vpc(vpc)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static StandardYarnSynthOptions.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: 'yarn install --frozen-lockfile'

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 StandardYarnSynthOptions.Builder builder()

Deprecated.

Returns:

a StandardYarnSynthOptions.Builder of StandardYarnSynthOptions