AWS Native v0.103.0, Apr 22 24

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

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

pulumi/pulumi-aws-native

aws-native.connect.getRule

Explore with Pulumi AI

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

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

pulumi/pulumi-aws-native

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.

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)
// Output-based functions aren't available in Java yet

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: The list of actions that will be executed when a rule is triggered.
Function string: The conditions of a rule.
Name string: The name of the rule.
PublishStatus Pulumi.AwsNative.Connect.RulePublishStatus: The publish status of a rule, either draft or published.
RuleArn string: The Amazon Resource Name (ARN) of the rule.
Tags List<Pulumi.AwsNative.Outputs.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.
Name string: The name of the rule.
PublishStatus RulePublishStatus: The publish status of a rule, either draft or published.
RuleArn string: The Amazon Resource Name (ARN) of the rule.
Tags 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.
name String: The name of the rule.
publishStatus RulePublishStatus: The publish status of a rule, either draft or published.
ruleArn String: The Amazon Resource Name (ARN) 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.
name string: The name of the rule.
publishStatus RulePublishStatus: The publish status of a rule, either draft or published.
ruleArn string: The Amazon Resource Name (ARN) of the rule.
tags Tag[]: One or more tags.

actions RuleActions: The list of actions that will be executed when a rule is triggered.
function str: The conditions of a rule.
name str: The name of the rule.
publish_status RulePublishStatus: The publish status of a rule, either draft or published.
rule_arn str: The Amazon Resource Name (ARN) of the rule.
tags Sequence[root_Tag]: 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.
name String: The name of the rule.
publishStatus "DRAFT" | "PUBLISHED": The publish status of a rule, either draft or published.
ruleArn String: The Amazon Resource Name (ARN) of the rule.
tags List<Property Map>: One or more tags.

Supporting Types

RuleActions

AssignContactCategoryActions List<Pulumi.AwsNative.Connect.Inputs.RuleAssignContactCategoryAction>
CreateCaseActions List<Pulumi.AwsNative.Connect.Inputs.RuleCreateCaseAction>
EndAssociatedTasksActions List<Pulumi.AwsNative.Connect.Inputs.RuleEndAssociatedTasksAction>
EventBridgeActions List<Pulumi.AwsNative.Connect.Inputs.RuleEventBridgeAction>
SendNotificationActions List<Pulumi.AwsNative.Connect.Inputs.RuleSendNotificationAction>
TaskActions List<Pulumi.AwsNative.Connect.Inputs.RuleTaskAction>
UpdateCaseActions List<Pulumi.AwsNative.Connect.Inputs.RuleUpdateCaseAction>

AssignContactCategoryActions []RuleAssignContactCategoryAction
CreateCaseActions []RuleCreateCaseAction
EndAssociatedTasksActions []RuleEndAssociatedTasksAction
EventBridgeActions []RuleEventBridgeAction
SendNotificationActions []RuleSendNotificationAction
TaskActions []RuleTaskAction
UpdateCaseActions []RuleUpdateCaseAction

assignContactCategoryActions List<RuleAssignContactCategoryAction>
createCaseActions List<RuleCreateCaseAction>
endAssociatedTasksActions List<RuleEndAssociatedTasksAction>
eventBridgeActions List<RuleEventBridgeAction>
sendNotificationActions List<RuleSendNotificationAction>
taskActions List<RuleTaskAction>
updateCaseActions List<RuleUpdateCaseAction>

assignContactCategoryActions RuleAssignContactCategoryAction[]
createCaseActions RuleCreateCaseAction[]
endAssociatedTasksActions RuleEndAssociatedTasksAction[]
eventBridgeActions RuleEventBridgeAction[]
sendNotificationActions RuleSendNotificationAction[]
taskActions RuleTaskAction[]
updateCaseActions RuleUpdateCaseAction[]

assign_contact_category_actions Sequence[RuleAssignContactCategoryAction]
create_case_actions Sequence[RuleCreateCaseAction]
end_associated_tasks_actions Sequence[RuleEndAssociatedTasksAction]
event_bridge_actions Sequence[RuleEventBridgeAction]
send_notification_actions Sequence[RuleSendNotificationAction]
task_actions Sequence[RuleTaskAction]
update_case_actions Sequence[RuleUpdateCaseAction]

assignContactCategoryActions List<Property Map>
createCaseActions List<Property Map>
endAssociatedTasksActions List<Property Map>
eventBridgeActions List<Property Map>
sendNotificationActions List<Property Map>
taskActions List<Property Map>
updateCaseActions List<Property Map>

RuleCreateCaseAction

Fields List<Pulumi.AwsNative.Connect.Inputs.RuleField>
TemplateId string: The Id of template.

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

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

Id string: The Id of the field
Value Pulumi.AwsNative.Connect.Inputs.RuleFieldValue

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

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

RuleReference

Type Pulumi.AwsNative.Connect.RuleReferenceType
Value string

Type RuleReferenceType
Value string

type RuleReferenceType
value String

type RuleReferenceType
value string

type RuleReferenceType
value str

type "URL" | "ATTACHMENT" | "NUMBER" | "STRING" | "DATE" | "EMAIL"
value String

RuleReferenceType

RuleSendNotificationAction

Content string: The content of notification.
ContentType Pulumi.AwsNative.Connect.RuleSendNotificationActionContentType: The type of content.
DeliveryMethod Pulumi.AwsNative.Connect.RuleSendNotificationActionDeliveryMethod: The means of delivery.
Recipient Pulumi.AwsNative.Connect.Inputs.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 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

RuleSendNotificationActionDeliveryMethod

RuleTaskAction

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).