software.amazon.awscdk.services.codebuild

Class ProjectProps.Builder

java.lang.Object

software.amazon.awscdk.services.codebuild.ProjectProps.Builder

Enclosing interface:

ProjectProps

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

A builder for ProjectProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ProjectProps.Builder	allowAllOutbound(java.lang.Boolean allowAllOutbound) Sets the value of CommonProjectProps.getAllowAllOutbound()
ProjectProps.Builder	artifacts(IArtifacts artifacts) Sets the value of ProjectProps.getArtifacts()
ProjectProps.Builder	badge(java.lang.Boolean badge) Sets the value of CommonProjectProps.getBadge()
ProjectProps	build() Builds the configured instance.
ProjectProps.Builder	buildSpec(BuildSpec buildSpec) Sets the value of CommonProjectProps.getBuildSpec()
ProjectProps.Builder	cache(Cache cache) Sets the value of CommonProjectProps.getCache()
ProjectProps.Builder	checkSecretsInPlainTextEnvVariables(java.lang.Boolean checkSecretsInPlainTextEnvVariables) Sets the value of CommonProjectProps.getCheckSecretsInPlainTextEnvVariables()
ProjectProps.Builder	concurrentBuildLimit(java.lang.Number concurrentBuildLimit) Sets the value of CommonProjectProps.getConcurrentBuildLimit()
ProjectProps.Builder	description(java.lang.String description) Sets the value of CommonProjectProps.getDescription()
ProjectProps.Builder	encryptionKey(IKey encryptionKey) Sets the value of CommonProjectProps.getEncryptionKey()
ProjectProps.Builder	environment(BuildEnvironment environment) Sets the value of CommonProjectProps.getEnvironment()
ProjectProps.Builder	environmentVariables(java.util.Map<java.lang.String,? extends BuildEnvironmentVariable> environmentVariables) Sets the value of CommonProjectProps.getEnvironmentVariables()
ProjectProps.Builder	fileSystemLocations(java.util.List<? extends IFileSystemLocation> fileSystemLocations) Sets the value of CommonProjectProps.getFileSystemLocations()
ProjectProps.Builder	grantReportGroupPermissions(java.lang.Boolean grantReportGroupPermissions) Sets the value of CommonProjectProps.getGrantReportGroupPermissions()
ProjectProps.Builder	logging(LoggingOptions logging) Sets the value of CommonProjectProps.getLogging()
ProjectProps.Builder	projectName(java.lang.String projectName) Sets the value of CommonProjectProps.getProjectName()
ProjectProps.Builder	queuedTimeout(Duration queuedTimeout) Sets the value of CommonProjectProps.getQueuedTimeout()
ProjectProps.Builder	role(IRole role) Sets the value of CommonProjectProps.getRole()
ProjectProps.Builder	secondaryArtifacts(java.util.List<? extends IArtifacts> secondaryArtifacts) Sets the value of ProjectProps.getSecondaryArtifacts()
ProjectProps.Builder	secondarySources(java.util.List<? extends ISource> secondarySources) Sets the value of ProjectProps.getSecondarySources()
ProjectProps.Builder	securityGroups(java.util.List<? extends ISecurityGroup> securityGroups) Sets the value of CommonProjectProps.getSecurityGroups()
ProjectProps.Builder	source(ISource source) Sets the value of ProjectProps.getSource()
ProjectProps.Builder	subnetSelection(SubnetSelection subnetSelection) Sets the value of CommonProjectProps.getSubnetSelection()
ProjectProps.Builder	timeout(Duration timeout) Sets the value of CommonProjectProps.getTimeout()
ProjectProps.Builder	vpc(IVpc vpc) Sets the value of CommonProjectProps.getVpc()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

artifacts

public ProjectProps.Builder artifacts(IArtifacts artifacts)

Sets the value of ProjectProps.getArtifacts()

Parameters:

artifacts - Defines where build artifacts will be stored. Could be: PipelineBuildArtifacts, NoArtifacts and S3Artifacts.

Returns:

this

secondaryArtifacts

public ProjectProps.Builder secondaryArtifacts(java.util.List<? extends IArtifacts> secondaryArtifacts)

Sets the value of ProjectProps.getSecondaryArtifacts()

Parameters:

