Package software.amazon.awscdk.services.codebuild

Class CfnSourceCredential

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.codebuild.CfnSourceCredential

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-18T17:54:14.073Z")
@Stability(Stable)
public class CfnSourceCredential
extends CfnResource
implements IInspectable

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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-sourcecredential.html

Nested Class Summary

Nested Classes

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

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnSourceCredential(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnSourceCredential(software.amazon.jsii.JsiiObjectRef objRef)
	CfnSourceCredential(software.constructs.Construct scope, String id, CfnSourceCredentialProps props)

Method Summary

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

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnSourceCredential

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

CfnSourceCredential

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

CfnSourceCredential

@Stability(Stable)
public CfnSourceCredential(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnSourceCredentialProps props)

Parameters:

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

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 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

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrId

@Stability(Stable)
@NotNull
public String getAttrId()

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getAuthType

@Stability(Stable)
@NotNull
public String getAuthType()

The type of authentication used by the credentials.

setAuthType

@Stability(Stable)
public void setAuthType(@NotNull
 String value)

The type of authentication used by the credentials.

getServerType

@Stability(Stable)
@NotNull
public String getServerType()

The type of source provider.

setServerType

@Stability(Stable)
public void setServerType(@NotNull
 String value)

The type of source provider.

getToken

@Stability(Stable)
@NotNull
public String getToken()

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

setToken

@Stability(Stable)
public void setToken(@NotNull
 String value)

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

getUsername

@Stability(Stable)
@Nullable
public String getUsername()

The Bitbucket username when the authType is BASIC_AUTH.

setUsername

@Stability(Stable)
public void setUsername(@Nullable
 String value)

The Bitbucket username when the authType is BASIC_AUTH.