Project.Builder

java.lang.Object
- software.amazon.awscdk.services.codebuild.Project.Builder

Enclosing class:: Project

public static final class Project.Builder
extends java.lang.Object

A fluent builder for Project.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Project.Builder`	`allowAllOutbound(java.lang.Boolean allowAllOutbound)` Whether to allow the CodeBuild to send all network traffic.
`Project.Builder`	`artifacts(IArtifacts artifacts)` Defines where build artifacts will be stored.
`Project.Builder`	`badge(java.lang.Boolean badge)` Indicates whether AWS CodeBuild generates a publicly accessible URL for your project's build badge.
`Project`	`build()`
`Project.Builder`	`buildSpec(BuildSpec buildSpec)` Filename or contents of buildspec in JSON format.
`Project.Builder`	`cache(Cache cache)` Caching strategy to use.
`Project.Builder`	`checkSecretsInPlainTextEnvVariables(java.lang.Boolean checkSecretsInPlainTextEnvVariables)` Whether to check for the presence of any secrets in the environment variables of the default type, BuildEnvironmentVariableType.PLAINTEXT.
`Project.Builder`	`concurrentBuildLimit(java.lang.Number concurrentBuildLimit)` Maximum number of concurrent builds.
`static Project.Builder`	`create(software.constructs.Construct scope, java.lang.String id)`
`Project.Builder`	`description(java.lang.String description)` A description of the project.
`Project.Builder`	`encryptionKey(IKey encryptionKey)` Encryption key to use to read and write artifacts.
`Project.Builder`	`environment(BuildEnvironment environment)` Build environment to use for the build.
`Project.Builder`	`environmentVariables(java.util.Map<java.lang.String,? extends BuildEnvironmentVariable> environmentVariables)` Additional environment variables to add to the build environment.
`Project.Builder`	`fileSystemLocations(java.util.List<? extends IFileSystemLocation> fileSystemLocations)` An ProjectFileSystemLocation objects for a CodeBuild build project.
`Project.Builder`	`grantReportGroupPermissions(java.lang.Boolean grantReportGroupPermissions)` Add permissions to this project's role to create and use test report groups with name starting with the name of this project.
`Project.Builder`	`logging(LoggingOptions logging)` Information about logs for the build project.
`Project.Builder`	`projectName(java.lang.String projectName)` The physical, human-readable name of the CodeBuild Project.
`Project.Builder`	`queuedTimeout(Duration queuedTimeout)` The number of minutes after which AWS CodeBuild stops the build if it's still in queue.
`Project.Builder`	`role(IRole role)` Service Role to assume while running the build.
`Project.Builder`	`secondaryArtifacts(java.util.List<? extends IArtifacts> secondaryArtifacts)` The secondary artifacts for the Project.
`Project.Builder`	`secondarySources(java.util.List<? extends ISource> secondarySources)` The secondary sources for the Project.
`Project.Builder`	`securityGroups(java.util.List<? extends ISecurityGroup> securityGroups)` What security group to associate with the codebuild project's network interfaces.
`Project.Builder`	`source(ISource source)` The source of the build.
`Project.Builder`	`subnetSelection(SubnetSelection subnetSelection)` Where to place the network interfaces within the VPC.
`Project.Builder`	`timeout(Duration timeout)` The number of minutes after which AWS CodeBuild stops the build if it's not complete.
`Project.Builder`	`vpc(IVpc vpc)` VPC network to place codebuild network interfaces.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - create
```
public static Project.Builder create(software.constructs.Construct scope,
                                     java.lang.String id)
