ActionsProperty Struct
A list of actions to be run when the rule is triggered.
Example
ts
// 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',
}],
sendInAppNotificationActions: [{
content: {
deDe: 'deDe',
enUs: 'enUs',
esEs: 'esEs',
frFr: 'frFr',
idId: 'idId',
itIt: 'itIt',
jaJp: 'jaJp',
koKr: 'koKr',
ptBr: 'ptBr',
zhCn: 'zhCn',
zhTw: 'zhTw',
},
recipient: {
userArns: ['userArns'],
userTags: {
userTagsKey: 'userTags',
},
},
// the properties below are optional
exclusion: {
userArns: ['userArns'],
userTags: {
userTagsKey: 'userTags',
},
},
priority: 'priority',
}],
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
assignContactCategoryActionsoptionalany[] | IResolvableassign_contact_category_actionsoptionaltyping.Union[typing.List[Any], IResolvable]assignContactCategoryActionsoptionalList<Object>AssignContactCategoryActionsoptionalobject[]AssignContactCategoryActionsoptionalinterface{}#Information about the contact category action.
The syntax can be empty, for example, {} .
assignSlaActionsoptionalIResolvable | IResolvable | CfnRule.AssignSlaActionProperty[]assign_sla_actionsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, AssignSlaActionProperty]]]assignSlaActionsoptionalIResolvableAssignSlaActionsoptionalIResolvableAssignSlaActionsoptionalinterface{}#This action will assign an SLA when a rule is triggered.
createCaseActionsoptionalIResolvable | IResolvable | CfnRule.CreateCaseActionProperty[]create_case_actionsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, CreateCaseActionProperty]]]createCaseActionsoptionalIResolvableCreateCaseActionsoptionalIResolvableCreateCaseActionsoptionalinterface{}#This action will create a case when a rule is triggered.
endAssociatedTasksActionsoptionalany[] | IResolvableend_associated_tasks_actionsoptionaltyping.Union[typing.List[Any], IResolvable]endAssociatedTasksActionsoptionalList<Object>EndAssociatedTasksActionsoptionalobject[]EndAssociatedTasksActionsoptionalinterface{}#This action will end associated tasks when a rule is triggered.
eventBridgeActionsoptionalIResolvable | IResolvable | CfnRule.EventBridgeActionProperty[]event_bridge_actionsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, EventBridgeActionProperty]]]eventBridgeActionsoptionalIResolvableEventBridgeActionsoptionalIResolvableEventBridgeActionsoptionalinterface{}#Information about the EventBridge action.
sendInAppNotificationActionsoptionalIResolvable | IResolvable | CfnRule.SendInAppNotificationActionProperty[]send_in_app_notification_actionsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, SendInAppNotificationActionProperty]]]sendInAppNotificationActionsoptionalIResolvableSendInAppNotificationActionsoptionalIResolvableSendInAppNotificationActionsoptionalinterface{}#This action will send an in-app notification when a rule is triggered.
sendNotificationActionsoptionalIResolvable | IResolvable | CfnRule.SendNotificationActionProperty[]send_notification_actionsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, SendNotificationActionProperty]]]sendNotificationActionsoptionalIResolvableSendNotificationActionsoptionalIResolvableSendNotificationActionsoptionalinterface{}#Information about the send notification action.
submitAutoEvaluationActionsoptionalIResolvable | IResolvable | CfnRule.SubmitAutoEvaluationActionProperty[]submit_auto_evaluation_actionsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, SubmitAutoEvaluationActionProperty]]]submitAutoEvaluationActionsoptionalIResolvableSubmitAutoEvaluationActionsoptionalIResolvableSubmitAutoEvaluationActionsoptionalinterface{}#This action will submit an auto contact evaluation when a rule is triggered.
taskActionsoptionalIResolvable | IResolvable | CfnRule.TaskActionProperty[]task_actionsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, TaskActionProperty]]]taskActionsoptionalIResolvableTaskActionsoptionalIResolvableTaskActionsoptionalinterface{}#Information about the task action.
This field is required if TriggerEventSource is one of the following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate
updateCaseActionsoptionalIResolvable | IResolvable | CfnRule.UpdateCaseActionProperty[]update_case_actionsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, UpdateCaseActionProperty]]]updateCaseActionsoptionalIResolvableUpdateCaseActionsoptionalIResolvableUpdateCaseActionsoptionalinterface{}#This action will update a case when a rule is triggered.