software.amazon.awscdk.services.codebuild

Class CfnProject.SourceProperty.Builder

java.lang.Object

software.amazon.awscdk.services.codebuild.CfnProject.SourceProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnProject.SourceProperty>

Enclosing interface:

CfnProject.SourceProperty

@Stability(value=Stable)
public static final class CfnProject.SourceProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnProject.SourceProperty>

A builder for CfnProject.SourceProperty

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnProject.SourceProperty.Builder	auth(CfnProject.SourceAuthProperty auth) Sets the value of CfnProject.SourceProperty.getAuth()
CfnProject.SourceProperty.Builder	auth(IResolvable auth) Sets the value of CfnProject.SourceProperty.getAuth()
CfnProject.SourceProperty	build() Builds the configured instance.
CfnProject.SourceProperty.Builder	buildSpec(String buildSpec) Sets the value of CfnProject.SourceProperty.getBuildSpec()
CfnProject.SourceProperty.Builder	buildStatusConfig(CfnProject.BuildStatusConfigProperty buildStatusConfig) Sets the value of CfnProject.SourceProperty.getBuildStatusConfig()
CfnProject.SourceProperty.Builder	buildStatusConfig(IResolvable buildStatusConfig) Sets the value of CfnProject.SourceProperty.getBuildStatusConfig()
CfnProject.SourceProperty.Builder	gitCloneDepth(Number gitCloneDepth) Sets the value of CfnProject.SourceProperty.getGitCloneDepth()
CfnProject.SourceProperty.Builder	gitSubmodulesConfig(CfnProject.GitSubmodulesConfigProperty gitSubmodulesConfig) Sets the value of CfnProject.SourceProperty.getGitSubmodulesConfig()
CfnProject.SourceProperty.Builder	gitSubmodulesConfig(IResolvable gitSubmodulesConfig) Sets the value of CfnProject.SourceProperty.getGitSubmodulesConfig()
CfnProject.SourceProperty.Builder	insecureSsl(Boolean insecureSsl) Sets the value of CfnProject.SourceProperty.getInsecureSsl()
CfnProject.SourceProperty.Builder	insecureSsl(IResolvable insecureSsl) Sets the value of CfnProject.SourceProperty.getInsecureSsl()
CfnProject.SourceProperty.Builder	location(String location) Sets the value of CfnProject.SourceProperty.getLocation()
CfnProject.SourceProperty.Builder	reportBuildStatus(Boolean reportBuildStatus) Sets the value of CfnProject.SourceProperty.getReportBuildStatus()
CfnProject.SourceProperty.Builder	reportBuildStatus(IResolvable reportBuildStatus) Sets the value of CfnProject.SourceProperty.getReportBuildStatus()
CfnProject.SourceProperty.Builder	sourceIdentifier(String sourceIdentifier) Sets the value of CfnProject.SourceProperty.getSourceIdentifier()
CfnProject.SourceProperty.Builder	type(String type) Sets the value of CfnProject.SourceProperty.getType()

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

type

@Stability(value=Stable)
public CfnProject.SourceProperty.Builder type(String type)

Sets the value of CfnProject.SourceProperty.getType()

Parameters:

type - The type of repository that contains the source code to be built. Valid values include:. This parameter is required.

• BITBUCKET : The source code is in a Bitbucket repository.
• CODECOMMIT : The source code is in an CodeCommit repository.
• CODEPIPELINE : The source code settings are specified in the source action of a pipeline in CodePipeline.
• GITHUB : The source code is in a GitHub or GitHub Enterprise Cloud repository.
• GITHUB_ENTERPRISE : The source code is in a GitHub Enterprise Server repository.
• NO_SOURCE : The project does not have input source code.
• S3 : The source code is in an Amazon S3 bucket.

Returns:

this

auth

@Stability(value=Stable)
public CfnProject.SourceProperty.Builder auth(CfnProject.SourceAuthProperty auth)

