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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.328Z")
 @Stability(value=Stable)
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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnSourceCredential(software.constructs.Construct scope, 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
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, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, 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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnSourceCredential(@NotNull
                                                    software.constructs.Construct scope,
                                                    @NotNull
                                                    String id,
                                                    @NotNull
                                                    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

@Stability(value=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(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getAuthType

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

The type of authentication used by the credentials.

Valid options are OAUTH, BASIC_AUTH, or PERSONAL_ACCESS_TOKEN.

setAuthType

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

The type of authentication used by the credentials.

Valid options are OAUTH, BASIC_AUTH, or PERSONAL_ACCESS_TOKEN.

getServerType

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

The type of source provider.

The valid options are GITHUB, GITHUB_ENTERPRISE, or BITBUCKET.

setServerType

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

The type of source provider.

The valid options are GITHUB, GITHUB_ENTERPRISE, or BITBUCKET.

getToken

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

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

For Bitbucket, this is the app password.

setToken

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

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

For Bitbucket, this is the app password.

getUsername

@Stability(value=Stable)
 @Nullable
public 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

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

The Bitbucket username when the `authType` is BASIC_AUTH.

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