Package software.amazon.awscdk.cfnpropertymixins.services.codebuild

Class CfnProjectMixinProps.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.codebuild.CfnProjectMixinProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnProjectMixinProps>

Enclosing interface:

CfnProjectMixinProps

@Stability(Stable)
public static final class CfnProjectMixinProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnProjectMixinProps>

A builder for CfnProjectMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnProjectMixinProps.Builder	artifacts(CfnProjectPropsMixin.ArtifactsProperty artifacts)	Sets the value of CfnProjectMixinProps.getArtifacts()
CfnProjectMixinProps.Builder	artifacts(IResolvable artifacts)	Sets the value of CfnProjectMixinProps.getArtifacts()
CfnProjectMixinProps.Builder	autoRetryLimit(Number autoRetryLimit)	Sets the value of CfnProjectMixinProps.getAutoRetryLimit()
CfnProjectMixinProps.Builder	badgeEnabled(Boolean badgeEnabled)	Sets the value of CfnProjectMixinProps.getBadgeEnabled()
CfnProjectMixinProps.Builder	badgeEnabled(IResolvable badgeEnabled)	Sets the value of CfnProjectMixinProps.getBadgeEnabled()
CfnProjectMixinProps	build()	Builds the configured instance.
CfnProjectMixinProps.Builder	buildBatchConfig(CfnProjectPropsMixin.ProjectBuildBatchConfigProperty buildBatchConfig)	Sets the value of CfnProjectMixinProps.getBuildBatchConfig()
CfnProjectMixinProps.Builder	buildBatchConfig(IResolvable buildBatchConfig)	Sets the value of CfnProjectMixinProps.getBuildBatchConfig()
CfnProjectMixinProps.Builder	cache(CfnProjectPropsMixin.ProjectCacheProperty cache)	Sets the value of CfnProjectMixinProps.getCache()
CfnProjectMixinProps.Builder	cache(IResolvable cache)	Sets the value of CfnProjectMixinProps.getCache()
CfnProjectMixinProps.Builder	concurrentBuildLimit(Number concurrentBuildLimit)	Sets the value of CfnProjectMixinProps.getConcurrentBuildLimit()
CfnProjectMixinProps.Builder	description(String description)	Sets the value of CfnProjectMixinProps.getDescription()
CfnProjectMixinProps.Builder	encryptionKey(String encryptionKey)	Sets the value of CfnProjectMixinProps.getEncryptionKey()
CfnProjectMixinProps.Builder	environment(CfnProjectPropsMixin.EnvironmentProperty environment)	Sets the value of CfnProjectMixinProps.getEnvironment()
CfnProjectMixinProps.Builder	environment(IResolvable environment)	Sets the value of CfnProjectMixinProps.getEnvironment()
CfnProjectMixinProps.Builder	fileSystemLocations(List<? extends Object> fileSystemLocations)	Sets the value of CfnProjectMixinProps.getFileSystemLocations()
CfnProjectMixinProps.Builder	fileSystemLocations(IResolvable fileSystemLocations)	Sets the value of CfnProjectMixinProps.getFileSystemLocations()
CfnProjectMixinProps.Builder	logsConfig(CfnProjectPropsMixin.LogsConfigProperty logsConfig)	Sets the value of CfnProjectMixinProps.getLogsConfig()
CfnProjectMixinProps.Builder	logsConfig(IResolvable logsConfig)	Sets the value of CfnProjectMixinProps.getLogsConfig()
CfnProjectMixinProps.Builder	name(String name)	Sets the value of CfnProjectMixinProps.getName()
CfnProjectMixinProps.Builder	queuedTimeoutInMinutes(Number queuedTimeoutInMinutes)	Sets the value of CfnProjectMixinProps.getQueuedTimeoutInMinutes()
CfnProjectMixinProps.Builder	resourceAccessRole(String resourceAccessRole)	Sets the value of CfnProjectMixinProps.getResourceAccessRole()
CfnProjectMixinProps.Builder	secondaryArtifacts(List<? extends Object> secondaryArtifacts)	Sets the value of CfnProjectMixinProps.getSecondaryArtifacts()
CfnProjectMixinProps.Builder	secondaryArtifacts(IResolvable secondaryArtifacts)	Sets the value of CfnProjectMixinProps.getSecondaryArtifacts()
CfnProjectMixinProps.Builder	secondarySources(List<? extends Object> secondarySources)	Sets the value of CfnProjectMixinProps.getSecondarySources()
CfnProjectMixinProps.Builder	secondarySources(IResolvable secondarySources)	Sets the value of CfnProjectMixinProps.getSecondarySources()
CfnProjectMixinProps.Builder	secondarySourceVersions(List<? extends Object> secondarySourceVersions)	Sets the value of CfnProjectMixinProps.getSecondarySourceVersions()
CfnProjectMixinProps.Builder	secondarySourceVersions(IResolvable secondarySourceVersions)	Sets the value of CfnProjectMixinProps.getSecondarySourceVersions()
CfnProjectMixinProps.Builder	serviceRole(String serviceRole)	Sets the value of CfnProjectMixinProps.getServiceRole()
CfnProjectMixinProps.Builder	source(CfnProjectPropsMixin.SourceProperty source)	Sets the value of CfnProjectMixinProps.getSource()
CfnProjectMixinProps.Builder	source(IResolvable source)	Sets the value of CfnProjectMixinProps.getSource()
CfnProjectMixinProps.Builder	sourceVersion(String sourceVersion)	Sets the value of CfnProjectMixinProps.getSourceVersion()
CfnProjectMixinProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnProjectMixinProps.getTags()
CfnProjectMixinProps.Builder	timeoutInMinutes(Number timeoutInMinutes)	Sets the value of CfnProjectMixinProps.getTimeoutInMinutes()
CfnProjectMixinProps.Builder	triggers(CfnProjectPropsMixin.ProjectTriggersProperty triggers)	Sets the value of CfnProjectMixinProps.getTriggers()
CfnProjectMixinProps.Builder	triggers(IResolvable triggers)	Sets the value of CfnProjectMixinProps.getTriggers()
CfnProjectMixinProps.Builder	visibility(String visibility)	Sets the value of CfnProjectMixinProps.getVisibility()
CfnProjectMixinProps.Builder	vpcConfig(CfnProjectPropsMixin.VpcConfigProperty vpcConfig)	Sets the value of CfnProjectMixinProps.getVpcConfig()
CfnProjectMixinProps.Builder	vpcConfig(IResolvable vpcConfig)	Sets the value of CfnProjectMixinProps.getVpcConfig()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

