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::Field
<a name="aws-resource-cases-field"></a>

Creates a field in the Cases domain. This field is used to define the case object model (that is, defines what data can be captured on cases) in a Cases domain. 

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

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

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

```
{
  "Type" : "AWS::Cases::Field",
  "Properties" : {
      "[Attributes](#cfn-cases-field-attributes)" : FieldAttributes,
      "[Description](#cfn-cases-field-description)" : String,
      "[DomainId](#cfn-cases-field-domainid)" : String,
      "[Name](#cfn-cases-field-name)" : String,
      "[Tags](#cfn-cases-field-tags)" : [ Tag, ... ],
      "[Type](#cfn-cases-field-type)" : String
    }
}
```

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

```
Type: AWS::Cases::Field
Properties:
  [Attributes](#cfn-cases-field-attributes): 
    FieldAttributes
  [Description](#cfn-cases-field-description): String
  [DomainId](#cfn-cases-field-domainid): String
  [Name](#cfn-cases-field-name): String
  [Tags](#cfn-cases-field-tags): 
    - Tag
  [Type](#cfn-cases-field-type): String
```

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

`Attributes`  <a name="cfn-cases-field-attributes"></a>
Union of field attributes.  
*Required*: No  
*Type*: [FieldAttributes](aws-properties-cases-field-fieldattributes.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Description`  <a name="cfn-cases-field-description"></a>
Description of the field.  
*Required*: No  
*Type*: String  
*Maximum*: `255`  
*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-field-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-field-name"></a>
Name of the field.  
*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-field-tags"></a>
An array of key-value pairs to apply to this resource.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-cases-field-tag.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Type`  <a name="cfn-cases-field-type"></a>
Type of the field.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `Text | Number | Boolean | DateTime | SingleSelect | Url | User`  
*Update requires*: Updates are not supported.

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

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

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

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

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-field-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-field-return-values-fn--getatt-fn--getatt"></a>

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

`FieldArn`  <a name="FieldArn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the field.

`FieldId`  <a name="FieldId-fn::getatt"></a>
Unique identifier of the field.

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

`Namespace`  <a name="Namespace-fn::getatt"></a>
Namespace of the field.

# AWS::Cases::Field FieldAttributes
<a name="aws-properties-cases-field-fieldattributes"></a>

Union of field attributes.

## Syntax
<a name="aws-properties-cases-field-fieldattributes-syntax"></a>

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

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

```
{
  "[Text](#cfn-cases-field-fieldattributes-text)" : TextAttributes
}
```

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

```
  [Text](#cfn-cases-field-fieldattributes-text): 
    TextAttributes
```

## Properties
<a name="aws-properties-cases-field-fieldattributes-properties"></a>

`Text`  <a name="cfn-cases-field-fieldattributes-text"></a>
Field attributes for Text field type.  
*Required*: No  
*Type*: [TextAttributes](aws-properties-cases-field-textattributes.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::Field Tag
<a name="aws-properties-cases-field-tag"></a>

A key-value pair to associate with a resource.

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

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

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

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

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

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

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

`Key`  <a name="cfn-cases-field-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-field-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)

# AWS::Cases::Field TextAttributes
<a name="aws-properties-cases-field-textattributes"></a>

Field attributes for Text field type.

## Syntax
<a name="aws-properties-cases-field-textattributes-syntax"></a>

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

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

```
{
  "[IsMultiline](#cfn-cases-field-textattributes-ismultiline)" : Boolean
}
```

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

```
  [IsMultiline](#cfn-cases-field-textattributes-ismultiline): Boolean
```

## Properties
<a name="aws-properties-cases-field-textattributes-properties"></a>

`IsMultiline`  <a name="cfn-cases-field-textattributes-ismultiline"></a>
Attribute that defines rendering component and validation.  
*Required*: Yes  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)