Package software.amazon.awscdk.services.notifications

Class CfnEventRule

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.notifications.CfnEventRule
All Implemented Interfaces:
IEnvironmentAware, IInspectable, IEventRuleRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-10T13:40:10.342Z") @Stability(Stable) public class CfnEventRule extends CfnResource implements IInspectable, IEventRuleRef
Creates an EventRule that is associated with a specified NotificationConfiguration .

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.notifications.*;
 CfnEventRule cfnEventRule = CfnEventRule.Builder.create(this, "MyCfnEventRule")
         .eventType("eventType")
         .notificationConfigurationArn("notificationConfigurationArn")
         .regions(List.of("regions"))
         .source("source")
         // the properties below are optional
         .eventPattern("eventPattern")
         .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

    • CfnEventRule

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

    • CfnEventRule

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

    • CfnEventRule

      @Stability(Stable) public CfnEventRule(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnEventRuleProps props)
      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

    • 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.

    • getAttrArn

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

      AWS CloudFormation stack generates this ARN and then uses this ARN associated with the NotificationConfiguration .

    • getAttrCreationTime

      @Stability(Stable) @NotNull public String getAttrCreationTime()
      The creation time of the EventRule .

    • getAttrManagedRules

      @Stability(Stable) @NotNull public List<String> getAttrManagedRules()
      A list of Amazon EventBridge Managed Rule ARNs associated with this EventRule .

      These are created by AWS User Notifications within your account so your EventRules can function.

    • getAttrStatusSummaryByRegion

      @Stability(Stable) @NotNull public IResolvable getAttrStatusSummaryByRegion()

    • getCfnProperties

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

    • getEventRuleRef

      @Stability(Stable) @NotNull public EventRuleReference getEventRuleRef()
      A reference to a EventRule resource.
      Specified by:
      getEventRuleRef in interface IEventRuleRef

    • getEventType

      @Stability(Stable) @NotNull public String getEventType()
      The event type this rule should match with the EventBridge events.

    • setEventType

      @Stability(Stable) public void setEventType(@NotNull String value)
      The event type this rule should match with the EventBridge events.

    • getNotificationConfigurationArn

      @Stability(Stable) @NotNull public String getNotificationConfigurationArn()
      The ARN for the NotificationConfiguration associated with this EventRule .

    • setNotificationConfigurationArn

      @Stability(Stable) public void setNotificationConfigurationArn(@NotNull String value)
      The ARN for the NotificationConfiguration associated with this EventRule .

    • getRegions

      @Stability(Stable) @NotNull public List<String> getRegions()
      A list of AWS Regions that send events to this EventRule .

    • setRegions

      @Stability(Stable) public void setRegions(@NotNull List<String> value)
      A list of AWS Regions that send events to this EventRule .

    • getSource

      @Stability(Stable) @NotNull public String getSource()
      The event source this rule should match with the EventBridge event sources.

    • setSource

      @Stability(Stable) public void setSource(@NotNull String value)
      The event source this rule should match with the EventBridge event sources.

    • getEventPattern

      @Stability(Stable) @Nullable public String getEventPattern()
      An additional event pattern used to further filter the events this EventRule receives.

    • setEventPattern

      @Stability(Stable) public void setEventPattern(@Nullable String value)
      An additional event pattern used to further filter the events this EventRule receives.