Package software.amazon.awscdk.services.codebuild

Interface CfnSourceCredentialProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSourceCredentialProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-25T14:21:11.971Z")
@Stability(Stable)
public interface CfnSourceCredentialProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnSourceCredential.

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.*;
 CfnSourceCredentialProps cfnSourceCredentialProps = CfnSourceCredentialProps.builder()
         .authType("authType")
         .serverType("serverType")
         .token("token")
         // the properties below are optional
         .username("username")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnSourceCredentialProps.Builder	A builder for CfnSourceCredentialProps
static final class	CfnSourceCredentialProps.Jsii$Proxy	An implementation for CfnSourceCredentialProps

Method Summary

Modifier and Type	Method	Description
static CfnSourceCredentialProps.Builder	builder()
String	getAuthType()	The type of authentication used by the credentials.
String	getServerType()	The type of source provider.
String	getToken()	For GitHub or GitHub Enterprise, this is the personal access token.
default String	getUsername()	The Bitbucket username when the authType is BASIC_AUTH.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAuthType

@Stability(Stable)
@NotNull
String getAuthType()

The type of authentication used by the credentials.

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

See Also:

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

getServerType

@Stability(Stable)
@NotNull
String getServerType()

The type of source provider.

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

See Also:

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

getToken

@Stability(Stable)
@NotNull
String getToken()

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

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 Also:

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

getUsername

@Stability(Stable)
@Nullable
default String getUsername()

The Bitbucket username when the authType is BASIC_AUTH.

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

See Also:

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

builder

@Stability(Stable)
static CfnSourceCredentialProps.Builder builder()

Returns:

a CfnSourceCredentialProps.Builder of CfnSourceCredentialProps