Modifier and Type | Method and Description |
---|---|
Branch.Builder |
app(IApp app)
(experimental) The application within which the branch must be created.
|
Branch.Builder |
asset(Asset asset)
(experimental) Asset for deployment.
|
Branch.Builder |
autoBuild(java.lang.Boolean autoBuild)
(experimental) Whether to enable auto building for the branch.
|
Branch.Builder |
basicAuth(BasicAuth basicAuth)
(experimental) The Basic Auth configuration.
|
Branch.Builder |
branchName(java.lang.String branchName)
(experimental) The name of the branch.
|
Branch |
build() |
Branch.Builder |
buildSpec(BuildSpec buildSpec)
(experimental) BuildSpec for the branch.
|
static Branch.Builder |
create(software.constructs.Construct scope,
java.lang.String id) |
Branch.Builder |
description(java.lang.String description)
(experimental) A description for the branch.
|
Branch.Builder |
environmentVariables(java.util.Map<java.lang.String,java.lang.String> environmentVariables)
(experimental) Environment variables for the branch.
|
Branch.Builder |
performanceMode(java.lang.Boolean performanceMode)
(experimental) Enables performance mode for the branch.
|
Branch.Builder |
pullRequestEnvironmentName(java.lang.String pullRequestEnvironmentName)
(experimental) The dedicated backend environment for the pull request previews.
|
Branch.Builder |
pullRequestPreview(java.lang.Boolean pullRequestPreview)
(experimental) Whether to enable pull request preview for the branch.
|
Branch.Builder |
stage(java.lang.String stage)
(experimental) Stage for the branch.
|
public static Branch.Builder create(software.constructs.Construct scope, java.lang.String id)
scope
- This parameter is required.id
- This parameter is required.Branch.Builder
.public Branch.Builder asset(Asset asset)
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
asset
- Asset for deployment. This parameter is required.this
public Branch.Builder autoBuild(java.lang.Boolean autoBuild)
Default: true
autoBuild
- Whether to enable auto building for the branch. This parameter is required.this
public Branch.Builder basicAuth(BasicAuth basicAuth)
Use this to set password protection for the branch
Default: - no password protection
basicAuth
- The Basic Auth configuration. This parameter is required.this
public Branch.Builder branchName(java.lang.String branchName)
Default: - the construct's id
branchName
- The name of the branch. This parameter is required.this
public Branch.Builder buildSpec(BuildSpec buildSpec)
Default: - no build spec
buildSpec
- BuildSpec for the branch. This parameter is required.this
public Branch.Builder description(java.lang.String description)
Default: - no description
description
- A description for the branch. This parameter is required.this
public Branch.Builder environmentVariables(java.util.Map<java.lang.String,java.lang.String> environmentVariables)
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
environmentVariables
- Environment variables for the branch. This parameter is required.this
public Branch.Builder performanceMode(java.lang.Boolean performanceMode)
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
performanceMode
- Enables performance mode for the branch. This parameter is required.this
public Branch.Builder pullRequestEnvironmentName(java.lang.String pullRequestEnvironmentName)
Default: - automatically provision a temporary backend
pullRequestEnvironmentName
- The dedicated backend environment for the pull request previews. This parameter is required.this
public Branch.Builder pullRequestPreview(java.lang.Boolean pullRequestPreview)
Default: true
pullRequestPreview
- Whether to enable pull request preview for the branch. This parameter is required.this
public Branch.Builder stage(java.lang.String stage)
Default: - no stage
stage
- Stage for the branch. This parameter is required.this
public Branch.Builder app(IApp app)
app
- The application within which the branch must be created. This parameter is required.this
public Branch build()