artifacts

@Stability(Stable)
public CfnProjectMixinProps.Builder artifacts(IResolvable artifacts)

Sets the value of CfnProjectMixinProps.getArtifacts()

Parameters:

artifacts - Artifacts is a property of the AWS::CodeBuild::Project resource that specifies output settings for artifacts generated by an AWS CodeBuild build.

Returns:

this

artifacts

@Stability(Stable)
public CfnProjectMixinProps.Builder artifacts(CfnProjectPropsMixin.ArtifactsProperty artifacts)

Sets the value of CfnProjectMixinProps.getArtifacts()

Parameters:

artifacts - Artifacts is a property of the AWS::CodeBuild::Project resource that specifies output settings for artifacts generated by an AWS CodeBuild build.

Returns:

this

autoRetryLimit

@Stability(Stable)
public CfnProjectMixinProps.Builder autoRetryLimit(Number autoRetryLimit)

Sets the value of CfnProjectMixinProps.getAutoRetryLimit()

Parameters:

autoRetryLimit - the value to be set.

Returns:

this

badgeEnabled

@Stability(Stable)
public CfnProjectMixinProps.Builder badgeEnabled(Boolean badgeEnabled)

Sets the value of CfnProjectMixinProps.getBadgeEnabled()

Parameters:

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

Including build badges with your project is currently not supported if the source type is CodePipeline. If you specify CODEPIPELINE for the Source property, do not specify the BadgeEnabled property.

