interface ActionsProperty

Language	Type name
.NET	`Amazon.CDK.AWS.Connect.CfnRule.ActionsProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsconnect#CfnRule_ActionsProperty`
Java	`software.amazon.awscdk.services.connect.CfnRule.ActionsProperty`
Python	`aws_cdk.aws_connect.CfnRule.ActionsProperty`
TypeScript	`aws-cdk-lib` » `aws_connect` » `CfnRule` » `ActionsProperty`

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

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],
  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
    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

Name	Type	Description
assignContactCategoryActions?	`any[] \|` `IResolvable`	Information about the contact category action.
createCaseActions?	`IResolvable` `\|` `IResolvable` `\|` `CreateCaseActionProperty[]`	This action will create a case when a rule is triggered.
endAssociatedTasksActions?	`any[] \|` `IResolvable`	This action will end associated tasks when a rule is triggered.
eventBridgeActions?	`IResolvable` `\|` `IResolvable` `\|` `EventBridgeActionProperty[]`	Information about the EventBridge action.
sendNotificationActions?	`IResolvable` `\|` `IResolvable` `\|` `SendNotificationActionProperty[]`	Information about the send notification action.
submitAutoEvaluationActions?	`IResolvable` `\|` `IResolvable` `\|` `SubmitAutoEvaluationActionProperty[]`	This action will submit an auto contact evaluation when a rule is triggered.
taskActions?	`IResolvable` `\|` `IResolvable` `\|` `TaskActionProperty[]`	Information about the task action.
updateCaseActions?	`IResolvable` `\|` `IResolvable` `\|` `UpdateCaseActionProperty[]`	This action will update a case when a rule is triggered.

assignContactCategoryActions?

Type: any[] | IResolvable (optional)

Information about the contact category action.

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

createCaseActions?

Type: IResolvable | IResolvable | CreateCaseActionProperty[] (optional)

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

endAssociatedTasksActions?

Type: any[] | IResolvable (optional)

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

eventBridgeActions?

Type: IResolvable | IResolvable | EventBridgeActionProperty[] (optional)

Information about the EventBridge action.

sendNotificationActions?

Type: IResolvable | IResolvable | SendNotificationActionProperty[] (optional)

Information about the send notification action.

submitAutoEvaluationActions?

Type: IResolvable | IResolvable | SubmitAutoEvaluationActionProperty[] (optional)

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

taskActions?

Type: IResolvable | IResolvable | TaskActionProperty[] (optional)

Information about the task action.

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

updateCaseActions?

Type: IResolvable | IResolvable | UpdateCaseActionProperty[] (optional)

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