Branch

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

The branch for an Amplify app, which maps to a third-party repository branch.

interface Branch {

activeJobId: string;

associatedResources?: string[] | null;

backendEnvironmentArn?: string | null;

basicAuthCredentials?: string | null;

branchArn: string;

branchName: string;

buildSpec?: string | null;

createTime: Date | number;

customDomains: string[];

description: string;

destinationBranch?: string | null;

displayName: string;

enableAutoBuild: boolean;

enableBasicAuth: boolean;

enableNotification: boolean;

enablePerformanceMode?: boolean | null;

enablePullRequestPreview: boolean;

environmentVariables: {

[key: string]: string | null | undefined;

};

framework: string;

pullRequestEnvironmentName?: string | null;

sourceBranch?: string | null;

stage: Stage;

tags?: {

[key: string]: string | null | undefined;

} | null;

thumbnailUrl?: string | null;

totalNumberOfJobs: string;

ttl: string;

updateTime: Date | number;

}

§Properties

activeJobId: string

[src]

The ID of the active job for a branch of an Amplify app.

associatedResources?: string[] | null

[src]

A list of custom resources that are linked to this branch.

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 a branch of an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.

branchArn: string

[src]

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

branchName: string

[src]

The name for the branch that is part of an Amplify app.

buildSpec?: string | null

[src]

The build specification (build spec) content for the branch of an Amplify app.

createTime: Date | number

[src]

The creation date and time for a branch that is part of an Amplify app.

customDomains: string[]

[src]

The custom domains for a branch of an Amplify app.

description: string

[src]

The description for the branch that is part of an Amplify app.

destinationBranch?: string | null

[src]

The destination branch if the branch is a pull request branch.

displayName: string

[src]

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

enableAutoBuild: boolean

[src]

Enables auto-building on push for a branch of an Amplify app.

enableBasicAuth: boolean

[src]

Enables basic authorization for a branch of an Amplify app.

enableNotification: boolean

[src]

Enables notifications for a branch that is part of an Amplify app.

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

[src]

Enables pull request previews for the branch.

environmentVariables: {

[key: string]: string | null | undefined;

}

[src]

The environment variables specific to a branch of an Amplify app.

framework: string

[src]

The framework for a branch of an Amplify app.

pullRequestEnvironmentName?: string | null