Sets the value of CfnProject.SourceProperty.getAuth()

Parameters:

auth - Information about the authorization settings for AWS CodeBuild to access the source code to be built. This information is for the AWS CodeBuild console's use only. Your code should not get or set Auth directly.

Returns:

this

auth

@Stability(value=Stable)
public CfnProject.SourceProperty.Builder auth(IResolvable auth)

Sets the value of CfnProject.SourceProperty.getAuth()

Parameters:

auth - Information about the authorization settings for AWS CodeBuild to access the source code to be built. This information is for the AWS CodeBuild console's use only. Your code should not get or set Auth directly.

Returns:

this

buildSpec

@Stability(value=Stable)
public CfnProject.SourceProperty.Builder buildSpec(String buildSpec)

Sets the value of CfnProject.SourceProperty.getBuildSpec()

Parameters:

buildSpec - The build specification for the project. If this value is not provided, then the source code must contain a buildspec file named buildspec.yml at the root level. If this value is provided, it can be either a single string containing the entire build specification, or the path to an alternate buildspec file relative to the value of the built-in environment variable CODEBUILD_SRC_DIR . The alternate buildspec file can have a name other than buildspec.yml , for example myspec.yml or build_spec_qa.yml or similar. For more information, see the Build Spec Reference in the AWS CodeBuild User Guide .

Returns:

this

buildStatusConfig

@Stability(value=Stable)
public CfnProject.SourceProperty.Builder buildStatusConfig(CfnProject.BuildStatusConfigProperty buildStatusConfig)

Sets the value of CfnProject.SourceProperty.getBuildStatusConfig()

Parameters:

buildStatusConfig - Contains information that defines how the build project reports the build status to the source provider. This option is only used when the source provider is GITHUB , GITHUB_ENTERPRISE , or BITBUCKET .

Returns:

this

buildStatusConfig

@Stability(value=Stable)
public CfnProject.SourceProperty.Builder buildStatusConfig(IResolvable buildStatusConfig)

Sets the value of CfnProject.SourceProperty.getBuildStatusConfig()

Parameters:

buildStatusConfig - Contains information that defines how the build project reports the build status to the source provider. This option is only used when the source provider is GITHUB , GITHUB_ENTERPRISE , or BITBUCKET .

Returns:

this

gitCloneDepth

@Stability(value=Stable)
public CfnProject.SourceProperty.Builder gitCloneDepth(Number gitCloneDepth)

Sets the value of CfnProject.SourceProperty.getGitCloneDepth()

Parameters:

gitCloneDepth - The depth of history to download. Minimum value is 0. If this value is 0, greater than 25, or not provided, then the full history is downloaded with each build project. If your source type is Amazon S3, this value is not supported.

Returns:

this

gitSubmodulesConfig

@Stability(value=Stable)
public CfnProject.SourceProperty.Builder gitSubmodulesConfig(CfnProject.GitSubmodulesConfigProperty gitSubmodulesConfig)

Sets the value of CfnProject.SourceProperty.getGitSubmodulesConfig()

Parameters:

gitSubmodulesConfig - Information about the Git submodules configuration for the build project.

Returns:

this

gitSubmodulesConfig

@Stability(value=Stable)
public CfnProject.SourceProperty.Builder gitSubmodulesConfig(IResolvable gitSubmodulesConfig)

Sets the value of CfnProject.SourceProperty.getGitSubmodulesConfig()

Parameters:

gitSubmodulesConfig - Information about the Git submodules configuration for the build project.

Returns:

this

insecureSsl

@Stability(value=Stable)
public CfnProject.SourceProperty.Builder insecureSsl(Boolean insecureSsl)

Sets the value of CfnProject.SourceProperty.getInsecureSsl()

Parameters:

insecureSsl - This is used with GitHub Enterprise only. Set to true to ignore SSL warnings while connecting to your GitHub Enterprise project repository. The default value is false . InsecureSsl should be used for testing purposes only. It should not be used in a production environment.

