Package software.amazon.awscdk.services.codebuild

Class CfnProject.SourceProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.codebuild.CfnProject.SourceProperty.Jsii$Proxy

All Implemented Interfaces:

CfnProject.SourceProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnProject.SourceProperty

@Stability(Stable)
@Internal
public static final class CfnProject.SourceProperty.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnProject.SourceProperty

An implementation for CfnProject.SourceProperty

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.codebuild.CfnProject.SourceProperty

CfnProject.SourceProperty.Builder, CfnProject.SourceProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnProject.SourceProperty.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnProject.SourceProperty.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Object	getAuth()	Information about the authorization settings for AWS CodeBuild to access the source code to be built.
final String	getBuildSpec()	The build specification for the project.
final Object	getBuildStatusConfig()	Contains information that defines how the build project reports the build status to the source provider.
final Number	getGitCloneDepth()	The depth of history to download.
final Object	getGitSubmodulesConfig()	Information about the Git submodules configuration for the build project.
final Object	getInsecureSsl()	This is used with GitHub Enterprise only.
final String	getLocation()	Information about the location of the source code to be built.
final Object	getReportBuildStatus()	Set to true to report the status of a build's start and finish to your source provider.
final String	getSourceIdentifier()	An identifier for this project source.
final String	getType()	The type of repository that contains the source code to be built.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnProject.SourceProperty.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnProject.SourceProperty.Builder.

Method Details

getType

public final String getType()

Description copied from interface: CfnProject.SourceProperty

The type of repository that contains the source code to be built. Valid values include:.

• 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 repository.
• GITHUB_ENTERPRISE : The source code is in a GitHub Enterprise Server repository.
• GITLAB : The source code is in a GitLab repository.
• GITLAB_SELF_MANAGED : The source code is in a self-managed GitLab repository.
• NO_SOURCE : The project does not have input source code.
• S3 : The source code is in an Amazon S3 bucket.

Specified by:

getType in interface CfnProject.SourceProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html#cfn-codebuild-project-source-type

getAuth

public final Object getAuth()

Description copied from interface: CfnProject.SourceProperty

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.

Specified by:

getAuth in interface CfnProject.SourceProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html#cfn-codebuild-project-source-auth

getBuildSpec

public final String getBuildSpec()

Description copied from interface: CfnProject.SourceProperty

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 .

Specified by:

getBuildSpec in interface CfnProject.SourceProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html#cfn-codebuild-project-source-buildspec

getBuildStatusConfig

public final Object getBuildStatusConfig()

Description copied from interface: CfnProject.SourceProperty

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 .

Specified by:

getBuildStatusConfig in interface CfnProject.SourceProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html#cfn-codebuild-project-source-buildstatusconfig

getGitCloneDepth

public final Number getGitCloneDepth()

Description copied from interface: CfnProject.SourceProperty

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.

Specified by:

getGitCloneDepth in interface CfnProject.SourceProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html#cfn-codebuild-project-source-gitclonedepth

getGitSubmodulesConfig

public final Object getGitSubmodulesConfig()

Description copied from interface: CfnProject.SourceProperty

Information about the Git submodules configuration for the build project.

Specified by:

getGitSubmodulesConfig in interface CfnProject.SourceProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html#cfn-codebuild-project-source-gitsubmodulesconfig

getInsecureSsl

public final Object getInsecureSsl()

Description copied from interface: CfnProject.SourceProperty

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.

Specified by:

getInsecureSsl in interface CfnProject.SourceProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html#cfn-codebuild-project-source-insecuressl

getLocation

public final String getLocation()

Description copied from interface: CfnProject.SourceProperty

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 an GitLab or self-managed GitLab repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your AWS account to your GitLab account. Use the AWS CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with GitLab, on the Connections Authorize application page, choose Authorize . Then on the AWS CodeConnections Create GitLab connection page, choose Connect to GitLab . (After you have connected to your GitLab account, you do not need to finish creating the build project. You can leave the AWS CodeBuild console.) To instruct AWS CodeBuild to override the default connection and use this connection instead, set the auth object's type value to CODECONNECTIONS in the source object.
• 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 .

Specified by:

getLocation in interface CfnProject.SourceProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html#cfn-codebuild-project-source-location

getReportBuildStatus

public final Object getReportBuildStatus()

Description copied from interface: CfnProject.SourceProperty

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.

Specified by:

getReportBuildStatus in interface CfnProject.SourceProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html#cfn-codebuild-project-source-reportbuildstatus

getSourceIdentifier

public final String getSourceIdentifier()

Description copied from interface: CfnProject.SourceProperty

An identifier for this project source.

The identifier can only contain alphanumeric characters and underscores, and must be less than 128 characters in length.

Specified by:

getSourceIdentifier in interface CfnProject.SourceProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html#cfn-codebuild-project-source-sourceidentifier

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object