Class PutRuleRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.eventbridge.model.EventBridgeRequest
software.amazon.awssdk.services.eventbridge.model.PutRuleRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<PutRuleRequest.Builder,PutRuleRequest>
@Generated("software.amazon.awssdk:codegen") public final class PutRuleRequest extends EventBridgeRequest implements ToCopyableBuilder<PutRuleRequest.Builder,PutRuleRequest>

  • Method Details

    • name

      public final String name()

      The name of the rule that you are creating or updating.

      Returns:
      The name of the rule that you are creating or updating.

    • scheduleExpression

      public final String scheduleExpression()

      The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 minutes)".

      Returns:
      The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 minutes)".

    • eventPattern

      public final String eventPattern()

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

      Returns:
      The event pattern. For more information, see Amazon EventBridge 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()

      A description of the rule.

      Returns:
      A description of the rule.

    • roleArn

      public final String roleArn()

      The Amazon Resource Name (ARN) of the IAM role associated with the rule.

      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 IAM role associated with the rule.

      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.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags 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.

    • tags

      public final List<Tag> tags()

      The list of key-value pairs to associate with the rule.

      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 hasTags() method.

      Returns:
      The list of key-value pairs to associate with the rule.

    • eventBusName

      public final String eventBusName()

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

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

    • toBuilder

      public PutRuleRequest.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<PutRuleRequest.Builder,PutRuleRequest>
      Specified by:
      toBuilder in class EventBridgeRequest
      Returns:
      a builder for type T

    • builder

      public static PutRuleRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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