CreateAppRequest

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

The request structure used to create apps in Amplify.

interface CreateAppRequest {

accessToken?: string | null;

autoBranchCreationConfig?: AutoBranchCreationConfig | null;

autoBranchCreationPatterns?: string[] | null;

basicAuthCredentials?: string | null;

buildSpec?: string | null;

customHeaders?: string | null;

customRules?: CustomRule[] | null;

description?: string | null;

enableAutoBranchCreation?: boolean | null;

enableBasicAuth?: boolean | null;

enableBranchAutoBuild?: boolean | null;

enableBranchAutoDeletion?: boolean | null;

environmentVariables?: {

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

} | null;

iamServiceRoleArn?: string | null;

name: string;

oauthToken?: string | null;

platform?: Platform | null;

repository?: string | null;

tags?: {

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

} | null;

}

§Properties

accessToken?: string | null

[src]

The personal access token for a GitHub repository for an Amplify app. The personal access token is used to authorize access to a GitHub repository using the Amplify GitHub App. The token is not stored.

Use accessToken for GitHub repositories only. To authorize access to a repository provider such as Bitbucket or CodeCommit, use oauthToken.

You must specify either accessToken or oauthToken when you create a new app.

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide .

autoBranchCreationConfig?: AutoBranchCreationConfig | null

[src]

The automated branch creation configuration for an Amplify app.

autoBranchCreationPatterns?: string[] | null

[src]

The automated branch creation glob patterns for an Amplify app.

basicAuthCredentials?: string | null

[src]

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

buildSpec?: string | null

[src]

The build specification (build spec) for an Amplify app.

customHeaders?: string | null

[src]

The custom HTTP headers for an Amplify app.

customRules?: CustomRule[] | null

[src]

The custom rewrite and redirect rules for an Amplify app.

description?: string | null

[src]

The description for an Amplify app.

enableAutoBranchCreation?: boolean | null

[src]

Enables automated branch creation for an Amplify app.

enableBasicAuth?: boolean | null

[src]

Enables basic authorization for an Amplify app. This will apply to all branches that are part of this app.

enableBranchAutoBuild?: boolean | null

[src]

Enables the auto building of branches for an Amplify app.

enableBranchAutoDeletion?: boolean | null

[src]

Automatically disconnects a branch in the Amplify Console when you delete a branch from your Git repository.

environmentVariables?: {

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

} | null

[src]

The environment variables map for an Amplify app.

iamServiceRoleArn?: string | null

[src]

The AWS Identity and Access Management (IAM) service role for an Amplify app.

name: string

[src]

The name for an Amplify app.

oauthToken?: string | null

[src]

The OAuth token for a third-party source control system for an Amplify app. The OAuth token is used to create a webhook and a read-only deploy key using SSH cloning. The OAuth token is not stored.

Use oauthToken for repository providers other than GitHub, such as Bitbucket or CodeCommit. To authorize access to GitHub as your repository provider, use accessToken.

You must specify either oauthToken or accessToken when you create a new app.

platform?: Platform | null

[src]

The platform for the Amplify app. For a static app, set the platform type to WEB. For a dynamic server-side rendered (SSR) app, set the platform type to WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR support only, set the platform type to WEB_DYNAMIC.

repository?: string | null

[src]

The repository for an Amplify app.

tags?: {

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

} | null

[src]

The tag for an Amplify app.