AWS Documentation » AWS CloudFormation » User Guide » Amplify Console Resource Type Reference » AWS::Amplify::App

Filter View: All JSON YAML

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,
      "CustomRules" : [ CustomRule, ... ],
      "Description" : String,
      "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
  CustomRules: 
    - CustomRule
  Description: String
  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

Credentials for Basic Authorization for an Amplify App.

Required: No

Type: BasicAuthConfig

Update requires: No interruption

BuildSpec

BuildSpec for an Amplify App

Required: No

Type: String

Update requires: No interruption

CustomRules

Custom rewrite / redirect rules for an Amplify App.

Required: No

Type: List of CustomRule

Update requires: No interruption

Description

Description for an Amplify App

Required: No

Type: String

Update requires: No interruption

EnvironmentVariables

Environment variables map for an Amplify App.

Required: No

Type: List of EnvironmentVariable

Update requires: No interruption

IAMServiceRole

IAM service role ARN for the Amplify App.

Required: No

Type: String

Update requires: No interruption

Name

Name for the Amplify App

Required: Yes

Type: String

Update requires: No interruption

OauthToken

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

Required: No

Type: String

Update requires: No interruption

Repository

Repository for an Amplify App

Required: No

Type: String

Update requires: No interruption

Tags

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.