@aws-cdk_aws-amplify-alpha.AutoBranchCreation

interface AutoBranchCreation ๐Ÿ”น

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

Auto branch creation configuration.

Example

const amplifyApp = new amplify.App(this, 'MyApp', {
  sourceCodeProvider: new amplify.GitHubSourceCodeProvider({
    owner: '<user>',
    repository: '<repo>',
    oauthToken: SecretValue.secretsManager('my-github-token'),
  }),
  autoBranchCreation: { // Automatically connect branches that match a pattern set
    patterns: ['feature/*', 'test/*'],
  },
  autoBranchDeletion: true, // Automatically disconnect a branch when you delete a branch from your repository
});

Properties

NameTypeDescription
autoBuild?๐Ÿ”นbooleanWhether to enable auto building for the auto created branch.
basicAuth?๐Ÿ”นBasicAuthThe Basic Auth configuration.
buildSpec?๐Ÿ”นBuildSpecBuild spec for the auto created branch.
environmentVariables?๐Ÿ”น{ [string]: string }Environment variables for the auto created branch.
patterns?๐Ÿ”นstring[]Automated branch creation glob patterns.
pullRequestEnvironmentName?๐Ÿ”นstringThe dedicated backend environment for the pull request previews of the auto created branch.
pullRequestPreview?๐Ÿ”นbooleanWhether to enable pull request preview for the auto created branch.
stage?๐Ÿ”นstringStage for the auto created branch.

autoBuild?๐Ÿ”น

Type: boolean (optional, default: true)

Whether to enable auto building for the auto created branch.


basicAuth?๐Ÿ”น

Type: BasicAuth (optional, default: no password protection)

The Basic Auth configuration.

Use this to set password protection for the auto created branch.


buildSpec?๐Ÿ”น

Type: BuildSpec (optional, default: application build spec)

Build spec for the auto created branch.


environmentVariables?๐Ÿ”น

Type: { [string]: string } (optional, default: application environment variables)

Environment variables for the auto created branch.

All environment variables that you add are encrypted to prevent rogue access so you can use them to store secret information.


patterns?๐Ÿ”น

Type: string[] (optional, default: all repository branches)

Automated branch creation glob patterns.


pullRequestEnvironmentName?๐Ÿ”น

Type: string (optional, default: automatically provision a temporary backend)

The dedicated backend environment for the pull request previews of the auto created branch.


pullRequestPreview?๐Ÿ”น

Type: boolean (optional, default: true)

Whether to enable pull request preview for the auto created branch.


stage?๐Ÿ”น

Type: string (optional, default: no stage)

Stage for the auto created branch.