Package software.amazon.awscdk.services.amplify

Class CfnBranchProps.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.amplify.CfnBranchProps.Jsii$Proxy
All Implemented Interfaces:
CfnBranchProps, software.amazon.jsii.JsiiSerializable
Enclosing interface:
CfnBranchProps
@Stability(Stable) @Internal public static final class CfnBranchProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CfnBranchProps
An implementation for CfnBranchProps

  • Constructor Details

    • Jsii$Proxy

      protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
      Constructor that initializes the object based on values retrieved from the JsiiObject.
      Parameters:
      objRef - Reference to the JSII managed object.

    • Jsii$Proxy

      protected Jsii$Proxy(CfnBranchProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the CfnBranchProps.Builder.

  • Method Details

    • getAppId

      public final String getAppId()
      Description copied from interface: CfnBranchProps
      The unique ID for an Amplify app.

      Length Constraints: Minimum length of 1. Maximum length of 20.

      Pattern: d[a-z0-9]+

      Specified by:
      getAppId in interface CfnBranchProps

    • getBranchName

      public final String getBranchName()
      Description copied from interface: CfnBranchProps
      The name for the branch.

      Length Constraints: Minimum length of 1. Maximum length of 255.

      Pattern: (?s).+

      Specified by:
      getBranchName in interface CfnBranchProps

    • getBasicAuthConfig

      public final Object getBasicAuthConfig()
      Description copied from interface: CfnBranchProps
      The basic authorization credentials for a branch of an Amplify app.

      You must base64-encode the authorization credentials and provide them in the format user:password .

      Specified by:
      getBasicAuthConfig in interface CfnBranchProps

    • getBuildSpec

      public final String getBuildSpec()
      Description copied from interface: CfnBranchProps
      The build specification (build spec) for the branch.

      Length Constraints: Minimum length of 1. Maximum length of 25000.

      Pattern: (?s).+

      Specified by:
      getBuildSpec in interface CfnBranchProps

    • getDescription

      public final String getDescription()
      Description copied from interface: CfnBranchProps
      The description for the branch that is part of an Amplify app.

      Length Constraints: Maximum length of 1000.

      Pattern: (?s).*

      Specified by:
      getDescription in interface CfnBranchProps

    • getEnableAutoBuild

      public final Object getEnableAutoBuild()
      Description copied from interface: CfnBranchProps
      Enables auto building for the branch.
      Specified by:
      getEnableAutoBuild in interface CfnBranchProps

    • getEnablePerformanceMode

      public final Object getEnablePerformanceMode()
      Description copied from interface: CfnBranchProps
      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.

      Specified by:
      getEnablePerformanceMode in interface CfnBranchProps

    • getEnablePullRequestPreview

      public final Object getEnablePullRequestPreview()
      Description copied from interface: CfnBranchProps
      Specifies whether Amplify Hosting creates a preview for each pull request that is made for this branch.

      If this property is enabled, Amplify 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, Amplify 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 .

      Specified by:
      getEnablePullRequestPreview in interface CfnBranchProps

    • getEnvironmentVariables

      public final Object getEnvironmentVariables()
      Description copied from interface: CfnBranchProps
      The environment variables for the branch.
      Specified by:
      getEnvironmentVariables in interface CfnBranchProps

    • getFramework

      public final String getFramework()
      Description copied from interface: CfnBranchProps
      The framework for the branch.
      Specified by:
      getFramework in interface CfnBranchProps

    • getPullRequestEnvironmentName

      public final String getPullRequestEnvironmentName()
      Description copied from interface: CfnBranchProps
      If pull request previews are enabled for this branch, you can use this property to specify a dedicated backend environment for your previews.

      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, Amplify Hosting provides backend support for each preview by automatically provisioning a temporary backend environment. Amplify Hosting 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).*

      Specified by:
      getPullRequestEnvironmentName in interface CfnBranchProps

    • getStage

      public final String getStage()
      Description copied from interface: CfnBranchProps
      Describes the current stage for the branch.

      Valid Values: PRODUCTION | BETA | DEVELOPMENT | EXPERIMENTAL | PULL_REQUEST

      Specified by:
      getStage in interface CfnBranchProps

    • getTags

      public final List<CfnTag> getTags()
      Description copied from interface: CfnBranchProps
      The tag for the branch.
      Specified by:
      getTags in interface CfnBranchProps

    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object