CfnCaseRule

class aws_cdk.aws_cases.CfnCaseRule(scope, id, *, name, rule, description=None, domain_id=None, tags=None)

Bases: CfnResource

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

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

# empty_value: Any

cfn_case_rule = cases.CfnCaseRule(self, "MyCfnCaseRule",
    name="name",
    rule=cases.CfnCaseRule.CaseRuleDetailsProperty(
        hidden=cases.CfnCaseRule.HiddenCaseRuleProperty(
            conditions=[cases.CfnCaseRule.BooleanConditionProperty(
                equal_to=cases.CfnCaseRule.BooleanOperandsProperty(
                    operand_one=cases.CfnCaseRule.OperandOneProperty(
                        field_id="fieldId"
                    ),
                    operand_two=cases.CfnCaseRule.OperandTwoProperty(
                        boolean_value=False,
                        double_value=123,
                        empty_value=empty_value,
                        string_value="stringValue"
                    ),
                    result=False
                ),
                not_equal_to=cases.CfnCaseRule.BooleanOperandsProperty(
                    operand_one=cases.CfnCaseRule.OperandOneProperty(
                        field_id="fieldId"
                    ),
                    operand_two=cases.CfnCaseRule.OperandTwoProperty(
                        boolean_value=False,
                        double_value=123,
                        empty_value=empty_value,
                        string_value="stringValue"
                    ),
                    result=False
                )
            )],
            default_value=False
        ),
        required=cases.CfnCaseRule.RequiredCaseRuleProperty(
            conditions=[cases.CfnCaseRule.BooleanConditionProperty(
                equal_to=cases.CfnCaseRule.BooleanOperandsProperty(
                    operand_one=cases.CfnCaseRule.OperandOneProperty(
                        field_id="fieldId"
                    ),
                    operand_two=cases.CfnCaseRule.OperandTwoProperty(
                        boolean_value=False,
                        double_value=123,
                        empty_value=empty_value,
                        string_value="stringValue"
                    ),
                    result=False
                ),
                not_equal_to=cases.CfnCaseRule.BooleanOperandsProperty(
                    operand_one=cases.CfnCaseRule.OperandOneProperty(
                        field_id="fieldId"
                    ),
                    operand_two=cases.CfnCaseRule.OperandTwoProperty(
                        boolean_value=False,
                        double_value=123,
                        empty_value=empty_value,
                        string_value="stringValue"
                    ),
                    result=False
                )
            )],
            default_value=False
        )
    ),

    # the properties below are optional
    description="description",
    domain_id="domainId",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Create a new AWS::Cases::CaseRule.

Parameters:

  • scope (Construct) – Scope in which this resource is defined.

  • id (str) – Construct identifier for this resource (unique in its scope).

  • name (str) – Name of the case rule.

  • rule (Union[IResolvable, CaseRuleDetailsProperty, Dict[str, Any]]) – Represents what rule type should take place, under what conditions.

  • description (Optional[str]) – Description of a case rule.

  • domain_id (Optional[str]) – Unique identifier of a Cases domain.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of key-value pairs to apply to this resource.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:

path (str) – The path of the value to delete.

Return type:

None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource)

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource)

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (str)

  • value (Any)

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:

property_path (str) – The path to the property.

Return type:

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

  • policy (Optional[RemovalPolicy])

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

  • attribute_name (str) – The name of the attribute.

  • type_hint (Optional[ResolutionTypeHint])

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str)

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) – tree inspector to collect and process attributes.

Return type:

None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:

List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:

List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:

new_logical_id (str) – The new logical ID to use for this stack element.

Return type:

None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource)

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:
Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Returns:

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::Cases::CaseRule'
attr_case_rule_arn

The Amazon Resource Name (ARN) of the case rule.

CloudformationAttribute:

CaseRuleArn

attr_case_rule_id

Unique identifier of a case rule.

CloudformationAttribute:

CaseRuleId

attr_created_time

Timestamp when the resource was created.

CloudformationAttribute:

CreatedTime

attr_last_modified_time

Timestamp when the resource was created or last modified.

CloudformationAttribute:

LastModifiedTime

case_rule_ref

A reference to a CaseRule resource.

cdk_tag_manager

Tag Manager which manages the tags for this resource.

cfn_options

Options for this resource, such as condition, update policy etc.

cfn_resource_type

AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

description

Description of a case rule.

domain_id

Unique identifier of a Cases domain.

env
logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

name

Name of the case rule.

node

The tree node.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

rule

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

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags

An array of key-value pairs to apply to this resource.

Static Methods

classmethod arn_for_case_rule(resource)
Parameters:

resource (ICaseRuleRef)

Return type:

str

classmethod is_cfn_case_rule(x)

Checks whether the given object is a CfnCaseRule.

Parameters:

x (Any)

Return type:

bool

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any)

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any)

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Construct.

BooleanConditionProperty

class CfnCaseRule.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 import aws_cases as cases

# empty_value: Any

