- Navigation Guide
@aws-sdk/client-amplify
CreateBranchCommandInput Interface
Members
Name | Type | Details |
|---|---|---|
appId Required | string | undefined | The unique ID for an Amplify app. |
branchName Required | string | undefined | The name for the branch. |
backend | Backend | undefined | The backend for a 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. |
backendEnvironmentArn | string | undefined | 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). |
basicAuthCredentials | string | undefined | The basic authorization credentials for the branch. You must base64-encode the authorization credentials and provide them in the format |
buildSpec | string | undefined | The build specification (build spec) for the branch. |
computeRoleArn | string | undefined | 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. |
description | string | undefined | The description for the branch. |
displayName | string | undefined | The display name for a branch. This is used as the default domain prefix. |
enableAutoBuild | boolean | undefined | Enables auto building for the branch. |
enableBasicAuth | boolean | undefined | Enables basic authorization for the branch. |
enableNotification | boolean | undefined | Enables notifications for the branch. |
enablePerformanceMode | boolean | undefined | 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. |
enablePullRequestPreview | boolean | undefined | Enables pull request previews for this branch. |
enableSkewProtection | boolean | undefined | 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 | Record<string, string> | undefined | The environment variables for the branch. |
framework | string | undefined | The framework for the branch. |
pullRequestEnvironmentName | string | undefined | The Amplify environment name for the pull request. |
stage | Stage | undefined | Describes the current stage for the branch. |
tags | Record<string, string> | undefined | The tag for the branch. |
ttl | string | undefined | The content Time To Live (TTL) for the website in seconds. |
Full Signature
export interface CreateBranchCommandInput extends CreateBranchRequest