@Stability(value=Stable) @Internal public static final class CfnBranchProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CfnBranchProps
CfnBranchPropssoftware.amazon.jsii.JsiiObject.InitializationModeCfnBranchProps.Builder, CfnBranchProps.Jsii$Proxy| Modifier | Constructor and Description |
|---|---|
protected |
Jsii$Proxy(CfnBranchProps.Builder builder)
Constructor that initializes the object based on literal property values passed by the
CfnBranchProps.Builder. |
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(Object o) |
String |
getAppId()
The unique ID for an Amplify app.
|
Object |
getBasicAuthConfig()
The basic authorization credentials for a branch of an Amplify app.
|
String |
getBranchName()
The name for the branch.
|
String |
getBuildSpec()
The build specification (build spec) for the branch.
|
String |
getDescription()
The description for the branch that is part of an Amplify app.
|
Object |
getEnableAutoBuild()
Enables auto building for the branch.
|
Object |
getEnablePerformanceMode()
Enables performance mode for the branch.
|
Object |
getEnablePullRequestPreview()
Sets whether the Amplify Console creates a preview for each pull request that is made for this branch.
|
Object |
getEnvironmentVariables()
The environment variables for the branch.
|
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.
|
String |
getStage()
Describes the current stage for the branch.
|
List<CfnTag> |
getTags()
The tag for the branch.
|
int |
hashCode() |
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetclone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitbuilderprotected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
objRef - Reference to the JSII managed object.protected Jsii$Proxy(CfnBranchProps.Builder builder)
CfnBranchProps.Builder.public final String getAppId()
CfnBranchPropsLength Constraints: Minimum length of 1. Maximum length of 20.
Pattern: d[a-z0-9]+
getAppId in interface CfnBranchPropspublic final String getBranchName()
CfnBranchPropsLength Constraints: Minimum length of 1. Maximum length of 255.
Pattern: (?s).+
getBranchName in interface CfnBranchPropspublic final Object getBasicAuthConfig()
CfnBranchProps
You must base64-encode the authorization credentials and provide them in the format user:password .
getBasicAuthConfig in interface CfnBranchPropspublic final String getBuildSpec()
CfnBranchPropsLength Constraints: Minimum length of 1. Maximum length of 25000.
Pattern: (?s).+
getBuildSpec in interface CfnBranchPropspublic final String getDescription()
CfnBranchPropsLength Constraints: Maximum length of 1000.
Pattern: (?s).*
getDescription in interface CfnBranchPropspublic final Object getEnableAutoBuild()
CfnBranchPropsgetEnableAutoBuild in interface CfnBranchPropspublic final Object getEnablePerformanceMode()
CfnBranchPropsPerformance 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 CfnBranchPropspublic final Object getEnablePullRequestPreview()
CfnBranchPropsIf 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 CfnBranchPropspublic final Object getEnvironmentVariables()
CfnBranchPropsgetEnvironmentVariables in interface CfnBranchPropspublic final 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 CfnBranchPropspublic final String getStage()
CfnBranchPropsValid Values: PRODUCTION | BETA | DEVELOPMENT | EXPERIMENTAL | PULL_REQUEST
getStage in interface CfnBranchPropspublic final List<CfnTag> getTags()
CfnBranchPropsgetTags in interface CfnBranchProps@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
$jsii$toJson in interface software.amazon.jsii.JsiiSerializableCopyright © 2022. All rights reserved.