Package software.amazon.awscdk.services.cases

Class CfnCaseRule

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.cases.CfnCaseRule

All Implemented Interfaces:

IInspectable, ICaseRuleRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.125.0 (build fdbe357)",
           date="2026-01-09T10:20:13.538Z")
@Stability(Stable)
public class CfnCaseRule
extends CfnResource
implements IInspectable, ICaseRuleRef, ITaggableV2

Creates a new case rule.

In the Amazon Connect admin website, case rules are known as case field conditions . For more information about case field conditions, see Add case field conditions to a case template .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cases.*;
 Object emptyValue;
 CfnCaseRule cfnCaseRule = CfnCaseRule.Builder.create(this, "MyCfnCaseRule")
         .name("name")
         .rule(CaseRuleDetailsProperty.builder()
                 .hidden(HiddenCaseRuleProperty.builder()
                         .conditions(List.of(BooleanConditionProperty.builder()
                                 .equalTo(BooleanOperandsProperty.builder()
                                         .operandOne(OperandOneProperty.builder()
                                                 .fieldId("fieldId")
                                                 .build())
                                         .operandTwo(OperandTwoProperty.builder()
                                                 .booleanValue(false)
                                                 .doubleValue(123)
                                                 .emptyValue(emptyValue)
                                                 .stringValue("stringValue")
                                                 .build())
                                         .result(false)
                                         .build())
                                 .notEqualTo(BooleanOperandsProperty.builder()
                                         .operandOne(OperandOneProperty.builder()
                                                 .fieldId("fieldId")
                                                 .build())
                                         .operandTwo(OperandTwoProperty.builder()
                                                 .booleanValue(false)
                                                 .doubleValue(123)
                                                 .emptyValue(emptyValue)
                                                 .stringValue("stringValue")
                                                 .build())
                                         .result(false)
                                         .build())
                                 .build()))
                         .defaultValue(false)
                         .build())
                 .required(RequiredCaseRuleProperty.builder()
                         .conditions(List.of(BooleanConditionProperty.builder()
                                 .equalTo(BooleanOperandsProperty.builder()
                                         .operandOne(OperandOneProperty.builder()
                                                 .fieldId("fieldId")
                                                 .build())
                                         .operandTwo(OperandTwoProperty.builder()
                                                 .booleanValue(false)
                                                 .doubleValue(123)
                                                 .emptyValue(emptyValue)
                                                 .stringValue("stringValue")
                                                 .build())
                                         .result(false)
                                         .build())
                                 .notEqualTo(BooleanOperandsProperty.builder()
                                         .operandOne(OperandOneProperty.builder()
                                                 .fieldId("fieldId")
                                                 .build())
                                         .operandTwo(OperandTwoProperty.builder()
                                                 .booleanValue(false)
                                                 .doubleValue(123)
                                                 .emptyValue(emptyValue)
                                                 .stringValue("stringValue")
                                                 .build())
                                         .result(false)
                                         .build())
                                 .build()))
                         .defaultValue(false)
                         .build())
                 .build())
         // the properties below are optional
         .description("description")
         .domainId("domainId")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cases-caserule.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnCaseRule.BooleanConditionProperty	Boolean condition for a rule.
static interface	CfnCaseRule.BooleanOperandsProperty	Boolean operands for a condition.
static final class	CfnCaseRule.Builder	A fluent builder for CfnCaseRule.
static interface	CfnCaseRule.CaseRuleDetailsProperty	Represents what rule type should take place, under what conditions.
static interface	CfnCaseRule.HiddenCaseRuleProperty	A rule that controls field visibility based on conditions.
static interface	CfnCaseRule.OperandOneProperty	Represents the left hand operand in the condition.
static interface	CfnCaseRule.OperandTwoProperty	Represents the right hand operand in the condition.
static interface	CfnCaseRule.RequiredCaseRuleProperty	Required rule type, used to indicate whether a field is required.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.cases.ICaseRuleRef

ICaseRuleRef.Jsii$Default, ICaseRuleRef.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2

ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnCaseRule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnCaseRule(software.amazon.jsii.JsiiObjectRef objRef)
	CfnCaseRule(software.constructs.Construct scope, String id, CfnCaseRuleProps props)	Create a new AWS::Cases::CaseRule.

Method Summary

