AWS Cloud Control v1.27.0, Apr 14 25

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

aws-native.connect.getRule

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

Using getRule

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getRule(args: GetRuleArgs, opts?: InvokeOptions): Promise<GetRuleResult>
function getRuleOutput(args: GetRuleOutputArgs, opts?: InvokeOptions): Output<GetRuleResult>

def get_rule(rule_arn: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetRuleResult
def get_rule_output(rule_arn: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetRuleResult]

func LookupRule(ctx *Context, args *LookupRuleArgs, opts ...InvokeOption) (*LookupRuleResult, error)
func LookupRuleOutput(ctx *Context, args *LookupRuleOutputArgs, opts ...InvokeOption) LookupRuleResultOutput

> Note: This function is named LookupRule in the Go SDK.

public static class GetRule 
{
    public static Task<GetRuleResult> InvokeAsync(GetRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetRuleResult> Invoke(GetRuleInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetRuleResult> getRule(GetRuleArgs args, InvokeOptions options)
public static Output<GetRuleResult> getRule(GetRuleArgs args, InvokeOptions options)

fn::invoke:
  function: aws-native:connect:getRule
  arguments:
    # arguments dictionary

The following arguments are supported:

RuleArn string: The Amazon Resource Name (ARN) of the rule.

RuleArn string: The Amazon Resource Name (ARN) of the rule.

ruleArn String: The Amazon Resource Name (ARN) of the rule.

ruleArn string: The Amazon Resource Name (ARN) of the rule.

rule_arn str: The Amazon Resource Name (ARN) of the rule.

ruleArn String: The Amazon Resource Name (ARN) of the rule.

getRule Result

The following output properties are available:

Actions Pulumi.AwsNative.Connect.Outputs.RuleActions: A list of actions to be run when the rule is triggered.
Function string: The conditions of the rule.
Name string: The name of the rule.
PublishStatus Pulumi.AwsNative.Connect.RulePublishStatus: The publish status of the rule. Allowed values: DRAFT | PUBLISHED
RuleArn string: The Amazon Resource Name (ARN) of the rule.
Tags List<Pulumi.AwsNative.Outputs.Tag>: The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

Actions RuleActions: A list of actions to be run when the rule is triggered.
Function string: The conditions of the rule.
Name string: The name of the rule.
PublishStatus RulePublishStatus: The publish status of the rule. Allowed values: DRAFT | PUBLISHED
RuleArn string: The Amazon Resource Name (ARN) of the rule.
Tags Tag: The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

actions RuleActions: A list of actions to be run when the rule is triggered.
function String: The conditions of the rule.
name String: The name of the rule.
publishStatus RulePublishStatus: The publish status of the rule. Allowed values: DRAFT | PUBLISHED
ruleArn String: The Amazon Resource Name (ARN) of the rule.
tags List<Tag>: The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

actions RuleActions: A list of actions to be run when the rule is triggered.
function string: The conditions of the rule.
name string: The name of the rule.
publishStatus RulePublishStatus: The publish status of the rule. Allowed values: DRAFT | PUBLISHED
ruleArn string: The Amazon Resource Name (ARN) of the rule.
tags Tag[]: The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

actions RuleActions: A list of actions to be run when the rule is triggered.
function str: The conditions of the rule.
name str: The name of the rule.
publish_status RulePublishStatus: The publish status of the rule. Allowed values: DRAFT | PUBLISHED
rule_arn str: The Amazon Resource Name (ARN) of the rule.
tags Sequence[root_Tag]: The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

actions Property Map: A list of actions to be run when the rule is triggered.
function String: The conditions of the rule.
name String: The name of the rule.
publishStatus "DRAFT" | "PUBLISHED": The publish status of the rule. Allowed values: DRAFT | PUBLISHED
ruleArn String: The Amazon Resource Name (ARN) of the rule.
tags List<Property Map>: The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

Supporting Types

RuleActions

AssignContactCategoryActions List<Pulumi.AwsNative.Connect.Inputs.RuleAssignContactCategoryAction>: Information about the contact category action. The syntax can be empty, for example, {}.
CreateCaseActions List<Pulumi.AwsNative.Connect.Inputs.RuleCreateCaseAction>
EndAssociatedTasksActions List<Pulumi.AwsNative.Connect.Inputs.RuleEndAssociatedTasksAction>
EventBridgeActions List<Pulumi.AwsNative.Connect.Inputs.RuleEventBridgeAction>: Information about the EV action.
SendNotificationActions List<Pulumi.AwsNative.Connect.Inputs.RuleSendNotificationAction>: Information about the send notification action.
SubmitAutoEvaluationActions List<Pulumi.AwsNative.Connect.Inputs.RuleSubmitAutoEvaluationAction>
TaskActions List<Pulumi.AwsNative.Connect.Inputs.RuleTaskAction>: Information about the task action. This field is required if TriggerEventSource is one of the following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate
UpdateCaseActions List<Pulumi.AwsNative.Connect.Inputs.RuleUpdateCaseAction>

AssignContactCategoryActions []RuleAssignContactCategoryAction: Information about the contact category action. The syntax can be empty, for example, {}.
CreateCaseActions []RuleCreateCaseAction
EndAssociatedTasksActions []RuleEndAssociatedTasksAction
EventBridgeActions []RuleEventBridgeAction: Information about the EV action.
SendNotificationActions []RuleSendNotificationAction: Information about the send notification action.
SubmitAutoEvaluationActions []RuleSubmitAutoEvaluationAction
TaskActions []RuleTaskAction: Information about the task action. This field is required if TriggerEventSource is one of the following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate
UpdateCaseActions []RuleUpdateCaseAction

assignContactCategoryActions List<RuleAssignContactCategoryAction>: Information about the contact category action. The syntax can be empty, for example, {}.
createCaseActions List<RuleCreateCaseAction>
endAssociatedTasksActions List<RuleEndAssociatedTasksAction>
eventBridgeActions List<RuleEventBridgeAction>: Information about the EV action.
sendNotificationActions List<RuleSendNotificationAction>: Information about the send notification action.
submitAutoEvaluationActions List<RuleSubmitAutoEvaluationAction>
taskActions List<RuleTaskAction>: Information about the task action. This field is required if TriggerEventSource is one of the following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate
updateCaseActions List<RuleUpdateCaseAction>

assignContactCategoryActions RuleAssignContactCategoryAction[]: Information about the contact category action. The syntax can be empty, for example, {}.
createCaseActions RuleCreateCaseAction[]
endAssociatedTasksActions RuleEndAssociatedTasksAction[]
eventBridgeActions RuleEventBridgeAction[]: Information about the EV action.
sendNotificationActions RuleSendNotificationAction[]: Information about the send notification action.
submitAutoEvaluationActions RuleSubmitAutoEvaluationAction[]
taskActions RuleTaskAction[]: Information about the task action. This field is required if TriggerEventSource is one of the following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate
updateCaseActions RuleUpdateCaseAction[]

assign_contact_category_actions Sequence[RuleAssignContactCategoryAction]: Information about the contact category action. The syntax can be empty, for example, {}.
create_case_actions Sequence[RuleCreateCaseAction]
end_associated_tasks_actions Sequence[RuleEndAssociatedTasksAction]
event_bridge_actions Sequence[RuleEventBridgeAction]: Information about the EV action.
send_notification_actions Sequence[RuleSendNotificationAction]: Information about the send notification action.
submit_auto_evaluation_actions Sequence[RuleSubmitAutoEvaluationAction]
task_actions Sequence[RuleTaskAction]: Information about the task action. This field is required if TriggerEventSource is one of the following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate
update_case_actions Sequence[RuleUpdateCaseAction]

assignContactCategoryActions List<Property Map>: Information about the contact category action. The syntax can be empty, for example, {}.
createCaseActions List<Property Map>
endAssociatedTasksActions List<Property Map>
eventBridgeActions List<Property Map>: Information about the EV action.
sendNotificationActions List<Property Map>: Information about the send notification action.
submitAutoEvaluationActions List<Property Map>
taskActions List<Property Map>: Information about the task action. This field is required if TriggerEventSource is one of the following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate
updateCaseActions List<Property Map>

RuleCreateCaseAction

Fields List<Pulumi.AwsNative.Connect.Inputs.RuleField>
TemplateId string

Fields []RuleField
TemplateId string

fields List<RuleField>
templateId String

fields RuleField[]
templateId string

fields Sequence[RuleField]
template_id str

fields List<Property Map>
templateId String

RuleEventBridgeAction

Name string: The name.

Name string: The name.

name String: The name.

name string: The name.

name str: The name.

name String: The name.

RuleField

Id string
Value Pulumi.AwsNative.Connect.Inputs.RuleFieldValue

Id string
Value RuleFieldValue

id String
value RuleFieldValue

id string
value RuleFieldValue

id str
value RuleFieldValue

id String
value Property Map

RuleFieldValue

BooleanValue bool
DoubleValue double
EmptyValue object
StringValue string

BooleanValue bool
DoubleValue float64
EmptyValue interface{}
StringValue string

booleanValue Boolean
doubleValue Double
emptyValue Object
stringValue String

booleanValue boolean
doubleValue number
emptyValue any
stringValue string

boolean_value bool
double_value float
empty_value Any
string_value str

booleanValue Boolean
doubleValue Number
emptyValue Any
stringValue String

RuleNotificationRecipientType

UserArns List<string>: The Amazon Resource Name (ARN) of the user account.
UserTags Dictionary<string, string>: The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }. CON users with the specified tags will be notified.

UserArns []string: The Amazon Resource Name (ARN) of the user account.
UserTags map[string]string: The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }. CON users with the specified tags will be notified.

userArns List<String>: The Amazon Resource Name (ARN) of the user account.
userTags Map<String,String>: The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }. CON users with the specified tags will be notified.

userArns string[]: The Amazon Resource Name (ARN) of the user account.
userTags {[key: string]: string}: The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }. CON users with the specified tags will be notified.

