AWS::Cases::Domain - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

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

AWS::Cases::Domain

Creates a domain, which is a container for all case data, such as cases, fields, templates and layouts. Each Amazon Connect instance can be associated with only one Cases domain.

Important

This will not associate your connect instance to Cases domain. Instead, use the Amazon Connect CreateIntegrationAssociation API. You need specific IAM permissions to successfully associate the Cases domain. For more information, see Onboard to Cases.

Syntax

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

JSON

{
  "Type" : "AWS::Cases::Domain",
  "Properties" : {
      "Name" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::Cases::Domain
Properties:
  Name: String
  Tags: 
    - Tag

Properties

Name

The name of the domain.

Required: Yes

Type: String

Pattern: ^.*[\S]$

Minimum: 1

Maximum: 100

Update requires: Updates are not supported.

Tags

An array of key-value pairs to apply to this resource.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ARN of the domain. For example:

arn:aws:cases:us-west-2:123456789012:domain/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

CreatedTime

The timestamp when the Cases domain was created.

DomainArn

The Amazon Resource Name (ARN) for the Cases domain.

DomainId

The unique identifier of the Cases domain.

DomainStatus

The status of the Cases domain.