Class CfnSourceCredentialProps

Properties for defining a CfnSourceCredential.

Inheritance

object

CfnSourceCredentialProps

Implements

ICfnSourceCredentialProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.CodeBuild

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnSourceCredentialProps : ICfnSourceCredentialProps

Syntax (vb)

Public Class CfnSourceCredentialProps Implements ICfnSourceCredentialProps

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.CodeBuild;

             var cfnSourceCredentialProps = new CfnSourceCredentialProps {
                 AuthType = "authType",
                 ServerType = "serverType",
                 Token = "token",

                 // the properties below are optional
                 Username = "username"
             };

Synopsis

Constructors

CfnSourceCredentialProps()

Properties for defining a CfnSourceCredential.

Properties

AuthType	The type of authentication used by the credentials.
ServerType	The type of source provider.
Token	For GitHub or GitHub Enterprise, this is the personal access token.
Username	The Bitbucket username when the authType is BASIC_AUTH.

Constructors

CfnSourceCredentialProps()

Properties for defining a CfnSourceCredential.

public CfnSourceCredentialProps()

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.CodeBuild;

             var cfnSourceCredentialProps = new CfnSourceCredentialProps {
                 AuthType = "authType",
                 ServerType = "serverType",
                 Token = "token",

                 // the properties below are optional
                 Username = "username"
             };

Properties

AuthType

The type of authentication used by the credentials.

public string AuthType { get; set; }

Property Value

string

Remarks

Valid options are OAUTH, BASIC_AUTH, PERSONAL_ACCESS_TOKEN, CODECONNECTIONS, or SECRETS_MANAGER.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-sourcecredential.html#cfn-codebuild-sourcecredential-authtype

ServerType

The type of source provider.

public string ServerType { get; set; }

Property Value

string

Remarks

The valid options are GITHUB, GITHUB_ENTERPRISE, GITLAB, GITLAB_SELF_MANAGED, or BITBUCKET.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-sourcecredential.html#cfn-codebuild-sourcecredential-servertype

Token

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

public string Token { get; set; }

Property Value

string

Remarks

For Bitbucket, this is either the access token or the app password. For the authType CODECONNECTIONS, this is the connectionArn . For the authType SECRETS_MANAGER, this is the secretArn .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-sourcecredential.html#cfn-codebuild-sourcecredential-token

Username

The Bitbucket username when the authType is BASIC_AUTH.

public string? Username { get; set; }

Property Value

string

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-sourcecredential.html#cfn-codebuild-sourcecredential-username

Implements

ICfnSourceCredentialProps