user_arns Sequence[str]: The Amazon Resource Name (ARN) of the user account.
user_tags Mapping[str, str]: The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }. CON users with the specified tags will be notified.

userArns List<String>: The Amazon Resource Name (ARN) of the user account.
userTags Map<String>: The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }. CON users with the specified tags will be notified.

RulePublishStatus

RuleReference

Type Pulumi.AwsNative.Connect.RuleReferenceType: The type of the reference. DATE must be of type Epoch timestamp. Allowed values: URL | ATTACHMENT | NUMBER | STRING | DATE | EMAIL
Value string: A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).

Type RuleReferenceType: The type of the reference. DATE must be of type Epoch timestamp. Allowed values: URL | ATTACHMENT | NUMBER | STRING | DATE | EMAIL
Value string: A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).

type RuleReferenceType: The type of the reference. DATE must be of type Epoch timestamp. Allowed values: URL | ATTACHMENT | NUMBER | STRING | DATE | EMAIL
value String: A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).

type RuleReferenceType: The type of the reference. DATE must be of type Epoch timestamp. Allowed values: URL | ATTACHMENT | NUMBER | STRING | DATE | EMAIL
value string: A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).

type RuleReferenceType: The type of the reference. DATE must be of type Epoch timestamp. Allowed values: URL | ATTACHMENT | NUMBER | STRING | DATE | EMAIL
value str: A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).

