Documentation

Represents the different branches of a repository for building, deploying, and hosting an Amplify app.

See: newApp smart constructor.

Create a value of App with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:autoBranchCreationConfig:App', app_autoBranchCreationConfig - Describes the automated branch creation configuration for the Amplify app.

$sel:autoBranchCreationPatterns:App', app_autoBranchCreationPatterns - Describes the automated branch creation glob patterns for the Amplify app.

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

App, app_buildSpec - Describes the content of the build specification (build spec) for the Amplify app.

$sel:customHeaders:App', app_customHeaders - Describes the custom HTTP headers for the Amplify app.

$sel:customRules:App', app_customRules - Describes the custom redirect and rewrite rules for the Amplify app.

$sel:enableAutoBranchCreation:App', app_enableAutoBranchCreation - Enables automated branch creation for the Amplify app.

$sel:enableBranchAutoDeletion:App', app_enableBranchAutoDeletion - Automatically disconnect a branch in the Amplify Console when you delete a branch from your Git repository.

$sel:iamServiceRoleArn:App', app_iamServiceRoleArn - The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app.

$sel:productionBranch:App', app_productionBranch - Describes the information about a production branch of the Amplify app.

$sel:repositoryCloneMethod:App', app_repositoryCloneMethod - This is for internal use.

The Amplify service uses this parameter to specify the authentication protocol to use to access the Git repository for an Amplify app. Amplify specifies TOKEN for a GitHub repository, SIGV4 for an Amazon Web Services CodeCommit repository, and SSH for GitLab and Bitbucket repositories.

$sel:tags:App', app_tags - The tag for the Amplify app.

$sel:appId:App', app_appId - The unique ID of the Amplify app.

$sel:appArn:App', app_appArn - The Amazon Resource Name (ARN) of the Amplify app.

$sel:name:App', app_name - The name for the Amplify app.

$sel:description:App', app_description - The description for the Amplify app.

$sel:repository:App', app_repository - The Git repository for the Amplify app.

$sel:platform:App', app_platform - 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.

$sel:createTime:App', app_createTime - Creates a date and time for the Amplify app.

$sel:updateTime:App', app_updateTime - Updates the date and time for the Amplify app.

App, app_environmentVariables - The environment variables for the Amplify app.

$sel:defaultDomain:App', app_defaultDomain - The default domain for the Amplify app.

$sel:enableBranchAutoBuild:App', app_enableBranchAutoBuild - Enables the auto-building of branches for the Amplify app.

App, app_enableBasicAuth - Enables basic authorization for the Amplify app's branches.

Describes the automated branch creation configuration for the Amplify app.

Describes the automated branch creation glob patterns for the Amplify app.

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

Describes the content of the build specification (build spec) for the Amplify app.

Describes the custom HTTP headers for the Amplify app.

Describes the custom redirect and rewrite rules for the Amplify app.

Enables automated branch creation for the Amplify app.

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

The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app.

Describes the information about a production branch of the Amplify app.

This is for internal use.

The Amplify service uses this parameter to specify the authentication protocol to use to access the Git repository for an Amplify app. Amplify specifies TOKEN for a GitHub repository, SIGV4 for an Amazon Web Services CodeCommit repository, and SSH for GitLab and Bitbucket repositories.

The tag for the Amplify app.

The unique ID of the Amplify app.

The Amazon Resource Name (ARN) of the Amplify app.

The name for the Amplify app.

The description for the Amplify app.

The Git repository for the Amplify app.

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.

Creates a date and time for the Amplify app.

Updates the date and time for the Amplify app.

The environment variables for the Amplify app.

The default domain for the Amplify app.

Enables the auto-building of branches for the Amplify app.

Enables basic authorization for the Amplify app's branches.