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

Class CodeBuildActionProps.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.codepipeline.actions.CodeBuildActionProps.Jsii$Proxy
All Implemented Interfaces:
CodeBuildActionProps, CommonActionProps, CommonAwsActionProps, software.amazon.jsii.JsiiSerializable
Enclosing interface:
CodeBuildActionProps
@Stability(Stable) @Internal public static final class CodeBuildActionProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CodeBuildActionProps
An implementation for CodeBuildActionProps

  • Constructor Details

    • 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(CodeBuildActionProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the CodeBuildActionProps.Builder.

  • Method Details

    • getInput

      public final Artifact getInput()
      Description copied from interface: CodeBuildActionProps
      The source to use as input for this action.
      Specified by:
      getInput in interface CodeBuildActionProps

    • getProject

      public final IProject getProject()
      Description copied from interface: CodeBuildActionProps
      The action's Project.
      Specified by:
      getProject in interface CodeBuildActionProps

    • getCheckSecretsInPlainTextEnvVariables

      public final Boolean getCheckSecretsInPlainTextEnvVariables()
      Description copied from interface: CodeBuildActionProps
      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

      Specified by:
      getCheckSecretsInPlainTextEnvVariables in interface CodeBuildActionProps

    • getCombineBatchBuildArtifacts

      public final Boolean getCombineBatchBuildArtifacts()
      Description copied from interface: CodeBuildActionProps
      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.

      Default: false

      Specified by:
      getCombineBatchBuildArtifacts in interface CodeBuildActionProps

    • getEnvironmentVariables

      public final Map<String,BuildEnvironmentVariable> getEnvironmentVariables()
      Description copied from interface: CodeBuildActionProps
      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.

      Specified by:
      getEnvironmentVariables in interface CodeBuildActionProps

    • getExecuteBatchBuild

      public final Boolean getExecuteBatchBuild()
      Description copied from interface: CodeBuildActionProps
      Trigger a batch build.

      Enabling this will enable batch builds on the CodeBuild project.

      Default: false

      Specified by:
      getExecuteBatchBuild in interface CodeBuildActionProps

    • getExtraInputs

      public final List<Artifact> getExtraInputs()
      Description copied from interface: CodeBuildActionProps
      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 .

      Specified by:
      getExtraInputs in interface CodeBuildActionProps

    • getOutputs

      public final List<Artifact> getOutputs()
      Description copied from interface: CodeBuildActionProps
      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

      Specified by:
      getOutputs in interface CodeBuildActionProps

    • getType

      public final CodeBuildActionType getType()
      Description copied from interface: CodeBuildActionProps
      The type of the action that determines its CodePipeline Category - Build, or Test.

      Default: CodeBuildActionType.BUILD

      Specified by:
      getType in interface CodeBuildActionProps

    • getRole

      public final IRole getRole()
      Description copied from interface: CommonAwsActionProps
      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 IAction.bind method in the ActionBindOptions.role property.

      Default: a new Role will be generated

      Specified by:
      getRole in interface CommonAwsActionProps

    • getActionName

      public final String getActionName()
      Description copied from interface: CommonActionProps
      The physical, human-readable name of the Action.

      Note that Action names must be unique within a single Stage.

      Specified by:
      getActionName in interface CommonActionProps

    • getRunOrder

      public final Number getRunOrder()
      Description copied from interface: CommonActionProps
      The runOrder property for this Action.

      RunOrder determines the relative order in which multiple Actions in the same Stage execute.

      Default: 1

      Specified by:
      getRunOrder in interface CommonActionProps
      See Also:

    • getVariablesNamespace

      public final String getVariablesNamespace()
      Description copied from interface: CommonActionProps
      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

      Specified by:
      getVariablesNamespace in interface CommonActionProps

    • $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