Package 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.84.0 (build 5404dcf)", date="2023-06-19T16:30:42.073Z") @Stability(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();

  • Method Details

    • getAutoBuild

      @Stability(Experimental) @Nullable default Boolean getAutoBuild()
      (experimental) Whether to enable auto building for the auto created branch.

      Default: true

    • getBasicAuth

      @Stability(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(Experimental) @Nullable default BuildSpec getBuildSpec()
      (experimental) Build spec for the auto created branch.

      Default: - application build spec

    • getEnvironmentVariables

      @Stability(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(Experimental) @Nullable default List<String> getPatterns()
      (experimental) Automated branch creation glob patterns.

      Default: - all repository branches

    • getPullRequestEnvironmentName

      @Stability(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(Experimental) @Nullable default Boolean getPullRequestPreview()
      (experimental) Whether to enable pull request preview for the auto created branch.

      Default: true

    • getStage

      @Stability(Experimental) @Nullable default String getStage()
      (experimental) Stage for the auto created branch.

      Default: - no stage

    • builder

      @Stability(Experimental) static AutoBranchCreation.Builder builder()
      Returns:
      a AutoBranchCreation.Builder of AutoBranchCreation