Class CfnSourceCredential

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
All Implemented Interfaces:
IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)", date="2024-05-24T02:42:35.245Z") @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:
  • 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.