public static final class CfnBranchProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CfnBranchProps
CfnBranchProps
CfnBranchProps.Builder, CfnBranchProps.Jsii$Proxy
Modifier | Constructor and Description |
---|---|
protected |
Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
Constructor that initializes the object based on values retrieved from the JsiiObject.
|
Modifier and Type | Method and Description |
---|---|
com.fasterxml.jackson.databind.JsonNode |
$jsii$toJson() |
boolean |
equals(java.lang.Object o) |
java.lang.String |
getAppId()
The unique ID for an Amplify app.
|
java.lang.Object |
getBasicAuthConfig()
The basic authorization credentials for a branch of an Amplify app.
|
java.lang.String |
getBranchName()
The name for the branch.
|
java.lang.String |
getBuildSpec()
The build specification (build spec) for the branch.
|
java.lang.String |
getDescription()
The description for the branch that is part of an Amplify app.
|
java.lang.Object |
getEnableAutoBuild()
Enables auto building for the branch.
|
java.lang.Object |
getEnablePerformanceMode()
Enables performance mode for the branch.
|
java.lang.Object |
getEnablePullRequestPreview()
Sets whether the Amplify Console creates a preview for each pull request that is made for this branch.
|
java.lang.Object |
getEnvironmentVariables()
The environment variables for the branch.
|
java.lang.String |
getPullRequestEnvironmentName()
If pull request previews are enabled for this branch, you can use this property to specify a dedicated backend environment for your previews.
|
java.lang.String |
getStage()
Describes the current stage for the branch.
|
java.util.List<CfnTag> |
getTags()
The tag for the branch.
|
int |
hashCode() |
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
builder
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
objRef
- Reference to the JSII managed object.public final java.lang.String getAppId()
CfnBranchProps
Length Constraints: Minimum length of 1. Maximum length of 20.
Pattern: d[a-z0-9]+
getAppId
in interface CfnBranchProps
public final java.lang.String getBranchName()
CfnBranchProps
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: (?s).+
getBranchName
in interface CfnBranchProps
public final java.lang.Object getBasicAuthConfig()
CfnBranchProps
You must base64-encode the authorization credentials and provide them in the format user:password
.
getBasicAuthConfig
in interface CfnBranchProps
public final java.lang.String getBuildSpec()
CfnBranchProps
Length Constraints: Minimum length of 1. Maximum length of 25000.
Pattern: (?s).+
getBuildSpec
in interface CfnBranchProps
public final java.lang.String getDescription()
CfnBranchProps
Length Constraints: Maximum length of 1000.
Pattern: (?s).*
getDescription
in interface CfnBranchProps
public final java.lang.Object getEnableAutoBuild()
CfnBranchProps
getEnableAutoBuild
in interface CfnBranchProps
public final java.lang.Object getEnablePerformanceMode()
CfnBranchProps
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.
getEnablePerformanceMode
in interface CfnBranchProps
public final java.lang.Object getEnablePullRequestPreview()
CfnBranchProps
If this property is enabled, the Amplify Console deploys your app to a unique preview URL after each pull request is opened. Development and QA teams can use this preview to test the pull request before it's merged into a production or integration branch.
To provide backend support for your preview, the Amplify Console automatically provisions a temporary backend environment that it deletes when the pull request is closed. If you want to specify a dedicated backend environment for your previews, use the PullRequestEnvironmentName
property.
For more information, see Web Previews in the AWS Amplify Hosting User Guide .
getEnablePullRequestPreview
in interface CfnBranchProps
public final java.lang.Object getEnvironmentVariables()
CfnBranchProps
getEnvironmentVariables
in interface CfnBranchProps
public final java.lang.String getPullRequestEnvironmentName()
CfnBranchProps
For example, you could specify an environment named prod
, test
, or dev
that you initialized with the Amplify CLI and mapped to this branch.
To enable pull request previews, set the EnablePullRequestPreview
property to true
.
If you don't specify an environment, the Amplify Console provides backend support for each preview by automatically provisioning a temporary backend environment. Amplify Console deletes this environment when the pull request is closed.
For more information about creating backend environments, see Feature Branch Deployments and Team Workflows in the AWS Amplify Hosting User Guide .
Length Constraints: Maximum length of 20.
Pattern: (?s).*
getPullRequestEnvironmentName
in interface CfnBranchProps
public final java.lang.String getStage()
CfnBranchProps
Valid Values: PRODUCTION | BETA | DEVELOPMENT | EXPERIMENTAL | PULL_REQUEST
getStage
in interface CfnBranchProps
public final java.util.List<CfnTag> getTags()
CfnBranchProps
getTags
in interface CfnBranchProps
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
public final boolean equals(java.lang.Object o)
public final int hashCode()