Interface CommonProjectProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
PipelineProjectProps, ProjectProps
All Known Implementing Classes:
CommonProjectProps.Jsii$Proxy, PipelineProjectProps.Jsii$Proxy, ProjectProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-07-22T22:42:48.855Z") @Stability(Stable) public interface CommonProjectProps extends software.amazon.jsii.JsiiSerializable
Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.codebuild.*;
 import software.amazon.awscdk.services.ec2.*;
 import software.amazon.awscdk.services.iam.*;
 import software.amazon.awscdk.services.kms.*;
 import software.amazon.awscdk.services.logs.*;
 import software.amazon.awscdk.services.s3.*;
 Bucket bucket;
 IBuildImage buildImage;
 BuildSpec buildSpec;
 Cache cache;
 IFileSystemLocation fileSystemLocation;
 Fleet fleet;
 Key key;
 LogGroup logGroup;
 Role role;
 SecurityGroup securityGroup;
 Subnet subnet;
 SubnetFilter subnetFilter;
 Object value;
 Vpc vpc;
 CommonProjectProps commonProjectProps = CommonProjectProps.builder()
         .allowAllOutbound(false)
         .badge(false)
         .buildSpec(buildSpec)
         .cache(cache)
         .checkSecretsInPlainTextEnvVariables(false)
         .concurrentBuildLimit(123)
         .description("description")
         .encryptionKey(key)
         .environment(BuildEnvironment.builder()
                 .buildImage(buildImage)
                 .certificate(BuildEnvironmentCertificate.builder()
                         .bucket(bucket)
                         .objectKey("objectKey")
                         .build())
                 .computeType(ComputeType.SMALL)
                 .environmentVariables(Map.of(
                         "environmentVariablesKey", BuildEnvironmentVariable.builder()
                                 .value(value)
                                 // the properties below are optional
                                 .type(BuildEnvironmentVariableType.PLAINTEXT)
                                 .build()))
                 .fleet(fleet)
                 .privileged(false)
                 .build())
         .environmentVariables(Map.of(
                 "environmentVariablesKey", BuildEnvironmentVariable.builder()
                         .value(value)
                         // the properties below are optional
                         .type(BuildEnvironmentVariableType.PLAINTEXT)
                         .build()))
         .fileSystemLocations(List.of(fileSystemLocation))
         .grantReportGroupPermissions(false)
         .logging(LoggingOptions.builder()
                 .cloudWatch(CloudWatchLoggingOptions.builder()
                         .enabled(false)
                         .logGroup(logGroup)
                         .prefix("prefix")
                         .build())
                 .s3(S3LoggingOptions.builder()
                         .bucket(bucket)
                         // the properties below are optional
                         .enabled(false)
                         .encrypted(false)
                         .prefix("prefix")
                         .build())
                 .build())
         .projectName("projectName")
         .queuedTimeout(Duration.minutes(30))
         .role(role)
         .securityGroups(List.of(securityGroup))
         .ssmSessionPermissions(false)
         .subnetSelection(SubnetSelection.builder()
                 .availabilityZones(List.of("availabilityZones"))
                 .onePerAz(false)
                 .subnetFilters(List.of(subnetFilter))
                 .subnetGroupName("subnetGroupName")
                 .subnets(List.of(subnet))
                 .subnetType(SubnetType.PRIVATE_ISOLATED)
                 .build())
         .timeout(Duration.minutes(30))
         .visibility(ProjectVisibility.PUBLIC_READ)
         .vpc(vpc)
         .build();
 
  • Method Details

    • getAllowAllOutbound

      @Stability(Stable) @Nullable default Boolean getAllowAllOutbound()
      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

    • getBadge

      @Stability(Stable) @Nullable default Boolean getBadge()
      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

    • getBuildSpec

      @Stability(Stable) @Nullable default BuildSpec getBuildSpec()
      Filename or contents of buildspec in JSON format.

      Default: - Empty buildspec.

      See Also:
    • getCache

      @Stability(Stable) @Nullable default Cache getCache()
      Caching strategy to use.

      Default: Cache.none

    • getCheckSecretsInPlainTextEnvVariables

      @Stability(Stable) @Nullable default Boolean getCheckSecretsInPlainTextEnvVariables()
      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

    • getConcurrentBuildLimit

      @Stability(Stable) @Nullable default Number getConcurrentBuildLimit()
      Maximum number of concurrent builds.

      Minimum value is 1 and maximum is account build limit.

      Default: - no explicit limit is set

    • getDescription

      @Stability(Stable) @Nullable default String getDescription()
      A description of the project.

      Use the description to identify the purpose of the project.

      Default: - No description.

    • getEncryptionKey

      @Stability(Stable) @Nullable default IKey getEncryptionKey()
      Encryption key to use to read and write artifacts.

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

    • getEnvironment

      @Stability(Stable) @Nullable default BuildEnvironment getEnvironment()
      Build environment to use for the build.

      Default: BuildEnvironment.LinuxBuildImage.STANDARD_1_0

    • getEnvironmentVariables

      @Stability(Stable) @Nullable default Map<String,BuildEnvironmentVariable> getEnvironmentVariables()
      Additional environment variables to add to the build environment.

      Default: - No additional environment variables are specified.

    • getFileSystemLocations

      @Stability(Stable) @Nullable default List<IFileSystemLocation> getFileSystemLocations()
      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

    • getGrantReportGroupPermissions

      @Stability(Stable) @Nullable default Boolean getGrantReportGroupPermissions()
      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

      See Also:
    • getLogging

      @Stability(Stable) @Nullable default LoggingOptions getLogging()
      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

    • getProjectName

      @Stability(Stable) @Nullable default String getProjectName()
      The physical, human-readable name of the CodeBuild Project.

      Default: - Name is automatically generated.

    • getQueuedTimeout

      @Stability(Stable) @Nullable default Duration getQueuedTimeout()
      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

    • getRole

      @Stability(Stable) @Nullable default IRole getRole()
      Service Role to assume while running the build.

      Default: - A role will be created.

    • getSecurityGroups

      @Stability(Stable) @Nullable default List<ISecurityGroup> getSecurityGroups()
      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.

    • getSsmSessionPermissions

      @Stability(Stable) @Nullable default Boolean getSsmSessionPermissions()
      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

      See Also:
    • getSubnetSelection

      @Stability(Stable) @Nullable default SubnetSelection getSubnetSelection()
      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

      See Also:
    • getTimeout

      @Stability(Stable) @Nullable default Duration getTimeout()
      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)

    • getVisibility

      @Stability(Stable) @Nullable default ProjectVisibility getVisibility()
      Specifies the visibility of the project's builds.

      Default: - no visibility is set

    • getVpc

      @Stability(Stable) @Nullable default IVpc getVpc()
      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.

    • builder

      @Stability(Stable) static CommonProjectProps.Builder builder()
      Returns:
      a CommonProjectProps.Builder of CommonProjectProps