AWS CDK Reference

Appearance

v2.277.0

Experimental

@aws-cdk/aws-amplify-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

SourceCodeProviderConfig Struct ​

Configuration for the source code provider.

Stability
Experimental
Source
lib/app.ts

Example ​

ts
// 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,
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_amplify_alpha as amplify_alpha
import aws_cdk as cdk

# secret_value: cdk.SecretValue

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

    # the properties below are optional
    access_token=secret_value,
    oauth_token=secret_value
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.amplify.alpha.*;
import software.amazon.awscdk.*;

SecretValue secretValue;

SourceCodeProviderConfig sourceCodeProviderConfig = SourceCodeProviderConfig.builder()
        .repository("repository")

        // the properties below are optional
        .accessToken(secretValue)
        .oauthToken(secretValue)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.AWS.Amplify.Alpha
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Amplify.Alpha;
using Amazon.CDK;

SecretValue secretValue;

var sourceCodeProviderConfig = new SourceCodeProviderConfig {
    Repository = "repository",

    // the properties below are optional
    AccessToken = secretValue,
    OauthToken = secretValue
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdkamplifyalpha/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import amplify_alpha "github.com/aws/aws-cdk-go/awscdkamplifyalpha"
import cdk "github.com/aws/aws-cdk-go/awscdk"

var secretValue SecretValue

sourceCodeProviderConfig := &SourceCodeProviderConfig{
	Repository: jsii.String("repository"),

	// the properties below are optional
	AccessToken: secretValue,
	OauthToken: secretValue,
}

Properties ​

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

Default: do not use a token

Token is not stored.

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

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

Default: do not use a token

OAuth token is not stored.

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

repositorystringrepositorystrrepositoryStringRepositorystringRepository*stringrequired#
The repository for the application. Must use the `HTTPS` protocol.

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