Returns:

this

insecureSsl

@Stability(value=Stable)
public CfnProject.SourceProperty.Builder insecureSsl(IResolvable insecureSsl)

Sets the value of CfnProject.SourceProperty.getInsecureSsl()

Parameters:

insecureSsl - This is used with GitHub Enterprise only. Set to true to ignore SSL warnings while connecting to your GitHub Enterprise project repository. The default value is false . InsecureSsl should be used for testing purposes only. It should not be used in a production environment.

Returns:

this

location

@Stability(value=Stable)
public CfnProject.SourceProperty.Builder location(String location)

Sets the value of CfnProject.SourceProperty.getLocation()

Parameters:

location - Information about the location of the source code to be built. Valid values include:.

• For source code settings that are specified in the source action of a pipeline in CodePipeline, location should not be specified. If it is specified, CodePipeline ignores it. This is because CodePipeline uses the settings in a pipeline's source action instead of this value.
• For source code in an CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the buildspec file (for example, https://git-codecommit.<region-ID>.amazonaws.com/v1/repos/<repo-name> ).
• For source code in an Amazon S3 input bucket, one of the following.
• The path to the ZIP file that contains the source code (for example, <bucket-name>/<path>/<object-name>.zip ).
• The path to the folder that contains the source code (for example, <bucket-name>/<path-to-source-code>/<folder>/ ).
• For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your AWS account to your GitHub account. Use the AWS CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with GitHub, on the GitHub Authorize application page, for Organization access , choose Request access next to each repository you want to allow AWS CodeBuild to have access to, and then choose Authorize application . (After you have connected to your GitHub account, you do not need to finish creating the build project. You can leave the AWS CodeBuild console.) To instruct AWS CodeBuild to use this connection, in the source object, set the auth object's type value to OAUTH .
• For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your AWS account to your Bitbucket account. Use the AWS CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with Bitbucket, on the Bitbucket Confirm access to your account page, choose Grant access . (After you have connected to your Bitbucket account, you do not need to finish creating the build project. You can leave the AWS CodeBuild console.) To instruct AWS CodeBuild to use this connection, in the source object, set the auth object's type value to OAUTH .

If you specify CODEPIPELINE for the Type property, don't specify this property. For all of the other types, you must specify Location .

Returns:

this

reportBuildStatus

@Stability(value=Stable)
public CfnProject.SourceProperty.Builder reportBuildStatus(Boolean reportBuildStatus)

Sets the value of CfnProject.SourceProperty.getReportBuildStatus()

Parameters:

reportBuildStatus - Set to true to report the status of a build's start and finish to your source provider. This option is valid only when your source provider is GitHub, GitHub Enterprise, or Bitbucket. If this is set and you use a different source provider, an invalidInputException is thrown.

Returns:

this

reportBuildStatus

@Stability(value=Stable)
public CfnProject.SourceProperty.Builder reportBuildStatus(IResolvable reportBuildStatus)

Sets the value of CfnProject.SourceProperty.getReportBuildStatus()

Parameters:

reportBuildStatus - Set to true to report the status of a build's start and finish to your source provider. This option is valid only when your source provider is GitHub, GitHub Enterprise, or Bitbucket. If this is set and you use a different source provider, an invalidInputException is thrown.

Returns:

this

sourceIdentifier

@Stability(value=Stable)
public CfnProject.SourceProperty.Builder sourceIdentifier(String sourceIdentifier)

Sets the value of CfnProject.SourceProperty.getSourceIdentifier()

Parameters:

sourceIdentifier - An identifier for this project source. The identifier can only contain alphanumeric characters and underscores, and must be less than 128 characters in length.

Returns:

this

build

@Stability(value=Stable)
public CfnProject.SourceProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnProject.SourceProperty>

Returns:

a new instance of CfnProject.SourceProperty

Throws:

NullPointerException - if any required attribute was not provided