interface CfnRuleProps

Language	Type name
.NET	Amazon.CDK.AWS.Connect.CfnRuleProps
Java	software.amazon.awscdk.services.connect.CfnRuleProps
Python	aws_cdk.aws_connect.CfnRuleProps
TypeScript	@aws-cdk/aws-connect » CfnRuleProps

Properties for defining a CfnRule.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as connect from '@aws-cdk/aws-connect';

declare const assignContactCategoryActions: any;
const cfnRuleProps: connect.CfnRuleProps = {
  actions: {
    assignContactCategoryActions: [assignContactCategoryActions],
    eventBridgeActions: [{
      name: 'name',
    }],
    sendNotificationActions: [{
      content: 'content',
      contentType: 'contentType',
      deliveryMethod: 'deliveryMethod',
      recipient: {
        userArns: ['userArns'],
        userTags: {
          userTagsKey: 'userTags',
        },
      },

      // the properties below are optional
      subject: 'subject',
    }],
    taskActions: [{
      contactFlowArn: 'contactFlowArn',
      name: 'name',

      // the properties below are optional
      description: 'description',
      references: {
        referencesKey: {
          type: 'type',
          value: 'value',
        },
      },
    }],
  },
  function: 'function',
  instanceArn: 'instanceArn',
  name: 'name',
  publishStatus: 'publishStatus',
  triggerEventSource: {
    eventSourceName: 'eventSourceName',

    // the properties below are optional
    integrationAssociationArn: 'integrationAssociationArn',
  },

  // the properties below are optional
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
actions	IResolvable | ActionsProperty	A list of actions to be run when the rule is triggered.
function	string	The conditions of the rule.
instanceArn	string	The Amazon Resource Name (ARN) of the instance.
name	string	The name of the rule.
publishStatus	string	The publish status of the rule.
triggerEventSource	IResolvable | RuleTriggerEventSourceProperty	The event source to trigger the rule.
tags?	CfnTag[]	The tags used to organize, track, or control access for this resource.

---

actions

Type: IResolvable | ActionsProperty

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

---

function

Type: string

The conditions of the rule.

---

instanceArn

Type: string

The Amazon Resource Name (ARN) of the instance.

---

name

Type: string

The name of the rule.

---

publishStatus

Type: string

The publish status of the rule.

Allowed values : DRAFT | PUBLISHED

---

triggerEventSource

Type: IResolvable | RuleTriggerEventSourceProperty

The event source to trigger the rule.

---

tags?

Type: CfnTag[] (optional)

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

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