software.amazon.awscdk.services.amplify

Interface AutoBranchCreation

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AutoBranchCreation.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-07T23:46:59.104Z")
 @Stability(value=Experimental)
public interface AutoBranchCreation
extends software.amazon.jsii.JsiiSerializable

(experimental) Auto branch creation configuration.

Example:

 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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AutoBranchCreation.Builder A builder for AutoBranchCreation
static class	AutoBranchCreation.Jsii$Proxy An implementation for AutoBranchCreation

Method Summary

Modifier and Type	Method and Description
static AutoBranchCreation.Builder	builder()
default Boolean	getAutoBuild() (experimental) Whether to enable auto building for the auto created branch.
default BasicAuth	getBasicAuth() (experimental) The Basic Auth configuration.
default BuildSpec	getBuildSpec() (experimental) Build spec for the auto created branch.
default Map<String,String>	getEnvironmentVariables() (experimental) Environment variables for the auto created branch.
default List<String>	getPatterns() (experimental) Automated branch creation glob patterns.
default String	getPullRequestEnvironmentName() (experimental) The dedicated backend environment for the pull request previews of the auto created branch.
default Boolean	getPullRequestPreview() (experimental) Whether to enable pull request preview for the auto created branch.
default String	getStage() (experimental) Stage for the auto created branch.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAutoBuild

@Stability(value=Experimental)
 @Nullable
default Boolean getAutoBuild()

(experimental) Whether to enable auto building for the auto created branch.

Default: true

getBasicAuth

@Stability(value=Experimental)
 @Nullable
default BasicAuth getBasicAuth()

(experimental) The Basic Auth configuration.

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

Default: - no password protection

getBuildSpec

@Stability(value=Experimental)
 @Nullable
default BuildSpec getBuildSpec()

(experimental) Build spec for the auto created branch.

Default: - application build spec

getEnvironmentVariables

@Stability(value=Experimental)
 @Nullable
default Map<String,String> getEnvironmentVariables()

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

Default: - application environment variables

getPatterns

@Stability(value=Experimental)
 @Nullable
default List<String> getPatterns()

(experimental) Automated branch creation glob patterns.

Default: - all repository branches

getPullRequestEnvironmentName

@Stability(value=Experimental)
 @Nullable
default String getPullRequestEnvironmentName()

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

Default: - automatically provision a temporary backend

getPullRequestPreview

@Stability(value=Experimental)
 @Nullable
default Boolean getPullRequestPreview()

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

Default: true

getStage

@Stability(value=Experimental)
 @Nullable
default String getStage()

(experimental) Stage for the auto created branch.

Default: - no stage

builder

@Stability(value=Experimental)
static AutoBranchCreation.Builder builder()

Returns:

a AutoBranchCreation.Builder of AutoBranchCreation