Returns:

this

badgeEnabled

@Stability(Stable)
public CfnProjectMixinProps.Builder badgeEnabled(IResolvable badgeEnabled)

Sets the value of CfnProjectMixinProps.getBadgeEnabled()

Parameters:

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

Including build badges with your project is currently not supported if the source type is CodePipeline. If you specify CODEPIPELINE for the Source property, do not specify the BadgeEnabled property.

Returns:

this

buildBatchConfig

@Stability(Stable)
public CfnProjectMixinProps.Builder buildBatchConfig(IResolvable buildBatchConfig)

Sets the value of CfnProjectMixinProps.getBuildBatchConfig()

Parameters:

buildBatchConfig - A ProjectBuildBatchConfig object that defines the batch build options for the project.

Returns:

this

buildBatchConfig

@Stability(Stable)
public CfnProjectMixinProps.Builder buildBatchConfig(CfnProjectPropsMixin.ProjectBuildBatchConfigProperty buildBatchConfig)

Sets the value of CfnProjectMixinProps.getBuildBatchConfig()

Parameters:

buildBatchConfig - A ProjectBuildBatchConfig object that defines the batch build options for the project.

Returns:

this

cache

@Stability(Stable)
public CfnProjectMixinProps.Builder cache(IResolvable cache)

Sets the value of CfnProjectMixinProps.getCache()

Parameters:

cache - Settings that AWS CodeBuild uses to store and reuse build dependencies.

Returns:

this

cache

@Stability(Stable)
public CfnProjectMixinProps.Builder cache(CfnProjectPropsMixin.ProjectCacheProperty cache)

Sets the value of CfnProjectMixinProps.getCache()

Parameters:

cache - Settings that AWS CodeBuild uses to store and reuse build dependencies.

Returns:

this

concurrentBuildLimit

@Stability(Stable)
public CfnProjectMixinProps.Builder concurrentBuildLimit(Number concurrentBuildLimit)

Sets the value of CfnProjectMixinProps.getConcurrentBuildLimit()

Parameters:

concurrentBuildLimit - The maximum number of concurrent builds that are allowed for this project. New builds are only started if the current number of builds is less than or equal to this limit. If the current build count meets this limit, new builds are throttled and are not run.

Returns:

this

description

@Stability(Stable)
public CfnProjectMixinProps.Builder description(String description)

Sets the value of CfnProjectMixinProps.getDescription()

Parameters:

description - A description that makes the build project easy to identify.

Returns:

this

encryptionKey

@Stability(Stable)
public CfnProjectMixinProps.Builder encryptionKey(String encryptionKey)

Sets the value of CfnProjectMixinProps.getEncryptionKey()

Parameters:

encryptionKey - The AWS Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.

You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/<alias-name> ). If you don't specify a value, CodeBuild uses the managed CMK for Amazon Simple Storage Service (Amazon S3).

Returns:

this

environment

@Stability(Stable)
public CfnProjectMixinProps.Builder environment(IResolvable environment)

Sets the value of CfnProjectMixinProps.getEnvironment()

Parameters:

environment - The build environment settings for the project, such as the environment type or the environment variables to use for the build environment.

Returns:

this

environment

@Stability(Stable)
public CfnProjectMixinProps.Builder environment(CfnProjectPropsMixin.EnvironmentProperty environment)

Sets the value of CfnProjectMixinProps.getEnvironment()

Parameters:

environment - The build environment settings for the project, such as the environment type or the environment variables to use for the build environment.

Returns:

this

fileSystemLocations

@Stability(Stable)
public CfnProjectMixinProps.Builder fileSystemLocations(IResolvable fileSystemLocations)

Sets the value of CfnProjectMixinProps.getFileSystemLocations()

Parameters:

fileSystemLocations - An array of 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

fileSystemLocations

@Stability(Stable)
public CfnProjectMixinProps.Builder fileSystemLocations(List<? extends Object> fileSystemLocations)

Sets the value of CfnProjectMixinProps.getFileSystemLocations()

