Interface PutRuleRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<PutRuleRequest.Builder,PutRuleRequest>, EventBridgeRequest.Builder, SdkBuilder<PutRuleRequest.Builder,PutRuleRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
PutRuleRequest
@Mutable @NotThreadSafe public static interface PutRuleRequest.Builder extends EventBridgeRequest.Builder, SdkPojo, CopyableBuilder<PutRuleRequest.Builder,PutRuleRequest>

  • Method Details

    • name

      PutRuleRequest.Builder name(String name)

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

      Parameters:
      name - The name of the rule that you are creating or updating.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scheduleExpression

      PutRuleRequest.Builder scheduleExpression(String scheduleExpression)

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

      Parameters:
      scheduleExpression - The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 minutes)".
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • eventPattern

      PutRuleRequest.Builder eventPattern(String eventPattern)

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

      Parameters:
      eventPattern - The event pattern. For more information, see Amazon EventBridge event patterns in the Amazon EventBridge User Guide .
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • state

      PutRuleRequest.Builder state(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • state

      PutRuleRequest.Builder state(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • description

      PutRuleRequest.Builder description(String description)

      A description of the rule.

      Parameters:
      description - A description of the rule.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • roleArn

      PutRuleRequest.Builder roleArn(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      PutRuleRequest.Builder tags(Collection<Tag> tags)

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

      Parameters:
      tags - The list of key-value pairs to associate with the rule.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      PutRuleRequest.Builder tags(Tag... tags)

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

      Parameters:
      tags - The list of key-value pairs to associate with the rule.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      PutRuleRequest.Builder tags(Consumer<Tag.Builder>... tags)

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

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • eventBusName

      PutRuleRequest.Builder eventBusName(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      PutRuleRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      PutRuleRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.