interface CfnTemplateProps
| Language | Type name |
|---|---|
.NET | Amazon.CDK.AWS.Cases.CfnTemplateProps |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awscases#CfnTemplateProps |
Java | software.amazon.awscdk.services.cases.CfnTemplateProps |
Python | aws_cdk.aws_cases.CfnTemplateProps |
TypeScript | aws-cdk-lib » aws_cases » CfnTemplateProps |
Properties for defining a CfnTemplate.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cases-template.html
Example
// 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
| Name | Type | Description |
|---|---|---|
| name | string | The template name. |
| description? | string | A brief description of the template. |
| domain | string | The unique identifier of the Cases domain. |
| layout | IResolvable | Layout | Object to store configuration of layouts associated to the template. |
| required | IResolvable | (IResolvable | Required)[] | A list of fields that must contain a value for a case to be successfully created with this template. |
| rules? | IResolvable | (IResolvable | Template)[] | A list of case rules (also known as case field conditions ) on a template. |
| status? | string | The status of the template. |
| tags? | Cfn[] | An array of key-value pairs to apply to this resource. |
name
Type:
string
The template name.
description?
Type:
string
(optional)
A brief description of the template.
domainId?
Type:
string
(optional)
The unique identifier of the Cases domain.
layoutConfiguration?
Type:
IResolvable | Layout
(optional)
Object to store configuration of layouts associated to the template.
requiredFields?
Type:
IResolvable | (IResolvable | Required)[]
(optional)
A list of fields that must contain a value for a case to be successfully created with this template.
rules?
Type:
IResolvable | (IResolvable | Template)[]
(optional)
A list of case rules (also known as case field conditions ) on a template.
status?
Type:
string
(optional)
The status of the template.
tags?
Type:
Cfn[]
(optional)
An array of key-value pairs to apply to this resource.

.NET
Go
Java
Python
TypeScript