Parameters:

fileSystemLocations - An array of 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

logsConfig

@Stability(Stable)
public CfnProjectMixinProps.Builder logsConfig(IResolvable logsConfig)

Sets the value of CfnProjectMixinProps.getLogsConfig()

Parameters:

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

Returns:

this

logsConfig

@Stability(Stable)
public CfnProjectMixinProps.Builder logsConfig(CfnProjectPropsMixin.LogsConfigProperty logsConfig)

Sets the value of CfnProjectMixinProps.getLogsConfig()

Parameters:

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

Returns:

this

name

@Stability(Stable)
public CfnProjectMixinProps.Builder name(String name)

Sets the value of CfnProjectMixinProps.getName()

Parameters:

name - The name of the build project. The name must be unique across all of the projects in your AWS account .

Returns:

this

queuedTimeoutInMinutes

@Stability(Stable)
public CfnProjectMixinProps.Builder queuedTimeoutInMinutes(Number queuedTimeoutInMinutes)

Sets the value of CfnProjectMixinProps.getQueuedTimeoutInMinutes()

Parameters:

queuedTimeoutInMinutes - The number of minutes a build is allowed to be queued before it times out.

Returns:

this

resourceAccessRole

@Stability(Stable)
public CfnProjectMixinProps.Builder resourceAccessRole(String resourceAccessRole)

Sets the value of CfnProjectMixinProps.getResourceAccessRole()

Parameters:

resourceAccessRole - The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project's builds.

Returns:

this

secondaryArtifacts

@Stability(Stable)
public CfnProjectMixinProps.Builder secondaryArtifacts(IResolvable secondaryArtifacts)

Sets the value of CfnProjectMixinProps.getSecondaryArtifacts()

Parameters:

secondaryArtifacts - A list of Artifacts objects. Each artifacts object specifies output settings that the project generates during a build.

Returns:

this

secondaryArtifacts

@Stability(Stable)
public CfnProjectMixinProps.Builder secondaryArtifacts(List<? extends Object> secondaryArtifacts)

Sets the value of CfnProjectMixinProps.getSecondaryArtifacts()

Parameters:

secondaryArtifacts - A list of Artifacts objects. Each artifacts object specifies output settings that the project generates during a build.

Returns:

this

secondarySources

@Stability(Stable)
public CfnProjectMixinProps.Builder secondarySources(IResolvable secondarySources)

Sets the value of CfnProjectMixinProps.getSecondarySources()

Parameters:

secondarySources - An array of ProjectSource objects.

Returns:

this

secondarySources

@Stability(Stable)
public CfnProjectMixinProps.Builder secondarySources(List<? extends Object> secondarySources)

Sets the value of CfnProjectMixinProps.getSecondarySources()

Parameters:

secondarySources - An array of ProjectSource objects.

Returns:

this

secondarySourceVersions

@Stability(Stable)
public CfnProjectMixinProps.Builder secondarySourceVersions(IResolvable secondarySourceVersions)

Sets the value of CfnProjectMixinProps.getSecondarySourceVersions()

Parameters:

secondarySourceVersions - An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take over these secondarySourceVersions (at the project level).

Returns:

this

secondarySourceVersions

@Stability(Stable)
public CfnProjectMixinProps.Builder secondarySourceVersions(List<? extends Object> secondarySourceVersions)

Sets the value of CfnProjectMixinProps.getSecondarySourceVersions()

Parameters:

secondarySourceVersions - An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take over these secondarySourceVersions (at the project level).

Returns:

this

serviceRole

@Stability(Stable)
public CfnProjectMixinProps.Builder serviceRole(String serviceRole)

Sets the value of CfnProjectMixinProps.getServiceRole()

Parameters:

serviceRole - The ARN of the IAM role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.

Returns:

this

source

@Stability(Stable)
public CfnProjectMixinProps.Builder source(IResolvable source)

Sets the value of CfnProjectMixinProps.getSource()

Parameters:

source - The source code settings for the project, such as the source code's repository type and location.

Returns:

this

source

