software.amazon.awscdk.services.codebuild

Class CfnSourceCredential

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.codebuild.CfnSourceCredential

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-18T02:14:11.506Z")
public class CfnSourceCredential
extends CfnResource
implements IInspectable

A CloudFormation `AWS::CodeBuild::SourceCredential`.

Information about the credentials for a GitHub, GitHub Enterprise, or Bitbucket repository. We strongly recommend that you use AWS Secrets Manager to store your credentials. If you use Secrets Manager , you must have secrets in your secrets manager. For more information, see Using Dynamic References to Specify Template Values .

For security purposes, do not use plain text in your AWS CloudFormation template to store your credentials.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.codebuild.*;
 CfnSourceCredential cfnSourceCredential = CfnSourceCredential.Builder.create(this, "MyCfnSourceCredential")
         .authType("authType")
         .serverType("serverType")
         .token("token")
         // the properties below are optional
         .username("username")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnSourceCredential.Builder A fluent builder for CfnSourceCredential.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnSourceCredential(Construct scope, java.lang.String id, CfnSourceCredentialProps props) Create a new `AWS::CodeBuild::SourceCredential`.
protected	CfnSourceCredential(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnSourceCredential(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAuthType() The type of authentication used by the credentials.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getServerType() The type of source provider.
java.lang.String	getToken() For GitHub or GitHub Enterprise, this is the personal access token.
java.lang.String	getUsername() The Bitbucket username when the `authType` is BASIC_AUTH.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setAuthType(java.lang.String value) The type of authentication used by the credentials.
void	setServerType(java.lang.String value) The type of source provider.
void	setToken(java.lang.String value) For GitHub or GitHub Enterprise, this is the personal access token.
void	setUsername(java.lang.String value) The Bitbucket username when the `authType` is BASIC_AUTH.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnSourceCredential

protected CfnSourceCredential(software.amazon.jsii.JsiiObjectRef objRef)

CfnSourceCredential

protected CfnSourceCredential(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnSourceCredential

public CfnSourceCredential(Construct scope,
                           java.lang.String id,
                           CfnSourceCredentialProps props)

Create a new `AWS::CodeBuild::SourceCredential`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getAuthType

public java.lang.String getAuthType()

The type of authentication used by the credentials.

Valid options are OAUTH, BASIC_AUTH, or PERSONAL_ACCESS_TOKEN.

setAuthType

public void setAuthType(java.lang.String value)

The type of authentication used by the credentials.

Valid options are OAUTH, BASIC_AUTH, or PERSONAL_ACCESS_TOKEN.

getServerType

public java.lang.String getServerType()

The type of source provider.

The valid options are GITHUB, GITHUB_ENTERPRISE, or BITBUCKET.

setServerType

public void setServerType(java.lang.String value)

The type of source provider.

The valid options are GITHUB, GITHUB_ENTERPRISE, or BITBUCKET.

getToken

public java.lang.String getToken()

For GitHub or GitHub Enterprise, this is the personal access token.

For Bitbucket, this is the app password.

setToken

public void setToken(java.lang.String value)

For GitHub or GitHub Enterprise, this is the personal access token.

For Bitbucket, this is the app password.

getUsername

public java.lang.String getUsername()

The Bitbucket username when the `authType` is BASIC_AUTH.

This parameter is not valid for other types of source providers or connections.

setUsername

public void setUsername(java.lang.String value)

The Bitbucket username when the `authType` is BASIC_AUTH.

This parameter is not valid for other types of source providers or connections.