software.amazon.awscdk.services.codebuild

Class CommonProjectProps.Builder

java.lang.Object

software.amazon.awscdk.services.codebuild.CommonProjectProps.Builder

Enclosing interface:

CommonProjectProps

public static final class CommonProjectProps.Builder
extends Object

A builder for CommonProjectProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CommonProjectProps	build() Builds the configured instance.
CommonProjectProps.Builder	withBadge(Boolean value) Sets the value of Badge
CommonProjectProps.Builder	withBuildScriptAsset(software.amazon.awscdk.assets.Asset value) Sets the value of BuildScriptAsset
CommonProjectProps.Builder	withBuildScriptAssetEntrypoint(String value) Sets the value of BuildScriptAssetEntrypoint
CommonProjectProps.Builder	withBuildSpec(Object value) Sets the value of BuildSpec
CommonProjectProps.Builder	withCacheBucket(software.amazon.awscdk.services.s3.BucketRef value) Sets the value of CacheBucket
CommonProjectProps.Builder	withCacheDir(String value) Sets the value of CacheDir
CommonProjectProps.Builder	withDescription(String value) Sets the value of Description
CommonProjectProps.Builder	withEncryptionKey(software.amazon.awscdk.services.kms.EncryptionKeyRef value) Sets the value of EncryptionKey
CommonProjectProps.Builder	withEnvironment(BuildEnvironment value) Sets the value of Environment
CommonProjectProps.Builder	withEnvironmentVariables(Map<String,BuildEnvironmentVariable> value) Sets the value of EnvironmentVariables
CommonProjectProps.Builder	withProjectName(String value) Sets the value of ProjectName
CommonProjectProps.Builder	withRole(software.amazon.awscdk.services.iam.Role value) Sets the value of Role
CommonProjectProps.Builder	withTimeout(Number value) Sets the value of Timeout

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

withBadge

public CommonProjectProps.Builder withBadge(@Nullable
                                            Boolean value)

Sets the value of Badge

Parameters:

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

withBuildScriptAsset

public CommonProjectProps.Builder withBuildScriptAsset(@Nullable
                                                       software.amazon.awscdk.assets.Asset value)

Sets the value of BuildScriptAsset

Parameters:

value - Run a script from an asset as build script If supplied together with buildSpec, the asset script will be run _after_ the existing commands in buildspec. This feature can also be used without a source, to simply run an arbitrary script in a serverless way.

Returns:

this

withBuildScriptAssetEntrypoint

public CommonProjectProps.Builder withBuildScriptAssetEntrypoint(@Nullable
                                                                 String value)

Sets the value of BuildScriptAssetEntrypoint

Parameters:

value - The script in the asset to run.

Returns:

this

withBuildSpec

public CommonProjectProps.Builder withBuildSpec(@Nullable
                                                Object value)

Sets the value of BuildSpec

Parameters:

value - Filename or contents of buildspec in JSON format.

Returns:

this

withCacheBucket

public CommonProjectProps.Builder withCacheBucket(@Nullable
                                                  software.amazon.awscdk.services.s3.BucketRef value)

Sets the value of CacheBucket

Parameters:

value - Bucket to store cached source artifacts If not specified, source artifacts will not be cached.

Returns:

this

withCacheDir

public CommonProjectProps.Builder withCacheDir(@Nullable
                                               String value)

Sets the value of CacheDir

Parameters:

value - Subdirectory to store cached artifacts

Returns:

this

withDescription

public CommonProjectProps.Builder withDescription(@Nullable
                                                  String value)

Sets the value of Description

Parameters:

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

Returns:

this

withEncryptionKey

public CommonProjectProps.Builder withEncryptionKey(@Nullable
                                                    software.amazon.awscdk.services.kms.EncryptionKeyRef value)

Sets the value of EncryptionKey

Parameters:

value - Encryption key to use to read and write artifacts If not specified, a role will be created.

Returns:

this

withEnvironment

public CommonProjectProps.Builder withEnvironment(@Nullable
                                                  BuildEnvironment value)

Sets the value of Environment

Parameters:

value - Build environment to use for the build.

Returns:

this

withEnvironmentVariables

public CommonProjectProps.Builder withEnvironmentVariables(@Nullable
                                                           Map<String,BuildEnvironmentVariable> value)

Sets the value of EnvironmentVariables

Parameters:

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

Returns:

this

withProjectName

public CommonProjectProps.Builder withProjectName(@Nullable
                                                  String value)

Sets the value of ProjectName

Parameters:

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

Returns:

this

withRole

public CommonProjectProps.Builder withRole(@Nullable
                                           software.amazon.awscdk.services.iam.Role value)

Sets the value of Role

Parameters:

value - Service Role to assume while running the build. If not specified, a role will be created.

Returns:

this

withTimeout

public CommonProjectProps.Builder withTimeout(@Nullable
                                              Number value)

Sets the value of Timeout

Parameters:

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

build

public CommonProjectProps build()

Builds the configured instance.

Returns:

a new instance of CommonProjectProps

Throws:

NullPointerException - if any required attribute was not provided