App - Amplify

App

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

Contents

appArn

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

Type: String

Length Constraints: Maximum length of 1000.

Required: Yes

appId

The unique ID of the Amplify app.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 20.

Pattern: d[a-z0-9]+

Required: Yes

autoBranchCreationConfig

Describes the automated branch creation configuration for the Amplify app.

Type: AutoBranchCreationConfig object

Required: No

autoBranchCreationPatterns

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

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: (?s).+

Required: No

basicAuthCredentials

The basic authorization credentials for branches for the Amplify app.

Type: String

Length Constraints: Maximum length of 2000.

Pattern: (?s).*

Required: No

buildSpec

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 25000.

Pattern: (?s).+

Required: No

createTime

Creates a date and time for the Amplify app.

Type: Timestamp

Required: Yes

customHeaders

Describes the custom HTTP headers for the Amplify app.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 25000.

Pattern: (?s).*

Required: No

customRules

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

Type: Array of CustomRule objects

Required: No

defaultDomain

The default domain for the Amplify app.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1000.

Required: Yes

description

The description for the Amplify app.

Type: String

Length Constraints: Maximum length of 1000.

Pattern: (?s).*

Required: Yes

enableAutoBranchCreation

Enables automated branch creation for the Amplify app.

Type: Boolean

Required: No

enableBasicAuth

Enables basic authorization for the Amplify app's branches.

Type: Boolean

Required: Yes

enableBranchAutoBuild

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

Type: Boolean

Required: Yes

enableBranchAutoDeletion

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

Type: Boolean

Required: No

environmentVariables

The environment variables for the Amplify app.

Type: String to string map

Key Length Constraints: Maximum length of 255.

Key Pattern: (?s).*

Value Length Constraints: Maximum length of 5500.

Value Pattern: (?s).*

Required: Yes

iamServiceRoleArn

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1000.

Pattern: (?s).*

Required: No

name

The name for the Amplify app.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: (?s).+

Required: Yes

platform

The platform for the Amplify app.

Type: String

Valid Values: WEB | WEB_DYNAMIC

Required: Yes

productionBranch

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

Type: ProductionBranch object

Required: No

repository

The repository for the Amplify app.

Type: String

Length Constraints: Maximum length of 1000.

Pattern: (?s).*

Required: Yes

tags

The tag for the Amplify app.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$

Value Length Constraints: Maximum length of 256.

Value Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

Required: No

updateTime

Updates the date and time for the Amplify app.

Type: Timestamp

Required: Yes

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: