AWS::Amplify::Domain SubDomainSetting - AWS CloudFormation
SyntaxProperties
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::Amplify::Domain SubDomainSetting

The SubDomainSetting property type enables you to connect a subdomain (for example, example.exampledomain.com) to a specific branch.

Syntax

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

JSON

{
  "BranchName" : String,
  "Prefix" : String
}

YAML

  BranchName: String
  Prefix: String

Properties

BranchName

The branch name setting for the subdomain.

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

Pattern: (?s).+

Required: Yes

Type: String

Pattern: (?s).+

Minimum: 1

Maximum: 255

Update requires: No interruption

Prefix

The prefix setting for the subdomain.

Required: Yes

Type: String

Pattern: (?s).*

Maximum: 255

Update requires: No interruption