Package software.amazon.awscdk.services.codebuild

Class CommonProjectProps.Jsii$Proxy

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

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

  • Method Details

    • getAllowAllOutbound

      public final Boolean getAllowAllOutbound()
      Description copied from interface: CommonProjectProps
      Whether to allow the CodeBuild to send all network traffic.

      If set to false, you must individually add traffic rules to allow the CodeBuild project to connect to network targets.

      Only used if 'vpc' is supplied.

      Default: true

      Specified by:
      getAllowAllOutbound in interface CommonProjectProps

    • getAutoRetryLimit

      public final Number getAutoRetryLimit()
      Description copied from interface: CommonProjectProps
      CodeBuild will automatically call retry build using the project's service role up to the auto-retry limit.

      autoRetryLimit must be between 0 and 10.

      Default: - no retry

      Specified by:
      getAutoRetryLimit in interface CommonProjectProps

    • getBadge

      public final Boolean getBadge()
      Description copied from interface: CommonProjectProps
      Indicates whether AWS CodeBuild generates a publicly accessible URL for your project's build badge.

      For more information, see Build Badges Sample in the AWS CodeBuild User Guide.

      Default: false

      Specified by:
      getBadge in interface CommonProjectProps

    • getBuildSpec

      public final BuildSpec getBuildSpec()
      Description copied from interface: CommonProjectProps
      Filename or contents of buildspec in JSON format.

      Default: - Empty buildspec.

      Specified by:
      getBuildSpec in interface CommonProjectProps
      See Also:

    • getCache

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

      Default: Cache.none

      Specified by:
      getCache in interface CommonProjectProps

    • getCheckSecretsInPlainTextEnvVariables

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

    • getConcurrentBuildLimit

      public final Number getConcurrentBuildLimit()
      Description copied from interface: CommonProjectProps
      Maximum number of concurrent builds.

      Minimum value is 1 and maximum is account build limit.

      Default: - no explicit limit is set

      Specified by:
      getConcurrentBuildLimit in interface CommonProjectProps

    • getDescription

      public final String getDescription()
      Description copied from interface: CommonProjectProps
      A description of the project.

      Use the description to identify the purpose of the project.

      Default: - No description.

      Specified by:
      getDescription in interface CommonProjectProps

    • getEncryptionKey

      public final IKey getEncryptionKey()
      Description copied from interface: CommonProjectProps
      Encryption key to use to read and write artifacts.

      Default: - The AWS-managed CMK for Amazon Simple Storage Service (Amazon S3) is used.

      Specified by:
      getEncryptionKey in interface CommonProjectProps

    • getEnvironment

      public final BuildEnvironment getEnvironment()
      Description copied from interface: CommonProjectProps
      Build environment to use for the build.

      Default: BuildEnvironment.LinuxBuildImage.STANDARD_7_0

      Specified by:
      getEnvironment in interface CommonProjectProps

    • getEnvironmentVariables

      public final Map<String,BuildEnvironmentVariable> getEnvironmentVariables()
      Description copied from interface: CommonProjectProps
      Additional environment variables to add to the build environment.

      Default: - No additional environment variables are specified.

      Specified by:
      getEnvironmentVariables in interface CommonProjectProps

    • getFileSystemLocations

      public final List<IFileSystemLocation> getFileSystemLocations()
      Description copied from interface: CommonProjectProps
      An ProjectFileSystemLocation objects for a CodeBuild build project.

      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 CommonProjectProps

    • getGrantReportGroupPermissions

      public final Boolean getGrantReportGroupPermissions()
      Description copied from interface: CommonProjectProps
      Add permissions to this project's role to create and use test report groups with name starting with the name of this project.

      That is the standard report group that gets created when a simple name (in contrast to an ARN) is used in the 'reports' section of the buildspec of this project. This is usually harmless, but you can turn these off if you don't plan on using test reports in this project.

      Default: true

      Specified by:
      getGrantReportGroupPermissions in interface CommonProjectProps
      See Also:

    • getLogging

      public final LoggingOptions getLogging()
      Description copied from interface: CommonProjectProps
      Information about logs for the build project.

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

      Default: - no log configuration is set

      Specified by:
      getLogging in interface CommonProjectProps

    • getProjectName

      public final String getProjectName()
      Description copied from interface: CommonProjectProps
      The physical, human-readable name of the CodeBuild Project.

      Default: - Name is automatically generated.

      Specified by:
      getProjectName in interface CommonProjectProps

    • getQueuedTimeout

      public final Duration getQueuedTimeout()
      Description copied from interface: CommonProjectProps
      The number of minutes after which AWS CodeBuild stops the build if it's still in queue.

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

      Default: - no queue timeout is set

      Specified by:
      getQueuedTimeout in interface CommonProjectProps

    • getRole

      public final IRole getRole()
      Description copied from interface: CommonProjectProps
      Service Role to assume while running the build.

      Default: - A role will be created.

      Specified by:
      getRole in interface CommonProjectProps

    • getSecurityGroups

      public final List<ISecurityGroup> getSecurityGroups()
      Description copied from interface: CommonProjectProps
      What security group to associate with the codebuild project's 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 CommonProjectProps

    • getSsmSessionPermissions

      public final Boolean getSsmSessionPermissions()
      Description copied from interface: CommonProjectProps
      Add the permissions necessary for debugging builds with SSM Session Manager.

      If the following prerequisites have been met:

      • The necessary permissions have been added by setting this flag to true.
      • The build image has the SSM agent installed (true for default CodeBuild images).
      • The build is started with debugSessionEnabled set to true.

      Then the build container can be paused and inspected using Session Manager by invoking the codebuild-breakpoint command somewhere during the build.

      codebuild-breakpoint commands will be ignored if the build is not started with debugSessionEnabled=true.

      Default: false

      Specified by:
      getSsmSessionPermissions in interface CommonProjectProps
      See Also:

    • getSubnetSelection

      public final SubnetSelection getSubnetSelection()
      Description copied from interface: CommonProjectProps
      Where to place the network interfaces within the VPC.

      To access AWS services, your CodeBuild project needs to be in one of the following types of subnets:

      1. Subnets with access to the internet (of type PRIVATE_WITH_EGRESS).
      2. Private subnets unconnected to the internet, but with VPC endpoints for the necessary services.

      If you don't specify a subnet selection, the default behavior is to use PRIVATE_WITH_EGRESS subnets first if they exist, then PRIVATE_WITHOUT_EGRESS, and finally PUBLIC subnets. If your VPC doesn't have PRIVATE_WITH_EGRESS subnets but you need AWS service access, add VPC Endpoints to your private subnets.

      Default: - private subnets if available else public subnets

      Specified by:
      getSubnetSelection in interface CommonProjectProps
      See Also:

    • getTimeout

      public final Duration getTimeout()
      Description copied from interface: CommonProjectProps
      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 CommonProjectProps

    • getVisibility

      public final ProjectVisibility getVisibility()
      Description copied from interface: CommonProjectProps
      Specifies the visibility of the project's builds.

      Default: - no visibility is set

      Specified by:
      getVisibility in interface CommonProjectProps

    • getVpc

      public final IVpc getVpc()
      Description copied from interface: CommonProjectProps
      VPC network to place codebuild network interfaces.

      Specify this if the codebuild project needs to access resources in a VPC.

      Default: - No VPC is specified.

      Specified by:
      getVpc in interface CommonProjectProps

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