SimpleSynthAction.Builder (software.amazon.awscdk:monocdk 1.95.0.DEVPREVIEW API)

java.lang.Object
- software.amazon.awscdk.pipelines.SimpleSynthAction.Builder

All Implemented Interfaces:: software.amazon.jsii.Builder<SimpleSynthAction>

Enclosing class:: SimpleSynthAction

@Stability(value=Experimental)
public static final class SimpleSynthAction.Builder
extends Object
implements software.amazon.jsii.Builder<SimpleSynthAction>

(experimental) A fluent builder for SimpleSynthAction.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`SimpleSynthAction.Builder`	`actionName(String actionName)` (experimental) Name of the build action.
`SimpleSynthAction.Builder`	`additionalArtifacts(List<? extends AdditionalArtifact> additionalArtifacts)` (experimental) Produce additional output artifacts after the build based on the given directories.
`SimpleSynthAction`	`build()`
`SimpleSynthAction.Builder`	`buildCommand(String buildCommand)` Deprecated. Use `buildCommands` instead
`SimpleSynthAction.Builder`	`buildCommands(List<String> buildCommands)` (experimental) The build commands.
`SimpleSynthAction.Builder`	`cloudAssemblyArtifact(Artifact cloudAssemblyArtifact)` (experimental) The artifact where the CloudAssembly should be emitted.
`SimpleSynthAction.Builder`	`copyEnvironmentVariables(List<String> copyEnvironmentVariables)` (experimental) Environment variables to copy over from parent env.
`static SimpleSynthAction.Builder`	`create()`
`SimpleSynthAction.Builder`	`environment(BuildEnvironment environment)` (experimental) Build environment to use for CodeBuild job.
`SimpleSynthAction.Builder`	`environmentVariables(Map<String,? extends BuildEnvironmentVariable> environmentVariables)` (experimental) Environment variables to send into build.
`SimpleSynthAction.Builder`	`installCommand(String installCommand)` Deprecated. Use `installCommands` instead
`SimpleSynthAction.Builder`	`installCommands(List<String> installCommands)` (experimental) Install commands.
`SimpleSynthAction.Builder`	`projectName(String projectName)` (experimental) Name of the CodeBuild project.
`SimpleSynthAction.Builder`	`rolePolicyStatements(List<? extends PolicyStatement> rolePolicyStatements)` (experimental) Policy statements to add to role used during the synth.
`SimpleSynthAction.Builder`	`sourceArtifact(Artifact sourceArtifact)` (experimental) The source artifact of the CodePipeline.
`SimpleSynthAction.Builder`	`subdirectory(String subdirectory)` (experimental) Directory inside the source where package.json and cdk.json are located.
`SimpleSynthAction.Builder`	`subnetSelection(SubnetSelection subnetSelection)` (experimental) Which subnets to use.
`SimpleSynthAction.Builder`	`synthCommand(String synthCommand)` (experimental) The synth command.
`SimpleSynthAction.Builder`	`testCommands(List<String> testCommands)` (experimental) Test commands.
`SimpleSynthAction.Builder`	`vpc(IVpc vpc)` (experimental) The VPC where to execute the SimpleSynth.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - create
```
@Stability(value=Experimental)
public static SimpleSynthAction.Builder create()
```
    Returns:
    
    a new instance of SimpleSynthAction.Builder.
  - cloudAssemblyArtifact
```
@Stability(value=Experimental)
public SimpleSynthAction.Builder cloudAssemblyArtifact(Artifact cloudAssemblyArtifact)
```
    (experimental) The artifact where the CloudAssembly should be emitted.
    
    Parameters:
    
    cloudAssemblyArtifact - The artifact where the CloudAssembly should be emitted. This parameter is required.
    
    Returns:
    
    this
  - sourceArtifact
```
@Stability(value=Experimental)
public SimpleSynthAction.Builder sourceArtifact(Artifact sourceArtifact)
```
    (experimental) The source artifact of the CodePipeline.
    
    Parameters:
    
    sourceArtifact - The source artifact of the CodePipeline. This parameter is required.
    
    Returns:
    
    this
  - actionName
```
@Stability(value=Experimental)
public SimpleSynthAction.Builder actionName(String actionName)
```
    (experimental) Name of the build action.
    Default: 'Synth'
    
    Parameters:
    
    actionName - Name of the build action. This parameter is required.
    
    Returns:
    
    this
  - additionalArtifacts
