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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::Cases::Layout
<a name="aws-resource-cases-layout"></a>

Creates a layout in the Cases domain. Layouts define the following configuration in the top section and More Info tab of the Cases user interface:
+ Fields to display to the users
+ Field ordering

**Note**  
Title and Status fields cannot be part of layouts since they are not configurable.

## Syntax
<a name="aws-resource-cases-layout-syntax"></a>

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

### JSON
<a name="aws-resource-cases-layout-syntax.json"></a>

```
{
  "Type" : "AWS::Cases::Layout",
  "Properties" : {
      "[Content](#cfn-cases-layout-content)" : LayoutContent,
      "[DomainId](#cfn-cases-layout-domainid)" : String,
      "[Name](#cfn-cases-layout-name)" : String,
      "[Tags](#cfn-cases-layout-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-cases-layout-syntax.yaml"></a>

```
Type: AWS::Cases::Layout
Properties:
  [Content](#cfn-cases-layout-content): 
    LayoutContent
  [DomainId](#cfn-cases-layout-domainid): String
  [Name](#cfn-cases-layout-name): String
  [Tags](#cfn-cases-layout-tags): 
    - Tag
```

## Properties
<a name="aws-resource-cases-layout-properties"></a>

`Content`  <a name="cfn-cases-layout-content"></a>
Object to store union of different versions of layout content.  
*Required*: Yes  
*Type*: [LayoutContent](aws-properties-cases-layout-layoutcontent.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DomainId`  <a name="cfn-cases-layout-domainid"></a>
The unique identifier of the Cases domain.   
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `500`  
*Update requires*: Updates are not supported.

`Name`  <a name="cfn-cases-layout-name"></a>
The name of the layout.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^.*[\S]$`  
*Minimum*: `1`  
*Maximum*: `100`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-cases-layout-tags"></a>
An array of key-value pairs to apply to this resource.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-cases-layout-tag.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-cases-layout-return-values"></a>

### Ref
<a name="aws-resource-cases-layout-return-values-ref"></a>

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

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

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-cases-layout-return-values-fn--getatt"></a>

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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-cases-layout-return-values-fn--getatt-fn--getatt"></a>

`CreatedTime`  <a name="CreatedTime-fn::getatt"></a>
Timestamp at which the resource was created.

`LastModifiedTime`  <a name="LastModifiedTime-fn::getatt"></a>
Timestamp at which the resource was created or last modified.

`LayoutArn`  <a name="LayoutArn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the newly created layout.

`LayoutId`  <a name="LayoutId-fn::getatt"></a>
The unique identifier of the layout.

# AWS::Cases::Layout BasicLayout
<a name="aws-properties-cases-layout-basiclayout"></a>

Content specific to `BasicLayout` type. It configures fields in the top panel and More Info tab of agent application. 

## Syntax
<a name="aws-properties-cases-layout-basiclayout-syntax"></a>

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

### JSON
<a name="aws-properties-cases-layout-basiclayout-syntax.json"></a>

```
{
  "[MoreInfo](#cfn-cases-layout-basiclayout-moreinfo)" : LayoutSections,
  "[TopPanel](#cfn-cases-layout-basiclayout-toppanel)" : LayoutSections
}
```

### YAML
<a name="aws-properties-cases-layout-basiclayout-syntax.yaml"></a>

```
  [MoreInfo](#cfn-cases-layout-basiclayout-moreinfo): 
    LayoutSections
  [TopPanel](#cfn-cases-layout-basiclayout-toppanel): 
    LayoutSections
```

## Properties
<a name="aws-properties-cases-layout-basiclayout-properties"></a>

`MoreInfo`  <a name="cfn-cases-layout-basiclayout-moreinfo"></a>
This represents sections in a tab of the page layout.  
*Required*: No  
*Type*: [LayoutSections](aws-properties-cases-layout-layoutsections.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TopPanel`  <a name="cfn-cases-layout-basiclayout-toppanel"></a>
This represents sections in a panel of the page layout.  
*Required*: No  
*Type*: [LayoutSections](aws-properties-cases-layout-layoutsections.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Cases::Layout FieldGroup
<a name="aws-properties-cases-layout-fieldgroup"></a>

Object for a group of fields and associated properties.

## Syntax
<a name="aws-properties-cases-layout-fieldgroup-syntax"></a>

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

### JSON
<a name="aws-properties-cases-layout-fieldgroup-syntax.json"></a>

```
{
  "[Fields](#cfn-cases-layout-fieldgroup-fields)" : [ FieldItem, ... ],
  "[Name](#cfn-cases-layout-fieldgroup-name)" : String
}
```

### YAML
<a name="aws-properties-cases-layout-fieldgroup-syntax.yaml"></a>

```
  [Fields](#cfn-cases-layout-fieldgroup-fields): 
    - FieldItem
  [Name](#cfn-cases-layout-fieldgroup-name): String
```

## Properties
<a name="aws-properties-cases-layout-fieldgroup-properties"></a>

`Fields`  <a name="cfn-cases-layout-fieldgroup-fields"></a>
Represents an ordered list containing field related information.  
*Required*: Yes  
*Type*: Array of [FieldItem](aws-properties-cases-layout-fielditem.md)  
*Maximum*: `220`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-cases-layout-fieldgroup-name"></a>
Name of the field group.  
*Required*: No  
*Type*: String  
*Maximum*: `100`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Cases::Layout FieldItem
<a name="aws-properties-cases-layout-fielditem"></a>

Object for field related information.

## Syntax
<a name="aws-properties-cases-layout-fielditem-syntax"></a>

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

### JSON
<a name="aws-properties-cases-layout-fielditem-syntax.json"></a>

```
{
  "[Id](#cfn-cases-layout-fielditem-id)" : String
}
```

### YAML
<a name="aws-properties-cases-layout-fielditem-syntax.yaml"></a>

```
  [Id](#cfn-cases-layout-fielditem-id): String
```

## Properties
<a name="aws-properties-cases-layout-fielditem-properties"></a>

`Id`  <a name="cfn-cases-layout-fielditem-id"></a>
Unique identifier of a field.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `500`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Cases::Layout LayoutContent
<a name="aws-properties-cases-layout-layoutcontent"></a>

Object to store union of different versions of layout content.

## Syntax
<a name="aws-properties-cases-layout-layoutcontent-syntax"></a>

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

### JSON
<a name="aws-properties-cases-layout-layoutcontent-syntax.json"></a>

```
{
  "[Basic](#cfn-cases-layout-layoutcontent-basic)" : BasicLayout
}
```

### YAML
<a name="aws-properties-cases-layout-layoutcontent-syntax.yaml"></a>

```
  [Basic](#cfn-cases-layout-layoutcontent-basic): 
    BasicLayout
```

## Properties
<a name="aws-properties-cases-layout-layoutcontent-properties"></a>

`Basic`  <a name="cfn-cases-layout-layoutcontent-basic"></a>
Content specific to `BasicLayout` type. It configures fields in the top panel and More Info tab of agent application.   
*Required*: Yes  
*Type*: [BasicLayout](aws-properties-cases-layout-basiclayout.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Cases::Layout LayoutSections
<a name="aws-properties-cases-layout-layoutsections"></a>

Ordered list containing different kinds of sections that can be added. A LayoutSections object can only contain one section.

## Syntax
<a name="aws-properties-cases-layout-layoutsections-syntax"></a>

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

### JSON
<a name="aws-properties-cases-layout-layoutsections-syntax.json"></a>

```
{
  "[Sections](#cfn-cases-layout-layoutsections-sections)" : [ Section, ... ]
}
```

### YAML
<a name="aws-properties-cases-layout-layoutsections-syntax.yaml"></a>

```
  [Sections](#cfn-cases-layout-layoutsections-sections): 
    - Section
```

## Properties
<a name="aws-properties-cases-layout-layoutsections-properties"></a>

`Sections`  <a name="cfn-cases-layout-layoutsections-sections"></a>
Ordered list containing different kinds of sections that can be added. A LayoutSections object can only contain one section.  
*Required*: No  
*Type*: Array of [Section](aws-properties-cases-layout-section.md)  
*Maximum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Cases::Layout Section
<a name="aws-properties-cases-layout-section"></a>

This represents a sections within a panel or tab of the page layout.

## Syntax
<a name="aws-properties-cases-layout-section-syntax"></a>

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

### JSON
<a name="aws-properties-cases-layout-section-syntax.json"></a>

```
{
  "[FieldGroup](#cfn-cases-layout-section-fieldgroup)" : FieldGroup
}
```

### YAML
<a name="aws-properties-cases-layout-section-syntax.yaml"></a>

```
  [FieldGroup](#cfn-cases-layout-section-fieldgroup): 
    FieldGroup
```

## Properties
<a name="aws-properties-cases-layout-section-properties"></a>

`FieldGroup`  <a name="cfn-cases-layout-section-fieldgroup"></a>
Consists of a group of fields and associated properties.  
*Required*: Yes  
*Type*: [FieldGroup](aws-properties-cases-layout-fieldgroup.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Cases::Layout Tag
<a name="aws-properties-cases-layout-tag"></a>

A key-value pair to associate with a resource.

## Syntax
<a name="aws-properties-cases-layout-tag-syntax"></a>

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

### JSON
<a name="aws-properties-cases-layout-tag-syntax.json"></a>

```
{
  "[Key](#cfn-cases-layout-tag-key)" : String,
  "[Value](#cfn-cases-layout-tag-value)" : String
}
```

### YAML
<a name="aws-properties-cases-layout-tag-syntax.yaml"></a>

```
  [Key](#cfn-cases-layout-tag-key): String
  [Value](#cfn-cases-layout-tag-value): String
```

## Properties
<a name="aws-properties-cases-layout-tag-properties"></a>

`Key`  <a name="cfn-cases-layout-tag-key"></a>
The key name of the tag. You can specify a value that's 1 to 128 Unicode characters in length and can't be prefixed with `aws:`. You can use any of the following characters: the set of Unicode letters, digits, whitespace, `_`, `.`, `:`, `/`, `=`, `+`, `@`, `-`, and `"`.  
For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).  
*Required*: Yes  
*Type*: String  
*Pattern*: `^(?!aws:)[a-zA-Z+-=._:/]+$`  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-cases-layout-tag-value"></a>
The value for the tag. You can specify a value that's 1 to 256 characters in length.  
For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).  
*Required*: Yes  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)