Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Interface CreateBranchCommandInputProtected

The input for CreateBranchCommand.

Hierarchy

Properties

appId backendEnvironmentArn? basicAuthCredentials? branchName buildSpec? description? displayName? enableAutoBuild? enableBasicAuth? enableNotification? enablePerformanceMode? enablePullRequestPreview? environmentVariables? framework? pullRequestEnvironmentName? stage? tags? ttl?

Properties

appId

appId: undefined | string

The unique ID for an Amplify app.

Optional backendEnvironmentArn

backendEnvironmentArn?: string

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

Optional basicAuthCredentials

basicAuthCredentials?: string

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

branchName

branchName: undefined | string

The name for the branch.

Optional buildSpec

buildSpec?: string

The build specification (build spec) for the branch.

Optional description

description?: string

The description for the branch.

Optional displayName

displayName?: string

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

Optional enableAutoBuild

enableAutoBuild?: boolean

Enables auto building for the branch.

Optional enableBasicAuth

enableBasicAuth?: boolean

Enables basic authorization for the branch.

Optional enableNotification

enableNotification?: boolean

Enables notifications for the branch.

Optional enablePerformanceMode

enablePerformanceMode?: boolean

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.

Optional enablePullRequestPreview

enablePullRequestPreview?: boolean

Enables pull request previews for this branch.

Optional environmentVariables

environmentVariables?: Record<string, string>

The environment variables for the branch.

Optional framework

framework?: string

The framework for the branch.

Optional pullRequestEnvironmentName

pullRequestEnvironmentName?: string

The Amplify environment name for the pull request.

Optional stage

stage?: string

Describes the current stage for the branch.

Optional tags

tags?: Record<string, string>

The tag for the branch.

Optional ttl

ttl?: string

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

Settings

Member Visibility

Theme