Class CreateBranchRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.amplify.model.AmplifyRequest
software.amazon.awssdk.services.amplify.model.CreateBranchRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateBranchRequest.Builder,CreateBranchRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateBranchRequest extends AmplifyRequest implements ToCopyableBuilder<CreateBranchRequest.Builder,CreateBranchRequest>

The request structure for the create branch request.

  • Method Details

    • appId

      public final String appId()

      The unique ID for an Amplify app.

      Returns:
      The unique ID for an Amplify app.

    • branchName

      public final String branchName()

      The name for the branch.

      Returns:
      The name for the branch.

    • description

      public final String description()

      The description for the branch.

      Returns:
      The description for the branch.

    • stage

      public final Stage stage()

      Describes the current stage for the branch.

      If the service returns an enum value that is not available in the current SDK version, stage will return Stage.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stageAsString().

      Returns:
      Describes the current stage for the branch.
      See Also:

    • stageAsString

      public final String stageAsString()

      Describes the current stage for the branch.

      If the service returns an enum value that is not available in the current SDK version, stage will return Stage.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stageAsString().

      Returns:
      Describes the current stage for the branch.
      See Also:

    • framework

      public final String framework()

      The framework for the branch.

      Returns:
      The framework for the branch.

    • enableNotification

      public final Boolean enableNotification()

      Enables notifications for the branch.

      Returns:
      Enables notifications for the branch.

    • enableAutoBuild

      public final Boolean enableAutoBuild()

      Enables auto building for the branch.

      Returns:
      Enables auto building for the branch.

    • enableSkewProtection

      public final Boolean enableSkewProtection()

      Specifies whether the skew protection feature is enabled for the branch.

      Deployment skew protection is available to Amplify applications to eliminate version skew issues between client and servers in web applications. When you apply skew protection to a branch, you can ensure that your clients always interact with the correct version of server-side assets, regardless of when a deployment occurs. For more information about skew protection, see Skew protection for Amplify deployments in the Amplify User Guide.

      Returns:
      Specifies whether the skew protection feature is enabled for the branch.

      Deployment skew protection is available to Amplify applications to eliminate version skew issues between client and servers in web applications. When you apply skew protection to a branch, you can ensure that your clients always interact with the correct version of server-side assets, regardless of when a deployment occurs. For more information about skew protection, see Skew protection for Amplify deployments in the Amplify User Guide.

    • hasEnvironmentVariables

      public final boolean hasEnvironmentVariables()
      For responses, this returns true if the service returned a value for the EnvironmentVariables property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • environmentVariables

      public final Map<String,String> environmentVariables()

      The environment variables for the branch.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEnvironmentVariables() method.

      Returns:
      The environment variables for the branch.

    • basicAuthCredentials

      public final String basicAuthCredentials()

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

      Returns:
      The basic authorization credentials for the branch. You must base64-encode the authorization credentials and provide them in the format user:password.

    • enableBasicAuth

      public final Boolean enableBasicAuth()

      Enables basic authorization for the branch.

      Returns:
      Enables basic authorization for the branch.

    • enablePerformanceMode

      public final Boolean enablePerformanceMode()

      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.

      Returns:
      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.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final Map<String,String> tags()

      The tag for the branch.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      The tag for the branch.

    • buildSpec

      public final String buildSpec()

      The build specification (build spec) for the branch.

      Returns:
      The build specification (build spec) for the branch.

    • ttl

      public final String ttl()

      The content Time To Live (TTL) for the website in seconds.

      Returns:
      The content Time To Live (TTL) for the website in seconds.

    • displayName

      public final String displayName()

      The display name for a branch. This is used as the default domain prefix.

      Returns:
      The display name for a branch. This is used as the default domain prefix.

    • enablePullRequestPreview

      public final Boolean enablePullRequestPreview()

      Enables pull request previews for this branch.

      Returns:
      Enables pull request previews for this branch.

    • pullRequestEnvironmentName

      public final String pullRequestEnvironmentName()

      The Amplify environment name for the pull request.

      Returns:
      The Amplify environment name for the pull request.

    • backendEnvironmentArn

      public final String backendEnvironmentArn()

      The Amazon Resource Name (ARN) for a backend environment that is part of a Gen 1 Amplify app.

      This field is available to Amplify Gen 1 apps only where the backend is created using Amplify Studio or the Amplify command line interface (CLI).

      Returns:
      The Amazon Resource Name (ARN) for a backend environment that is part of a Gen 1 Amplify app.

      This field is available to Amplify Gen 1 apps only where the backend is created using Amplify Studio or the Amplify command line interface (CLI).

    • backend

      public final Backend backend()

      The backend for a Branch of an Amplify app. Use for a backend created from an CloudFormation stack.

      This field is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.

      Returns:
      The backend for a Branch of an Amplify app. Use for a backend created from an CloudFormation stack.

      This field is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.

    • computeRoleArn

      public final String computeRoleArn()

      The Amazon Resource Name (ARN) of the IAM role to assign to a branch of an SSR app. The SSR Compute role allows the Amplify Hosting compute service to securely access specific Amazon Web Services resources based on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User Guide.

      Returns:
      The Amazon Resource Name (ARN) of the IAM role to assign to a branch of an SSR app. The SSR Compute role allows the Amplify Hosting compute service to securely access specific Amazon Web Services resources based on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User Guide.

    • toBuilder

      public CreateBranchRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateBranchRequest.Builder,CreateBranchRequest>
      Specified by:
      toBuilder in class AmplifyRequest
      Returns:
      a builder for type T

    • builder

      public static CreateBranchRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateBranchRequest.Builder> serializableBuilderClass()

    • hashCode

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

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.