software.amazon.awscdk.pipelines

Class StandardYarnSynthOptions.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.pipelines.StandardYarnSynthOptions.Jsii$Proxy

All Implemented Interfaces:

SimpleSynthOptions, StandardYarnSynthOptions, software.amazon.jsii.JsiiSerializable

Enclosing interface:

StandardYarnSynthOptions

@Stability(value=Experimental)
 @Internal
public static final class StandardYarnSynthOptions.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements StandardYarnSynthOptions

An implementation for StandardYarnSynthOptions

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.pipelines.StandardYarnSynthOptions

StandardYarnSynthOptions.Builder, StandardYarnSynthOptions.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.
protected	Jsii$Proxy(String buildCommand, String installCommand, String synthCommand, Artifact cloudAssemblyArtifact, Artifact sourceArtifact, String actionName, List<? extends AdditionalArtifact> additionalArtifacts, List<String> copyEnvironmentVariables, BuildEnvironment environment, Map<String,? extends BuildEnvironmentVariable> environmentVariables, String projectName, List<? extends PolicyStatement> rolePolicyStatements, String subdirectory, SubnetSelection subnetSelection, IVpc vpc) Constructor that initializes the object based on literal property values passed by the StandardYarnSynthOptions.Builder.

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
boolean	equals(Object o)
String	getActionName() (experimental) Name of the build action.
List<AdditionalArtifact>	getAdditionalArtifacts() (experimental) Produce additional output artifacts after the build based on the given directories.
String	getBuildCommand() (experimental) The build command.
Artifact	getCloudAssemblyArtifact() (experimental) The artifact where the CloudAssembly should be emitted.
List<String>	getCopyEnvironmentVariables() (experimental) Environment variables to copy over from parent env.
BuildEnvironment	getEnvironment() (experimental) Build environment to use for CodeBuild job.
Map<String,BuildEnvironmentVariable>	getEnvironmentVariables() (experimental) Environment variables to send into build.
String	getInstallCommand() (experimental) The install command.
String	getProjectName() (experimental) Name of the CodeBuild project.
List<PolicyStatement>	getRolePolicyStatements() (experimental) Policy statements to add to role used during the synth.
Artifact	getSourceArtifact() (experimental) The source artifact of the CodePipeline.
String	getSubdirectory() (experimental) Directory inside the source where package.json and cdk.json are located.
SubnetSelection	getSubnetSelection() (experimental) Which subnets to use.
String	getSynthCommand() (experimental) The synth command.
IVpc	getVpc() (experimental) The VPC where to execute the SimpleSynth.
int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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

builder

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(String buildCommand,
                     String installCommand,
                     String synthCommand,
                     Artifact cloudAssemblyArtifact,
                     Artifact sourceArtifact,
                     String actionName,
                     List<? extends AdditionalArtifact> additionalArtifacts,
                     List<String> copyEnvironmentVariables,
                     BuildEnvironment environment,
                     Map<String,? extends BuildEnvironmentVariable> environmentVariables,
                     String projectName,
                     List<? extends PolicyStatement> rolePolicyStatements,
                     String subdirectory,
                     SubnetSelection subnetSelection,
                     IVpc vpc)

Constructor that initializes the object based on literal property values passed by the StandardYarnSynthOptions.Builder.

Method Detail

getBuildCommand

public final String getBuildCommand()

Description copied from interface: StandardYarnSynthOptions

(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

Specified by:

getBuildCommand in interface StandardYarnSynthOptions

getInstallCommand

public final String getInstallCommand()

Description copied from interface: StandardYarnSynthOptions

(experimental) The install command.

Default: 'yarn install --frozen-lockfile'

Specified by:

getInstallCommand in interface StandardYarnSynthOptions

getSynthCommand

public final String getSynthCommand()

Description copied from interface: StandardYarnSynthOptions

(experimental) The synth command.

Default: 'npx cdk synth'

Specified by:

getSynthCommand in interface StandardYarnSynthOptions

getCloudAssemblyArtifact

public final Artifact getCloudAssemblyArtifact()

Description copied from interface: SimpleSynthOptions

(experimental) The artifact where the CloudAssembly should be emitted.

Specified by:

getCloudAssemblyArtifact in interface SimpleSynthOptions

getSourceArtifact

public final Artifact getSourceArtifact()

Description copied from interface: SimpleSynthOptions

(experimental) The source artifact of the CodePipeline.

Specified by:

getSourceArtifact in interface SimpleSynthOptions

getActionName

public final String getActionName()

Description copied from interface: SimpleSynthOptions

(experimental) Name of the build action.

Default: 'Synth'

Specified by:

getActionName in interface SimpleSynthOptions

getAdditionalArtifacts

public final List<AdditionalArtifact> getAdditionalArtifacts()

Description copied from interface: SimpleSynthOptions

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

Default: - No additional artifacts generated

Specified by:

getAdditionalArtifacts in interface SimpleSynthOptions

getCopyEnvironmentVariables

public final List<String> getCopyEnvironmentVariables()

Description copied from interface: SimpleSynthOptions

(experimental) Environment variables to copy over from parent env.

These are environment variables that are being used by the build.

Default: - No environment variables copied

Specified by:

getCopyEnvironmentVariables in interface SimpleSynthOptions

getEnvironment

public final BuildEnvironment getEnvironment()

Description copied from interface: SimpleSynthOptions

(experimental) Build environment to use for CodeBuild job.

Default: BuildEnvironment.LinuxBuildImage.STANDARD_4_0

Specified by:

getEnvironment in interface SimpleSynthOptions

getEnvironmentVariables

public final Map<String,BuildEnvironmentVariable> getEnvironmentVariables()

Description copied from interface: SimpleSynthOptions

(experimental) Environment variables to send into build.

Default: - No additional environment variables

Specified by:

getEnvironmentVariables in interface SimpleSynthOptions

getProjectName

public final String getProjectName()

Description copied from interface: SimpleSynthOptions

(experimental) Name of the CodeBuild project.

Default: - Automatically generated

Specified by:

getProjectName in interface SimpleSynthOptions

getRolePolicyStatements

public final List<PolicyStatement> getRolePolicyStatements()

Description copied from interface: SimpleSynthOptions

(experimental) Policy statements to add to role used during the synth.

Can be used to add acces to a CodeArtifact repository etc.

Default: - No policy statements added to CodeBuild Project Role

Specified by:

getRolePolicyStatements in interface SimpleSynthOptions

getSubdirectory

public final String getSubdirectory()

Description copied from interface: SimpleSynthOptions

(experimental) Directory inside the source where package.json and cdk.json are located.

Default: - Repository root

Specified by:

getSubdirectory in interface SimpleSynthOptions

getSubnetSelection

public final SubnetSelection getSubnetSelection()

Description copied from interface: SimpleSynthOptions

(experimental) Which subnets to use.

Only used if 'vpc' is supplied.

Default: - All private subnets.

Specified by:

getSubnetSelection in interface SimpleSynthOptions

getVpc

public final IVpc getVpc()

Description copied from interface: SimpleSynthOptions

(experimental) The VPC where to execute the SimpleSynth.

Default: - No VPC

Specified by:

getVpc in interface SimpleSynthOptions

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object