Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

UpdateBranchRequest

import type { UpdateBranchRequest } from "https://aws-api.deno.dev/v0.4/services/amplify.ts?docs=full";

The request structure for the update branch request.

interface UpdateBranchRequest {
appId: string;
backendEnvironmentArn?: string | null;
basicAuthCredentials?: string | null;
branchName: string;
buildSpec?: string | null;
description?: string | null;
displayName?: string | null;
enableAutoBuild?: boolean | null;
enableBasicAuth?: boolean | null;
enableNotification?: boolean | null;
enablePerformanceMode?: boolean | null;
enablePullRequestPreview?: boolean | null;
environmentVariables?: {
[key: string]: string | null | undefined;
}
| null;
framework?: string | null;
pullRequestEnvironmentName?: string | null;
stage?: Stage | null;
ttl?: string | null;
}

§Properties

§
appId: string
[src]

The unique ID for an Amplify app.

§
backendEnvironmentArn?: string | null
[src]

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

§
basicAuthCredentials?: string | null
[src]

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

§
branchName: string
[src]

The name for the branch.

§
buildSpec?: string | null
[src]

The build specification (build spec) for the branch.

§
description?: string | null
[src]

The description for the branch.

§
displayName?: string | null
[src]

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

§
enableAutoBuild?: boolean | null
[src]

Enables auto building for the branch.

§
enableBasicAuth?: boolean | null
[src]

Enables basic authorization for the branch.

§
enableNotification?: boolean | null
[src]

Enables notifications for the branch.

§
enablePerformanceMode?: boolean | null
[src]

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 | null
[src]

Enables pull request previews for this branch.

§
environmentVariables?: {
[key: string]: string | null | undefined;
}
| null
[src]

The environment variables for the branch.

§
framework?: string | null
[src]

The framework for the branch.

§
pullRequestEnvironmentName?: string | null
[src]

The Amplify environment name for the pull request.

§
stage?: Stage | null
[src]

Describes the current stage for the branch.

§
ttl?: string | null
[src]

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