AWS::Cases::Template - Amazon CloudFormation
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::Template

Creates a template in the Cases domain. This template is used to define the case object model (that is, to define what data can be captured on cases) in a Cases domain. A template must have a unique name within a domain, and it must reference existing field IDs and layout IDs. Additionally, multiple fields with same IDs are not allowed within the same Template. A template can be either Active or Inactive, as indicated by its status. Inactive templates cannot be used to create cases.

Other template APIs are:

Syntax

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

JSON

{ "Type" : "AWS::Cases::Template", "Properties" : { "Description" : String, "DomainId" : String, "LayoutConfiguration" : LayoutConfiguration, "Name" : String, "RequiredFields" : [ RequiredField, ... ], "Rules" : [ TemplateRule, ... ], "Status" : String, "Tags" : [ Tag, ... ] } }

YAML

Type: AWS::Cases::Template Properties: Description: String DomainId: String LayoutConfiguration: LayoutConfiguration Name: String RequiredFields: - RequiredField Rules: - TemplateRule Status: String Tags: - Tag

Properties

Description

A brief description of the template.

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.

LayoutConfiguration

Object to store configuration of layouts associated to the template.

Required: No

Type: LayoutConfiguration

Update requires: No interruption

Name

The template name.

Required: Yes

Type: String

Pattern: ^.*[\S]$

Minimum: 1

Maximum: 100

Update requires: No interruption

RequiredFields

A list of fields that must contain a value for a case to be successfully created with this template.

Required: No

Type: Array of RequiredField

Maximum: 100

Update requires: No interruption

Rules

A list of case rules (also known as case field conditions) on a template.

Required: No

Type: Array of TemplateRule

Maximum: 50

Update requires: No interruption

Status

The status of the template.

Required: No

Type: String

Allowed values: Active | Inactive

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

Return values

Ref

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

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

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.

LastModifiedTime

Timestamp at which the resource was created or last modified.

TemplateArn

The Amazon Resource Name (ARN) of the template.

TemplateId

A unique identifier of a template.