```
    Parameters:
    
    scope - This parameter is required.
    
    id - This parameter is required.
    
    Returns:
    
    a new instance of Project.Builder.
  - allowAllOutbound
```
public Project.Builder allowAllOutbound(java.lang.Boolean allowAllOutbound)
```
    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
    
    Parameters:
    
    allowAllOutbound - Whether to allow the CodeBuild to send all network traffic. This parameter is required.
    
    Returns:
    
    this
  - badge
```
public Project.Builder badge(java.lang.Boolean badge)
```
    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
    
    Parameters:
    
    badge - Indicates whether AWS CodeBuild generates a publicly accessible URL for your project's build badge. This parameter is required.
    
    Returns:
    
    this
  - buildSpec
```
public Project.Builder buildSpec(BuildSpec buildSpec)
```
    Filename or contents of buildspec in JSON format.
    Default: - Empty buildspec.
    
    Parameters:
    
    buildSpec - Filename or contents of buildspec in JSON format. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec-ref-example
  - cache
```
public Project.Builder cache(Cache cache)
```
    Caching strategy to use.
    Default: Cache.none
    
    Parameters:
    
    cache - Caching strategy to use. This parameter is required.
    
    Returns:
    
    this
  - checkSecretsInPlainTextEnvVariables
```
public Project.Builder checkSecretsInPlainTextEnvVariables(java.lang.Boolean checkSecretsInPlainTextEnvVariables)
```
    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
    
    Parameters:
    
    checkSecretsInPlainTextEnvVariables - 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. This parameter is required.
    
    Returns:
    
    this
  - concurrentBuildLimit
```
public Project.Builder concurrentBuildLimit(java.lang.Number concurrentBuildLimit)
```
    Maximum number of concurrent builds.
    Minimum value is 1 and maximum is account build limit.
    Default: - no explicit limit is set
    
    Parameters:
    
    concurrentBuildLimit - Maximum number of concurrent builds. This parameter is required.
    
    Returns:
    
    this
  - description
```
public Project.Builder description(java.lang.String description)
```
    A description of the project.
    Use the description to identify the purpose of the project.
    Default: - No description.
    
    Parameters:
    
    description - A description of the project. This parameter is required.
    
    Returns:
    
    this
  - encryptionKey
```
public Project.Builder encryptionKey(IKey encryptionKey)
```
    Encryption key to use to read and write artifacts.
    Default: - The AWS-managed CMK for Amazon Simple Storage Service (Amazon S3) is used.
    
    Parameters:
    
    encryptionKey - Encryption key to use to read and write artifacts. This parameter is required.
    
    Returns:
    
    this
  - environment
```
public Project.Builder environment(BuildEnvironment environment)
```
    Build environment to use for the build.
    Default: BuildEnvironment.LinuxBuildImage.STANDARD_1_0
    
    Parameters:
    
    environment - Build environment to use for the build. This parameter is required.
    
    Returns:
    
    this
  - environmentVariables
```
public Project.Builder environmentVariables(java.util.Map<java.lang.String,? extends BuildEnvironmentVariable> environmentVariables)
```
    Additional environment variables to add to the build environment.
    Default: - No additional environment variables are specified.
    
    Parameters:
    
    environmentVariables - Additional environment variables to add to the build environment. This parameter is required.
    
    Returns:
    
    this
  - fileSystemLocations
```
public Project.Builder fileSystemLocations(java.util.List<? extends IFileSystemLocation> fileSystemLocations)
```
    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
    
    Parameters:
    
    fileSystemLocations - An ProjectFileSystemLocation objects for a CodeBuild build project. This parameter is required.
    
    Returns:
    
    this
  - grantReportGroupPermissions
```
public Project.Builder grantReportGroupPermissions(java.lang.Boolean grantReportGroupPermissions)
```
    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
    
    Parameters:
    
    grantReportGroupPermissions - Add permissions to this project's role to create and use test report groups with name starting with the name of this project. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/codebuild/latest/userguide/test-report-group-naming.html
  - logging
```
public Project.Builder logging(LoggingOptions logging)
```
    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
    
    Parameters:
    
    logging - Information about logs for the build project. This parameter is required.
    
    Returns:
    
    this
  - projectName
```
public Project.Builder projectName(java.lang.String projectName)
```
    The physical, human-readable name of the CodeBuild Project.
    Default: - Name is automatically generated.
    
    Parameters:
    
    projectName - The physical, human-readable name of the CodeBuild Project. This parameter is required.
    
    Returns:
    
    this
  - queuedTimeout
```
public Project.Builder queuedTimeout(Duration queuedTimeout)
```
    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
    
    Parameters:
    
    queuedTimeout - The number of minutes after which AWS CodeBuild stops the build if it's still in queue. This parameter is required.
    
    Returns:
    
    this
  - role
```
public Project.Builder role(IRole role)
```
    Service Role to assume while running the build.
    Default: - A role will be created.
    
    Parameters:
    
    role - Service Role to assume while running the build. This parameter is required.
    
    Returns:
    
    this
  - securityGroups
```
public Project.Builder securityGroups(java.util.List<? extends ISecurityGroup> securityGroups)
```
    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.
    
    Parameters:
    
    securityGroups - What security group to associate with the codebuild project's network interfaces. This parameter is required.
    
    Returns:
    
    this
  - subnetSelection
```
public Project.Builder subnetSelection(SubnetSelection subnetSelection)
```
    Where to place the network interfaces within the VPC.
    Only used if 'vpc' is supplied.
    Default: - All private subnets.
    
    Parameters:
    
    subnetSelection - Where to place the network interfaces within the VPC. This parameter is required.
    
    Returns:
    
    this
  - timeout
```
public Project.Builder timeout(Duration timeout)
```
    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)
    
    Parameters:
    
    timeout - The number of minutes after which AWS CodeBuild stops the build if it's not complete. This parameter is required.
    
    Returns:
    
    this
  - vpc
```
public Project.Builder vpc(IVpc vpc)
```
    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.
    
    Parameters:
    
    vpc - VPC network to place codebuild network interfaces. This parameter is required.
    
    Returns:
    
    this
  - artifacts
```
public Project.Builder artifacts(IArtifacts artifacts)
```
    Defines where build artifacts will be stored.
    Could be: PipelineBuildArtifacts, NoArtifacts and S3Artifacts.
    Default: NoArtifacts
    
    Parameters:
    
    artifacts - Defines where build artifacts will be stored. This parameter is required.
    
    Returns:
    
    this
  - secondaryArtifacts
```
public Project.Builder secondaryArtifacts(java.util.List<? extends IArtifacts> secondaryArtifacts)
```
    The secondary artifacts for the Project.
    Can also be added after the Project has been created by using the {@link Project#addSecondaryArtifact} method.
    Default: - No secondary artifacts.
    
    Parameters:
    
    secondaryArtifacts - The secondary artifacts for the Project. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/codebuild/latest/userguide/sample-multi-in-out.html
  - secondarySources
```
public Project.Builder secondarySources(java.util.List<? extends ISource> secondarySources)
```
    The secondary sources for the Project.
    Can be also added after the Project has been created by using the {@link Project#addSecondarySource} method.
    Default: - No secondary sources.
    
    Parameters:
    
    secondarySources - The secondary sources for the Project. This parameter is required.
    
    Returns:
    
    this
    
    See Also:
    
    https://docs.aws.amazon.com/codebuild/latest/userguide/sample-multi-in-out.html
  - source
```
public Project.Builder source(ISource source)
```
    The source of the build.
    Note: if {@link NoSource} is given as the source, then you need to provide an explicit buildSpec.
    Default: - NoSource
    
    Parameters:
    
    source - The source of the build. This parameter is required.
    
    Returns:
    
    this
  - build
```
public Project build()
```

Class Project.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

allowAllOutbound

badge

buildSpec

cache

checkSecretsInPlainTextEnvVariables

concurrentBuildLimit

description

encryptionKey

environment

environmentVariables

fileSystemLocations

grantReportGroupPermissions

logging

projectName

queuedTimeout

role

securityGroups

subnetSelection

timeout

vpc

artifacts

secondaryArtifacts

secondarySources

source

build