CfnTemplatePropsMixin

class aws_cdk.mixins_preview.aws_cases.mixins.CfnTemplatePropsMixin(props, *, strategy=None)

Bases: Mixin

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:

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cases-template.html
CloudformationResource:: AWS::Cases::Template
Mixin:: true
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_cases import mixins as cases_mixins

cfn_template_props_mixin = cases_mixins.CfnTemplatePropsMixin(cases_mixins.CfnTemplateMixinProps(
    description="description",
    domain_id="domainId",
    layout_configuration=cases_mixins.CfnTemplatePropsMixin.LayoutConfigurationProperty(
        default_layout="defaultLayout"
    ),
    name="name",
    required_fields=[cases_mixins.CfnTemplatePropsMixin.RequiredFieldProperty(
        field_id="fieldId"
    )],
    rules=[cases_mixins.CfnTemplatePropsMixin.TemplateRuleProperty(
        case_rule_id="caseRuleId",
        field_id="fieldId"
    )],
    status="status",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Cases::Template.

Parameters:

props (Union[CfnTemplateMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['description', 'domainId', 'layoutConfiguration', 'name', 'requiredFields', 'rules', 'status', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

LayoutConfigurationProperty

class CfnTemplatePropsMixin.LayoutConfigurationProperty(*, default_layout=None)

Bases: object

Object to store configuration of layouts associated to the template.

Parameters:: default_layout (Optional[str]) – Unique identifier of a layout.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-template-layoutconfiguration.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_cases import mixins as cases_mixins

layout_configuration_property = cases_mixins.CfnTemplatePropsMixin.LayoutConfigurationProperty(
    default_layout="defaultLayout"
)

Attributes

default_layout

Unique identifier of a layout.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-template-layoutconfiguration.html#cfn-cases-template-layoutconfiguration-defaultlayout

RequiredFieldProperty

class CfnTemplatePropsMixin.RequiredFieldProperty(*, field_id=None)

Bases: object

List of fields that must have a value provided to create a case.

Parameters:: field_id (Optional[str]) – Unique identifier of a field.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-template-requiredfield.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_cases import mixins as cases_mixins

required_field_property = cases_mixins.CfnTemplatePropsMixin.RequiredFieldProperty(
    field_id="fieldId"
)

Attributes

field_id

Unique identifier of a field.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-template-requiredfield.html#cfn-cases-template-requiredfield-fieldid

TemplateRuleProperty

class CfnTemplatePropsMixin.TemplateRuleProperty(*, case_rule_id=None, field_id=None)

Bases: object

An association representing a case rule acting upon a field.

In the Amazon Connect admin website, case rules are known as case field conditions . For more information about case field conditions, see Add case field conditions to a case template .

Parameters:

case_rule_id (Optional[str]) – Unique identifier of a case rule.
field_id (Optional[str]) – Unique identifier of a field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-template-templaterule.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_cases import mixins as cases_mixins

template_rule_property = cases_mixins.CfnTemplatePropsMixin.TemplateRuleProperty(
    case_rule_id="caseRuleId",
    field_id="fieldId"
)

Attributes

case_rule_id

Unique identifier of a case rule.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-template-templaterule.html#cfn-cases-template-templaterule-caseruleid

field_id

Unique identifier of a field.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-template-templaterule.html#cfn-cases-template-templaterule-fieldid