CfnTemplateProps
- class aws_cdk.aws_cases.CfnTemplateProps(*, name, description=None, domain_id=None, layout_configuration=None, required_fields=None, rules=None, status=None, tags=None)
Bases:
objectProperties for defining a
CfnTemplate.- Parameters:
name (
str) – The template name.description (
Optional[str]) – A brief description of the template.domain_id (
Optional[str]) – The unique identifier of the Cases domain.layout_configuration (
Union[IResolvable,LayoutConfigurationProperty,Dict[str,Any],None]) – Object to store configuration of layouts associated to the template.required_fields (
Union[IResolvable,Sequence[Union[IResolvable,RequiredFieldProperty,Dict[str,Any]]],None]) – A list of fields that must contain a value for a case to be successfully created with this template.rules (
Union[IResolvable,Sequence[Union[IResolvable,TemplateRuleProperty,Dict[str,Any]]],None]) – A list of case rules (also known as case field conditions ) on a template.status (
Optional[str]) – The status of the template.tags (
Optional[Sequence[Union[CfnTag,Dict[str,Any]]]]) – An array of key-value pairs to apply to this resource.
- See:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cases-template.html
- ExampleMetadata:
fixture=_generated
Example:
from aws_cdk import CfnTag # The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_cases as cases cfn_template_props = cases.CfnTemplateProps( name="name", # the properties below are optional description="description", domain_id="domainId", layout_configuration=cases.CfnTemplate.LayoutConfigurationProperty( default_layout="defaultLayout" ), required_fields=[cases.CfnTemplate.RequiredFieldProperty( field_id="fieldId" )], rules=[cases.CfnTemplate.TemplateRuleProperty( case_rule_id="caseRuleId", # the properties below are optional field_id="fieldId" )], status="status", tags=[CfnTag( key="key", value="value" )] )
Attributes
- description
A brief description of the template.
- domain_id
The unique identifier of the Cases domain.
- layout_configuration
Object to store configuration of layouts associated to the template.
- name
The template name.
- required_fields
A list of fields that must contain a value for a case to be successfully created with this template.
- rules
A list of case rules (also known as case field conditions ) on a template.
- status
The status of the template.
- tags
An array of key-value pairs to apply to this resource.