boolean_condition_property = cases.CfnCaseRule.BooleanConditionProperty(
    equal_to=cases.CfnCaseRule.BooleanOperandsProperty(
        operand_one=cases.CfnCaseRule.OperandOneProperty(
            field_id="fieldId"
        ),
        operand_two=cases.CfnCaseRule.OperandTwoProperty(
            boolean_value=False,
            double_value=123,
            empty_value=empty_value,
            string_value="stringValue"
        ),
        result=False
    ),
    not_equal_to=cases.CfnCaseRule.BooleanOperandsProperty(
        operand_one=cases.CfnCaseRule.OperandOneProperty(
            field_id="fieldId"
        ),
        operand_two=cases.CfnCaseRule.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 CfnCaseRule.BooleanOperandsProperty(*, operand_one, operand_two, result)

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]]) – Represents the left hand operand in the condition.

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

  • result (Union[bool, IResolvable]) – 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 import aws_cases as cases

# empty_value: Any

boolean_operands_property = cases.CfnCaseRule.BooleanOperandsProperty(
    operand_one=cases.CfnCaseRule.OperandOneProperty(
        field_id="fieldId"
    ),
    operand_two=cases.CfnCaseRule.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 CfnCaseRule.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 import aws_cases as cases

# empty_value: Any

case_rule_details_property = cases.CfnCaseRule.CaseRuleDetailsProperty(
    hidden=cases.CfnCaseRule.HiddenCaseRuleProperty(
        conditions=[cases.CfnCaseRule.BooleanConditionProperty(
            equal_to=cases.CfnCaseRule.BooleanOperandsProperty(
                operand_one=cases.CfnCaseRule.OperandOneProperty(
                    field_id="fieldId"
                ),
                operand_two=cases.CfnCaseRule.OperandTwoProperty(
                    boolean_value=False,
                    double_value=123,
                    empty_value=empty_value,
                    string_value="stringValue"
                ),
                result=False
            ),
            not_equal_to=cases.CfnCaseRule.BooleanOperandsProperty(
                operand_one=cases.CfnCaseRule.OperandOneProperty(
                    field_id="fieldId"
                ),
                operand_two=cases.CfnCaseRule.OperandTwoProperty(
                    boolean_value=False,
                    double_value=123,
                    empty_value=empty_value,
                    string_value="stringValue"
                ),
                result=False
            )
        )],
        default_value=False
    ),
    required=cases.CfnCaseRule.RequiredCaseRuleProperty(
        conditions=[cases.CfnCaseRule.BooleanConditionProperty(
            equal_to=cases.CfnCaseRule.BooleanOperandsProperty(
                operand_one=cases.CfnCaseRule.OperandOneProperty(
                    field_id="fieldId"
                ),
                operand_two=cases.CfnCaseRule.OperandTwoProperty(
                    boolean_value=False,
                    double_value=123,
                    empty_value=empty_value,
                    string_value="stringValue"
                ),
                result=False
            ),
            not_equal_to=cases.CfnCaseRule.BooleanOperandsProperty(
                operand_one=cases.CfnCaseRule.OperandOneProperty(
                    field_id="fieldId"
                ),
                operand_two=cases.CfnCaseRule.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 CfnCaseRule.HiddenCaseRuleProperty(*, conditions, default_value)

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 import aws_cases as cases

# empty_value: Any

hidden_case_rule_property = cases.CfnCaseRule.HiddenCaseRuleProperty(
    conditions=[cases.CfnCaseRule.BooleanConditionProperty(
        equal_to=cases.CfnCaseRule.BooleanOperandsProperty(
            operand_one=cases.CfnCaseRule.OperandOneProperty(
                field_id="fieldId"
            ),
            operand_two=cases.CfnCaseRule.OperandTwoProperty(
                boolean_value=False,
                double_value=123,
                empty_value=empty_value,
                string_value="stringValue"
            ),
            result=False
        ),
        not_equal_to=cases.CfnCaseRule.BooleanOperandsProperty(
            operand_one=cases.CfnCaseRule.OperandOneProperty(
                field_id="fieldId"
            ),
            operand_two=cases.CfnCaseRule.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 CfnCaseRule.OperandOneProperty(*, field_id)

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 (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 import aws_cases as cases

operand_one_property = cases.CfnCaseRule.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 CfnCaseRule.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 import aws_cases as cases

# empty_value: Any

operand_two_property = cases.CfnCaseRule.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 CfnCaseRule.RequiredCaseRuleProperty(*, conditions, default_value)

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]]]]) – 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]) – 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 import aws_cases as cases

# empty_value: Any

required_case_rule_property = cases.CfnCaseRule.RequiredCaseRuleProperty(
    conditions=[cases.CfnCaseRule.BooleanConditionProperty(
        equal_to=cases.CfnCaseRule.BooleanOperandsProperty(
            operand_one=cases.CfnCaseRule.OperandOneProperty(
                field_id="fieldId"
            ),
            operand_two=cases.CfnCaseRule.OperandTwoProperty(
                boolean_value=False,
                double_value=123,
                empty_value=empty_value,
                string_value="stringValue"
            ),
            result=False
        ),
        not_equal_to=cases.CfnCaseRule.BooleanOperandsProperty(
            operand_one=cases.CfnCaseRule.OperandOneProperty(
                field_id="fieldId"
            ),
            operand_two=cases.CfnCaseRule.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