Package software.amazon.awscdk.pipelines

Class CodeBuildStepProps.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.pipelines.CodeBuildStepProps.Jsii$Proxy
All Implemented Interfaces:
CodeBuildStepProps, ShellStepProps, software.amazon.jsii.JsiiSerializable
Enclosing interface:
CodeBuildStepProps
@Stability(Stable) @Internal public static final class CodeBuildStepProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CodeBuildStepProps
An implementation for CodeBuildStepProps

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

  • Method Details

    • getActionRole

      public final IRole getActionRole()
      Description copied from interface: CodeBuildStepProps
      Custom execution role to be used for the Code Build Action.

      Default: - A role is automatically created

      Specified by:
      getActionRole in interface CodeBuildStepProps

    • getBuildEnvironment

      public final BuildEnvironment getBuildEnvironment()
      Description copied from interface: CodeBuildStepProps
      Changes to environment.

      This environment will be combined with the pipeline's default environment.

      Default: - Use the pipeline's default build environment

      Specified by:
      getBuildEnvironment in interface CodeBuildStepProps

    • getCache

      public final Cache getCache()
      Description copied from interface: CodeBuildStepProps
      Caching strategy to use.

      Default: - No cache

      Specified by:
      getCache in interface CodeBuildStepProps

    • getFileSystemLocations

      public final List<IFileSystemLocation> getFileSystemLocations()
      Description copied from interface: CodeBuildStepProps
      ProjectFileSystemLocation objects for CodeBuild build projects.

      A ProjectFileSystemLocation object specifies the identifier, location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System.

      Default: - no file system locations

      Specified by:
      getFileSystemLocations in interface CodeBuildStepProps

    • getLogging

      public final LoggingOptions getLogging()
      Description copied from interface: CodeBuildStepProps
      Information about logs for CodeBuild projects.

      A CodeBuild project can create logs in Amazon CloudWatch Logs, an S3 bucket, or both.

      Default: - no log configuration is set

      Specified by:
      getLogging in interface CodeBuildStepProps

    • getPartialBuildSpec

      public final BuildSpec getPartialBuildSpec()
      Description copied from interface: CodeBuildStepProps
      Additional configuration that can only be configured via BuildSpec.

      You should not use this to specify output artifacts; those should be supplied via the other properties of this class, otherwise CDK Pipelines won't be able to inspect the artifacts.

      Set the commands to an empty array if you want to fully specify the BuildSpec using this field.

      The BuildSpec must be available inline--it cannot reference a file on disk.

      Default: - BuildSpec completely derived from other properties

      Specified by:
      getPartialBuildSpec in interface CodeBuildStepProps

    • getProjectName

      public final String getProjectName()
      Description copied from interface: CodeBuildStepProps
      Name for the generated CodeBuild project.

      Default: - Automatically generated

      Specified by:
      getProjectName in interface CodeBuildStepProps

    • getRole

      public final IRole getRole()
      Description copied from interface: CodeBuildStepProps
      Custom execution role to be used for the CodeBuild project.

      Default: - A role is automatically created

      Specified by:
      getRole in interface CodeBuildStepProps

    • getRolePolicyStatements

      public final List<PolicyStatement> getRolePolicyStatements()
      Description copied from interface: CodeBuildStepProps
      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

      Specified by:
      getRolePolicyStatements in interface CodeBuildStepProps

    • getSecurityGroups

      public final List<ISecurityGroup> getSecurityGroups()
      Description copied from interface: CodeBuildStepProps
      Which security group to associate with the script's project network interfaces.

      If no security group is identified, one will be created automatically.

      Only used if 'vpc' is supplied.

      Default: - Security group will be automatically created.

      Specified by:
      getSecurityGroups in interface CodeBuildStepProps

    • getSubnetSelection

      public final SubnetSelection getSubnetSelection()
      Description copied from interface: CodeBuildStepProps
      Which subnets to use.

      Only used if 'vpc' is supplied.

      Default: - All private subnets.

      Specified by:
      getSubnetSelection in interface CodeBuildStepProps

    • getTimeout

      public final Duration getTimeout()
      Description copied from interface: CodeBuildStepProps
      The number of minutes after which AWS CodeBuild stops the build if it's not complete.

      For valid values, see the timeoutInMinutes field in the AWS CodeBuild User Guide.

      Default: Duration.hours(1)

      Specified by:
      getTimeout in interface CodeBuildStepProps

    • getVpc

      public final IVpc getVpc()
      Description copied from interface: CodeBuildStepProps
      The VPC where to execute the SimpleSynth.

      Default: - No VPC

      Specified by:
      getVpc in interface CodeBuildStepProps

    • getCommands

      public final List<String> getCommands()
      Description copied from interface: ShellStepProps
      Commands to run.
      Specified by:
      getCommands in interface ShellStepProps

    • getAdditionalInputs

      public final Map<String,IFileSetProducer> getAdditionalInputs()
      Description copied from interface: ShellStepProps
      Additional FileSets to put in other directories.

      Specifies a mapping from directory name to FileSets. During the script execution, the FileSets will be available in the directories indicated.

      The directory names may be relative. For example, you can put the main input and an additional input side-by-side with the following configuration: 

       ShellStep script = ShellStep.Builder.create("MainScript")
         .commands(List.of("npm ci", "npm run build", "npx cdk synth"))
         .input(CodePipelineSource.gitHub("org/source1", "main"))
         .additionalInputs(Map.of(
                 "../siblingdir", CodePipelineSource.gitHub("org/source2", "main")))
         .build();

      Default: - No additional inputs

      Specified by:
      getAdditionalInputs in interface ShellStepProps

    • getEnv

      public final Map<String,String> getEnv()
      Description copied from interface: ShellStepProps
      Environment variables to set.

      Default: - No environment variables

      Specified by:
      getEnv in interface ShellStepProps

    • getEnvFromCfnOutputs

      public final Map<String,CfnOutput> getEnvFromCfnOutputs()
      Description copied from interface: ShellStepProps
      Set environment variables based on Stack Outputs.

      ShellSteps following stack or stage deployments may access the CfnOutputs of those stacks to get access to --for example--automatically generated resource names or endpoint URLs.

      Default: - No environment variables created from stack outputs

      Specified by:
      getEnvFromCfnOutputs in interface ShellStepProps

    • getInput

      public final IFileSetProducer getInput()
      Description copied from interface: ShellStepProps
      FileSet to run these scripts on.

      The files in the FileSet will be placed in the working directory when the script is executed. Use additionalInputs to download file sets to other directories as well.

      Default: - No input specified

      Specified by:
      getInput in interface ShellStepProps

    • getInstallCommands

      public final List<String> getInstallCommands()
      Description copied from interface: ShellStepProps
      Installation commands to run before the regular commands.

      For deployment engines that support it, install commands will be classified differently in the job history from the regular commands.

      Default: - No installation commands

      Specified by:
      getInstallCommands in interface ShellStepProps

    • getPrimaryOutputDirectory

      public final String getPrimaryOutputDirectory()
      Description copied from interface: ShellStepProps
      The directory that will contain the primary output fileset.

      After running the script, the contents of the given directory will be treated as the primary output of this Step.

      Default: - No primary output

      Specified by:
      getPrimaryOutputDirectory in interface ShellStepProps

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