AWS::Cases::Field - 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::Field

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

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

JSON

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

YAML

Type: AWS::Cases::Field
Properties:
  Description: String
  DomainId: String
  Name: String
  Tags: 
    - Tag
  Type: String

Properties

Description

Description of the field.

Required: No

Type: String

Maximum: 255

Update requires: No interruption

DomainId

The unique identifier of the Cases domain.

Required: No

Type: String

Minimum: 1

Maximum: 500

Update requires: Updates are not supported.

Name

Name of the field.

Required: Yes

Type: String

Pattern: ^.*[\S]$

Minimum: 1

Maximum: 100

Update requires: No interruption

Tags

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

Required: No

Type: Array of Tag

Update requires: No interruption

Type

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

Ref

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 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

Timestamp at which the resource was created.

FieldArn

The Amazon Resource Name (ARN) of the field.

FieldId

Unique identifier of the field.

LastModifiedTime

Timestamp at which the resource was created or last modified.

Namespace

Namespace of the field.