Experimental
@aws-cdk/aws-amplify-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
AutoBranchCreation Struct
Auto branch creation configuration.
| Stability | Experimental |
|---|---|
| Source | lib/app.ts |
Example
ts
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
});
python
amplify_app = amplify.App(self, "MyApp",
source_code_provider=amplify.GitHubSourceCodeProvider(
owner="<user>",
repository="<repo>",
oauth_token=SecretValue.secrets_manager("my-github-token")
),
auto_branch_creation=amplify.AutoBranchCreation( # Automatically connect branches that match a pattern set
patterns=["feature/*", "test/*"]),
auto_branch_deletion=True
)
java
App amplifyApp = App.Builder.create(this, "MyApp")
.sourceCodeProvider(GitHubSourceCodeProvider.Builder.create()
.owner("<user>")
.repository("<repo>")
.oauthToken(SecretValue.secretsManager("my-github-token"))
.build())
.autoBranchCreation(AutoBranchCreation.builder() // Automatically connect branches that match a pattern set
.patterns(List.of("feature/*", "test/*")).build())
.autoBranchDeletion(true)
.build();
csharp
// Install: dotnet add package Amazon.CDK.AWS.Amplify.Alpha
var amplifyApp = new App(this, "MyApp", new AppProps {
SourceCodeProvider = new GitHubSourceCodeProvider(new GitHubSourceCodeProviderProps {
Owner = "<user>",
Repository = "<repo>",
OauthToken = SecretValue.SecretsManager("my-github-token")
}),
AutoBranchCreation = new AutoBranchCreation { // Automatically connect branches that match a pattern set
Patterns = new [] { "feature/*", "test/*" } },
AutoBranchDeletion = true
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdkamplifyalpha/v2
amplifyApp := amplify.NewApp(this, jsii.String("MyApp"), &AppProps{
SourceCodeProvider: amplify.NewGitHubSourceCodeProvider(&GitHubSourceCodeProviderProps{
Owner: jsii.String("<user>"),
Repository: jsii.String("<repo>"),
OauthToken: awscdk.SecretValue_SecretsManager(jsii.String("my-github-token")),
}),
AutoBranchCreation: &AutoBranchCreation{
// Automatically connect branches that match a pattern set
Patterns: []*string{
jsii.String("feature/*"),
jsii.String("test/*"),
},
},
AutoBranchDeletion: jsii.Boolean(true),
})
Properties
autoBuildoptionalbooleanauto_buildoptionalboolautoBuildoptionalBooleanAutoBuildoptionalboolAutoBuildoptional*bool = true #Whether to enable auto building for the auto created branch.
basicAuthoptionalBasicAuthbasic_authoptionalBasicAuthbasicAuthoptionalBasicAuthBasicAuthoptionalBasicAuthBasicAuthoptionalBasicAuth #The Basic Auth configuration.
Default: no password protection
Use this to set password protection for the auto created branch.
buildSpecoptionalBuildSpecbuild_specoptionalBuildSpecbuildSpecoptionalBuildSpecBuildSpecoptionalBuildSpecBuildSpecoptionalBuildSpec #Build spec for the auto created branch.
Default: application build spec
environmentVariablesoptional{ [key: string]: string }environment_variablesoptionaltyping.Mapping[str, str]environmentVariablesoptionalMap<String, String>EnvironmentVariablesoptionalIDictionary<string, string>EnvironmentVariablesoptional*map[string]*string #Environment variables for the auto created branch.
Default: application environment variables
All environment variables that you add are encrypted to prevent rogue access so you can use them to store secret information.
patternsoptionalstring[]patternsoptionaltyping.List[str]patternsoptionalList<String>Patternsoptionalstring[]Patternsoptional*[]*string #Automated branch creation glob patterns.
Default: all repository branches
pullRequestEnvironmentNameoptionalstringpull_request_environment_nameoptionalstrpullRequestEnvironmentNameoptionalStringPullRequestEnvironmentNameoptionalstringPullRequestEnvironmentNameoptional*string #The dedicated backend environment for the pull request previews of the auto created branch.
Default: automatically provision a temporary backend
pullRequestPreviewoptionalbooleanpull_request_previewoptionalboolpullRequestPreviewoptionalBooleanPullRequestPreviewoptionalboolPullRequestPreviewoptional*bool = true #Whether to enable pull request preview for the auto created branch.
Stage for the auto created branch.
Default: no stage