Package software.amazon.awscdk.services.connect

Class CfnRule

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.connect.CfnRule
All Implemented Interfaces:
IInspectable, IRuleRef, IEnvironmentAware, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-12-01T16:02:17.673Z") @Stability(Stable) public class CfnRule extends CfnResource implements IInspectable, IRuleRef, ITaggable
Creates a rule for the specified Amazon Connect instance.

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.connect.*;
 Object assignContactCategoryActions;
 Object emptyValue;
 Object endAssociatedTasksActions;
 CfnRule cfnRule = CfnRule.Builder.create(this, "MyCfnRule")
         .actions(ActionsProperty.builder()
                 .assignContactCategoryActions(List.of(assignContactCategoryActions))
                 .createCaseActions(List.of(CreateCaseActionProperty.builder()
                         .fields(List.of(FieldProperty.builder()
                                 .id("id")
                                 .value(FieldValueProperty.builder()
                                         .booleanValue(false)
                                         .doubleValue(123)
                                         .emptyValue(emptyValue)
                                         .stringValue("stringValue")
                                         .build())
                                 .build()))
                         .templateId("templateId")
                         .build()))
                 .endAssociatedTasksActions(List.of(endAssociatedTasksActions))
                 .eventBridgeActions(List.of(EventBridgeActionProperty.builder()
                         .name("name")
                         .build()))
                 .sendNotificationActions(List.of(SendNotificationActionProperty.builder()
                         .content("content")
                         .contentType("contentType")
                         .deliveryMethod("deliveryMethod")
                         .recipient(NotificationRecipientTypeProperty.builder()
                                 .userArns(List.of("userArns"))
                                 .userTags(Map.of(
                                         "userTagsKey", "userTags"))
                                 .build())
                         // the properties below are optional
                         .subject("subject")
                         .build()))
                 .submitAutoEvaluationActions(List.of(SubmitAutoEvaluationActionProperty.builder()
                         .evaluationFormArn("evaluationFormArn")
                         .build()))
                 .taskActions(List.of(TaskActionProperty.builder()
                         .contactFlowArn("contactFlowArn")
                         .name("name")
                         // the properties below are optional
                         .description("description")
                         .references(Map.of(
                                 "referencesKey", ReferenceProperty.builder()
                                         .type("type")
                                         .value("value")
                                         .build()))
                         .build()))
                 .updateCaseActions(List.of(UpdateCaseActionProperty.builder()
                         .fields(List.of(FieldProperty.builder()
                                 .id("id")
                                 .value(FieldValueProperty.builder()
                                         .booleanValue(false)
                                         .doubleValue(123)
                                         .emptyValue(emptyValue)
                                         .stringValue("stringValue")
                                         .build())
                                 .build()))
                         .build()))
                 .build())
         .function("function")
         .instanceArn("instanceArn")
         .name("name")
         .publishStatus("publishStatus")
         .triggerEventSource(RuleTriggerEventSourceProperty.builder()
                 .eventSourceName("eventSourceName")
                 // the properties below are optional
                 .integrationAssociationArn("integrationAssociationArn")
                 .build())
         // the properties below are optional
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • 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

    • CfnRule

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

    • CfnRule

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

    • CfnRule

      @Stability(Stable) public CfnRule(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnRuleProps props)
      Create a new AWS::Connect::Rule.

      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

    • arnForRule

      @Stability(Stable) @NotNull public static String arnForRule(@NotNull IRuleRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnRule

      @Stability(Stable) @NotNull public static Boolean isCfnRule(@NotNull Object x)
      Checks whether the given object is a CfnRule.

      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.

    • getAttrRuleArn

      @Stability(Stable) @NotNull public String getAttrRuleArn()
      The Amazon Resource Name (ARN) of the rule.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getRuleRef

      @Stability(Stable) @NotNull public RuleReference getRuleRef()
      A reference to a Rule resource.
      Specified by:
      getRuleRef in interface IRuleRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getActions

      @Stability(Stable) @NotNull public Object getActions()
      A list of actions to be run when the rule is triggered.

      Returns union: either IResolvable or CfnRule.ActionsProperty

    • setActions

      @Stability(Stable) public void setActions(@NotNull IResolvable value)
      A list of actions to be run when the rule is triggered.

    • setActions

      @Stability(Stable) public void setActions(@NotNull CfnRule.ActionsProperty value)
      A list of actions to be run when the rule is triggered.

    • getFunction

      @Stability(Stable) @NotNull public String getFunction()
      The conditions of the rule.

    • setFunction

      @Stability(Stable) public void setFunction(@NotNull String value)
      The conditions of the rule.

    • getInstanceArn

      @Stability(Stable) @NotNull public String getInstanceArn()
      The Amazon Resource Name (ARN) of the instance.

    • setInstanceArn

      @Stability(Stable) public void setInstanceArn(@NotNull String value)
      The Amazon Resource Name (ARN) of the instance.

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the rule.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the rule.

    • getPublishStatus

      @Stability(Stable) @NotNull public String getPublishStatus()
      The publish status of the rule.

    • setPublishStatus

      @Stability(Stable) public void setPublishStatus(@NotNull String value)
      The publish status of the rule.

    • getTriggerEventSource

      @Stability(Stable) @NotNull public Object getTriggerEventSource()
      The event source to trigger the rule.

      Returns union: either IResolvable or CfnRule.RuleTriggerEventSourceProperty

    • setTriggerEventSource

      @Stability(Stable) public void setTriggerEventSource(@NotNull IResolvable value)
      The event source to trigger the rule.

    • setTriggerEventSource

      @Stability(Stable) public void setTriggerEventSource(@NotNull CfnRule.RuleTriggerEventSourceProperty value)
      The event source to trigger the rule.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      The tags used to organize, track, or control access for this resource.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      The tags used to organize, track, or control access for this resource.