CreateBranchRequest
import type { CreateBranchRequest } from "https://aws-api.deno.dev/v0.4/services/amplify.ts?docs=full";
The request structure for the create branch request.
interface CreateBranchRequest {
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?: {} | null;
[key: string]: string | null | undefined;
framework?: string | null;
pullRequestEnvironmentName?: string | null;
stage?: Stage | null;
tags?: {} | null;
[key: string]: string | null | undefined;
ttl?: string | null;
}§Properties
§
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
.
§
displayName?: string | null
[src]The display name for a branch. This is used as the default domain prefix.
§
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.