Class Rule

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

Contains information about a rule in Amazon EventBridge.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the rule.

      Returns:
      The name of the rule.

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the rule.

      Returns:
      The Amazon Resource Name (ARN) of the rule.

    • eventPattern

      public final String eventPattern()

      The event pattern of the rule. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide .

      Returns:
      The event pattern of the rule. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide .

    • state

      public final RuleState state()

      The state of the rule.

      Valid values include:

      • DISABLED: The rule is disabled. EventBridge does not match any events against the rule.

      • ENABLED: The rule is enabled. EventBridge matches events against the rule, except for Amazon Web Services management events delivered through CloudTrail.

      • ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS: The rule is enabled for all events, including Amazon Web Services management events delivered through CloudTrail.

        Management events provide visibility into management operations that are performed on resources in your Amazon Web Services account. These are also known as control plane operations. For more information, see Logging management events in the CloudTrail User Guide, and Filtering management events from Amazon Web Services services in the Amazon EventBridge User Guide .

        This value is only valid for rules on the default event bus or custom event buses. It does not apply to partner event buses.

      If the service returns an enum value that is not available in the current SDK version, state will return RuleState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      The state of the rule.

      Valid values include:

      • DISABLED: The rule is disabled. EventBridge does not match any events against the rule.

      • ENABLED: The rule is enabled. EventBridge matches events against the rule, except for Amazon Web Services management events delivered through CloudTrail.

      • ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS: The rule is enabled for all events, including Amazon Web Services management events delivered through CloudTrail.

        Management events provide visibility into management operations that are performed on resources in your Amazon Web Services account. These are also known as control plane operations. For more information, see Logging management events in the CloudTrail User Guide, and Filtering management events from Amazon Web Services services in the Amazon EventBridge User Guide .

        This value is only valid for rules on the default event bus or custom event buses. It does not apply to partner event buses.

      See Also:

    • stateAsString

      public final String stateAsString()

      The state of the rule.

      Valid values include:

      • DISABLED: The rule is disabled. EventBridge does not match any events against the rule.

      • ENABLED: The rule is enabled. EventBridge matches events against the rule, except for Amazon Web Services management events delivered through CloudTrail.

      • ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS: The rule is enabled for all events, including Amazon Web Services management events delivered through CloudTrail.

        Management events provide visibility into management operations that are performed on resources in your Amazon Web Services account. These are also known as control plane operations. For more information, see Logging management events in the CloudTrail User Guide, and Filtering management events from Amazon Web Services services in the Amazon EventBridge User Guide .

        This value is only valid for rules on the default event bus or custom event buses. It does not apply to partner event buses.

      If the service returns an enum value that is not available in the current SDK version, state will return RuleState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      The state of the rule.

      Valid values include:

      • DISABLED: The rule is disabled. EventBridge does not match any events against the rule.

      • ENABLED: The rule is enabled. EventBridge matches events against the rule, except for Amazon Web Services management events delivered through CloudTrail.

      • ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS: The rule is enabled for all events, including Amazon Web Services management events delivered through CloudTrail.

        Management events provide visibility into management operations that are performed on resources in your Amazon Web Services account. These are also known as control plane operations. For more information, see Logging management events in the CloudTrail User Guide, and Filtering management events from Amazon Web Services services in the Amazon EventBridge User Guide .

        This value is only valid for rules on the default event bus or custom event buses. It does not apply to partner event buses.

      See Also:

    • description

      public final String description()

      The description of the rule.

      Returns:
      The description of the rule.

    • scheduleExpression

      public final String scheduleExpression()

      The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)". For more information, see Creating an Amazon EventBridge rule that runs on a schedule.

      Returns:
      The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)". For more information, see Creating an Amazon EventBridge rule that runs on a schedule.

    • roleArn

      public final String roleArn()

      The Amazon Resource Name (ARN) of the role that is used for target invocation.

      If you're setting an event bus in another account as the target and that account granted permission to your account through an organization instead of directly by the account ID, you must specify a RoleArn with proper permissions in the Target structure, instead of here in this parameter.

      Returns:
      The Amazon Resource Name (ARN) of the role that is used for target invocation.

      If you're setting an event bus in another account as the target and that account granted permission to your account through an organization instead of directly by the account ID, you must specify a RoleArn with proper permissions in the Target structure, instead of here in this parameter.

    • managedBy

      public final String managedBy()

      If the rule was created on behalf of your account by an Amazon Web Services service, this field displays the principal name of the service that created the rule.

      Returns:
      If the rule was created on behalf of your account by an Amazon Web Services service, this field displays the principal name of the service that created the rule.

    • eventBusName

      public final String eventBusName()

      The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

      Returns:
      The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

    • toBuilder

      public Rule.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<Rule.Builder,Rule>
      Returns:
      a builder for type T

    • builder

      public static Rule.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Rule.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.