CommonProjectProps

All Known Subinterfaces:: PipelineProjectProps, ProjectProps

All Known Implementing Classes:: CommonProjectProps.Jsii$Proxy, PipelineProjectProps.Jsii$Proxy, ProjectProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-20T22:20:01.137Z")
public interface CommonProjectProps

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 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.*;
 import software.amazon.awscdk.core.*;
 Bucket bucket;
 IBuildImage buildImage;
 BuildSpec buildSpec;
 Cache cache;
 IFileSystemLocation fileSystemLocation;
 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()))
                 .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))
         .subnetSelection(SubnetSelection.builder()
                 .availabilityZones(List.of("availabilityZones"))
                 .onePerAz(false)
                 .subnetFilters(List.of(subnetFilter))
                 .subnetGroupName("subnetGroupName")
                 .subnetName("subnetName")
                 .subnets(List.of(subnet))
                 .subnetType(SubnetType.ISOLATED)
                 .build())
         .timeout(Duration.minutes(30))
         .vpc(vpc)
         .build();

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`CommonProjectProps.Builder` A builder for `CommonProjectProps`
`static class`	`CommonProjectProps.Jsii$Proxy` An implementation for `CommonProjectProps`

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`static CommonProjectProps.Builder`	`builder()`
`default java.lang.Boolean`	`getAllowAllOutbound()` Whether to allow the CodeBuild to send all network traffic.
`default java.lang.Boolean`	`getBadge()` Indicates whether AWS CodeBuild generates a publicly accessible URL for your project's build badge.
`default BuildSpec`	`getBuildSpec()` Filename or contents of buildspec in JSON format.
`default Cache`	`getCache()` Caching strategy to use.
`default java.lang.Boolean`	`getCheckSecretsInPlainTextEnvVariables()` Whether to check for the presence of any secrets in the environment variables of the default type, BuildEnvironmentVariableType.PLAINTEXT.
`default java.lang.Number`	`getConcurrentBuildLimit()` Maximum number of concurrent builds.
`default java.lang.String`	`getDescription()` A description of the project.
`default IKey`	`getEncryptionKey()` Encryption key to use to read and write artifacts.
`default BuildEnvironment`	`getEnvironment()` Build environment to use for the build.
`default java.util.Map<java.lang.String,BuildEnvironmentVariable>`	`getEnvironmentVariables()` Additional environment variables to add to the build environment.
`default java.util.List<IFileSystemLocation>`	`getFileSystemLocations()` An ProjectFileSystemLocation objects for a CodeBuild build project.
`default java.lang.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.
`default LoggingOptions`	`getLogging()` Information about logs for the build project.
`default java.lang.String`	`getProjectName()` The physical, human-readable name of the CodeBuild Project.
`default Duration`	`getQueuedTimeout()` The number of minutes after which AWS CodeBuild stops the build if it's still in queue.
`default IRole`	`getRole()` Service Role to assume while running the build.
`default java.util.List<ISecurityGroup>`	`getSecurityGroups()` What security group to associate with the codebuild project's network interfaces.
`default SubnetSelection`	`getSubnetSelection()` Where to place the network interfaces within the VPC.
`default Duration`	`getTimeout()` The number of minutes after which AWS CodeBuild stops the build if it's not complete.
`default IVpc`	`getVpc()` VPC network to place codebuild network interfaces.

- Method Detail
  - getAllowAllOutbound
```
default java.lang.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
```
default java.lang.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
```
default BuildSpec getBuildSpec()
```
    Filename or contents of buildspec in JSON format.
    Default: - Empty buildspec.
    
    See Also:
    
    https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec-ref-example
  - getCache
```
default Cache getCache()
```
    Caching strategy to use.
    Default: Cache.none
  - getCheckSecretsInPlainTextEnvVariables
```
default java.lang.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
```
default java.lang.Number getConcurrentBuildLimit()
```
    Maximum number of concurrent builds.
    Minimum value is 1 and maximum is account build limit.
    Default: - no explicit limit is set
  - getDescription
```
default java.lang.String getDescription()
```
    A description of the project.
    Use the description to identify the purpose of the project.
    Default: - No description.
  - getEncryptionKey
```
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
```
default BuildEnvironment getEnvironment()
```
    Build environment to use for the build.
    Default: BuildEnvironment.LinuxBuildImage.STANDARD_1_0
  - getEnvironmentVariables
```
default java.util.Map<java.lang.String,BuildEnvironmentVariable> getEnvironmentVariables()
```
    Additional environment variables to add to the build environment.
    Default: - No additional environment variables are specified.
  - getFileSystemLocations
```
default java.util.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
```
default java.lang.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:
    
    https://docs.aws.amazon.com/codebuild/latest/userguide/test-report-group-naming.html
  - getLogging
```
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
```
default java.lang.String getProjectName()
```
    The physical, human-readable name of the CodeBuild Project.
    Default: - Name is automatically generated.
  - getQueuedTimeout
```
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
```
default IRole getRole()
```
    Service Role to assume while running the build.
    Default: - A role will be created.
  - getSecurityGroups
```
default java.util.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.
  - getSubnetSelection
```
default SubnetSelection getSubnetSelection()
```
    Where to place the network interfaces within the VPC.
    Only used if 'vpc' is supplied.
    Default: - All private subnets.
  - getTimeout
```
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)
  - getVpc
```
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
```
static CommonProjectProps.Builder builder()
```
    Returns:
    
    a CommonProjectProps.Builder of CommonProjectProps

Interface CommonProjectProps

Nested Class Summary

Method Summary

Method Detail

getAllowAllOutbound

getBadge

getBuildSpec

getCache

getCheckSecretsInPlainTextEnvVariables

getConcurrentBuildLimit

getDescription

getEncryptionKey

getEnvironment

getEnvironmentVariables

getFileSystemLocations

getGrantReportGroupPermissions

getLogging

getProjectName

getQueuedTimeout

getRole

getSecurityGroups

getSubnetSelection

getTimeout

getVpc

builder