software.amazon.awscdk.pipelines

Interface SimpleSynthOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

SimpleSynthActionProps, StandardNpmSynthOptions, StandardYarnSynthOptions

All Known Implementing Classes:

SimpleSynthActionProps.Jsii$Proxy, SimpleSynthOptions.Jsii$Proxy, StandardNpmSynthOptions.Jsii$Proxy, StandardYarnSynthOptions.Jsii$Proxy

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

(experimental) Configuration options for a SimpleSynth.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static SimpleSynthOptions.Builder	builder()
default String	getActionName() (experimental) Name of the build action.
default List<AdditionalArtifact>	getAdditionalArtifacts() (experimental) Produce additional output artifacts after the build based on the given directories.
Artifact	getCloudAssemblyArtifact() (experimental) The artifact where the CloudAssembly should be emitted.
default List<String>	getCopyEnvironmentVariables() (experimental) Environment variables to copy over from parent env.
default BuildEnvironment	getEnvironment() (experimental) Build environment to use for CodeBuild job.
default Map<String,BuildEnvironmentVariable>	getEnvironmentVariables() (experimental) Environment variables to send into build.
default String	getProjectName() (experimental) Name of the CodeBuild project.
default List<PolicyStatement>	getRolePolicyStatements() (experimental) Policy statements to add to role used during the synth.
Artifact	getSourceArtifact() (experimental) The source artifact of the CodePipeline.
default String	getSubdirectory() (experimental) Directory inside the source where package.json and cdk.json are located.
default SubnetSelection	getSubnetSelection() (experimental) Which subnets to use.
default IVpc	getVpc() (experimental) The VPC where to execute the SimpleSynth.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCloudAssemblyArtifact

@Stability(value=Experimental)
 @NotNull
Artifact getCloudAssemblyArtifact()

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

getSourceArtifact

@Stability(value=Experimental)
 @NotNull
Artifact getSourceArtifact()

(experimental) The source artifact of the CodePipeline.

getActionName

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

(experimental) Name of the build action.

Default: 'Synth'

getAdditionalArtifacts

@Stability(value=Experimental)
 @Nullable
default List<AdditionalArtifact> getAdditionalArtifacts()

(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

getCopyEnvironmentVariables

@Stability(value=Experimental)
 @Nullable
default List<String> getCopyEnvironmentVariables()

(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

getEnvironment

@Stability(value=Experimental)
 @Nullable
default BuildEnvironment getEnvironment()

(experimental) Build environment to use for CodeBuild job.

Default: BuildEnvironment.LinuxBuildImage.STANDARD_4_0

getEnvironmentVariables

@Stability(value=Experimental)
 @Nullable
default Map<String,BuildEnvironmentVariable> getEnvironmentVariables()

(experimental) Environment variables to send into build.

Default: - No additional environment variables

getProjectName

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

(experimental) Name of the CodeBuild project.

Default: - Automatically generated

getRolePolicyStatements

@Stability(value=Experimental)
 @Nullable
default List<PolicyStatement> getRolePolicyStatements()

(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

getSubdirectory

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

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

Default: - Repository root

getSubnetSelection

@Stability(value=Experimental)
 @Nullable
default SubnetSelection getSubnetSelection()

(experimental) Which subnets to use.

Only used if 'vpc' is supplied.

Default: - All private subnets.

getVpc

@Stability(value=Experimental)
 @Nullable
default IVpc getVpc()

(experimental) The VPC where to execute the SimpleSynth.

Default: - No VPC

builder

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

Returns:

a SimpleSynthOptions.Builder of SimpleSynthOptions