AWS::Amplify::App

The AWS::Amplify::App resource creates Apps in the Amplify Console. An App is a collection of branches.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Amplify::App",
  "Properties" : {
      "AccessToken" : String,
      "AutoBranchCreationConfig" : AutoBranchCreationConfig,
      "BasicAuthConfig" : BasicAuthConfig,
      "BuildSpec" : String,
      "CustomHeaders" : String,
      "CustomRules" : [ CustomRule, ... ],
      "Description" : String,
      "EnableBranchAutoDeletion" : Boolean,
      "EnvironmentVariables" : [ EnvironmentVariable, ... ],
      "IAMServiceRole" : String,
      "Name" : String,
      "OauthToken" : String,
      "Repository" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::Amplify::App
Properties: 
  AccessToken: String
  AutoBranchCreationConfig: 
    AutoBranchCreationConfig
  BasicAuthConfig: 
    BasicAuthConfig
  BuildSpec: String
  CustomHeaders: String
  CustomRules: 
    - CustomRule
  Description: String
  EnableBranchAutoDeletion: Boolean
  EnvironmentVariables: 
    - EnvironmentVariable
  IAMServiceRole: String
  Name: String
  OauthToken: String
  Repository: String
  Tags: 
    - Tag

Properties

AccessToken

Personal Access token for 3rd party source control system for an Amplify App, used to create webhook and read-only deploy key. Token is not stored.

Required: No

Type: String

Update requires: No interruption

AutoBranchCreationConfig

Sets the configuration for your automatic branch creation.

Required: No

Type: AutoBranchCreationConfig

Update requires: No interruption

BasicAuthConfig

The credentials for basic authorization for an Amplify app.

Required: No

Type: BasicAuthConfig

Update requires: No interruption

BuildSpec

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

Required: No

Type: String

Update requires: No interruption

CustomHeaders

The custom HTTP headers for an Amplify app.

Required: No

Type: String

Update requires: No interruption

CustomRules

The custom rewrite and redirect rules for an Amplify app.

Required: No

Type: List of CustomRule

Update requires: No interruption

Description

The description for an Amplify app.

Required: No

Type: String

Update requires: No interruption

EnableBranchAutoDeletion

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

Required: No

Type: Boolean

Update requires: No interruption

EnvironmentVariables

The environment variables map for an Amplify app.

Required: No

Type: List of EnvironmentVariable

Update requires: No interruption

IAMServiceRole

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

Required: No

Type: String

Update requires: No interruption

Name

The name for an Amplify app.

Required: Yes

Type: String

Update requires: No interruption

OauthToken

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. The OAuth token is not stored.

Required: No

Type: String

Update requires: No interruption

Repository

The repository for an Amplify app.

Required: No

Type: String

Update requires: No interruption

Tags

The tag for an Amplify app.

Required: No

Type: List of Tag

Update requires: No interruption

Return values

Fn::GetAtt

AppId

Unique Id for the Amplify App.

AppName

Name for the Amplify App.

Arn

ARN for the Amplify App.

DefaultDomain

Default domain for the Amplify App.