CreateBranchRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/amazon-amplify/json-schema/amazon-amplify-create-branch-request-schema.json",
  "title": "CreateBranchRequest",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/amazon-amplify-branches-api-openapi.yml#/components/schemas/CreateBranchRequest",
  "type": "object",
  "properties": {
    "appId": {
      "type": "string",
      "description": "The unique ID for an Amplify app."
    },
    "branchName": {
      "type": "string",
      "description": "The name for the branch."
    },
    "description": {
      "type": "string",
      "description": "The description for the branch."
    },
    "stage": {
      "type": "string",
      "enum": [
        "PRODUCTION",
        "BETA",
        "DEVELOPMENT",
        "EXPERIMENTAL",
        "PULL_REQUEST"
      ],
      "description": "Describes the current stage for the branch."
    },
    "framework": {
      "type": "string",
      "description": "The framework for the branch."
    },
    "enableNotification": {
      "type": "boolean",
      "description": "Enables notifications for the branch."
    },
    "enableAutoBuild": {
      "type": "boolean",
      "description": "Enables auto building for the branch."
    },
    "enableSkewProtection": {
      "type": "boolean",
      "description": "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."
    },
    "environmentVariables": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "The environment variables for the branch."
    },
    "basicAuthCredentials": {
      "type": "string",
      "description": "The basic authorization credentials for the branch. You must base64-encode the authorization credentials and provide them in the format user:password."
    },
    "enableBasicAuth": {
      "type": "boolean",
      "description": "Enables basic authorization for the branch."
    },
    "enablePerformanceMode": {
      "type": "boolean",
      "description": "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."
    },
    "tags": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "The tag for the branch."
    },
    "buildSpec": {
      "type": "string",
      "description": "The build specification (build spec) for the branch."
    },
    "ttl": {
      "type": "string",
      "description": "The content Time To Live (TTL) for the website in seconds."
    },
    "displayName": {
      "type": "string",
      "description": "The display name for a branch. This is used as the default domain prefix."
    },
    "enablePullRequestPreview": {
      "type": "boolean",
      "description": "Enables pull request previews for this branch."
    },
    "pullRequestEnvironmentName": {
      "type": "string",
      "description": "The Amplify environment name for the pull request."
    },
    "backendEnvironmentArn": {
      "type": "string",
      "description": "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": {
      "$ref": "#/$defs/Backend"
    },
    "computeRoleArn": {
      "type": "string",
      "description": "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."
    }
  },
  "required": [
    "appId",
    "branchName"
  ],
  "$defs": {
    "Backend": {
      "type": "object",
      "properties": {
        "stackArn": {
          "type": "string",
          "description": "The Amazon Resource Name (ARN) for the CloudFormation stack."
        }
      }
    }
  }
}