Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-connect-rule.json
Parent schema serverless-framework-configuration
Type: object

Resource Type definition for AWS:Connect::Rule. Source:- https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-connect

Properties

Name string | Aws_CF_FunctionString required

The name of the rule.

InstanceArn string | Aws_CF_FunctionString required

The Amazon Resource Name (ARN) of the instance.

TriggerEventSource object required

The event source that will trigger the rule.

2 nested properties
EventSourceName string | Aws_CF_FunctionString required

The name of event source.

IntegrationAssociationArn string | Aws_CF_FunctionString

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

Function string | Aws_CF_FunctionString required

The conditions of a rule.

Actions object required

The list of actions that will be executed when a rule is triggered.

4 nested properties
AssignContactCategoryActions AssignContactCategoryAction[]

This action will assign contact category when a rule is triggered.

minItems=1maxItems=1uniqueItems=true
EventBridgeActions EventBridgeAction[]

This action will send event bridge notification when a rule is triggered.

minItems=1maxItems=1uniqueItems=true
TaskActions TaskAction[]

This action will generate a task when a rule is triggered.

minItems=1maxItems=1uniqueItems=true
SendNotificationActions SendNotificationAction[]

The action will send notification when a rule is triggered.

minItems=1maxItems=1uniqueItems=true
PublishStatus string | Aws_CF_FunctionString required

The publish status of a rule, either draft or published.

Tags Tag[]

One or more tags.

maxItems=50uniqueItems=true

Definitions

UserArn string | Aws_CF_FunctionString

The Amazon Resource Name (ARN) of the user.

NotificationRecipientType object

The type of notification recipient.

UserTags

The collection of recipients who are identified by user tags

UserArns UserArn[]

The list of recipients by user arns.

minItems=1maxItems=5uniqueItems=true
Reference object

A contact reference.

Value string | Aws_CF_FunctionString required
Type string | Aws_CF_FunctionString required
TaskAction object

The definition of task action.

Name string | Aws_CF_FunctionString required

The name which appears in the agent's Contact Control Panel (CCP).

ContactFlowArn string | Aws_CF_FunctionString required

The Amazon Resource Name (ARN) of the contact flow.

Description string | Aws_CF_FunctionString

The description which appears in the agent's Contact Control Panel (CCP).

References

A formatted URL that is shown to an agent in the Contact Control Panel (CCP).

EventBridgeAction object

The definition for event bridge action.

Name string | Aws_CF_FunctionString required

The name of the event bridge action.

AssignContactCategoryAction object

The definition for assigning contact category action.

SendNotificationAction object

The definition for sending notification action.

DeliveryMethod string | Aws_CF_FunctionString required

The means of delivery.

Content string | Aws_CF_FunctionString required

The content of notification.

ContentType string | Aws_CF_FunctionString required

The type of content.

Recipient object required

The type of notification recipient.

2 nested properties
UserTags

The collection of recipients who are identified by user tags

UserArns UserArn[]

The list of recipients by user arns.

minItems=1maxItems=5uniqueItems=true
Subject string | Aws_CF_FunctionString

The subject of notification.

AssignContactCategoryActions AssignContactCategoryAction[]

This action will assign contact category when a rule is triggered.

EventBridgeActions EventBridgeAction[]

This action will send event bridge notification when a rule is triggered.

RuleTriggerEventSource object

The event source that will trigger the rule.

EventSourceName string | Aws_CF_FunctionString required

The name of event source.

IntegrationAssociationArn string | Aws_CF_FunctionString

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

TaskActions TaskAction[]

This action will generate a task when a rule is triggered.

SendNotificationActions SendNotificationAction[]

The action will send notification when a rule is triggered.

Actions object

The list of actions that will be executed when a rule is triggered.

AssignContactCategoryActions AssignContactCategoryAction[]

This action will assign contact category when a rule is triggered.

minItems=1maxItems=1uniqueItems=true
EventBridgeActions EventBridgeAction[]

This action will send event bridge notification when a rule is triggered.

minItems=1maxItems=1uniqueItems=true
TaskActions TaskAction[]

This action will generate a task when a rule is triggered.

minItems=1maxItems=1uniqueItems=true
SendNotificationActions SendNotificationAction[]

The action will send notification when a rule is triggered.

minItems=1maxItems=1uniqueItems=true
Tag object

A key-value pair to associate with a resource.

Key string | Aws_CF_FunctionString required

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Value string | Aws_CF_FunctionString required

The value for the tag. You can specify a value that's 1 to 256 characters in length.