CfnRule

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

Bases: CfnResource

A CloudFormation AWS::Connect::Rule.

Creates a rule for the specified Amazon Connect instance.

CloudformationResource:: AWS::Connect::Rule
Link:: 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.
import aws_cdk.aws_connect as connect

# assign_contact_category_actions: Any

cfn_rule = connect.CfnRule(self, "MyCfnRule",
    actions=connect.CfnRule.ActionsProperty(
        assign_contact_category_actions=[assign_contact_category_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"
        )],
        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"
                )
            }
        )]
    ),
    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"
    )]
)

Create a new AWS::Connect::Rule.

Parameters:

scope (Construct) –
- scope in which this resource is defined.
id (str) –
- scoped id of the resource.
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”} }.

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_depends_on(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_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 intermdediate 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).

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 resoure, please consult that specific resource’s documentation.

Return type:

None

get_att(attribute_name)

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.
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

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

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::Connect::Rule'

actions

A list of actions to be run when the rule is triggered.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-rule.html#cfn-connect-rule-actions

attr_rule_arn

The Amazon Resource Name (ARN) of the rule.

CloudformationAttribute:: RuleArn

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.

function

The conditions of the rule.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-rule.html#cfn-connect-rule-function

instance_arn

The Amazon Resource Name (ARN) of the instance.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-rule.html#cfn-connect-rule-instancearn

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

The name of the rule.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-rule.html#cfn-connect-rule-name

node: The construct tree node associated with this construct.

publish_status

The publish status of the rule.

Allowed values : DRAFT | PUBLISHED

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-rule.html#cfn-connect-rule-publishstatus

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 }).

stack

The stack in which this element is defined.

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

tags

The tags used to organize, track, or control access for this resource.

For example, { “tags”: {“key1”:”value1”, “key2”:”value2”} }.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-rule.html#cfn-connect-rule-tags

trigger_event_source

The event source to trigger the rule.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-rule.html#cfn-connect-rule-triggereventsource

Static Methods

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(construct)

Check whether the given construct is a CfnResource.

Parameters:

construct (IConstruct) –

Return type:

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters:

x (Any) –

Return type:

bool

ActionsProperty

class CfnRule.ActionsProperty(*, assign_contact_category_actions=None, event_bridge_actions=None, send_notification_actions=None, task_actions=None)

Bases: object

A list of actions to be run when the rule is triggered.

Parameters:

assign_contact_category_actions (Union[Sequence[Any], IResolvable, None]) – Information about the contact category action. The syntax can be empty, for example, {} .
event_bridge_actions (Union[IResolvable, Sequence[Union[IResolvable, EventBridgeActionProperty, Dict[str, Any]]], None]) – Information about the EventBridge action.
send_notification_actions (Union[IResolvable, Sequence[Union[IResolvable, SendNotificationActionProperty, Dict[str, Any]]], None]) – Information about the send notification action.
task_actions (Union[IResolvable, Sequence[Union[IResolvable, TaskActionProperty, Dict[str, Any]]], None]) – Information about the task action. This field is required if TriggerEventSource is one of the following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-rule-actions.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_connect as connect

# assign_contact_category_actions: Any

actions_property = connect.CfnRule.ActionsProperty(
    assign_contact_category_actions=[assign_contact_category_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"
    )],
    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"
            )
        }
    )]
)

Attributes

assign_contact_category_actions

Information about the contact category action.

The syntax can be empty, for example, {} .

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-rule-actions.html#cfn-connect-rule-actions-assigncontactcategoryactions

event_bridge_actions

Information about the EventBridge action.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-rule-actions.html#cfn-connect-rule-actions-eventbridgeactions

send_notification_actions

Information about the send notification action.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-rule-actions.html#cfn-connect-rule-actions-sendnotificationactions

task_actions

Information about the task action.

This field is required if TriggerEventSource is one of the following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-rule-actions.html#cfn-connect-rule-actions-taskactions

EventBridgeActionProperty

class CfnRule.EventBridgeActionProperty(*, name)

Bases: object

The EventBridge action definition.

Parameters:: name (str) – The name.
Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-rule-eventbridgeaction.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_connect as connect

event_bridge_action_property = connect.CfnRule.EventBridgeActionProperty(
    name="name"
)

Attributes

name

The name.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-rule-eventbridgeaction.html#cfn-connect-rule-eventbridgeaction-name

NotificationRecipientTypeProperty

class CfnRule.NotificationRecipientTypeProperty(*, user_arns=None, user_tags=None)

Bases: object

The type of notification recipient.

Parameters:

user_arns (Optional[Sequence[str]]) – The Amazon Resource Name (ARN) of the user account.
user_tags (Union[IResolvable, Mapping[str, str], None]) – The tags used to organize, track, or control access for this resource. For example, { “tags”: {“key1”:”value1”, “key2”:”value2”} }. Amazon Connect users with the specified tags will be notified.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-rule-notificationrecipienttype.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_connect as connect

notification_recipient_type_property = connect.CfnRule.NotificationRecipientTypeProperty(
    user_arns=["userArns"],
    user_tags={
        "user_tags_key": "userTags"
    }
)

Attributes

user_arns

The Amazon Resource Name (ARN) of the user account.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-rule-notificationrecipienttype.html#cfn-connect-rule-notificationrecipienttype-userarns

user_tags

The tags used to organize, track, or control access for this resource.

For example, { “tags”: {“key1”:”value1”, “key2”:”value2”} }. Amazon Connect users with the specified tags will be notified.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-rule-notificationrecipienttype.html#cfn-connect-rule-notificationrecipienttype-usertags

ReferenceProperty

class CfnRule.ReferenceProperty(*, type, value)

Bases: object

Information about the reference when the referenceType is URL .

Otherwise, null. (Supports variable injection in the Value field.)

Parameters:

type (str) – The type of the reference. DATE must be of type Epoch timestamp. Allowed values : URL | ATTACHMENT | NUMBER | STRING | DATE | EMAIL
value (str) – A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-rule-reference.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_connect as connect

reference_property = connect.CfnRule.ReferenceProperty(
    type="type",
    value="value"
)

Attributes

type

The type of the reference. DATE must be of type Epoch timestamp.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-rule-reference.html#cfn-connect-rule-reference-type

value

A valid value for the reference.

For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-rule-reference.html#cfn-connect-rule-reference-value

RuleTriggerEventSourceProperty

class CfnRule.RuleTriggerEventSourceProperty(*, event_source_name, integration_association_arn=None)

Bases: object

The name of the event source.

Parameters:

event_source_name (str) – The name of the event source. Allowed values : OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable | OnPostChatAnalysisAvailable | OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate
integration_association_arn (Optional[str]) – The Amazon Resource Name (ARN) for the integration association. IntegrationAssociationArn is required if TriggerEventSource is one of the following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-rule-ruletriggereventsource.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_connect as connect

rule_trigger_event_source_property = connect.CfnRule.RuleTriggerEventSourceProperty(
    event_source_name="eventSourceName",

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

Attributes

event_source_name

The name of the event source.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-rule-ruletriggereventsource.html#cfn-connect-rule-ruletriggereventsource-eventsourcename

integration_association_arn

The Amazon Resource Name (ARN) for the integration association.

IntegrationAssociationArn is required if TriggerEventSource is one of the following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-rule-ruletriggereventsource.html#cfn-connect-rule-ruletriggereventsource-integrationassociationarn

SendNotificationActionProperty

class CfnRule.SendNotificationActionProperty(*, content, content_type, delivery_method, recipient, subject=None)

Bases: object

Information about the send notification action.

Parameters:

content (str) – Notification content. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide .
content_type (str) – Content type format. Allowed value : PLAIN_TEXT
delivery_method (str) – Notification delivery method. Allowed value : EMAIL
recipient (Union[IResolvable, NotificationRecipientTypeProperty, Dict[str, Any]]) – Notification recipient.
subject (Optional[str]) –
The subject of the email if the delivery method is EMAIL . Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide .

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-rule-sendnotificationaction.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_connect as connect

send_notification_action_property = 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"
)

Attributes

content

Notification content.

Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide .

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-rule-sendnotificationaction.html#cfn-connect-rule-sendnotificationaction-content

content_type

Content type format.

Allowed value : PLAIN_TEXT

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-rule-sendnotificationaction.html#cfn-connect-rule-sendnotificationaction-contenttype

delivery_method

Notification delivery method.

Allowed value : EMAIL

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-rule-sendnotificationaction.html#cfn-connect-rule-sendnotificationaction-deliverymethod

recipient

Notification recipient.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-rule-sendnotificationaction.html#cfn-connect-rule-sendnotificationaction-recipient

subject

The subject of the email if the delivery method is EMAIL .

Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide .

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-rule-sendnotificationaction.html#cfn-connect-rule-sendnotificationaction-subject

TaskActionProperty

class CfnRule.TaskActionProperty(*, contact_flow_arn, name, description=None, references=None)

Bases: object

Information about the task action.

This field is required if TriggerEventSource is one of the following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate

Parameters:

contact_flow_arn (str) – The Amazon Resource Name (ARN) of the flow.
name (str) –
The name. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide .
description (Optional[str]) –
The description. Supports variable injection. For more information, see JSONPath reference in the Amazon Connect Administrators Guide .
references (Union[IResolvable, Mapping[str, Union[IResolvable, ReferenceProperty, Dict[str, Any]]], None]) – Information about the reference when the referenceType is URL . Otherwise, null. URL is the only accepted type. (Supports variable injection in the Value field.)

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-rule-taskaction.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_connect as connect

task_action_property = 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"
        )
    }
)