@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
date="2022-08-09T19:16:39.890Z")
public interface BranchOptions
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");
Modifier and Type | Interface and Description |
---|---|
static class |
BranchOptions.Builder
A builder for
BranchOptions |
static class |
BranchOptions.Jsii$Proxy
An implementation for
BranchOptions |
Modifier and Type | Method and Description |
---|---|
static BranchOptions.Builder |
builder() |
default Asset |
getAsset()
(experimental) Asset for deployment.
|
default java.lang.Boolean |
getAutoBuild()
(experimental) Whether to enable auto building for the branch.
|
default BasicAuth |
getBasicAuth()
(experimental) The Basic Auth configuration.
|
default java.lang.String |
getBranchName()
(experimental) The name of the branch.
|
default BuildSpec |
getBuildSpec()
(experimental) BuildSpec for the branch.
|
default java.lang.String |
getDescription()
(experimental) A description for the branch.
|
default java.util.Map<java.lang.String,java.lang.String> |
getEnvironmentVariables()
(experimental) Environment variables for the branch.
|
default java.lang.Boolean |
getPerformanceMode()
(experimental) Enables performance mode for the branch.
|
default java.lang.String |
getPullRequestEnvironmentName()
(experimental) The dedicated backend environment for the pull request previews.
|
default java.lang.Boolean |
getPullRequestPreview()
(experimental) Whether to enable pull request preview for the branch.
|
default java.lang.String |
getStage()
(experimental) Stage for the branch.
|
default Asset getAsset()
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
default java.lang.Boolean getAutoBuild()
Default: true
default BasicAuth getBasicAuth()
Use this to set password protection for the branch
Default: - no password protection
default java.lang.String getBranchName()
Default: - the construct's id
default BuildSpec getBuildSpec()
Default: - no build spec
default java.lang.String getDescription()
Default: - no description
default java.util.Map<java.lang.String,java.lang.String> getEnvironmentVariables()
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
default java.lang.Boolean getPerformanceMode()
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
default java.lang.String getPullRequestEnvironmentName()
Default: - automatically provision a temporary backend
default java.lang.Boolean getPullRequestPreview()
Default: true
default java.lang.String getStage()
Default: - no stage
static BranchOptions.Builder builder()
BranchOptions.Builder
of BranchOptions