Class EventRuleStructure

java.lang.Object
software.amazon.awssdk.services.notifications.model.EventRuleStructure
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<EventRuleStructure.Builder,EventRuleStructure>
@Generated("software.amazon.awssdk:codegen") public final class EventRuleStructure extends Object implements SdkPojo, Serializable, ToCopyableBuilder<EventRuleStructure.Builder,EventRuleStructure>

Contains a complete list of fields related to an EventRule.

See Also:

  • Method Details

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the EventRule. CloudFormation stack generates this ARN and then uses this ARN to associate with the NotificationConfiguration.

      Returns:
      The Amazon Resource Name (ARN) of the EventRule. CloudFormation stack generates this ARN and then uses this ARN to associate with the NotificationConfiguration.

    • notificationConfigurationArn

      public final String notificationConfigurationArn()

      The ARN for the NotificationConfiguration associated with this EventRule.

      Returns:
      The ARN for the NotificationConfiguration associated with this EventRule.

    • creationTime

      public final Instant creationTime()

      The creation time of the EventRule.

      Returns:
      The creation time of the EventRule.

    • source

      public final String source()

      The event source this rule should match with the EventBridge event sources. It must match with atleast one of the valid EventBridge event sources. Only Amazon Web Services service sourced events are supported. For example, aws.ec2 and aws.cloudwatch. For more information, see Event delivery from Amazon Web Services services in the Amazon EventBridge User Guide.

      Returns:
      The event source this rule should match with the EventBridge event sources. It must match with atleast one of the valid EventBridge event sources. Only Amazon Web Services service sourced events are supported. For example, aws.ec2 and aws.cloudwatch. For more information, see Event delivery from Amazon Web Services services in the Amazon EventBridge User Guide.

    • eventType

      public final String eventType()

      The event type this rule should match with the EventBridge events. It must match with atleast one of the valid EventBridge event types. For example, Amazon EC2 Instance State change Notification and Amazon CloudWatch State Change. For more information, see Event delivery from Amazon Web Services services in the Amazon EventBridge User Guide.

      Returns:
      The event type this rule should match with the EventBridge events. It must match with atleast one of the valid EventBridge event types. For example, Amazon EC2 Instance State change Notification and Amazon CloudWatch State Change. For more information, see Event delivery from Amazon Web Services services in the Amazon EventBridge User Guide.

    • eventPattern

      public final String eventPattern()

      An additional event pattern used to further filter the events this EventRule receives.

      For more information, see Amazon EventBridge event patterns in the Amazon EventBridge User Guide.

      Returns:
      An additional event pattern used to further filter the events this EventRule receives.

      For more information, see Amazon EventBridge event patterns in the Amazon EventBridge User Guide.

    • hasRegions

      public final boolean hasRegions()
      For responses, this returns true if the service returned a value for the Regions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • regions

      public final List<String> regions()

      A list of Amazon Web Services Regions that send events to this EventRule.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRegions() method.

      Returns:
      A list of Amazon Web Services Regions that send events to this EventRule.

    • hasManagedRules

      public final boolean hasManagedRules()
      For responses, this returns true if the service returned a value for the ManagedRules property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • managedRules

      public final List<String> managedRules()

      A list of Amazon EventBridge Managed Rule ARNs associated with this EventRule.

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasManagedRules() method.

      Returns:
      A list of Amazon EventBridge Managed Rule ARNs associated with this EventRule.

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

    • hasStatusSummaryByRegion

      public final boolean hasStatusSummaryByRegion()
      For responses, this returns true if the service returned a value for the StatusSummaryByRegion property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • statusSummaryByRegion

      public final Map<String,EventRuleStatusSummary> statusSummaryByRegion()

      A list of an EventRule's status by Region. Regions are mapped to EventRuleStatusSummary .

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasStatusSummaryByRegion() method.

      Returns:
      A list of an EventRule's status by Region. Regions are mapped to EventRuleStatusSummary.

    • toBuilder

      public EventRuleStructure.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<EventRuleStructure.Builder,EventRuleStructure>
      Returns:
      a builder for type T

    • builder

      public static EventRuleStructure.Builder builder()

    • serializableBuilderClass

      public static Class<? extends EventRuleStructure.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.