Modifier and Type	Method	Description
static String	arnForCaseRule(ICaseRuleRef resource)
String	getAttrCaseRuleArn()	The Amazon Resource Name (ARN) of the case rule.
String	getAttrCaseRuleId()	Unique identifier of a case rule.
String	getAttrCreatedTime()	Timestamp when the resource was created.
String	getAttrLastModifiedTime()	Timestamp when the resource was created or last modified.
CaseRuleReference	getCaseRuleRef()	A reference to a CaseRule resource.
TagManager	getCdkTagManager()	Tag Manager which manages the tags for this resource.
protected Map<String,Object>	getCfnProperties()
String	getDescription()	Description of a case rule.
String	getDomainId()	Unique identifier of a Cases domain.
String	getName()	Name of the case rule.
Object	getRule()	Represents what rule type should take place, under what conditions.
List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
static Boolean	isCfnCaseRule(Object x)	Checks whether the given object is a CfnCaseRule.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value)	Description of a case rule.
void	setDomainId(String value)	Unique identifier of a Cases domain.
void	setName(String value)	Name of the case rule.
void	setRule(IResolvable value)	Represents what rule type should take place, under what conditions.
void	setRule(CfnCaseRule.CaseRuleDetailsProperty value)	Represents what rule type should take place, under what conditions.
void	setTags(List<CfnTag> value)	An array of key-value pairs to apply to this resource.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnCaseRule

protected CfnCaseRule(software.amazon.jsii.JsiiObjectRef objRef)

CfnCaseRule

protected CfnCaseRule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnCaseRule

@Stability(Stable)
public CfnCaseRule(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnCaseRuleProps props)

Create a new AWS::Cases::CaseRule.

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

arnForCaseRule

@Stability(Stable)
@NotNull
public static String arnForCaseRule(@NotNull
 ICaseRuleRef resource)

Parameters:

resource - This parameter is required.

isCfnCaseRule

@Stability(Stable)
@NotNull
public static Boolean isCfnCaseRule(@NotNull
 Object x)

Checks whether the given object is a CfnCaseRule.

Parameters:

x - This parameter is required.

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrCaseRuleArn

@Stability(Stable)
@NotNull
public String getAttrCaseRuleArn()

The Amazon Resource Name (ARN) of the case rule.

getAttrCaseRuleId

@Stability(Stable)
@NotNull
public String getAttrCaseRuleId()

Unique identifier of a case rule.

getAttrCreatedTime

@Stability(Stable)
@NotNull
public String getAttrCreatedTime()

Timestamp when the resource was created.

getAttrLastModifiedTime

@Stability(Stable)
@NotNull
public String getAttrLastModifiedTime()

Timestamp when the resource was created or last modified.

getCaseRuleRef

@Stability(Stable)
@NotNull
public CaseRuleReference getCaseRuleRef()

A reference to a CaseRule resource.

Specified by:

getCaseRuleRef in interface ICaseRuleRef

getCdkTagManager

@Stability(Stable)
@NotNull
public TagManager getCdkTagManager()

Tag Manager which manages the tags for this resource.

Specified by:

getCdkTagManager in interface ITaggableV2

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getName

@Stability(Stable)
@NotNull
public String getName()

Name of the case rule.

setName

@Stability(Stable)
public void setName(@NotNull
 String value)

Name of the case rule.

getRule

@Stability(Stable)
@NotNull
public Object getRule()

Represents what rule type should take place, under what conditions.

Returns union: either IResolvable or CfnCaseRule.CaseRuleDetailsProperty

setRule

@Stability(Stable)
public void setRule(@NotNull
 IResolvable value)

Represents what rule type should take place, under what conditions.

setRule

@Stability(Stable)
public void setRule(@NotNull
 CfnCaseRule.CaseRuleDetailsProperty value)

Represents what rule type should take place, under what conditions.

getDescription

@Stability(Stable)
@Nullable
public String getDescription()

Description of a case rule.

setDescription

@Stability(Stable)
public void setDescription(@Nullable
 String value)

Description of a case rule.

getDomainId

@Stability(Stable)
@Nullable
public String getDomainId()

Unique identifier of a Cases domain.

setDomainId

@Stability(Stable)
public void setDomainId(@Nullable
 String value)

Unique identifier of a Cases domain.

getTags

@Stability(Stable)
@Nullable
public List<CfnTag> getTags()

An array of key-value pairs to apply to this resource.

setTags

@Stability(Stable)
public void setTags(@Nullable
 List<CfnTag> value)

An array of key-value pairs to apply to this resource.