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

Interface Rule.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Rule.Builder,Rule>, SdkBuilder<Rule.Builder,Rule>, SdkPojo

Enclosing class:

Rule

public static interface Rule.Builder
extends SdkPojo, CopyableBuilder<Rule.Builder,Rule>

Method Summary

Modifier and Type	Method	Description
Rule.Builder	arn(String arn)	The Amazon Resource Name (ARN) of the rule.
Rule.Builder	description(String description)	The description of the rule.
Rule.Builder	eventBusName(String eventBusName)	The name or ARN of the event bus associated with the rule.
Rule.Builder	eventPattern(String eventPattern)	The event pattern of the rule.
Rule.Builder	managedBy(String managedBy)	If the rule was created on behalf of your account by an Amazon Web Services service, this field displays the principal name of the service that created the rule.
Rule.Builder	name(String name)	The name of the rule.
Rule.Builder	roleArn(String roleArn)	The Amazon Resource Name (ARN) of the role that is used for target invocation.
Rule.Builder	scheduleExpression(String scheduleExpression)	The scheduling expression.
Rule.Builder	state(String state)	The state of the rule.
Rule.Builder	state(RuleState state)	The state of the rule.

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

copy

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

applyMutation, build

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

equalsBySdkFields, sdkFields

Method Detail

name

Rule.Builder name(String name)

The name of the rule.

Parameters:

name - The name of the rule.

Returns:

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

arn

Rule.Builder arn(String arn)

The Amazon Resource Name (ARN) of the rule.

Parameters:

arn - The Amazon Resource Name (ARN) of the rule.

Returns:

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

eventPattern

Rule.Builder eventPattern(String eventPattern)

The event pattern of the rule. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.

Parameters:

eventPattern - The event pattern of the rule. 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

Rule.Builder state(String state)

The state of the rule.

Parameters:

state - The state of the rule.

Returns:

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

See Also:

RuleState, RuleState

state

Rule.Builder state(RuleState state)

The state of the rule.

Parameters:

state - The state of the rule.

Returns:

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

See Also:

RuleState, RuleState

description

Rule.Builder description(String description)

The description of the rule.

Parameters:

description - The description of the rule.

Returns:

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

scheduleExpression

Rule.Builder scheduleExpression(String scheduleExpression)

The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)". For more information, see Creating an Amazon EventBridge rule that runs on a schedule.

Parameters:

scheduleExpression - The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)". For more information, see Creating an Amazon EventBridge rule that runs on a schedule.

Returns:

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

roleArn

Rule.Builder roleArn(String roleArn)

The Amazon Resource Name (ARN) of the role that is used for target invocation.

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 role that is used for target invocation.

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.

managedBy

Rule.Builder managedBy(String managedBy)

If the rule was created on behalf of your account by an Amazon Web Services service, this field displays the principal name of the service that created the rule.

Parameters:

managedBy - If the rule was created on behalf of your account by an Amazon Web Services service, this field displays the principal name of the service that created the rule.

Returns:

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

eventBusName

Rule.Builder eventBusName(String eventBusName)

The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

Parameters:

eventBusName - The name or ARN of the event bus associated with the 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.