software.amazon.awssdk.services.eventbridge.model

Interface PutRuleRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<PutRuleRequest.Builder,PutRuleRequest>, EventBridgeRequest.Builder, SdkBuilder<PutRuleRequest.Builder,PutRuleRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

PutRuleRequest

public static interface PutRuleRequest.Builder
extends EventBridgeRequest.Builder, SdkPojo, CopyableBuilder<PutRuleRequest.Builder,PutRuleRequest>

Method Summary

Modifier and Type	Method and Description
PutRuleRequest.Builder	description(String description) A description of the rule.
PutRuleRequest.Builder	eventBusName(String eventBusName) The name or ARN of the event bus to associate with this rule.
PutRuleRequest.Builder	eventPattern(String eventPattern) The event pattern.
PutRuleRequest.Builder	name(String name) The name of the rule that you are creating or updating.
PutRuleRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
PutRuleRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
PutRuleRequest.Builder	roleArn(String roleArn) The Amazon Resource Name (ARN) of the IAM role associated with the rule.
PutRuleRequest.Builder	scheduleExpression(String scheduleExpression) The scheduling expression.
PutRuleRequest.Builder	state(RuleState state) Indicates whether the rule is enabled or disabled.
PutRuleRequest.Builder	state(String state) Indicates whether the rule is enabled or disabled.
PutRuleRequest.Builder	tags(Collection<Tag> tags) The list of key-value pairs to associate with the rule.
PutRuleRequest.Builder	tags(Consumer<Tag.Builder>... tags) The list of key-value pairs to associate with the rule.
PutRuleRequest.Builder	tags(Tag... tags) The list of key-value pairs to associate with the rule.

Methods inherited from interface software.amazon.awssdk.services.eventbridge.model.EventBridgeRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

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 Events and Event Patterns in the Amazon EventBridge User Guide.

Parameters:

eventPattern - The event pattern. For more information, see Events and 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)

Indicates whether the rule is enabled or disabled.

Parameters:

state - Indicates whether the rule is enabled or disabled.

Returns:

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

See Also:

RuleState, RuleState

state

PutRuleRequest.Builder state(RuleState state)

Indicates whether the rule is enabled or disabled.

Parameters:

state - Indicates whether the rule is enabled or disabled.

Returns:

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

See Also:

RuleState, RuleState

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.

Parameters:

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

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 that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#tags(List)

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.