software.amazon.awssdk.services.cloudwatchevents.model

Interface PutRuleRequest.Builder

All Superinterfaces:

AwsRequest.Builder, CloudWatchEventsRequest.Builder, CopyableBuilder<PutRuleRequest.Builder,PutRuleRequest>, SdkBuilder<PutRuleRequest.Builder,PutRuleRequest>, SdkRequest.Builder

Enclosing class:

PutRuleRequest

public static interface PutRuleRequest.Builder
extends CloudWatchEventsRequest.Builder, CopyableBuilder<PutRuleRequest.Builder,PutRuleRequest>

Method Summary

Modifier and Type	Method and Description
PutRuleRequest.Builder	description(String description) A description of the 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	requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) Add an optional request override configuration.
PutRuleRequest.Builder	requestOverrideConfig(Consumer<AwsRequestOverrideConfig.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.

Methods inherited from interface software.amazon.awssdk.services.cloudwatchevents.model.CloudWatchEventsRequest.Builder

build

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

requestOverrideConfig

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

copy

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

apply, 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 CloudWatch Events User Guide.

Parameters:

eventPattern - The event pattern. For more information, see Events and Event Patterns in the Amazon CloudWatch Events 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.

requestOverrideConfig

PutRuleRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

awsRequestOverrideConfig - The override configuration.

Returns:

This object for method chaining.

requestOverrideConfig

PutRuleRequest.Builder requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfig.Builder will be given.

Returns:

This object for method chaining.