SourceCodeProviderConfig

class aws_cdk.aws_amplify.SourceCodeProviderConfig(*, repository, access_token=None, oauth_token=None)

Bases: object

(experimental) Configuration for the source code provider.

Parameters:
  • repository (str) – (experimental) The repository for the application. Must use the HTTPS protocol. For example, https://github.com/aws/aws-cdk.

  • access_token (Optional[SecretValue]) – (experimental) 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. Default: - do not use a token

  • oauth_token (Optional[SecretValue]) – (experimental) 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. Default: - do not use a token

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_amplify as amplify
import aws_cdk.core as cdk

# secret_value: cdk.SecretValue

source_code_provider_config = amplify.SourceCodeProviderConfig(
    repository="repository",

    # the properties below are optional
    access_token=secret_value,
    oauth_token=secret_value
)

Attributes

access_token

(experimental) 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.

Default:
  • do not use a token

Stability:

experimental

oauth_token

(experimental) 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.

Default:
  • do not use a token

Stability:

experimental

repository

(experimental) The repository for the application. Must use the HTTPS protocol.

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

Stability:

experimental