Package software.amazon.awscdk.services.codepipeline.actions

Class CodeBuildActionProps.Builder

java.lang.Object
software.amazon.awscdk.services.codepipeline.actions.CodeBuildActionProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CodeBuildActionProps>
Enclosing interface:
CodeBuildActionProps
@Stability(Stable) public static final class CodeBuildActionProps.Builder extends Object implements software.amazon.jsii.Builder<CodeBuildActionProps>
A builder for CodeBuildActionProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • input

      @Stability(Stable) public CodeBuildActionProps.Builder input(Artifact input)
      Sets the value of CodeBuildActionProps.getInput()
      Parameters:
      input - The source to use as input for this action. This parameter is required.
      Returns:
      this

    • project

      @Stability(Stable) public CodeBuildActionProps.Builder project(IProject project)
      Sets the value of CodeBuildActionProps.getProject()
      Parameters:
      project - The action's Project. This parameter is required.
      Returns:
      this

    • checkSecretsInPlainTextEnvVariables

      @Stability(Stable) public CodeBuildActionProps.Builder checkSecretsInPlainTextEnvVariables(Boolean checkSecretsInPlainTextEnvVariables)
      Sets the value of CodeBuildActionProps.getCheckSecretsInPlainTextEnvVariables()
      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.
      Returns:
      this

    • combineBatchBuildArtifacts

      @Stability(Stable) public CodeBuildActionProps.Builder combineBatchBuildArtifacts(Boolean combineBatchBuildArtifacts)
      Sets the value of CodeBuildActionProps.getCombineBatchBuildArtifacts()
      Parameters:
      combineBatchBuildArtifacts - Combine the build artifacts for a batch builds. Enabling this will combine the build artifacts into the same location for batch builds. If executeBatchBuild is not set to true, this property is ignored.
      Returns:
      this

    • environmentVariables

      @Stability(Stable) public CodeBuildActionProps.Builder environmentVariables(Map<String,? extends BuildEnvironmentVariable> environmentVariables)
      Sets the value of CodeBuildActionProps.getEnvironmentVariables()
      Parameters:
      environmentVariables - 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.
      Returns:
      this

    • executeBatchBuild

      @Stability(Stable) public CodeBuildActionProps.Builder executeBatchBuild(Boolean executeBatchBuild)
      Sets the value of CodeBuildActionProps.getExecuteBatchBuild()
      Parameters:
      executeBatchBuild - Trigger a batch build. Enabling this will enable batch builds on the CodeBuild project.
      Returns:
      this

    • extraInputs

      @Stability(Stable) public CodeBuildActionProps.Builder extraInputs(List<? extends Artifact> extraInputs)
      Sets the value of CodeBuildActionProps.getExtraInputs()
      Parameters:
      extraInputs - 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_invalid input: '<'artifact-name> environment variables. The project's build always starts in the directory with the primary input artifact checked out, the one pointed to by the input property. For more information, see https://docs.aws.amazon.com/codebuild/latest/userguide/sample-multi-in-out.html .
      Returns:
      this

    • outputs

      @Stability(Stable) public CodeBuildActionProps.Builder outputs(List<? extends Artifact> outputs)
      Sets the value of CodeBuildActionProps.getOutputs()
      Parameters:
      outputs - 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.
      Returns:
      this

    • type

      @Stability(Stable) public CodeBuildActionProps.Builder type(CodeBuildActionType type)
      Sets the value of CodeBuildActionProps.getType()
      Parameters:
      type - The type of the action that determines its CodePipeline Category - Build, or Test.
      Returns:
      this

    • role

      @Stability(Stable) public CodeBuildActionProps.Builder role(IRole role)
      Sets the value of CommonAwsActionProps.getRole()
      Parameters:
      role - 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
      invalid @link 
      IAction.bind
      method in the
      invalid @link 
      ActionBindOptions.role
      property.
      Returns:
      this

    • actionName

      @Stability(Stable) public CodeBuildActionProps.Builder actionName(String actionName)
      Sets the value of CommonActionProps.getActionName()
      Parameters:
      actionName - The physical, human-readable name of the Action. This parameter is required. Note that Action names must be unique within a single Stage.
      Returns:
      this

    • runOrder

      @Stability(Stable) public CodeBuildActionProps.Builder runOrder(Number runOrder)
      Sets the value of CommonActionProps.getRunOrder()
      Parameters:
      runOrder - The runOrder property for this Action. RunOrder determines the relative order in which multiple Actions in the same Stage execute.
      Returns:
      this

    • variablesNamespace

      @Stability(Stable) public CodeBuildActionProps.Builder variablesNamespace(String variablesNamespace)
      Sets the value of CommonActionProps.getVariablesNamespace()
      Parameters:
      variablesNamespace - The name of the namespace to use for variables emitted by this action.
      Returns:
      this

    • build

      @Stability(Stable) public CodeBuildActionProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CodeBuildActionProps>
      Returns:
      a new instance of CodeBuildActionProps
      Throws:
      NullPointerException - if any required attribute was not provided