@Stability(Stable)
public CfnProjectMixinProps.Builder source(CfnProjectPropsMixin.SourceProperty source)

Sets the value of CfnProjectMixinProps.getSource()

Parameters:

source - The source code settings for the project, such as the source code's repository type and location.

Returns:

this

sourceVersion

@Stability(Stable)
public CfnProjectMixinProps.Builder sourceVersion(String sourceVersion)

Sets the value of CfnProjectMixinProps.getSourceVersion()

Parameters:

sourceVersion - A version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of:

• For CodeCommit: the commit ID, branch, or Git tag to use.
• For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25 ). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
• For GitLab: the commit ID, branch, or Git tag to use.
• For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
• For Amazon S3: the version ID of the object that represents the build input ZIP file to use.

If sourceVersion is specified at the build level, then that version takes precedence over this sourceVersion (at the project level).

For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide .

Returns:

this

tags

@Stability(Stable)
public CfnProjectMixinProps.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnProjectMixinProps.getTags()

Parameters:

tags - An arbitrary set of tags (key-value pairs) for the AWS CodeBuild project. These tags are available for use by AWS services that support AWS CodeBuild build project tags.

Returns:

this

timeoutInMinutes

@Stability(Stable)
public CfnProjectMixinProps.Builder timeoutInMinutes(Number timeoutInMinutes)

Sets the value of CfnProjectMixinProps.getTimeoutInMinutes()

Parameters:

timeoutInMinutes - How long, in minutes, from 5 to 2160 (36 hours), for AWS CodeBuild to wait before timing out any related build that did not get marked as completed. The default is 60 minutes.

Returns:

this

triggers

@Stability(Stable)
public CfnProjectMixinProps.Builder triggers(IResolvable triggers)

Sets the value of CfnProjectMixinProps.getTriggers()

Parameters:

triggers - For an existing AWS CodeBuild build project that has its source code stored in a GitHub repository, enables AWS CodeBuild to begin automatically rebuilding the source code every time a code change is pushed to the repository.

Returns:

this

triggers

@Stability(Stable)
public CfnProjectMixinProps.Builder triggers(CfnProjectPropsMixin.ProjectTriggersProperty triggers)

Sets the value of CfnProjectMixinProps.getTriggers()

Parameters:

triggers - For an existing AWS CodeBuild build project that has its source code stored in a GitHub repository, enables AWS CodeBuild to begin automatically rebuilding the source code every time a code change is pushed to the repository.

Returns:

this

visibility

@Stability(Stable)
public CfnProjectMixinProps.Builder visibility(String visibility)

Sets the value of CfnProjectMixinProps.getVisibility()

Parameters:

visibility - Specifies the visibility of the project's builds. Possible values are:.

• PUBLIC_READ - The project builds are visible to the public.
• PRIVATE - The project builds are not visible to the public.

Returns:

this

vpcConfig

@Stability(Stable)
public CfnProjectMixinProps.Builder vpcConfig(IResolvable vpcConfig)

Sets the value of CfnProjectMixinProps.getVpcConfig()

Parameters:

vpcConfig - VpcConfig specifies settings that enable AWS CodeBuild to access resources in an Amazon VPC. For more information, see Use AWS CodeBuild with Amazon Virtual Private Cloud in the AWS CodeBuild User Guide .

Returns:

this

vpcConfig

@Stability(Stable)
public CfnProjectMixinProps.Builder vpcConfig(CfnProjectPropsMixin.VpcConfigProperty vpcConfig)

Sets the value of CfnProjectMixinProps.getVpcConfig()

Parameters:

vpcConfig - VpcConfig specifies settings that enable AWS CodeBuild to access resources in an Amazon VPC. For more information, see Use AWS CodeBuild with Amazon Virtual Private Cloud in the AWS CodeBuild User Guide .

Returns:

this

build

@Stability(Stable)
public CfnProjectMixinProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnProjectMixinProps>

Returns:

a new instance of CfnProjectMixinProps

Throws:

NullPointerException - if any required attribute was not provided