1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. cases
  5. getCaseRule

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

AWS Cloud Control v1.44.0 published on Friday, Dec 19, 2025 by Pulumi
aws-native logo

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

AWS Cloud Control v1.44.0 published on Friday, Dec 19, 2025 by Pulumi

    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 dictionary

    The following arguments are supported:

    CaseRuleArn string
    The Amazon Resource Name (ARN) of a case rule.
    CaseRuleArn string
    The Amazon Resource Name (ARN) of a case rule.
    caseRuleArn String
    The Amazon Resource Name (ARN) of a case rule.
    caseRuleArn string
    The Amazon Resource Name (ARN) of a case rule.
    case_rule_arn str
    The Amazon Resource Name (ARN) of a case rule.
    caseRuleArn String
    The Amazon Resource Name (ARN) of a case rule.

    getCaseRule Result

    The following output properties are available:

    CaseRuleArn string
    The Amazon Resource Name (ARN) of a case rule.
    CaseRuleId string
    The unique identifier of a case rule.
    CreatedTime 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.
    LastModifiedTime string
    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.AwsNative.Cases.Outputs.CaseRuleDetails0Properties | Pulumi.AwsNative.Cases.Outputs.CaseRuleDetails1Properties
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    The tags that you attach to this case rule.
    CaseRuleArn string
    The Amazon Resource Name (ARN) of a case rule.
    CaseRuleId string
    The unique identifier of a case rule.
    CreatedTime 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.
    LastModifiedTime string
    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 CaseRuleDetails0Properties | CaseRuleDetails1Properties
    Tags Tag
    The tags that you attach to this case rule.
    caseRuleArn String
    The Amazon Resource Name (ARN) of a case rule.
    caseRuleId String
    The unique identifier of a case rule.
    createdTime 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.
    lastModifiedTime String
    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 CaseRuleDetails0Properties | CaseRuleDetails1Properties
    tags List<Tag>
    The tags that you attach to this case rule.
    caseRuleArn string
    The Amazon Resource Name (ARN) of a case rule.
    caseRuleId string
    The unique identifier of a case rule.
    createdTime 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.
    lastModifiedTime string
    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 CaseRuleDetails0Properties | CaseRuleDetails1Properties
    tags Tag[]
    The tags that you attach to this case rule.
    case_rule_arn str
    The Amazon Resource Name (ARN) of a case rule.
    case_rule_id str
    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_time str
    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 CaseRuleDetails0Properties | CaseRuleDetails1Properties
    tags Sequence[root_Tag]
    The tags that you attach to this case rule.
    caseRuleArn String
    The Amazon Resource Name (ARN) of a case rule.
    caseRuleId String
    The unique identifier of a case rule.
    createdTime 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.
    lastModifiedTime String
    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
    tags List<Property Map>
    The tags that you attach to this case rule.

    Supporting Types

    CaseRuleBooleanCondition0Properties

    CaseRuleBooleanCondition1Properties

    CaseRuleBooleanOperands

    operandOne Property Map
    operandTwo 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.AwsNative.Cases.Inputs.CaseRuleBooleanCondition0Properties, Pulumi.AwsNative.Cases.Inputs.CaseRuleBooleanCondition1Properties>>
    List of conditions for the hidden rule; the first condition to evaluate to true dictates the value of the rule
    DefaultValue 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
    DefaultValue bool
    The value of the rule (i.e. whether the field is hidden) should none of the conditions evaluate to true
    conditions List<Either<CaseRuleBooleanCondition0Properties,CaseRuleBooleanCondition1Properties>>
    List of conditions for the hidden rule; the first condition to evaluate to true dictates the value of the rule
    defaultValue Boolean
    The value of the rule (i.e. whether the field is hidden) should none of the conditions evaluate to true
    conditions (CaseRuleBooleanCondition0Properties | CaseRuleBooleanCondition1Properties)[]
    List of conditions for the hidden rule; the first condition to evaluate to true dictates the value of the rule
    defaultValue boolean
    The value of the rule (i.e. whether the field is hidden) should none of the conditions evaluate to true
    conditions Sequence[Union[CaseRuleBooleanCondition0Properties, CaseRuleBooleanCondition1Properties]]
    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
    defaultValue Boolean
    The value of the rule (i.e. whether the field is hidden) should none of the conditions evaluate to true

    CaseRuleOperandOneProperties

    FieldId string
    The field ID this operand should take the value of.
    FieldId string
    The field ID this operand should take the value of.
    fieldId String
    The field ID this operand should take the value of.
    fieldId string
    The field ID this operand should take the value of.
    field_id str
    The field ID this operand should take the value of.
    fieldId String
    The field ID this operand should take the value of.

    CaseRuleOperandTwo0Properties

    StringValue string
    A string value to compare against the field value in the condition evaluation.
    StringValue string
    A string value to compare against the field value in the condition evaluation.
    stringValue String
    A string value to compare against the field value in the condition evaluation.
    stringValue 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.
    stringValue String
    A string value to compare against the field value in the condition evaluation.

    CaseRuleOperandTwo1Properties

    BooleanValue bool
    A boolean value to compare against the field value in the condition evaluation.
    BooleanValue bool
    A boolean value to compare against the field value in the condition evaluation.
    booleanValue Boolean
    A boolean value to compare against the field value in the condition evaluation.
    booleanValue 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.
    booleanValue Boolean
    A boolean value to compare against the field value in the condition evaluation.

    CaseRuleOperandTwo2Properties

    DoubleValue double
    A numeric value to compare against the field value in the condition evaluation.
    DoubleValue float64
    A numeric value to compare against the field value in the condition evaluation.
    doubleValue Double
    A numeric value to compare against the field value in the condition evaluation.
    doubleValue 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.
    doubleValue Number
    A numeric value to compare against the field value in the condition evaluation.

    CaseRuleOperandTwo3Properties

    CaseRuleRequiredCaseRule

    Conditions List<Union<Pulumi.AwsNative.Cases.Inputs.CaseRuleBooleanCondition0Properties, Pulumi.AwsNative.Cases.Inputs.CaseRuleBooleanCondition1Properties>>
    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.
    DefaultValue 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.
    DefaultValue 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<CaseRuleBooleanCondition0Properties,CaseRuleBooleanCondition1Properties>>
    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.
    defaultValue 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 (CaseRuleBooleanCondition0Properties | CaseRuleBooleanCondition1Properties)[]
    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.
    defaultValue 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[CaseRuleBooleanCondition0Properties, CaseRuleBooleanCondition1Properties]]
    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.
    defaultValue 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

    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

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

    AWS Cloud Control v1.44.0 published on Friday, Dec 19, 2025 by Pulumi
      Meet Neo: Your AI Platform Teammate