interface SourceCodeProviderConfig
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.Amplify.SourceCodeProviderConfig |
 Java | software.amazon.awscdk.services.amplify.SourceCodeProviderConfig |
 Python | aws_cdk.aws_amplify.SourceCodeProviderConfig |
 TypeScript (source) | @aws-cdk/aws-amplify » SourceCodeProviderConfig |
Obtainable from
Code.bind(), Git.bind(), Git.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 from '@aws-cdk/aws-amplify';
import * as cdk from '@aws-cdk/core';
declare const secretValue: cdk.SecretValue;
const sourceCodeProviderConfig: amplify.SourceCodeProviderConfig = {
repository: 'repository',
// the properties below are optional
accessToken: secretValue,
oauthToken: secretValue,
};
Properties
| Name | Type | Description |
|---|---|---|
| repository | string | The repository for the application. Must use the HTTPS protocol. |
| access | Secret | Personal Access token for 3rd party source control system for an Amplify App, used to create webhook and read-only deploy key. |
| oauth | Secret | OAuth 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:
Secret
(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:
Secret
(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.