CodeBuildAction.Builder (software.amazon.awscdk:aws-cdk-lib 2.0.0-rc.10 API)

java.lang.Object
- software.amazon.awscdk.services.codepipeline.actions.CodeBuildAction.Builder

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

Enclosing class:: CodeBuildAction

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

(experimental) A fluent builder for CodeBuildAction.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CodeBuildAction.Builder`	`actionName(String actionName)` (experimental) The physical, human-readable name of the Action.
`CodeBuildAction`	`build()`
`CodeBuildAction.Builder`	`checkSecretsInPlainTextEnvVariables(Boolean checkSecretsInPlainTextEnvVariables)` (experimental) Whether to check for the presence of any secrets in the environment variables of the default type, BuildEnvironmentVariableType.PLAINTEXT.
`static CodeBuildAction.Builder`	`create()`
`CodeBuildAction.Builder`	`environmentVariables(Map<String,? extends BuildEnvironmentVariable> environmentVariables)` (experimental) The environment variables to pass to the CodeBuild project when this action executes.
`CodeBuildAction.Builder`	`executeBatchBuild(Boolean executeBatchBuild)` (experimental) Trigger a batch build.
`CodeBuildAction.Builder`	`extraInputs(List<? extends Artifact> extraInputs)` (experimental) The list of additional input Artifacts for this action.
`CodeBuildAction.Builder`	`input(Artifact input)` (experimental) The source to use as input for this action.
`CodeBuildAction.Builder`	`outputs(List<? extends Artifact> outputs)` (experimental) The list of output Artifacts for this action.
`CodeBuildAction.Builder`	`project(IProject project)` (experimental) The action's Project.
`CodeBuildAction.Builder`	`role(IRole role)` (experimental) The Role in which context's this Action will be executing in.
`CodeBuildAction.Builder`	`runOrder(Number runOrder)` (experimental) The runOrder property for this Action.
`CodeBuildAction.Builder`	`type(CodeBuildActionType type)` (experimental) The type of the action that determines its CodePipeline Category - Build, or Test.
`CodeBuildAction.Builder`	`variablesNamespace(String variablesNamespace)` (experimental) The name of the namespace to use for variables emitted by this action.

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 CodeBuildAction.Builder create()
```
    Returns:
    
    a new instance of CodeBuildAction.Builder.
  - actionName
```
@Stability(value=Experimental)
public CodeBuildAction.Builder actionName(String actionName)
```
    (experimental) The physical, human-readable name of the Action.
    Note that Action names must be unique within a single Stage.
    
    Parameters:
    
    actionName - The physical, human-readable name of the Action. This parameter is required.
    
    Returns:
    
    this
  - runOrder
```
@Stability(value=Experimental)
public CodeBuildAction.Builder runOrder(Number runOrder)
```
    (experimental) The runOrder property for this Action.
    RunOrder determines the relative order in which multiple Actions in the same Stage execute.
    Default: 1
    
    Parameters:
    
    runOrder - The runOrder property for this Action. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html
  - variablesNamespace
```
@Stability(value=Experimental)
public CodeBuildAction.Builder variablesNamespace(String variablesNamespace)
```
    (experimental) The name of the namespace to use for variables emitted by this action.
    Default: - a name will be generated, based on the stage and action names, if any of the action's variables were referenced - otherwise, no namespace will be set
    
    Parameters:
    
    variablesNamespace - The name of the namespace to use for variables emitted by this action. This parameter is required.
    
    Returns:
    
    this
  - role
```
@Stability(value=Experimental)
public CodeBuildAction.Builder role(IRole role)
```
    (experimental) The Role in which context's this Action will be executing in.
    The Pipeline's Role will assume this Role (the required permissions for that will be granted automatically) right before executing this Action. This Action will be passed into your {@link IAction.bind} method in the {@link ActionBindOptions.role} property.
    Default: a new Role will be generated
    
    Parameters:
    
    role - The Role in which context's this Action will be executing in. This parameter is required.
    
    Returns:
    
    this
  - input
```
@Stability(value=Experimental)
public CodeBuildAction.Builder input(Artifact input)
```
    (experimental) The source to use as input for this action.
    
    Parameters:
    
    input - The source to use as input for this action. This parameter is required.
    
    Returns:
    
    this
  - project
