Class BranchOptions.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.amplify.BranchOptions.Jsii$Proxy
All Implemented Interfaces:
BranchOptions, software.amazon.jsii.JsiiSerializable
Enclosing interface:
BranchOptions

@Stability(Experimental) @Internal public static final class BranchOptions.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements BranchOptions
An implementation for BranchOptions
  • 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(BranchOptions.Builder builder)
      Constructor that initializes the object based on literal property values passed by the BranchOptions.Builder.
  • Method Details

    • getAsset

      public final Asset getAsset()
      Description copied from interface: BranchOptions
      (experimental) Asset for deployment.

      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

      Specified by:
      getAsset in interface BranchOptions
    • getAutoBuild

      public final Boolean getAutoBuild()
      Description copied from interface: BranchOptions
      (experimental) Whether to enable auto building for the branch.

      Default: true

      Specified by:
      getAutoBuild in interface BranchOptions
    • getBasicAuth

      public final BasicAuth getBasicAuth()
      Description copied from interface: BranchOptions
      (experimental) The Basic Auth configuration.

      Use this to set password protection for the branch

      Default: - no password protection

      Specified by:
      getBasicAuth in interface BranchOptions
    • getBranchName

      public final String getBranchName()
      Description copied from interface: BranchOptions
      (experimental) The name of the branch.

      Default: - the construct's id

      Specified by:
      getBranchName in interface BranchOptions
    • getBuildSpec

      public final BuildSpec getBuildSpec()
      Description copied from interface: BranchOptions
      (experimental) BuildSpec for the branch.

      Default: - no build spec

      Specified by:
      getBuildSpec in interface BranchOptions
      See Also:
    • getDescription

      public final String getDescription()
      Description copied from interface: BranchOptions
      (experimental) A description for the branch.

      Default: - no description

      Specified by:
      getDescription in interface BranchOptions
    • getEnvironmentVariables

      public final Map<String,String> getEnvironmentVariables()
      Description copied from interface: BranchOptions
      (experimental) Environment variables for the branch.

      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

      Specified by:
      getEnvironmentVariables in interface BranchOptions
    • getPerformanceMode

      public final Boolean getPerformanceMode()
      Description copied from interface: BranchOptions
      (experimental) 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.

      Default: false

      Specified by:
      getPerformanceMode in interface BranchOptions
    • getPullRequestEnvironmentName

      public final String getPullRequestEnvironmentName()
      Description copied from interface: BranchOptions
      (experimental) The dedicated backend environment for the pull request previews.

      Default: - automatically provision a temporary backend

      Specified by:
      getPullRequestEnvironmentName in interface BranchOptions
    • getPullRequestPreview

      public final Boolean getPullRequestPreview()
      Description copied from interface: BranchOptions
      (experimental) Whether to enable pull request preview for the branch.

      Default: true

      Specified by:
      getPullRequestPreview in interface BranchOptions
    • getStage

      public final String getStage()
      Description copied from interface: BranchOptions
      (experimental) Stage for the branch.

      Default: - no stage

      Specified by:
      getStage in interface BranchOptions
    • $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