We recommend new projects start with resources from the AWS provider.
We recommend new projects start with resources from the AWS provider.
A case rule. In the Amazon Connect admin website, case rules are known as case field conditions. Case rules are used to define the situations under which fields should have certain effects (such as required).
Using getCaseRule
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 getCaseRule(args: GetCaseRuleArgs, opts?: InvokeOptions): Promise<GetCaseRuleResult>
function getCaseRuleOutput(args: GetCaseRuleOutputArgs, opts?: InvokeOptions): Output<GetCaseRuleResult>def get_case_rule(case_rule_arn: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetCaseRuleResult
def get_case_rule_output(case_rule_arn: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetCaseRuleResult]func LookupCaseRule(ctx *Context, args *LookupCaseRuleArgs, opts ...InvokeOption) (*LookupCaseRuleResult, error)
func LookupCaseRuleOutput(ctx *Context, args *LookupCaseRuleOutputArgs, opts ...InvokeOption) LookupCaseRuleResultOutput> Note: This function is named LookupCaseRule in the Go SDK.
public static class GetCaseRule
{
public static Task<GetCaseRuleResult> InvokeAsync(GetCaseRuleArgs args, InvokeOptions? opts = null)
public static Output<GetCaseRuleResult> Invoke(GetCaseRuleInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetCaseRuleResult> getCaseRule(GetCaseRuleArgs args, InvokeOptions options)
public static Output<GetCaseRuleResult> getCaseRule(GetCaseRuleArgs args, InvokeOptions options)
fn::invoke:
function: aws-native:cases:getCaseRule
arguments:
# arguments dictionaryThe following arguments are supported:
- Case
Rule stringArn - The Amazon Resource Name (ARN) of a case rule.
- Case
Rule stringArn - The Amazon Resource Name (ARN) of a case rule.
- case
Rule StringArn - The Amazon Resource Name (ARN) of a case rule.
- case
Rule stringArn - The Amazon Resource Name (ARN) of a case rule.
- case_
rule_ strarn - The Amazon Resource Name (ARN) of a case rule.
- case
Rule StringArn - The Amazon Resource Name (ARN) of a case rule.
getCaseRule Result
The following output properties are available:
- Case
Rule stringArn - The Amazon Resource Name (ARN) of a case rule.
- Case
Rule stringId - The unique identifier of a case rule.
- Created
Time string - The time at which the case rule was created.
- Description string
- A description explaining the purpose and behavior of this case rule. Helps administrators understand when and why this rule applies to case fields.
- Last
Modified stringTime - The time at which the case rule was created or last modified.
- Name string
- A descriptive name for the case rule. Must be unique within the domain and should clearly indicate the rule's purpose (e.g., 'Priority Field Required for Urgent Cases').
- Rule
Pulumi.
Aws | Pulumi.Native. Cases. Outputs. Case Rule Details0Properties Aws Native. Cases. Outputs. Case Rule Details1Properties -
List<Pulumi.
Aws Native. Outputs. Tag> - The tags that you attach to this case rule.
- Case
Rule stringArn - The Amazon Resource Name (ARN) of a case rule.
- Case
Rule stringId - The unique identifier of a case rule.
- Created
Time string - The time at which the case rule was created.
- Description string
- A description explaining the purpose and behavior of this case rule. Helps administrators understand when and why this rule applies to case fields.
- Last
Modified stringTime - The time at which the case rule was created or last modified.
- Name string
- A descriptive name for the case rule. Must be unique within the domain and should clearly indicate the rule's purpose (e.g., 'Priority Field Required for Urgent Cases').
- Rule
Case
Rule | CaseDetails0Properties Rule Details1Properties - Tag
- The tags that you attach to this case rule.
- case
Rule StringArn - The Amazon Resource Name (ARN) of a case rule.
- case
Rule StringId - The unique identifier of a case rule.
- created
Time String - The time at which the case rule was created.
- description String
- A description explaining the purpose and behavior of this case rule. Helps administrators understand when and why this rule applies to case fields.
- last
Modified StringTime - The time at which the case rule was created or last modified.
- name String
- A descriptive name for the case rule. Must be unique within the domain and should clearly indicate the rule's purpose (e.g., 'Priority Field Required for Urgent Cases').
- rule
Case
Rule | CaseDetails0Properties Rule Details1Properties - List<Tag>
- The tags that you attach to this case rule.
- case
Rule stringArn - The Amazon Resource Name (ARN) of a case rule.
- case
Rule stringId - The unique identifier of a case rule.
- created
Time string - The time at which the case rule was created.
- description string
- A description explaining the purpose and behavior of this case rule. Helps administrators understand when and why this rule applies to case fields.
- last
Modified stringTime - The time at which the case rule was created or last modified.
- name string
- A descriptive name for the case rule. Must be unique within the domain and should clearly indicate the rule's purpose (e.g., 'Priority Field Required for Urgent Cases').
- rule
Case
Rule | CaseDetails0Properties Rule Details1Properties - Tag[]
- The tags that you attach to this case rule.
- case_
rule_ strarn - The Amazon Resource Name (ARN) of a case rule.
- case_
rule_ strid - The unique identifier of a case rule.
- created_
time str - The time at which the case rule was created.
- description str
- A description explaining the purpose and behavior of this case rule. Helps administrators understand when and why this rule applies to case fields.
- last_
modified_ strtime - The time at which the case rule was created or last modified.
- name str
- A descriptive name for the case rule. Must be unique within the domain and should clearly indicate the rule's purpose (e.g., 'Priority Field Required for Urgent Cases').
- rule
Case
Rule | CaseDetails0Properties Rule Details1Properties - Sequence[root_Tag]
- The tags that you attach to this case rule.
- case
Rule StringArn - The Amazon Resource Name (ARN) of a case rule.
- case
Rule StringId - The unique identifier of a case rule.
- created
Time String - The time at which the case rule was created.
- description String
- A description explaining the purpose and behavior of this case rule. Helps administrators understand when and why this rule applies to case fields.
- last
Modified StringTime - The time at which the case rule was created or last modified.
- name String
- A descriptive name for the case rule. Must be unique within the domain and should clearly indicate the rule's purpose (e.g., 'Priority Field Required for Urgent Cases').
- rule Property Map | Property Map
- List<Property Map>
- The tags that you attach to this case rule.
Supporting Types
CaseRuleBooleanCondition0Properties
CaseRuleBooleanCondition1Properties
CaseRuleBooleanOperands
- Operand
One Pulumi.Aws Native. Cases. Inputs. Case Rule Operand One Properties - Operand
Two Pulumi.Aws | Pulumi.Native. Cases. Inputs. Case Rule Operand Two0Properties Aws | Pulumi.Native. Cases. Inputs. Case Rule Operand Two1Properties Aws | Pulumi.Native. Cases. Inputs. Case Rule Operand Two2Properties Aws Native. Cases. Inputs. Case Rule Operand Two3Properties - Result bool
- The value of the outer rule if the condition evaluates to true.
- Operand
One CaseRule Operand One Properties - Operand
Two CaseRule | CaseOperand Two0Properties Rule | CaseOperand Two1Properties Rule | CaseOperand Two2Properties Rule Operand Two3Properties - Result bool
- The value of the outer rule if the condition evaluates to true.
- operand
One CaseRule Operand One Properties - operand
Two CaseRule | CaseOperand Two0Properties Rule | CaseOperand Two1Properties Rule | CaseOperand Two2Properties Rule Operand Two3Properties - result Boolean
- The value of the outer rule if the condition evaluates to true.
- operand
One CaseRule Operand One Properties - operand
Two CaseRule | CaseOperand Two0Properties Rule | CaseOperand Two1Properties Rule | CaseOperand Two2Properties Rule Operand Two3Properties - result boolean
- The value of the outer rule if the condition evaluates to true.
- operand_
one CaseRule Operand One Properties - operand_
two CaseRule | CaseOperand Two0Properties Rule | CaseOperand Two1Properties Rule | CaseOperand Two2Properties Rule Operand Two3Properties - result bool
- The value of the outer rule if the condition evaluates to true.
- operand
One Property Map - operand
Two Property Map | Property Map | Property Map | Property Map - result Boolean
- The value of the outer rule if the condition evaluates to true.
CaseRuleDetails0Properties
CaseRuleDetails1Properties
CaseRuleHiddenCaseRule
- Conditions
List<Union<Pulumi.
Aws Native. Cases. Inputs. Case Rule Boolean Condition0Properties, Pulumi. Aws Native. Cases. Inputs. Case Rule Boolean Condition1Properties>> - List of conditions for the hidden rule; the first condition to evaluate to true dictates the value of the rule
- Default
Value bool - The value of the rule (i.e. whether the field is hidden) should none of the conditions evaluate to true
- Conditions []interface{}
- List of conditions for the hidden rule; the first condition to evaluate to true dictates the value of the rule
- Default
Value bool - The value of the rule (i.e. whether the field is hidden) should none of the conditions evaluate to true
- conditions
List<Either<Case
Rule Boolean Condition0Properties,Case Rule Boolean Condition1Properties>> - List of conditions for the hidden rule; the first condition to evaluate to true dictates the value of the rule
- default
Value Boolean - The value of the rule (i.e. whether the field is hidden) should none of the conditions evaluate to true
- conditions
(Case
Rule Boolean Condition0Properties | Case Rule Boolean Condition1Properties)[] - List of conditions for the hidden rule; the first condition to evaluate to true dictates the value of the rule
- default
Value boolean - The value of the rule (i.e. whether the field is hidden) should none of the conditions evaluate to true
- conditions
Sequence[Union[Case
Rule Boolean Condition0Properties, Case Rule Boolean Condition1Properties]] - List of conditions for the hidden rule; the first condition to evaluate to true dictates the value of the rule
- default_
value bool - The value of the rule (i.e. whether the field is hidden) should none of the conditions evaluate to true
- conditions List<Property Map | Property Map>
- List of conditions for the hidden rule; the first condition to evaluate to true dictates the value of the rule
- default
Value Boolean - The value of the rule (i.e. whether the field is hidden) should none of the conditions evaluate to true
CaseRuleOperandOneProperties
- Field
Id string - The field ID this operand should take the value of.
- Field
Id string - The field ID this operand should take the value of.
- field
Id String - The field ID this operand should take the value of.
- field
Id string - The field ID this operand should take the value of.
- field_
id str - The field ID this operand should take the value of.
- field
Id String - The field ID this operand should take the value of.
CaseRuleOperandTwo0Properties
- String
Value string - A string value to compare against the field value in the condition evaluation.
- String
Value string - A string value to compare against the field value in the condition evaluation.
- string
Value String - A string value to compare against the field value in the condition evaluation.
- string
Value string - A string value to compare against the field value in the condition evaluation.
- string_
value str - A string value to compare against the field value in the condition evaluation.
- string
Value String - A string value to compare against the field value in the condition evaluation.
CaseRuleOperandTwo1Properties
- Boolean
Value bool - A boolean value to compare against the field value in the condition evaluation.
- Boolean
Value bool - A boolean value to compare against the field value in the condition evaluation.
- boolean
Value Boolean - A boolean value to compare against the field value in the condition evaluation.
- boolean
Value boolean - A boolean value to compare against the field value in the condition evaluation.
- boolean_
value bool - A boolean value to compare against the field value in the condition evaluation.
- boolean
Value Boolean - A boolean value to compare against the field value in the condition evaluation.
CaseRuleOperandTwo2Properties
- Double
Value double - A numeric value to compare against the field value in the condition evaluation.
- Double
Value float64 - A numeric value to compare against the field value in the condition evaluation.
- double
Value Double - A numeric value to compare against the field value in the condition evaluation.
- double
Value number - A numeric value to compare against the field value in the condition evaluation.
- double_
value float - A numeric value to compare against the field value in the condition evaluation.
- double
Value Number - A numeric value to compare against the field value in the condition evaluation.
CaseRuleOperandTwo3Properties
CaseRuleRequiredCaseRule
- Conditions
List<Union<Pulumi.
Aws Native. Cases. Inputs. Case Rule Boolean Condition0Properties, Pulumi. Aws Native. Cases. Inputs. Case Rule Boolean Condition1Properties>> - An ordered list of boolean conditions that determine when the field should be required. Conditions are evaluated in order, and the first condition that evaluates to true determines whether the field is required, overriding the default value.
- Default
Value bool - The default required state for the field when none of the specified conditions are met. If true, the field is required by default; if false, the field is optional by default.
- Conditions []interface{}
- An ordered list of boolean conditions that determine when the field should be required. Conditions are evaluated in order, and the first condition that evaluates to true determines whether the field is required, overriding the default value.
- Default
Value bool - The default required state for the field when none of the specified conditions are met. If true, the field is required by default; if false, the field is optional by default.
- conditions
List<Either<Case
Rule Boolean Condition0Properties,Case Rule Boolean Condition1Properties>> - An ordered list of boolean conditions that determine when the field should be required. Conditions are evaluated in order, and the first condition that evaluates to true determines whether the field is required, overriding the default value.
- default
Value Boolean - The default required state for the field when none of the specified conditions are met. If true, the field is required by default; if false, the field is optional by default.
- conditions
(Case
Rule Boolean Condition0Properties | Case Rule Boolean Condition1Properties)[] - An ordered list of boolean conditions that determine when the field should be required. Conditions are evaluated in order, and the first condition that evaluates to true determines whether the field is required, overriding the default value.
- default
Value boolean - The default required state for the field when none of the specified conditions are met. If true, the field is required by default; if false, the field is optional by default.
- conditions
Sequence[Union[Case
Rule Boolean Condition0Properties, Case Rule Boolean Condition1Properties]] - An ordered list of boolean conditions that determine when the field should be required. Conditions are evaluated in order, and the first condition that evaluates to true determines whether the field is required, overriding the default value.
- default_
value bool - The default required state for the field when none of the specified conditions are met. If true, the field is required by default; if false, the field is optional by default.
- conditions List<Property Map | Property Map>
- An ordered list of boolean conditions that determine when the field should be required. Conditions are evaluated in order, and the first condition that evaluates to true determines whether the field is required, overriding the default value.
- default
Value Boolean - The default required state for the field when none of the specified conditions are met. If true, the field is required by default; if false, the field is optional by default.
Tag
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
