aws-cdk-lib.aws_connect.CfnRule.ActionsProperty

ActionsProperty Struct

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

Source

Generated code

Type last changed

v2.262.0 · 22 Jul 2026

Example

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

declare const assignContactCategoryActions: any;
declare const emptyValue: any;
declare const endAssociatedTasksActions: any;
const actionsProperty: connect.CfnRule.ActionsProperty = {
  assignContactCategoryActions: [assignContactCategoryActions],
  assignSlaActions: [{
    caseSlaConfiguration: {
      name: 'name',
      targetSlaMinutes: 123,
      type: 'type',

      // the properties below are optional
      fieldId: 'fieldId',
      targetFieldValues: [{
        stringValue: 'stringValue',
      }],
    },
    slaAssignmentType: 'slaAssignmentType',
  }],
  createCaseActions: [{
    fields: [{
      id: 'id',
      value: {
        booleanValue: false,
        doubleValue: 123,
        emptyValue: emptyValue,
        stringValue: 'stringValue',
      },
    }],
    templateId: 'templateId',
  }],
  endAssociatedTasksActions: [endAssociatedTasksActions],
  eventBridgeActions: [{
    name: 'name',
  }],
  sendNotificationActions: [{
    content: 'content',
    contentType: 'contentType',
    deliveryMethod: 'deliveryMethod',
    recipient: {
      userArns: ['userArns'],
      userTags: {
        userTagsKey: 'userTags',
      },
    },

    // the properties below are optional
    exclusion: {
      userArns: ['userArns'],
      userTags: {
        userTagsKey: 'userTags',
      },
    },
    subject: 'subject',
  }],
  submitAutoEvaluationActions: [{
    evaluationFormArn: 'evaluationFormArn',
  }],
  taskActions: [{
    contactFlowArn: 'contactFlowArn',
    name: 'name',

    // the properties below are optional
    description: 'description',
    references: {
      referencesKey: {
        type: 'type',
        value: 'value',
      },
    },
  }],
  updateCaseActions: [{
    fields: [{
      id: 'id',
      value: {
        booleanValue: false,
        doubleValue: 123,
        emptyValue: emptyValue,
        stringValue: 'stringValue',
      },
    }],
  }],
};

Properties

assignContactCategoryActionsany[] | IResolvableassign_contact_category_actionstyping.Union[typing.List[Any], IResolvable]assignContactCategoryActionsList<Object>AssignContactCategoryActionsobject[]AssignContactCategoryActionsinterface{}#

Information about the contact category action.

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

assignSlaActionsIResolvable | IResolvable | CfnRule.AssignSlaActionProperty[]assign_sla_actionstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, AssignSlaActionProperty]]]assignSlaActionsIResolvableAssignSlaActionsIResolvableAssignSlaActionsinterface{}#

This action will assign an SLA when a rule is triggered.

createCaseActionsIResolvable | IResolvable | CfnRule.CreateCaseActionProperty[]create_case_actionstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, CreateCaseActionProperty]]]createCaseActionsIResolvableCreateCaseActionsIResolvableCreateCaseActionsinterface{}#

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

endAssociatedTasksActionsany[] | IResolvableend_associated_tasks_actionstyping.Union[typing.List[Any], IResolvable]endAssociatedTasksActionsList<Object>EndAssociatedTasksActionsobject[]EndAssociatedTasksActionsinterface{}#

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

eventBridgeActionsIResolvable | IResolvable | CfnRule.EventBridgeActionProperty[]event_bridge_actionstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, EventBridgeActionProperty]]]eventBridgeActionsIResolvableEventBridgeActionsIResolvableEventBridgeActionsinterface{}#

Information about the EventBridge action.

sendNotificationActionsIResolvable | IResolvable | CfnRule.SendNotificationActionProperty[]send_notification_actionstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, SendNotificationActionProperty]]]sendNotificationActionsIResolvableSendNotificationActionsIResolvableSendNotificationActionsinterface{}#

Information about the send notification action.

submitAutoEvaluationActionsIResolvable | IResolvable | CfnRule.SubmitAutoEvaluationActionProperty[]submit_auto_evaluation_actionstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, SubmitAutoEvaluationActionProperty]]]submitAutoEvaluationActionsIResolvableSubmitAutoEvaluationActionsIResolvableSubmitAutoEvaluationActionsinterface{}#

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

taskActionsIResolvable | IResolvable | CfnRule.TaskActionProperty[]task_actionstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, TaskActionProperty]]]taskActionsIResolvableTaskActionsIResolvableTaskActionsinterface{}#

Information about the task action.

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

updateCaseActionsIResolvable | IResolvable | CfnRule.UpdateCaseActionProperty[]update_case_actionstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, UpdateCaseActionProperty]]]updateCaseActionsIResolvableUpdateCaseActionsIResolvableUpdateCaseActionsinterface{}#

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