Interface ICfnSourceCredentialProps

Properties for defining a CfnSourceCredential.

Namespace: Amazon.CDK.AWS.CodeBuild

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnSourceCredentialProps

Syntax (vb)

Public Interface 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

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.

Properties

AuthType

The type of authentication used by the credentials.

string AuthType { get; }

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.

string ServerType { get; }

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.

string Token { get; }

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.

string? Username { get; }

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