CfnCaseRulePropsMixin

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

Bases: Mixin

Creates a new case rule.

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 .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cases-caserule.html

CloudformationResource:

AWS::Cases::CaseRule

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

# empty_value: Any

cfn_case_rule_props_mixin = cases_mixins.CfnCaseRulePropsMixin(cases_mixins.CfnCaseRuleMixinProps(
    description="description",
    domain_id="domainId",
    name="name",
    rule=cases_mixins.CfnCaseRulePropsMixin.CaseRuleDetailsProperty(
        hidden=cases_mixins.CfnCaseRulePropsMixin.HiddenCaseRuleProperty(
            conditions=[cases_mixins.CfnCaseRulePropsMixin.BooleanConditionProperty(
                equal_to=cases_mixins.CfnCaseRulePropsMixin.BooleanOperandsProperty(
                    operand_one=cases_mixins.CfnCaseRulePropsMixin.OperandOneProperty(
                        field_id="fieldId"
                    ),
                    operand_two=cases_mixins.CfnCaseRulePropsMixin.OperandTwoProperty(
                        boolean_value=False,
                        double_value=123,
                        empty_value=empty_value,
                        string_value="stringValue"
                    ),
                    result=False
                ),
                not_equal_to=cases_mixins.CfnCaseRulePropsMixin.BooleanOperandsProperty(
                    operand_one=cases_mixins.CfnCaseRulePropsMixin.OperandOneProperty(
                        field_id="fieldId"
                    ),
                    operand_two=cases_mixins.CfnCaseRulePropsMixin.OperandTwoProperty(
                        boolean_value=False,
                        double_value=123,
                        empty_value=empty_value,
                        string_value="stringValue"
                    ),
                    result=False
                )
            )],
            default_value=False
        ),
        required=cases_mixins.CfnCaseRulePropsMixin.RequiredCaseRuleProperty(
            conditions=[cases_mixins.CfnCaseRulePropsMixin.BooleanConditionProperty(
                equal_to=cases_mixins.CfnCaseRulePropsMixin.BooleanOperandsProperty(
                    operand_one=cases_mixins.CfnCaseRulePropsMixin.OperandOneProperty(
                        field_id="fieldId"
                    ),
                    operand_two=cases_mixins.CfnCaseRulePropsMixin.OperandTwoProperty(
                        boolean_value=False,
                        double_value=123,
                        empty_value=empty_value,
                        string_value="stringValue"
                    ),
                    result=False
                ),
                not_equal_to=cases_mixins.CfnCaseRulePropsMixin.BooleanOperandsProperty(
                    operand_one=cases_mixins.CfnCaseRulePropsMixin.OperandOneProperty(
                        field_id="fieldId"
                    ),
                    operand_two=cases_mixins.CfnCaseRulePropsMixin.OperandTwoProperty(
                        boolean_value=False,
                        double_value=123,
                        empty_value=empty_value,
                        string_value="stringValue"
                    ),
                    result=False
                )
            )],
            default_value=False
        )
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

  • props (Union[CfnCaseRuleMixinProps, 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', 'name', 'rule', '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

BooleanConditionProperty

class CfnCaseRulePropsMixin.BooleanConditionProperty(*, equal_to=None, not_equal_to=None)

Bases: object

Boolean condition for a rule.

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:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-caserule-booleancondition.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

# empty_value: Any

boolean_condition_property = cases_mixins.CfnCaseRulePropsMixin.BooleanConditionProperty(
    equal_to=cases_mixins.CfnCaseRulePropsMixin.BooleanOperandsProperty(
        operand_one=cases_mixins.CfnCaseRulePropsMixin.OperandOneProperty(
            field_id="fieldId"
        ),
        operand_two=cases_mixins.CfnCaseRulePropsMixin.OperandTwoProperty(
            boolean_value=False,
            double_value=123,
            empty_value=empty_value,
            string_value="stringValue"
        ),
        result=False
    ),
    not_equal_to=cases_mixins.CfnCaseRulePropsMixin.BooleanOperandsProperty(
        operand_one=cases_mixins.CfnCaseRulePropsMixin.OperandOneProperty(
            field_id="fieldId"
        ),
        operand_two=cases_mixins.CfnCaseRulePropsMixin.OperandTwoProperty(
            boolean_value=False,
            double_value=123,
            empty_value=empty_value,
            string_value="stringValue"
        ),
        result=False
    )
)

Attributes

equal_to

Tests that operandOne is equal to operandTwo.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-caserule-booleancondition.html#cfn-cases-caserule-booleancondition-equalto

not_equal_to

Tests that operandOne is not equal to operandTwo.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-caserule-booleancondition.html#cfn-cases-caserule-booleancondition-notequalto

BooleanOperandsProperty

class CfnCaseRulePropsMixin.BooleanOperandsProperty(*, operand_one=None, operand_two=None, result=None)

Bases: object

Boolean operands for a condition.

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:

  • operand_one (Union[IResolvable, OperandOneProperty, Dict[str, Any], None]) – Represents the left hand operand in the condition.

  • operand_two (Union[IResolvable, OperandTwoProperty, Dict[str, Any], None]) – Represents the right hand operand in the condition.

  • result (Union[bool, IResolvable, None]) – The value of the outer rule if the condition evaluates to true.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-caserule-booleanoperands.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

# empty_value: Any

boolean_operands_property = cases_mixins.CfnCaseRulePropsMixin.BooleanOperandsProperty(
    operand_one=cases_mixins.CfnCaseRulePropsMixin.OperandOneProperty(
        field_id="fieldId"
    ),
    operand_two=cases_mixins.CfnCaseRulePropsMixin.OperandTwoProperty(
        boolean_value=False,
        double_value=123,
        empty_value=empty_value,
        string_value="stringValue"
    ),
    result=False
)

Attributes

operand_one

Represents the left hand operand in the condition.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-caserule-booleanoperands.html#cfn-cases-caserule-booleanoperands-operandone

operand_two

Represents the right hand operand in the condition.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-caserule-booleanoperands.html#cfn-cases-caserule-booleanoperands-operandtwo

result

The value of the outer rule if the condition evaluates to true.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-caserule-booleanoperands.html#cfn-cases-caserule-booleanoperands-result

CaseRuleDetailsProperty

class CfnCaseRulePropsMixin.CaseRuleDetailsProperty(*, hidden=None, required=None)

Bases: object

Represents what rule type should take place, under what conditions.

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:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-caserule-caseruledetails.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

# empty_value: Any

case_rule_details_property = cases_mixins.CfnCaseRulePropsMixin.CaseRuleDetailsProperty(
    hidden=cases_mixins.CfnCaseRulePropsMixin.HiddenCaseRuleProperty(
        conditions=[cases_mixins.CfnCaseRulePropsMixin.BooleanConditionProperty(
            equal_to=cases_mixins.CfnCaseRulePropsMixin.BooleanOperandsProperty(
                operand_one=cases_mixins.CfnCaseRulePropsMixin.OperandOneProperty(
                    field_id="fieldId"
                ),
                operand_two=cases_mixins.CfnCaseRulePropsMixin.OperandTwoProperty(
                    boolean_value=False,
                    double_value=123,
                    empty_value=empty_value,
                    string_value="stringValue"
                ),
                result=False
            ),
            not_equal_to=cases_mixins.CfnCaseRulePropsMixin.BooleanOperandsProperty(
                operand_one=cases_mixins.CfnCaseRulePropsMixin.OperandOneProperty(
                    field_id="fieldId"
                ),
                operand_two=cases_mixins.CfnCaseRulePropsMixin.OperandTwoProperty(
                    boolean_value=False,
                    double_value=123,
                    empty_value=empty_value,
                    string_value="stringValue"
                ),
                result=False
            )
        )],
        default_value=False
    ),
    required=cases_mixins.CfnCaseRulePropsMixin.RequiredCaseRuleProperty(
        conditions=[cases_mixins.CfnCaseRulePropsMixin.BooleanConditionProperty(
            equal_to=cases_mixins.CfnCaseRulePropsMixin.BooleanOperandsProperty(
                operand_one=cases_mixins.CfnCaseRulePropsMixin.OperandOneProperty(
                    field_id="fieldId"
                ),
                operand_two=cases_mixins.CfnCaseRulePropsMixin.OperandTwoProperty(
                    boolean_value=False,
                    double_value=123,
                    empty_value=empty_value,
                    string_value="stringValue"
                ),
                result=False
            ),
            not_equal_to=cases_mixins.CfnCaseRulePropsMixin.BooleanOperandsProperty(
                operand_one=cases_mixins.CfnCaseRulePropsMixin.OperandOneProperty(
                    field_id="fieldId"
                ),
                operand_two=cases_mixins.CfnCaseRulePropsMixin.OperandTwoProperty(
                    boolean_value=False,
                    double_value=123,
                    empty_value=empty_value,
                    string_value="stringValue"
                ),
                result=False
            )
        )],
        default_value=False
    )
)

Attributes

hidden

Whether a field is visible, based on values in other fields.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-caserule-caseruledetails.html#cfn-cases-caserule-caseruledetails-hidden

required

Required rule type, used to indicate whether a field is required.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-caserule-caseruledetails.html#cfn-cases-caserule-caseruledetails-required

HiddenCaseRuleProperty

class CfnCaseRulePropsMixin.HiddenCaseRuleProperty(*, conditions=None, default_value=None)

Bases: object

A rule that controls field visibility based on conditions.

Fields can be shown or hidden dynamically based on values in other fields.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-caserule-hiddencaserule.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

# empty_value: Any

hidden_case_rule_property = cases_mixins.CfnCaseRulePropsMixin.HiddenCaseRuleProperty(
    conditions=[cases_mixins.CfnCaseRulePropsMixin.BooleanConditionProperty(
        equal_to=cases_mixins.CfnCaseRulePropsMixin.BooleanOperandsProperty(
            operand_one=cases_mixins.CfnCaseRulePropsMixin.OperandOneProperty(
                field_id="fieldId"
            ),
            operand_two=cases_mixins.CfnCaseRulePropsMixin.OperandTwoProperty(
                boolean_value=False,
                double_value=123,
                empty_value=empty_value,
                string_value="stringValue"
            ),
            result=False
        ),
        not_equal_to=cases_mixins.CfnCaseRulePropsMixin.BooleanOperandsProperty(
            operand_one=cases_mixins.CfnCaseRulePropsMixin.OperandOneProperty(
                field_id="fieldId"
            ),
            operand_two=cases_mixins.CfnCaseRulePropsMixin.OperandTwoProperty(
                boolean_value=False,
                double_value=123,
                empty_value=empty_value,
                string_value="stringValue"
            ),
            result=False
        )
    )],
    default_value=False
)

Attributes

conditions

A list of conditions that determine field visibility.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-caserule-hiddencaserule.html#cfn-cases-caserule-hiddencaserule-conditions

default_value

Whether the field is hidden when no conditions match.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-caserule-hiddencaserule.html#cfn-cases-caserule-hiddencaserule-defaultvalue

OperandOneProperty

class CfnCaseRulePropsMixin.OperandOneProperty(*, field_id=None)

Bases: object

Represents the left hand operand in the condition.

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:

field_id (Optional[str]) – The field ID that this operand should take the value of.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-caserule-operandone.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

operand_one_property = cases_mixins.CfnCaseRulePropsMixin.OperandOneProperty(
    field_id="fieldId"
)

Attributes

field_id

The field ID that this operand should take the value of.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-caserule-operandone.html#cfn-cases-caserule-operandone-fieldid

OperandTwoProperty

class CfnCaseRulePropsMixin.OperandTwoProperty(*, boolean_value=None, double_value=None, empty_value=None, string_value=None)

Bases: object

Represents the right hand operand in the condition.

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:

  • boolean_value (Union[bool, IResolvable, None]) – Boolean value type.

  • double_value (Union[int, float, None]) – Double value type.

  • empty_value (Any) –

    Represents an empty operand value. 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 .

  • string_value (Optional[str]) – String value type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-caserule-operandtwo.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

# empty_value: Any

operand_two_property = cases_mixins.CfnCaseRulePropsMixin.OperandTwoProperty(
    boolean_value=False,
    double_value=123,
    empty_value=empty_value,
    string_value="stringValue"
)

Attributes

boolean_value

Boolean value type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-caserule-operandtwo.html#cfn-cases-caserule-operandtwo-booleanvalue

double_value

Double value type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-caserule-operandtwo.html#cfn-cases-caserule-operandtwo-doublevalue

empty_value

Represents an empty operand value.

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 .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-caserule-operandtwo.html#cfn-cases-caserule-operandtwo-emptyvalue

string_value

String value type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-caserule-operandtwo.html#cfn-cases-caserule-operandtwo-stringvalue

RequiredCaseRuleProperty

class CfnCaseRulePropsMixin.RequiredCaseRuleProperty(*, conditions=None, default_value=None)

Bases: object

Required rule type, used to indicate whether a field is required.

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:

  • conditions (Union[IResolvable, Sequence[Union[IResolvable, BooleanConditionProperty, Dict[str, Any]]], None]) – List of conditions for the required rule; the first condition to evaluate to true dictates the value of the rule.

  • default_value (Union[bool, IResolvable, None]) – The value of the rule (that is, whether the field is required) should none of the conditions evaluate to true.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-caserule-requiredcaserule.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

# empty_value: Any

required_case_rule_property = cases_mixins.CfnCaseRulePropsMixin.RequiredCaseRuleProperty(
    conditions=[cases_mixins.CfnCaseRulePropsMixin.BooleanConditionProperty(
        equal_to=cases_mixins.CfnCaseRulePropsMixin.BooleanOperandsProperty(
            operand_one=cases_mixins.CfnCaseRulePropsMixin.OperandOneProperty(
                field_id="fieldId"
            ),
            operand_two=cases_mixins.CfnCaseRulePropsMixin.OperandTwoProperty(
                boolean_value=False,
                double_value=123,
                empty_value=empty_value,
                string_value="stringValue"
            ),
            result=False
        ),
        not_equal_to=cases_mixins.CfnCaseRulePropsMixin.BooleanOperandsProperty(
            operand_one=cases_mixins.CfnCaseRulePropsMixin.OperandOneProperty(
                field_id="fieldId"
            ),
            operand_two=cases_mixins.CfnCaseRulePropsMixin.OperandTwoProperty(
                boolean_value=False,
                double_value=123,
                empty_value=empty_value,
                string_value="stringValue"
            ),
            result=False
        )
    )],
    default_value=False
)

Attributes

conditions

List of conditions for the required rule;

the first condition to evaluate to true dictates the value of the rule.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-caserule-requiredcaserule.html#cfn-cases-caserule-requiredcaserule-conditions

default_value

The value of the rule (that is, whether the field is required) should none of the conditions evaluate to true.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-caserule-requiredcaserule.html#cfn-cases-caserule-requiredcaserule-defaultvalue