type "URL" | "ATTACHMENT" | "NUMBER" | "STRING" | "DATE" | "EMAIL": The type of the reference. DATE must be of type Epoch timestamp. Allowed values: URL | ATTACHMENT | NUMBER | STRING | DATE | EMAIL
value String: A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).

RuleReferenceType

RuleSendNotificationAction

Content string: Notification content. Supports variable injection. For more information, see JSONPath reference in the Administrators Guide.
ContentType Pulumi.AwsNative.Connect.RuleSendNotificationActionContentType: Content type format. Allowed value: PLAIN_TEXT
DeliveryMethod Pulumi.AwsNative.Connect.RuleSendNotificationActionDeliveryMethod: Notification delivery method. Allowed value: EMAIL
Recipient Pulumi.AwsNative.Connect.Inputs.RuleNotificationRecipientType: Notification recipient.
Subject string: The subject of the email if the delivery method is EMAIL. Supports variable injection. For more information, see JSONPath reference in the Administrators Guide.

Content string: Notification content. Supports variable injection. For more information, see JSONPath reference in the Administrators Guide.
ContentType RuleSendNotificationActionContentType: Content type format. Allowed value: PLAIN_TEXT
DeliveryMethod RuleSendNotificationActionDeliveryMethod: Notification delivery method. Allowed value: EMAIL
Recipient RuleNotificationRecipientType: Notification recipient.
Subject string: The subject of the email if the delivery method is EMAIL. Supports variable injection. For more information, see JSONPath reference in the Administrators Guide.

content String: Notification content. Supports variable injection. For more information, see JSONPath reference in the Administrators Guide.
contentType RuleSendNotificationActionContentType: Content type format. Allowed value: PLAIN_TEXT
deliveryMethod RuleSendNotificationActionDeliveryMethod: Notification delivery method. Allowed value: EMAIL
recipient RuleNotificationRecipientType: Notification recipient.
subject String: The subject of the email if the delivery method is EMAIL. Supports variable injection. For more information, see JSONPath reference in the Administrators Guide.

