Skip to content
v2.274.0

CfnTemplateProps Struct ​

Properties for defining a CfnTemplate.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cases as cases } from 'aws-cdk-lib';
const cfnTemplateProps: cases.CfnTemplateProps = {
  name: 'name',

  // the properties below are optional
  description: 'description',
  domainId: 'domainId',
  layoutConfiguration: {
    defaultLayout: 'defaultLayout',
  },
  requiredFields: [{
    fieldId: 'fieldId',
  }],
  rules: [{
    caseRuleId: 'caseRuleId',

    // the properties below are optional
    fieldId: 'fieldId',
  }],
  status: 'status',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
A brief description of the template.
domainIdoptionalstringdomain_idoptionalstrdomainIdoptionalStringDomainIdoptionalstringDomainIdoptional*string#
The unique identifier of the Cases domain.
layoutConfigurationoptionalIResolvable | CfnTemplate.LayoutConfigurationPropertylayout_configurationoptionaltyping.Union[IResolvable, LayoutConfigurationProperty]layoutConfigurationoptionalIResolvableLayoutConfigurationoptionalIResolvableLayoutConfigurationoptionalinterface{}#
Object to store configuration of layouts associated to the template.
namestringnamestrnameStringNamestringName*stringrequired#
The template name.
requiredFieldsoptionalIResolvable | IResolvable | CfnTemplate.RequiredFieldProperty[]required_fieldsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, RequiredFieldProperty]]]requiredFieldsoptionalIResolvableRequiredFieldsoptionalIResolvableRequiredFieldsoptionalinterface{}#
A list of fields that must contain a value for a case to be successfully created with this template.
rulesoptionalIResolvable | IResolvable | CfnTemplate.TemplateRuleProperty[]rulesoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, TemplateRuleProperty]]]rulesoptionalIResolvableRulesoptionalIResolvableRulesoptionalinterface{}#
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.
statusoptionalstringstatusoptionalstrstatusoptionalStringStatusoptionalstringStatusoptional*string#
The status of the template.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
An array of key-value pairs to apply to this resource.