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.103.1 (build bef2dea)",
date="2024-10-11T15:55:54.921Z")
@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:
-
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.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
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
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 TypeMethodDescriptionThe type of authentication used by the credentials.The type of source provider.getToken()
For GitHub or GitHub Enterprise, this is the personal access token.The Bitbucket username when theauthType
is BASIC_AUTH.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.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
For GitHub or GitHub Enterprise, this is the personal access token.void
setUsername
(String value) The Bitbucket username when theauthType
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
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
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- 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 classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrId
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getAuthType
The type of authentication used by the credentials. -
setAuthType
The type of authentication used by the credentials. -
getServerType
The type of source provider. -
setServerType
The type of source provider. -
getToken
For GitHub or GitHub Enterprise, this is the personal access token. -
setToken
For GitHub or GitHub Enterprise, this is the personal access token. -
getUsername
The Bitbucket username when theauthType
is BASIC_AUTH. -
setUsername
The Bitbucket username when theauthType
is BASIC_AUTH.
-