1. Packages
  2. AWS Native
  3. API Docs
  4. connect
  5. Rule

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi

aws-native.connect.Rule

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi

    Resource Type definition for AWS:Connect::Rule

    Create Rule Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Rule(name: string, args: RuleArgs, opts?: CustomResourceOptions);
    @overload
    def Rule(resource_name: str,
             args: RuleArgs,
             opts: Optional[ResourceOptions] = None)
    
    @overload
    def Rule(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             actions: Optional[RuleActionsArgs] = None,
             function: Optional[str] = None,
             instance_arn: Optional[str] = None,
             publish_status: Optional[RulePublishStatus] = None,
             trigger_event_source: Optional[RuleTriggerEventSourceArgs] = None,
             name: Optional[str] = None,
             tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewRule(ctx *Context, name string, args RuleArgs, opts ...ResourceOption) (*Rule, error)
    public Rule(string name, RuleArgs args, CustomResourceOptions? opts = null)
    public Rule(String name, RuleArgs args)
    public Rule(String name, RuleArgs args, CustomResourceOptions options)
    
    type: aws-native:connect:Rule
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args RuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args RuleArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args RuleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RuleArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const ruleResource = new aws_native.connect.Rule("ruleResource", {
        actions: {
            assignContactCategoryActions: [{}],
            createCaseActions: [{
                fields: [{
                    id: "string",
                    value: {
                        booleanValue: false,
                        doubleValue: 0,
                        emptyValue: "any",
                        stringValue: "string",
                    },
                }],
                templateId: "string",
            }],
            endAssociatedTasksActions: [{}],
            eventBridgeActions: [{
                name: "string",
            }],
            sendNotificationActions: [{
                content: "string",
                contentType: aws_native.connect.RuleSendNotificationActionContentType.PlainText,
                deliveryMethod: aws_native.connect.RuleSendNotificationActionDeliveryMethod.Email,
                recipient: {
                    userArns: ["string"],
                    userTags: {
                        string: "string",
                    },
                },
                subject: "string",
            }],
            taskActions: [{
                contactFlowArn: "string",
                name: "string",
                description: "string",
                references: {
                    string: {
                        type: aws_native.connect.RuleReferenceType.Url,
                        value: "string",
                    },
                },
            }],
            updateCaseActions: [{
                fields: [{
                    id: "string",
                    value: {
                        booleanValue: false,
                        doubleValue: 0,
                        emptyValue: "any",
                        stringValue: "string",
                    },
                }],
            }],
        },
        "function": "string",
        instanceArn: "string",
        publishStatus: aws_native.connect.RulePublishStatus.Draft,
        triggerEventSource: {
            eventSourceName: aws_native.connect.RuleTriggerEventSourceEventSourceName.OnContactEvaluationSubmit,
            integrationAssociationArn: "string",
        },
        name: "string",
        tags: [{
            key: "string",
            value: "string",
        }],
    });
    
    Coming soon!
    

    Rule Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Rule resource accepts the following input properties:

    Actions Pulumi.AwsNative.Connect.Inputs.RuleActions
    The list of actions that will be executed when a rule is triggered.
    Function string
    The conditions of a rule.
    InstanceArn string
    The Amazon Resource Name (ARN) of the instance.
    PublishStatus Pulumi.AwsNative.Connect.RulePublishStatus
    The publish status of a rule, either draft or published.
    TriggerEventSource Pulumi.AwsNative.Connect.Inputs.RuleTriggerEventSource
    The event source that triggers the rule.
    Name string
    The name of the rule.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    One or more tags.
    Actions RuleActionsArgs
    The list of actions that will be executed when a rule is triggered.
    Function string
    The conditions of a rule.
    InstanceArn string
    The Amazon Resource Name (ARN) of the instance.
    PublishStatus RulePublishStatus
    The publish status of a rule, either draft or published.
    TriggerEventSource RuleTriggerEventSourceArgs
    The event source that triggers the rule.
    Name string
    The name of the rule.
    Tags TagArgs
    One or more tags.
    actions RuleActions
    The list of actions that will be executed when a rule is triggered.
    function String
    The conditions of a rule.
    instanceArn String
    The Amazon Resource Name (ARN) of the instance.
    publishStatus RulePublishStatus
    The publish status of a rule, either draft or published.
    triggerEventSource RuleTriggerEventSource
    The event source that triggers the rule.
    name String
    The name of the rule.
    tags List<Tag>
    One or more tags.
    actions RuleActions
    The list of actions that will be executed when a rule is triggered.
    function string
    The conditions of a rule.
    instanceArn string
    The Amazon Resource Name (ARN) of the instance.
    publishStatus RulePublishStatus
    The publish status of a rule, either draft or published.
    triggerEventSource RuleTriggerEventSource
    The event source that triggers the rule.
    name string
    The name of the rule.
    tags Tag[]
    One or more tags.
    actions RuleActionsArgs
    The list of actions that will be executed when a rule is triggered.
    function str
    The conditions of a rule.
    instance_arn str
    The Amazon Resource Name (ARN) of the instance.
    publish_status RulePublishStatus
    The publish status of a rule, either draft or published.
    trigger_event_source RuleTriggerEventSourceArgs
    The event source that triggers the rule.
    name str
    The name of the rule.
    tags Sequence[TagArgs]
    One or more tags.
    actions Property Map
    The list of actions that will be executed when a rule is triggered.
    function String
    The conditions of a rule.
    instanceArn String
    The Amazon Resource Name (ARN) of the instance.
    publishStatus "DRAFT" | "PUBLISHED"
    The publish status of a rule, either draft or published.
    triggerEventSource Property Map
    The event source that triggers the rule.
    name String
    The name of the rule.
    tags List<Property Map>
    One or more tags.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Rule resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    RuleArn string
    The Amazon Resource Name (ARN) of the rule.
    Id string
    The provider-assigned unique ID for this managed resource.
    RuleArn string
    The Amazon Resource Name (ARN) of the rule.
    id String
    The provider-assigned unique ID for this managed resource.
    ruleArn String
    The Amazon Resource Name (ARN) of the rule.
    id string
    The provider-assigned unique ID for this managed resource.
    ruleArn string
    The Amazon Resource Name (ARN) of the rule.
    id str
    The provider-assigned unique ID for this managed resource.
    rule_arn str
    The Amazon Resource Name (ARN) of the rule.
    id String
    The provider-assigned unique ID for this managed resource.
    ruleArn String
    The Amazon Resource Name (ARN) of the rule.

    Supporting Types

    RuleActions, RuleActionsArgs

    RuleCreateCaseAction, RuleCreateCaseActionArgs

    Fields []RuleField
    TemplateId string
    The Id of template.
    fields List<RuleField>
    templateId String
    The Id of template.
    fields RuleField[]
    templateId string
    The Id of template.
    fields Sequence[RuleField]
    template_id str
    The Id of template.
    fields List<Property Map>
    templateId String
    The Id of template.

    RuleEventBridgeAction, RuleEventBridgeActionArgs

    Name string
    The name of the event bridge action.
    Name string
    The name of the event bridge action.
    name String
    The name of the event bridge action.
    name string
    The name of the event bridge action.
    name str
    The name of the event bridge action.
    name String
    The name of the event bridge action.

    RuleField, RuleFieldArgs

    Id string
    The Id of the field
    Value RuleFieldValue
    id String
    The Id of the field
    value RuleFieldValue
    id string
    The Id of the field
    value RuleFieldValue
    id str
    The Id of the field
    value RuleFieldValue
    id String
    The Id of the field
    value Property Map

    RuleFieldValue, RuleFieldValueArgs

    BooleanValue bool
    DoubleValue float64
    EmptyValue interface{}
    StringValue string

    RuleNotificationRecipientType, RuleNotificationRecipientTypeArgs

    UserArns List<string>
    The list of recipients by user arns.
    UserTags Dictionary<string, string>
    The collection of recipients who are identified by user tags
    UserArns []string
    The list of recipients by user arns.
    UserTags map[string]string
    The collection of recipients who are identified by user tags
    userArns List<String>
    The list of recipients by user arns.
    userTags Map<String,String>
    The collection of recipients who are identified by user tags
    userArns string[]
    The list of recipients by user arns.
    userTags {[key: string]: string}
    The collection of recipients who are identified by user tags
    user_arns Sequence[str]
    The list of recipients by user arns.
    user_tags Mapping[str, str]
    The collection of recipients who are identified by user tags
    userArns List<String>
    The list of recipients by user arns.
    userTags Map<String>
    The collection of recipients who are identified by user tags

    RulePublishStatus, RulePublishStatusArgs

    Draft
    DRAFT
    Published
    PUBLISHED
    RulePublishStatusDraft
    DRAFT
    RulePublishStatusPublished
    PUBLISHED
    Draft
    DRAFT
    Published
    PUBLISHED
    Draft
    DRAFT
    Published
    PUBLISHED
    DRAFT
    DRAFT
    PUBLISHED
    PUBLISHED
    "DRAFT"
    DRAFT
    "PUBLISHED"
    PUBLISHED

    RuleReference, RuleReferenceArgs

    RuleReferenceType, RuleReferenceTypeArgs

    Url
    URL
    Attachment
    ATTACHMENT
    Number
    NUMBER
    String
    STRING
    Date
    DATE
    Email
    EMAIL
    RuleReferenceTypeUrl
    URL
    RuleReferenceTypeAttachment
    ATTACHMENT
    RuleReferenceTypeNumber
    NUMBER
    RuleReferenceTypeString
    STRING
    RuleReferenceTypeDate
    DATE
    RuleReferenceTypeEmail
    EMAIL
    Url
    URL
    Attachment
    ATTACHMENT
    Number
    NUMBER
    String
    STRING
    Date
    DATE
    Email
    EMAIL
    Url
    URL
    Attachment
    ATTACHMENT
    Number
    NUMBER
    String
    STRING
    Date
    DATE
    Email
    EMAIL
    URL
    URL
    ATTACHMENT
    ATTACHMENT
    NUMBER
    NUMBER
    STRING
    STRING
    DATE
    DATE
    EMAIL
    EMAIL
    "URL"
    URL
    "ATTACHMENT"
    ATTACHMENT
    "NUMBER"
    NUMBER
    "STRING"
    STRING
    "DATE"
    DATE
    "EMAIL"
    EMAIL

    RuleSendNotificationAction, RuleSendNotificationActionArgs

    Content string
    The content of notification.
    ContentType RuleSendNotificationActionContentType
    The type of content.
    DeliveryMethod RuleSendNotificationActionDeliveryMethod
    The means of delivery.
    Recipient RuleNotificationRecipientType
    Subject string
    The subject of notification.
    content String
    The content of notification.
    contentType RuleSendNotificationActionContentType
    The type of content.
    deliveryMethod RuleSendNotificationActionDeliveryMethod
    The means of delivery.
    recipient RuleNotificationRecipientType
    subject String
    The subject of notification.
    content string
    The content of notification.
    contentType RuleSendNotificationActionContentType
    The type of content.
    deliveryMethod RuleSendNotificationActionDeliveryMethod
    The means of delivery.
    recipient RuleNotificationRecipientType
    subject string
    The subject of notification.
    content str
    The content of notification.
    content_type RuleSendNotificationActionContentType
    The type of content.
    delivery_method RuleSendNotificationActionDeliveryMethod
    The means of delivery.
    recipient RuleNotificationRecipientType
    subject str
    The subject of notification.
    content String
    The content of notification.
    contentType "PLAIN_TEXT"
    The type of content.
    deliveryMethod "EMAIL"
    The means of delivery.
    recipient Property Map
    subject String
    The subject of notification.

    RuleSendNotificationActionContentType, RuleSendNotificationActionContentTypeArgs

    PlainText
    PLAIN_TEXT
    RuleSendNotificationActionContentTypePlainText
    PLAIN_TEXT
    PlainText
    PLAIN_TEXT
    PlainText
    PLAIN_TEXT
    PLAIN_TEXT
    PLAIN_TEXT
    "PLAIN_TEXT"
    PLAIN_TEXT

    RuleSendNotificationActionDeliveryMethod, RuleSendNotificationActionDeliveryMethodArgs

    Email
    EMAIL
    RuleSendNotificationActionDeliveryMethodEmail
    EMAIL
    Email
    EMAIL
    Email
    EMAIL
    EMAIL
    EMAIL
    "EMAIL"
    EMAIL

    RuleTaskAction, RuleTaskActionArgs

    ContactFlowArn string
    The Amazon Resource Name (ARN) of the contact flow.
    Name string
    The name which appears in the agent's Contact Control Panel (CCP).
    Description string
    The description which appears in the agent's Contact Control Panel (CCP).
    References Dictionary<string, Pulumi.AwsNative.Connect.Inputs.RuleReference>
    A formatted URL that is shown to an agent in the Contact Control Panel (CCP).
    ContactFlowArn string
    The Amazon Resource Name (ARN) of the contact flow.
    Name string
    The name which appears in the agent's Contact Control Panel (CCP).
    Description string
    The description which appears in the agent's Contact Control Panel (CCP).
    References map[string]RuleReference
    A formatted URL that is shown to an agent in the Contact Control Panel (CCP).
    contactFlowArn String
    The Amazon Resource Name (ARN) of the contact flow.
    name String
    The name which appears in the agent's Contact Control Panel (CCP).
    description String
    The description which appears in the agent's Contact Control Panel (CCP).
    references Map<String,RuleReference>
    A formatted URL that is shown to an agent in the Contact Control Panel (CCP).
    contactFlowArn string
    The Amazon Resource Name (ARN) of the contact flow.
    name string
    The name which appears in the agent's Contact Control Panel (CCP).
    description string
    The description which appears in the agent's Contact Control Panel (CCP).
    references {[key: string]: RuleReference}
    A formatted URL that is shown to an agent in the Contact Control Panel (CCP).
    contact_flow_arn str
    The Amazon Resource Name (ARN) of the contact flow.
    name str
    The name which appears in the agent's Contact Control Panel (CCP).
    description str
    The description which appears in the agent's Contact Control Panel (CCP).
    references Mapping[str, RuleReference]
    A formatted URL that is shown to an agent in the Contact Control Panel (CCP).
    contactFlowArn String
    The Amazon Resource Name (ARN) of the contact flow.
    name String
    The name which appears in the agent's Contact Control Panel (CCP).
    description String
    The description which appears in the agent's Contact Control Panel (CCP).
    references Map<Property Map>
    A formatted URL that is shown to an agent in the Contact Control Panel (CCP).

    RuleTriggerEventSource, RuleTriggerEventSourceArgs

    EventSourceName Pulumi.AwsNative.Connect.RuleTriggerEventSourceEventSourceName
    The name of event source.
    IntegrationAssociationArn string
    The Amazon Resource Name (ARN) for the AppIntegration association.
    EventSourceName RuleTriggerEventSourceEventSourceName
    The name of event source.
    IntegrationAssociationArn string
    The Amazon Resource Name (ARN) for the AppIntegration association.
    eventSourceName RuleTriggerEventSourceEventSourceName
    The name of event source.
    integrationAssociationArn String
    The Amazon Resource Name (ARN) for the AppIntegration association.
    eventSourceName RuleTriggerEventSourceEventSourceName
    The name of event source.
    integrationAssociationArn string
    The Amazon Resource Name (ARN) for the AppIntegration association.
    event_source_name RuleTriggerEventSourceEventSourceName
    The name of event source.
    integration_association_arn str
    The Amazon Resource Name (ARN) for the AppIntegration association.

    RuleTriggerEventSourceEventSourceName, RuleTriggerEventSourceEventSourceNameArgs

    OnContactEvaluationSubmit
    OnContactEvaluationSubmit
    OnPostCallAnalysisAvailable
    OnPostCallAnalysisAvailable
    OnRealTimeCallAnalysisAvailable
    OnRealTimeCallAnalysisAvailable
    OnRealTimeChatAnalysisAvailable
    OnRealTimeChatAnalysisAvailable
    OnPostChatAnalysisAvailable
    OnPostChatAnalysisAvailable
    OnZendeskTicketCreate
    OnZendeskTicketCreate
    OnZendeskTicketStatusUpdate
    OnZendeskTicketStatusUpdate
    OnSalesforceCaseCreate
    OnSalesforceCaseCreate
    OnMetricDataUpdate
    OnMetricDataUpdate
    OnCaseCreate
    OnCaseCreate
    OnCaseUpdate
    OnCaseUpdate
    RuleTriggerEventSourceEventSourceNameOnContactEvaluationSubmit
    OnContactEvaluationSubmit
    RuleTriggerEventSourceEventSourceNameOnPostCallAnalysisAvailable
    OnPostCallAnalysisAvailable
    RuleTriggerEventSourceEventSourceNameOnRealTimeCallAnalysisAvailable
    OnRealTimeCallAnalysisAvailable
    RuleTriggerEventSourceEventSourceNameOnRealTimeChatAnalysisAvailable
    OnRealTimeChatAnalysisAvailable
    RuleTriggerEventSourceEventSourceNameOnPostChatAnalysisAvailable
    OnPostChatAnalysisAvailable
    RuleTriggerEventSourceEventSourceNameOnZendeskTicketCreate
    OnZendeskTicketCreate
    RuleTriggerEventSourceEventSourceNameOnZendeskTicketStatusUpdate
    OnZendeskTicketStatusUpdate
    RuleTriggerEventSourceEventSourceNameOnSalesforceCaseCreate
    OnSalesforceCaseCreate
    RuleTriggerEventSourceEventSourceNameOnMetricDataUpdate
    OnMetricDataUpdate
    RuleTriggerEventSourceEventSourceNameOnCaseCreate
    OnCaseCreate
    RuleTriggerEventSourceEventSourceNameOnCaseUpdate
    OnCaseUpdate
    OnContactEvaluationSubmit
    OnContactEvaluationSubmit
    OnPostCallAnalysisAvailable
    OnPostCallAnalysisAvailable
    OnRealTimeCallAnalysisAvailable
    OnRealTimeCallAnalysisAvailable
    OnRealTimeChatAnalysisAvailable
    OnRealTimeChatAnalysisAvailable
    OnPostChatAnalysisAvailable
    OnPostChatAnalysisAvailable
    OnZendeskTicketCreate
    OnZendeskTicketCreate
    OnZendeskTicketStatusUpdate
    OnZendeskTicketStatusUpdate
    OnSalesforceCaseCreate
    OnSalesforceCaseCreate
    OnMetricDataUpdate
    OnMetricDataUpdate
    OnCaseCreate
    OnCaseCreate
    OnCaseUpdate
    OnCaseUpdate
    OnContactEvaluationSubmit
    OnContactEvaluationSubmit
    OnPostCallAnalysisAvailable
    OnPostCallAnalysisAvailable
    OnRealTimeCallAnalysisAvailable
    OnRealTimeCallAnalysisAvailable
    OnRealTimeChatAnalysisAvailable
    OnRealTimeChatAnalysisAvailable
    OnPostChatAnalysisAvailable
    OnPostChatAnalysisAvailable
    OnZendeskTicketCreate
    OnZendeskTicketCreate
    OnZendeskTicketStatusUpdate
    OnZendeskTicketStatusUpdate
    OnSalesforceCaseCreate
    OnSalesforceCaseCreate
    OnMetricDataUpdate
    OnMetricDataUpdate
    OnCaseCreate
    OnCaseCreate
    OnCaseUpdate
    OnCaseUpdate
    ON_CONTACT_EVALUATION_SUBMIT
    OnContactEvaluationSubmit
    ON_POST_CALL_ANALYSIS_AVAILABLE
    OnPostCallAnalysisAvailable
    ON_REAL_TIME_CALL_ANALYSIS_AVAILABLE
    OnRealTimeCallAnalysisAvailable
    ON_REAL_TIME_CHAT_ANALYSIS_AVAILABLE
    OnRealTimeChatAnalysisAvailable
    ON_POST_CHAT_ANALYSIS_AVAILABLE
    OnPostChatAnalysisAvailable
    ON_ZENDESK_TICKET_CREATE
    OnZendeskTicketCreate
    ON_ZENDESK_TICKET_STATUS_UPDATE
    OnZendeskTicketStatusUpdate
    ON_SALESFORCE_CASE_CREATE
    OnSalesforceCaseCreate
    ON_METRIC_DATA_UPDATE
    OnMetricDataUpdate
    ON_CASE_CREATE
    OnCaseCreate
    ON_CASE_UPDATE
    OnCaseUpdate
    "OnContactEvaluationSubmit"
    OnContactEvaluationSubmit
    "OnPostCallAnalysisAvailable"
    OnPostCallAnalysisAvailable
    "OnRealTimeCallAnalysisAvailable"
    OnRealTimeCallAnalysisAvailable
    "OnRealTimeChatAnalysisAvailable"
    OnRealTimeChatAnalysisAvailable
    "OnPostChatAnalysisAvailable"
    OnPostChatAnalysisAvailable
    "OnZendeskTicketCreate"
    OnZendeskTicketCreate
    "OnZendeskTicketStatusUpdate"
    OnZendeskTicketStatusUpdate
    "OnSalesforceCaseCreate"
    OnSalesforceCaseCreate
    "OnMetricDataUpdate"
    OnMetricDataUpdate
    "OnCaseCreate"
    OnCaseCreate
    "OnCaseUpdate"
    OnCaseUpdate

    RuleUpdateCaseAction, RuleUpdateCaseActionArgs

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi