AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::Cases::Template

CfnTemplate

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: - [DeleteTemplate](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_DeleteTemplate.html) - [GetTemplate](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_GetTemplate.html) - [ListTemplates](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_ListTemplates.html) - [UpdateTemplate](https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_UpdateTemplate.html)

Import

import { CfnTemplate } from 'aws-cdk-lib/aws-cases';

Or use the module namespace:

import * as cases from 'aws-cdk-lib/aws-cases';
// cases.CfnTemplate

Properties

Configuration passed to the constructor as CfnTemplateProps.

nameRequired
string

The template name.

descriptionOptional
string

A brief description of the template.

domainIdOptional
string

The unique identifier of the Cases domain.

layoutConfigurationOptional
IResolvable | LayoutConfigurationProperty

Object to store configuration of layouts associated to the template.

requiredFieldsOptional
IResolvable | IResolvable | RequiredFieldProperty[]

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

rulesOptional
IResolvable | IResolvable | TemplateRuleProperty[]

A list of case rules (also known as [case field conditions](https://docs.aws.amazon.com/connect/latest/adminguide/case-field-conditions.html) ) on a template.

statusOptional
string

The status of the template.

tagsOptional
CfnTag[]

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

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::Cases::TemplateView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-cases
CFN TypeAWS::Cases::Template
Properties8

Related Constructs

Explore This Service

External Links