CfnRuleProps

class aws_cdk.aws_connect.CfnRuleProps(*, actions, function, instance_arn, name, publish_status, trigger_event_source, tags=None)

Bases: object

Properties for defining a CfnRule.

Parameters:

actions (Union[IResolvable, ActionsProperty, Dict[str, Any]]) – A list of actions to be run when the rule is triggered.
function (str) – The conditions of the rule.
instance_arn (str) – The Amazon Resource Name (ARN) of the instance.
name (str) – The name of the rule.
publish_status (str) – The publish status of the rule. Allowed values : DRAFT | PUBLISHED
trigger_event_source (Union[IResolvable, RuleTriggerEventSourceProperty, Dict[str, Any]]) – The event source to trigger the rule.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags used to organize, track, or control access for this resource. For example, { “tags”: {“key1”:”value1”, “key2”:”value2”} }.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-rule.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_connect as connect

# assign_contact_category_actions: Any
# empty_value: Any
# end_associated_tasks_actions: Any

cfn_rule_props = connect.CfnRuleProps(
    actions=connect.CfnRule.ActionsProperty(
        assign_contact_category_actions=[assign_contact_category_actions],
        create_case_actions=[connect.CfnRule.CreateCaseActionProperty(
            fields=[connect.CfnRule.FieldProperty(
                id="id",
                value=connect.CfnRule.FieldValueProperty(
                    boolean_value=False,
                    double_value=123,
                    empty_value=empty_value,
                    string_value="stringValue"
                )
            )],
            template_id="templateId"
        )],
        end_associated_tasks_actions=[end_associated_tasks_actions],
        event_bridge_actions=[connect.CfnRule.EventBridgeActionProperty(
            name="name"
        )],
        send_notification_actions=[connect.CfnRule.SendNotificationActionProperty(
            content="content",
            content_type="contentType",
            delivery_method="deliveryMethod",
            recipient=connect.CfnRule.NotificationRecipientTypeProperty(
                user_arns=["userArns"],
                user_tags={
                    "user_tags_key": "userTags"
                }
            ),

            # the properties below are optional
            subject="subject"
        )],
        submit_auto_evaluation_actions=[connect.CfnRule.SubmitAutoEvaluationActionProperty(
            evaluation_form_arn="evaluationFormArn"
        )],
        task_actions=[connect.CfnRule.TaskActionProperty(
            contact_flow_arn="contactFlowArn",
            name="name",

            # the properties below are optional
            description="description",
            references={
                "references_key": connect.CfnRule.ReferenceProperty(
                    type="type",
                    value="value"
                )
            }
        )],
        update_case_actions=[connect.CfnRule.UpdateCaseActionProperty(
            fields=[connect.CfnRule.FieldProperty(
                id="id",
                value=connect.CfnRule.FieldValueProperty(
                    boolean_value=False,
                    double_value=123,
                    empty_value=empty_value,
                    string_value="stringValue"
                )
            )]
        )]
    ),
    function="function",
    instance_arn="instanceArn",
    name="name",
    publish_status="publishStatus",
    trigger_event_source=connect.CfnRule.RuleTriggerEventSourceProperty(
        event_source_name="eventSourceName",

        # the properties below are optional
        integration_association_arn="integrationAssociationArn"
    ),

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