software.amazon.awscdk.services.amplify

Interface BranchOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

BranchProps

All Known Implementing Classes:

BranchOptions.Jsii$Proxy, BranchProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:43.077Z")
 @Stability(value=Experimental)
public interface BranchOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) Options to add a branch to an application.

Example:

 App amplifyApp;
 Branch master = amplifyApp.addBranch("master"); // `id` will be used as repo branch name
 Branch dev = amplifyApp.addBranch("dev", BranchOptions.builder()
         .performanceMode(true)
         .build());
 dev.addEnvironment("STAGE", "dev");
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static BranchOptions.Builder	builder()
default Asset	getAsset() (experimental) Asset for deployment.
default Boolean	getAutoBuild() (experimental) Whether to enable auto building for the branch.
default BasicAuth	getBasicAuth() (experimental) The Basic Auth configuration.
default String	getBranchName() (experimental) The name of the branch.
default BuildSpec	getBuildSpec() (experimental) BuildSpec for the branch.
default String	getDescription() (experimental) A description for the branch.
default Map<String,String>	getEnvironmentVariables() (experimental) Environment variables for the branch.
default Boolean	getPerformanceMode() (experimental) Enables performance mode for the branch.
default String	getPullRequestEnvironmentName() (experimental) The dedicated backend environment for the pull request previews.
default Boolean	getPullRequestPreview() (experimental) Whether to enable pull request preview for the branch.
default String	getStage() (experimental) Stage for the branch.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAsset

@Stability(value=Experimental)
 @Nullable
default Asset getAsset()

(experimental) Asset for deployment.

The Amplify app must not have a sourceCodeProvider configured as this resource uses Amplify's startDeployment API to initiate and deploy a S3 asset onto the App.

Default: - no asset

getAutoBuild

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

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

Default: true

getBasicAuth

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

(experimental) The Basic Auth configuration.

Use this to set password protection for the branch

Default: - no password protection

getBranchName

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

(experimental) The name of the branch.

Default: - the construct's id

getBuildSpec

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

(experimental) BuildSpec for the branch.

Default: - no build spec

See Also:

https://docs.aws.amazon.com/amplify/latest/userguide/build-settings.html

getDescription

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

(experimental) A description for the branch.

Default: - no description

getEnvironmentVariables

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

(experimental) Environment variables for the 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

getPerformanceMode

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

(experimental) Enables performance mode for the branch.

Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.

Default: false

getPullRequestEnvironmentName

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

(experimental) The dedicated backend environment for the pull request previews.

Default: - automatically provision a temporary backend

getPullRequestPreview

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

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

Default: true

getStage

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

(experimental) Stage for the branch.

Default: - no stage

builder

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

Returns:

a BranchOptions.Builder of BranchOptions