Package software.amazon.awssdk.services.eventbridge.model

Class PutRuleRequest

    • Method Detail

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

      • 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:
        RuleState

      • 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:
        RuleState

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

      • 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