public static interface Rule.Builder extends SdkPojo, CopyableBuilder<Rule.Builder,Rule>
Modifier and Type | Method and 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(RuleState state)
The state of the rule.
|
Rule.Builder |
state(String state)
The state of the rule.
|
equalsBySdkFields, sdkFields
copy
applyMutation, build
Rule.Builder name(String name)
The name of the rule.
name
- The name of the rule.Rule.Builder arn(String arn)
The Amazon Resource Name (ARN) of the rule.
arn
- The Amazon Resource Name (ARN) of the rule.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.
eventPattern
- The event pattern of the rule. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.Rule.Builder state(String state)
The state of the rule.
Rule.Builder state(RuleState state)
The state of the rule.
Rule.Builder description(String description)
The description of the rule.
description
- The description of the rule.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.
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.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.
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.
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.
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 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.
eventBusName
- The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is
used.Copyright © 2022. All rights reserved.