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).
Create CaseRule Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new CaseRule(name: string, args: CaseRuleArgs, opts?: CustomResourceOptions);@overload
def CaseRule(resource_name: str,
args: CaseRuleArgs,
opts: Optional[ResourceOptions] = None)
@overload
def CaseRule(resource_name: str,
opts: Optional[ResourceOptions] = None,
rule: Optional[Union[CaseRuleDetails0PropertiesArgs, CaseRuleDetails1PropertiesArgs]] = None,
description: Optional[str] = None,
domain_id: Optional[str] = None,
name: Optional[str] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None)func NewCaseRule(ctx *Context, name string, args CaseRuleArgs, opts ...ResourceOption) (*CaseRule, error)public CaseRule(string name, CaseRuleArgs args, CustomResourceOptions? opts = null)
public CaseRule(String name, CaseRuleArgs args)
public CaseRule(String name, CaseRuleArgs args, CustomResourceOptions options)
type: aws-native:cases:CaseRule
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 CaseRuleArgs
- 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 CaseRuleArgs
- 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 CaseRuleArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CaseRuleArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CaseRuleArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
CaseRule Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The CaseRule resource accepts the following input properties:
- Rule
Pulumi.
Aws | Pulumi.Native. Cases. Inputs. Case Rule Details0Properties Aws Native. Cases. Inputs. Case Rule Details1Properties - 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.
- Domain
Id string - The unique identifier of the Cases domain.
- 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').
-
List<Pulumi.
Aws Native. Inputs. Tag> - The tags that you attach to this case rule.
- Rule
Case
Rule | CaseDetails0Properties Args Rule Details1Properties Args - 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.
- Domain
Id string - The unique identifier of the Cases domain.
- 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').
-
Tag
Args - The tags that you attach to this case rule.
- rule
Case
Rule | CaseDetails0Properties Rule Details1Properties - 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.
- domain
Id String - The unique identifier of the Cases domain.
- 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').
- List<Tag>
- The tags that you attach to this case rule.
- rule
Case
Rule | CaseDetails0Properties Rule Details1Properties - 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.
- domain
Id string - The unique identifier of the Cases domain.
- 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').
- Tag[]
- The tags that you attach to this case rule.
- rule
Case
Rule | CaseDetails0Properties Args Rule Details1Properties Args - 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.
- domain_
id str - The unique identifier of the Cases domain.
- 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').
-
Sequence[Tag
Args] - The tags that you attach to this case rule.
- rule Property Map | Property Map
- 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.
- domain
Id String - The unique identifier of the Cases domain.
- 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').
- List<Property Map>
- The tags that you attach to this case rule.
Outputs
All input properties are implicitly available as output properties. Additionally, the CaseRule resource produces the following output properties:
- 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.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Modified stringTime - The time at which the case rule was created or last modified.
- 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.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Modified stringTime - The time at which the case rule was created or last modified.
- 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.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Modified StringTime - The time at which the case rule was created or last modified.
- 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.
- id string
- The provider-assigned unique ID for this managed resource.
- last
Modified stringTime - The time at which the case rule was created or last modified.
- 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.
- id str
- The provider-assigned unique ID for this managed resource.
- last_
modified_ strtime - The time at which the case rule was created or last modified.
- 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.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Modified StringTime - The time at which the case rule was created or last modified.
Supporting Types
CaseRuleBooleanCondition0Properties, CaseRuleBooleanCondition0PropertiesArgs
A boolean condition for a rule.CaseRuleBooleanCondition1Properties, CaseRuleBooleanCondition1PropertiesArgs
A boolean condition for a rule.CaseRuleBooleanOperands, CaseRuleBooleanOperandsArgs
Boolean operands for a condition.- 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, CaseRuleDetails0PropertiesArgs
Defines the rule behavior and conditions. Specifies the rule type and the conditions under which it applies. In the Amazon Connect admin website, this corresponds to case field conditions.CaseRuleDetails1Properties, CaseRuleDetails1PropertiesArgs
Defines the rule behavior and conditions. Specifies the rule type and the conditions under which it applies. In the Amazon Connect admin website, this corresponds to case field conditions.CaseRuleHiddenCaseRule, CaseRuleHiddenCaseRuleArgs
Hidden rule type, used to indicate whether a field is hidden- 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, CaseRuleOperandOnePropertiesArgs
The left hand operand in the condition.- 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, CaseRuleOperandTwo0PropertiesArgs
The right hand operand in the condition.- 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, CaseRuleOperandTwo1PropertiesArgs
The right hand operand in the condition.- 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, CaseRuleOperandTwo2PropertiesArgs
The right hand operand in the condition.- 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, CaseRuleOperandTwo3PropertiesArgs
The right hand operand in the condition.CaseRuleRequiredCaseRule, CaseRuleRequiredCaseRuleArgs
A required rule type, used to indicate whether a field is required.- 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, TagArgs
A set of tags to apply to the resource.Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
