Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1437207152.4 KB

Creates a new Amplify app.

post/apps

Request body

namestring required

The name for an Amplify app.

descriptionstring

The description for an Amplify app.

repositorystring

The repository for an Amplify app.

platform'WEB' | 'WEB_DYNAMIC' | 'WEB_COMPUTE'

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

iamServiceRoleArnstring

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

oauthTokenstring password
<p>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.</p> <p>Use <code>oauthToken</code> for repository providers other than GitHub, such as Bitbucket or CodeCommit. To authorize access to GitHub as your repository provider, use <code>accessToken</code>.</p> <p>You must specify either <code>oauthToken</code> or <code>accessToken</code> when you create a new app.</p> <p>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 <a href="https://docs.aws.amazon.com/amplify/latest/UserGuide/setting-up-GitHub-access.html#migrating-to-github-app-auth">Migrating an existing OAuth app to the Amplify GitHub App</a> in the <i>Amplify User Guide</i> .</p>
accessTokenstring password
<p>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.</p> <p>Use <code>accessToken</code> for GitHub repositories only. To authorize access to a repository provider such as Bitbucket or CodeCommit, use <code>oauthToken</code>.</p> <p>You must specify either <code>accessToken</code> or <code>oauthToken</code> when you create a new app.</p> <p>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 <a href="https://docs.aws.amazon.com/amplify/latest/UserGuide/setting-up-GitHub-access.html#migrating-to-github-app-auth">Migrating an existing OAuth app to the Amplify GitHub App</a> in the <i>Amplify User Guide</i> .</p>
environmentVariablesobject

The environment variables map for an Amplify app.

enableBranchAutoBuildboolean

Enables the auto building of branches for an Amplify app.

enableBranchAutoDeletionboolean

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

enableBasicAuthboolean

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

basicAuthCredentialsstring password

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

tagsobject

The tag for an Amplify app.

buildSpecstring password

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

customHeadersstring

The custom HTTP headers for an Amplify app.

enableAutoBranchCreationboolean

Enables automated branch creation for an Amplify app.

autoBranchCreationPatternsAutoBranchCreationPattern[]

The automated branch creation glob patterns for an Amplify app.

Response

Success