secondaryArtifacts - The secondary artifacts for the Project. Can also be added after the Project has been created by using the {@link Project#addSecondaryArtifact} method.

Returns:

this

secondarySources

public ProjectProps.Builder secondarySources(java.util.List<? extends ISource> secondarySources)

Sets the value of ProjectProps.getSecondarySources()

Parameters:

secondarySources - The secondary sources for the Project. Can be also added after the Project has been created by using the {@link Project#addSecondarySource} method.

Returns:

this

source

public ProjectProps.Builder source(ISource source)

Sets the value of ProjectProps.getSource()

Parameters:

source - The source of the build. Note: if {@link NoSource} is given as the source, then you need to provide an explicit buildSpec.

Returns:

this

allowAllOutbound

public ProjectProps.Builder allowAllOutbound(java.lang.Boolean allowAllOutbound)

Sets the value of CommonProjectProps.getAllowAllOutbound()

Parameters:

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.

Returns:

this

badge

public ProjectProps.Builder badge(java.lang.Boolean badge)

Sets the value of CommonProjectProps.getBadge()

Parameters:

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.

Returns:

this

buildSpec

public ProjectProps.Builder buildSpec(BuildSpec buildSpec)

Sets the value of CommonProjectProps.getBuildSpec()

Parameters:

buildSpec - Filename or contents of buildspec in JSON format.

Returns:

this

cache

public ProjectProps.Builder cache(Cache cache)

Sets the value of CommonProjectProps.getCache()

Parameters:

cache - Caching strategy to use.

Returns:

this

checkSecretsInPlainTextEnvVariables

public ProjectProps.Builder checkSecretsInPlainTextEnvVariables(java.lang.Boolean checkSecretsInPlainTextEnvVariables)

Sets the value of CommonProjectProps.getCheckSecretsInPlainTextEnvVariables()

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.

Returns:

this

concurrentBuildLimit

public ProjectProps.Builder concurrentBuildLimit(java.lang.Number concurrentBuildLimit)

Sets the value of CommonProjectProps.getConcurrentBuildLimit()

Parameters:

concurrentBuildLimit - Maximum number of concurrent builds. Minimum value is 1 and maximum is account build limit.

Returns:

this

description

public ProjectProps.Builder description(java.lang.String description)

Sets the value of CommonProjectProps.getDescription()

Parameters:

description - A description of the project. Use the description to identify the purpose of the project.

Returns:

this

encryptionKey

public ProjectProps.Builder encryptionKey(IKey encryptionKey)

Sets the value of CommonProjectProps.getEncryptionKey()

Parameters:

encryptionKey - Encryption key to use to read and write artifacts.

Returns:

this

environment

public ProjectProps.Builder environment(BuildEnvironment environment)

Sets the value of CommonProjectProps.getEnvironment()

Parameters:

environment - Build environment to use for the build.

Returns:

this

environmentVariables

public ProjectProps.Builder environmentVariables(java.util.Map<java.lang.String,? extends BuildEnvironmentVariable> environmentVariables)

Sets the value of CommonProjectProps.getEnvironmentVariables()

Parameters:

environmentVariables - Additional environment variables to add to the build environment.

Returns:

this

fileSystemLocations

public ProjectProps.Builder fileSystemLocations(java.util.List<? extends IFileSystemLocation> fileSystemLocations)

Sets the value of CommonProjectProps.getFileSystemLocations()

Parameters:

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.

Returns:

this

grantReportGroupPermissions

public ProjectProps.Builder grantReportGroupPermissions(java.lang.Boolean grantReportGroupPermissions)

Sets the value of CommonProjectProps.getGrantReportGroupPermissions()

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. 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.

Returns:

this

logging

public ProjectProps.Builder logging(LoggingOptions logging)

Sets the value of CommonProjectProps.getLogging()

Parameters:

logging - Information about logs for the build project. A project can create logs in Amazon CloudWatch Logs, an S3 bucket, or both.

Returns:

this

projectName

public ProjectProps.Builder projectName(java.lang.String projectName)

Sets the value of CommonProjectProps.getProjectName()

Parameters:

projectName - The physical, human-readable name of the CodeBuild Project.

Returns:

this

queuedTimeout

public ProjectProps.Builder queuedTimeout(Duration queuedTimeout)

Sets the value of CommonProjectProps.getQueuedTimeout()

Parameters:

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.

Returns:

this

role

public ProjectProps.Builder role(IRole role)

Sets the value of CommonProjectProps.getRole()

Parameters:

role - Service Role to assume while running the build.

Returns:

this

securityGroups

public ProjectProps.Builder securityGroups(java.util.List<? extends ISecurityGroup> securityGroups)

Sets the value of CommonProjectProps.getSecurityGroups()

Parameters:

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.

Returns:

this

subnetSelection

public ProjectProps.Builder subnetSelection(SubnetSelection subnetSelection)

Sets the value of CommonProjectProps.getSubnetSelection()

Parameters:

subnetSelection - Where to place the network interfaces within the VPC. Only used if 'vpc' is supplied.

Returns:

this

timeout

public ProjectProps.Builder timeout(Duration timeout)

Sets the value of CommonProjectProps.getTimeout()

Parameters:

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.

Returns:

this

vpc

public ProjectProps.Builder vpc(IVpc vpc)

Sets the value of CommonProjectProps.getVpc()

Parameters:

vpc - VPC network to place codebuild network interfaces. Specify this if the codebuild project needs to access resources in a VPC.

Returns:

this

build

public ProjectProps build()

Builds the configured instance.

Returns:

a new instance of ProjectProps

Throws:

java.lang.NullPointerException - if any required attribute was not provided