```
@Stability(value=Experimental)
public SimpleSynthAction.Builder additionalArtifacts(List<? extends AdditionalArtifact> additionalArtifacts)
```
    (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
    
    Parameters:
    
    additionalArtifacts - Produce additional output artifacts after the build based on the given directories. This parameter is required.
    
    Returns:
    
    this
  - copyEnvironmentVariables
```
@Stability(value=Experimental)
public SimpleSynthAction.Builder copyEnvironmentVariables(List<String> copyEnvironmentVariables)
```
    (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
    
    Parameters:
    
    copyEnvironmentVariables - Environment variables to copy over from parent env. This parameter is required.
    
    Returns:
    
    this
  - environment
```
@Stability(value=Experimental)
public SimpleSynthAction.Builder environment(BuildEnvironment environment)
```
    (experimental) Build environment to use for CodeBuild job.
    Default: BuildEnvironment.LinuxBuildImage.STANDARD_4_0
    
    Parameters:
    
    environment - Build environment to use for CodeBuild job. This parameter is required.
    
    Returns:
    
    this
  - environmentVariables
```
@Stability(value=Experimental)
public SimpleSynthAction.Builder environmentVariables(Map<String,? extends BuildEnvironmentVariable> environmentVariables)
```
    (experimental) Environment variables to send into build.
    Default: - No additional environment variables
    
    Parameters:
    
    environmentVariables - Environment variables to send into build. This parameter is required.
    
    Returns:
    
    this
  - projectName
```
@Stability(value=Experimental)
public SimpleSynthAction.Builder projectName(String projectName)
```
    (experimental) Name of the CodeBuild project.
    Default: - Automatically generated
    
    Parameters:
    
    projectName - Name of the CodeBuild project. This parameter is required.
    
    Returns:
    
    this
  - rolePolicyStatements
```
@Stability(value=Experimental)
public SimpleSynthAction.Builder rolePolicyStatements(List<? extends PolicyStatement> rolePolicyStatements)
```
    (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
    
    Parameters:
    
    rolePolicyStatements - Policy statements to add to role used during the synth. This parameter is required.
    
    Returns:
    
    this
  - subdirectory
```
@Stability(value=Experimental)
public SimpleSynthAction.Builder subdirectory(String subdirectory)
```
    (experimental) Directory inside the source where package.json and cdk.json are located.
    Default: - Repository root
    
    Parameters:
    
    subdirectory - Directory inside the source where package.json and cdk.json are located. This parameter is required.
    
    Returns:
    
    this
  - subnetSelection
```
@Stability(value=Experimental)
public SimpleSynthAction.Builder subnetSelection(SubnetSelection subnetSelection)
```
    (experimental) Which subnets to use.
    Only used if 'vpc' is supplied.
    Default: - All private subnets.
    
    Parameters:
    
    subnetSelection - Which subnets to use. This parameter is required.
    
    Returns:
    
    this
  - vpc
```
@Stability(value=Experimental)
public SimpleSynthAction.Builder vpc(IVpc vpc)
```
    (experimental) The VPC where to execute the SimpleSynth.
    Default: - No VPC
    
    Parameters:
    
    vpc - The VPC where to execute the SimpleSynth. This parameter is required.
    
    Returns:
    
    this
  - synthCommand
```
@Stability(value=Experimental)
public SimpleSynthAction.Builder synthCommand(String synthCommand)
```
    (experimental) The synth command.
    
    Parameters:
    
    synthCommand - The synth command. This parameter is required.
    
    Returns:
    
    this
  - buildCommand
```
@Stability(value=Deprecated)
 @Deprecated
public SimpleSynthAction.Builder buildCommand(String buildCommand)
```
    Deprecated. Use `buildCommands` instead
    
    (deprecated) The build command.
    If your programming language requires a compilation step, put the compilation command here.
    Default: - No build required
    
    Parameters:
    
    buildCommand - The build command. This parameter is required.
    
    Returns:
    
    this
  - buildCommands
```
@Stability(value=Experimental)
public SimpleSynthAction.Builder buildCommands(List<String> buildCommands)
```
    (experimental) The build commands.
    If your programming language requires a compilation step, put the compilation command here.
    Default: - No build required
    
    Parameters:
    
    buildCommands - The build commands. This parameter is required.
    
    Returns:
    
    this
  - installCommand
```
@Stability(value=Deprecated)
 @Deprecated
public SimpleSynthAction.Builder installCommand(String installCommand)
```
    Deprecated. Use `installCommands` instead
    
    (deprecated) The install command.
    If not provided by the build image or another dependency management tool, at least install the CDK CLI here using npm install -g aws-cdk.
    Default: - No install required
    
    Parameters:
    
    installCommand - The install command. This parameter is required.
    
    Returns:
    
    this
  - installCommands
```
@Stability(value=Experimental)
public SimpleSynthAction.Builder installCommands(List<String> installCommands)
```
    (experimental) Install commands.
    If not provided by the build image or another dependency management tool, at least install the CDK CLI here using npm install -g aws-cdk.
    Default: - No install required
    
    Parameters:
    
    installCommands - Install commands. This parameter is required.
    
    Returns:
    
    this
  - testCommands
```
@Stability(value=Experimental)
public SimpleSynthAction.Builder testCommands(List<String> testCommands)
```
    (experimental) Test commands.
    These commands are run after the build commands but before the synth command.
    Default: - No test commands
    
    Parameters:
    
    testCommands - Test commands. This parameter is required.
    
    Returns:
    
    this
  - build
```
@Stability(value=Experimental)
public SimpleSynthAction build()
```
    Specified by:
    
    build in interface software.amazon.jsii.Builder<SimpleSynthAction>

Class SimpleSynthAction.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

cloudAssemblyArtifact

sourceArtifact

actionName

additionalArtifacts

copyEnvironmentVariables

environment

environmentVariables

projectName

rolePolicyStatements

subdirectory

subnetSelection

vpc

synthCommand

buildCommand

buildCommands

installCommand

installCommands

testCommands

build