```
@Stability(value=Experimental)
public CodeBuildAction.Builder project(IProject project)
```
    (experimental) The action's Project.
    
    Parameters:
    
    project - The action's Project. This parameter is required.
    
    Returns:
    
    this
  - checkSecretsInPlainTextEnvVariables
```
@Stability(value=Experimental)
public CodeBuildAction.Builder checkSecretsInPlainTextEnvVariables(Boolean checkSecretsInPlainTextEnvVariables)
```
    (experimental) Whether to check for the presence of any secrets in the environment variables of the default type, BuildEnvironmentVariableType.PLAINTEXT. Since using a secret for the value of that kind of variable would result in it being displayed in plain text in the AWS Console, the construct will throw an exception if it detects a secret was passed there. Pass this property as false if you want to skip this validation, and keep using a secret in a plain text environment variable.
    Default: true
    
    Parameters:
    
    checkSecretsInPlainTextEnvVariables - Whether to check for the presence of any secrets in the environment variables of the default type, BuildEnvironmentVariableType.PLAINTEXT. Since using a secret for the value of that kind of variable would result in it being displayed in plain text in the AWS Console, the construct will throw an exception if it detects a secret was passed there. Pass this property as false if you want to skip this validation, and keep using a secret in a plain text environment variable. This parameter is required.
    
    Returns:
    
    this
  - environmentVariables
```
@Stability(value=Experimental)
public CodeBuildAction.Builder environmentVariables(Map<String,? extends BuildEnvironmentVariable> environmentVariables)
```
    (experimental) The environment variables to pass to the CodeBuild project when this action executes.
    If a variable with the same name was set both on the project level, and here, this value will take precedence.
    Default: - No additional environment variables are specified.
    
    Parameters:
    
    environmentVariables - The environment variables to pass to the CodeBuild project when this action executes. This parameter is required.
    
    Returns:
    
    this
  - executeBatchBuild
```
@Stability(value=Experimental)
public CodeBuildAction.Builder executeBatchBuild(Boolean executeBatchBuild)
```
    (experimental) Trigger a batch build.
    Enabling this will enable batch builds on the CodeBuild project.
    Default: false
    
    Parameters:
    
    executeBatchBuild - Trigger a batch build. This parameter is required.
    
    Returns:
    
    this
  - extraInputs
```
@Stability(value=Experimental)
public CodeBuildAction.Builder extraInputs(List<? extends Artifact> extraInputs)
```
    (experimental) The list of additional input Artifacts for this action.
    The directories the additional inputs will be available at are available during the project's build in the CODEBUILD_SRC_DIR_ environment variables. The project's build always starts in the directory with the primary input artifact checked out, the one pointed to by the {@link input} property. For more information, see https://docs.aws.amazon.com/codebuild/latest/userguide/sample-multi-in-out.html .
    
    Parameters:
    
    extraInputs - The list of additional input Artifacts for this action. This parameter is required.
    
    Returns:
    
    this
  - outputs
```
@Stability(value=Experimental)
public CodeBuildAction.Builder outputs(List<? extends Artifact> outputs)
```
    (experimental) The list of output Artifacts for this action.
    Note: if you specify more than one output Artifact here, you cannot use the primary 'artifacts' section of the buildspec; you have to use the 'secondary-artifacts' section instead. See https://docs.aws.amazon.com/codebuild/latest/userguide/sample-multi-in-out.html for details.
    Default: the action will not have any outputs
    
    Parameters:
    
    outputs - The list of output Artifacts for this action. This parameter is required.
    
    Returns:
    
    this
  - type
```
@Stability(value=Experimental)
public CodeBuildAction.Builder type(CodeBuildActionType type)
```
    (experimental) The type of the action that determines its CodePipeline Category - Build, or Test.
    Default: CodeBuildActionType.BUILD
    
    Parameters:
    
    type - The type of the action that determines its CodePipeline Category - Build, or Test. This parameter is required.
    
    Returns:
    
    this
  - build
```
@Stability(value=Experimental)
public CodeBuildAction build()
```
    Specified by:
    
    build in interface software.amazon.jsii.Builder<CodeBuildAction>

Class CodeBuildAction.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

actionName

runOrder

variablesNamespace

role

input

project

checkSecretsInPlainTextEnvVariables

environmentVariables

executeBatchBuild

extraInputs

outputs

type

build