public static interface PutRuleRequest.Builder extends EventBridgeRequest.Builder, SdkPojo, CopyableBuilder<PutRuleRequest.Builder,PutRuleRequest>
| 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.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildPutRuleRequest.Builder name(String name)
The name of the rule that you are creating or updating.
name - The name of the rule that you are creating or updating.PutRuleRequest.Builder scheduleExpression(String scheduleExpression)
The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 minutes)".
scheduleExpression - The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 minutes)".PutRuleRequest.Builder eventPattern(String eventPattern)
The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.
eventPattern - The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.PutRuleRequest.Builder state(String state)
Indicates whether the rule is enabled or disabled.
PutRuleRequest.Builder state(RuleState state)
Indicates whether the rule is enabled or disabled.
PutRuleRequest.Builder description(String description)
A description of the rule.
description - A description of the rule.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.
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.
PutRuleRequest.Builder tags(Collection<Tag> tags)
The list of key-value pairs to associate with the rule.
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.
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.
This is a convenience that creates an instance of theList.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) .tags - a consumer that will call methods on List.Builder #tags(List) 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.
eventBusName - The name or ARN of the event bus to associate with this rule. If you omit this, the default event bus
is used.PutRuleRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderoverrideConfiguration - The override configuration.PutRuleRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderbuilderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be
given.