@aws-cdk_aws-amplify-alpha.SourceCodeProviderConfig

interface SourceCodeProviderConfig ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Amplify.Alpha.SourceCodeProviderConfig
Gogithub.com/aws/aws-cdk-go/awscdkamplifyalpha/v2#SourceCodeProviderConfig
Javasoftware.amazon.awscdk.services.amplify.alpha.SourceCodeProviderConfig
Pythonaws_cdk.aws_amplify_alpha.SourceCodeProviderConfig
TypeScript (source)@aws-cdk/aws-amplify-alpha ยป SourceCodeProviderConfig

Obtainable from CodeCommitSourceCodeProvider.bind(), GitHubSourceCodeProvider.bind(), GitLabSourceCodeProvider.bind()

Configuration for the source code provider.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as amplify_alpha from '@aws-cdk/aws-amplify-alpha';
import * as cdk from 'aws-cdk-lib';

declare const secretValue: cdk.SecretValue;
const sourceCodeProviderConfig: amplify_alpha.SourceCodeProviderConfig = {
  repository: 'repository',

  // the properties below are optional
  accessToken: secretValue,
  oauthToken: secretValue,
};

Properties

NameTypeDescription
repository๐Ÿ”นstringThe repository for the application. Must use the HTTPS protocol.
accessToken?๐Ÿ”นSecretValuePersonal Access token for 3rd party source control system for an Amplify App, used to create webhook and read-only deploy key.
oauthToken?๐Ÿ”นSecretValueOAuth token for 3rd party source control system for an Amplify App, used to create webhook and read-only deploy key.

repository๐Ÿ”น

Type: string

The repository for the application. Must use the HTTPS protocol.

For example, https://github.com/aws/aws-cdk.


accessToken?๐Ÿ”น

Type: SecretValue (optional, default: do not use a token)

Personal Access token for 3rd party source control system for an Amplify App, used to create webhook and read-only deploy key.

Token is not stored.

Either accessToken or oauthToken must be specified if repository is sepcified.


oauthToken?๐Ÿ”น

Type: SecretValue (optional, default: do not use a token)

OAuth token for 3rd party source control system for an Amplify App, used to create webhook and read-only deploy key.

OAuth token is not stored.

Either accessToken or oauthToken must be specified if repository is specified.