content string: Notification content. Supports variable injection. For more information, see JSONPath reference in the Administrators Guide.
contentType RuleSendNotificationActionContentType: Content type format. Allowed value: PLAIN_TEXT
deliveryMethod RuleSendNotificationActionDeliveryMethod: Notification delivery method. Allowed value: EMAIL
recipient RuleNotificationRecipientType: Notification recipient.
subject string: The subject of the email if the delivery method is EMAIL. Supports variable injection. For more information, see JSONPath reference in the Administrators Guide.

content str: Notification content. Supports variable injection. For more information, see JSONPath reference in the Administrators Guide.
content_type RuleSendNotificationActionContentType: Content type format. Allowed value: PLAIN_TEXT
delivery_method RuleSendNotificationActionDeliveryMethod: Notification delivery method. Allowed value: EMAIL
recipient RuleNotificationRecipientType: Notification recipient.
subject str: The subject of the email if the delivery method is EMAIL. Supports variable injection. For more information, see JSONPath reference in the Administrators Guide.

content String: Notification content. Supports variable injection. For more information, see JSONPath reference in the Administrators Guide.
contentType "PLAIN_TEXT": Content type format. Allowed value: PLAIN_TEXT
deliveryMethod "EMAIL": Notification delivery method. Allowed value: EMAIL
recipient Property Map: Notification recipient.
subject String: The subject of the email if the delivery method is EMAIL. Supports variable injection. For more information, see JSONPath reference in the Administrators Guide.

RuleSendNotificationActionContentType

RuleSendNotificationActionDeliveryMethod

RuleSubmitAutoEvaluationAction

EvaluationFormArn string

EvaluationFormArn string

evaluationFormArn String

evaluationFormArn string

evaluation_form_arn str

evaluationFormArn String

RuleTaskAction

ContactFlowArn string: The Amazon Resource Name (ARN) of the flow.
Name string: The name. Supports variable injection. For more information, see JSONPath reference in the Administrators Guide.
Description string: The description. Supports variable injection. For more information, see JSONPath reference in the Administrators Guide.
References Dictionary<string, Pulumi.AwsNative.Connect.Inputs.RuleReference>: Information about the reference when the referenceType is URL. Otherwise, null. URL is the only accepted type. (Supports variable injection in the Value field.)

ContactFlowArn string: The Amazon Resource Name (ARN) of the flow.
Name string: The name. Supports variable injection. For more information, see JSONPath reference in the Administrators Guide.
Description string: The description. Supports variable injection. For more information, see JSONPath reference in the Administrators Guide.
References map[string]RuleReference: Information about the reference when the referenceType is URL. Otherwise, null. URL is the only accepted type. (Supports variable injection in the Value field.)

contactFlowArn String: The Amazon Resource Name (ARN) of the flow.
name String: The name. Supports variable injection. For more information, see JSONPath reference in the Administrators Guide.
description String: The description. Supports variable injection. For more information, see JSONPath reference in the Administrators Guide.
references Map<String,RuleReference>: Information about the reference when the referenceType is URL. Otherwise, null. URL is the only accepted type. (Supports variable injection in the Value field.)

contactFlowArn string: The Amazon Resource Name (ARN) of the flow.
name string: The name. Supports variable injection. For more information, see JSONPath reference in the Administrators Guide.
description string: The description. Supports variable injection. For more information, see JSONPath reference in the Administrators Guide.
references {[key: string]: RuleReference}: Information about the reference when the referenceType is URL. Otherwise, null. URL is the only accepted type. (Supports variable injection in the Value field.)

contact_flow_arn str: The Amazon Resource Name (ARN) of the flow.
name str: The name. Supports variable injection. For more information, see JSONPath reference in the Administrators Guide.
description str: The description. Supports variable injection. For more information, see JSONPath reference in the Administrators Guide.
references Mapping[str, RuleReference]: Information about the reference when the referenceType is URL. Otherwise, null. URL is the only accepted type. (Supports variable injection in the Value field.)

contactFlowArn String: The Amazon Resource Name (ARN) of the flow.
name String: The name. Supports variable injection. For more information, see JSONPath reference in the Administrators Guide.
description String: The description. Supports variable injection. For more information, see JSONPath reference in the Administrators Guide.
references Map<Property Map>: Information about the reference when the referenceType is URL. Otherwise, null. URL is the only accepted type. (Supports variable injection in the Value field.)