CfnRule

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

Bases: CfnResource

Creates a rule for the specified Amazon Connect instance.

See:

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

CloudformationResource:

AWS::Connect::Rule

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 = connect.CfnRule(self, "MyCfnRule",
    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"
    )]
)
Parameters:

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

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

  • 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_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::Connect::Rule'
actions

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

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.

instance_arn

The Amazon Resource Name (ARN) of the instance.

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.

node

The tree node.

publish_status

The publish status of the rule.

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

Tag Manager which manages the tags for this resource.

tags_raw

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

trigger_event_source

The event source to trigger the rule.

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

ActionsProperty

class CfnRule.ActionsProperty(*, assign_contact_category_actions=None, create_case_actions=None, end_associated_tasks_actions=None, event_bridge_actions=None, send_notification_actions=None, submit_auto_evaluation_actions=None, task_actions=None, update_case_actions=None)

Bases: object

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

Parameters:
See:

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.
from aws_cdk import aws_connect as connect

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

actions_property = 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"
            )
        )]
    )]
)

Attributes

assign_contact_category_actions

Information about the contact category action.

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

See:

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

create_case_actions

This action will create a case when a rule is triggered.

See:

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

end_associated_tasks_actions

This action will end associated tasks when a rule is triggered.

See:

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

event_bridge_actions

Information about the EventBridge action.

See:

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.

See:

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

submit_auto_evaluation_actions

This action will submit an auto contact evaluation when a rule is triggered.

See:

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

task_actions

Information about the task action.

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

See:

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

update_case_actions

This action will update a case when a rule is triggered.

See:

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

CreateCaseActionProperty

class CfnRule.CreateCaseActionProperty(*, fields, template_id)

Bases: object

The definition for create case action.

Parameters:
See:

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

# empty_value: Any

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

Attributes

fields

An array of case fields.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-rule-createcaseaction.html#cfn-connect-rule-createcaseaction-fields

template_id

The Id of template.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-rule-createcaseaction.html#cfn-connect-rule-createcaseaction-templateid

EventBridgeActionProperty

class CfnRule.EventBridgeActionProperty(*, name)

Bases: object

The EventBridge action definition.

Parameters:

name (str) – The name.

See:

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.
from aws_cdk import aws_connect as connect

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

Attributes

name

The name.

See:

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

FieldProperty

class CfnRule.FieldProperty(*, id, value)

Bases: object

The field of the case.

Parameters:
See:

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

# empty_value: Any

field_property = connect.CfnRule.FieldProperty(
    id="id",
    value=connect.CfnRule.FieldValueProperty(
        boolean_value=False,
        double_value=123,
        empty_value=empty_value,
        string_value="stringValue"
    )
)

Attributes

id

The Id of the field.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-rule-field.html#cfn-connect-rule-field-id

value

The value of the field.

See:

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

FieldValueProperty

class CfnRule.FieldValueProperty(*, boolean_value=None, double_value=None, empty_value=None, string_value=None)

Bases: object

Object for case field values.

Parameters:

  • boolean_value (Union[bool, IResolvable, None]) –

  • double_value (Union[int, float, None]) –

  • empty_value (Any) –

  • string_value (Optional[str]) –

See:

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

# empty_value: Any

field_value_property = connect.CfnRule.FieldValueProperty(
    boolean_value=False,
    double_value=123,
    empty_value=empty_value,
    string_value="stringValue"
)

Attributes

boolean_value

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-rule-fieldvalue.html#cfn-connect-rule-fieldvalue-booleanvalue

Type:

see

double_value

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-rule-fieldvalue.html#cfn-connect-rule-fieldvalue-doublevalue

Type:

see

empty_value

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-rule-fieldvalue.html#cfn-connect-rule-fieldvalue-emptyvalue

Type:

see

string_value

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-rule-fieldvalue.html#cfn-connect-rule-fieldvalue-stringvalue

Type:

see

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.

See:

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.
from aws_cdk import 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.

See:

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.

See:

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

See:

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.
from aws_cdk import 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.

Allowed values : URL | ATTACHMENT | NUMBER | STRING | DATE | EMAIL

See:

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

See:

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.

  • integration_association_arn (Optional[str]) – The Amazon Resource Name (ARN) of the integration association. IntegrationAssociationArn is required if TriggerEventSource is one of the following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate

See:

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.
from aws_cdk import 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.

See:

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) of the integration association.

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

See:

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 .

See:

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.
from aws_cdk import 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 .

See:

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

See:

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

See:

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

recipient

Notification recipient.

See:

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 .

See:

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

SubmitAutoEvaluationActionProperty

class CfnRule.SubmitAutoEvaluationActionProperty(*, evaluation_form_arn)

Bases: object

The definition of submit auto evaluation action.

Parameters:

evaluation_form_arn (str) – The Amazon Resource Name (ARN) of the evaluation form.

See:

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

submit_auto_evaluation_action_property = connect.CfnRule.SubmitAutoEvaluationActionProperty(
    evaluation_form_arn="evaluationFormArn"
)

Attributes

evaluation_form_arn

The Amazon Resource Name (ARN) of the evaluation form.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-rule-submitautoevaluationaction.html#cfn-connect-rule-submitautoevaluationaction-evaluationformarn

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

See:

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.
from aws_cdk import 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"
        )
    }
)

Attributes

contact_flow_arn

The Amazon Resource Name (ARN) of the flow.

See:

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

description

The description.

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

See:

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

name

The name.

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

See:

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

references

Information about the reference when the referenceType is URL .

Otherwise, null. URL is the only accepted type. (Supports variable injection in the Value field.)

See:

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

UpdateCaseActionProperty

class CfnRule.UpdateCaseActionProperty(*, fields)

Bases: object

The definition for update case action.

Parameters:

fields (Union[IResolvable, Sequence[Union[IResolvable, FieldProperty, Dict[str, Any]]]]) – An array of case fields.

See:

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

# empty_value: Any

update_case_action_property = 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"
        )
    )]
)

Attributes

fields

An array of case fields.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-rule-updatecaseaction.html#cfn-connect-rule-updatecaseaction-fields