| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.CloudWatchEvents.Types.Rule
Description
Synopsis
- data Rule = Rule' {}
- newRule :: Rule
- rule_arn :: Lens' Rule (Maybe Text)
- rule_description :: Lens' Rule (Maybe Text)
- rule_eventBusName :: Lens' Rule (Maybe Text)
- rule_eventPattern :: Lens' Rule (Maybe Text)
- rule_managedBy :: Lens' Rule (Maybe Text)
- rule_name :: Lens' Rule (Maybe Text)
- rule_roleArn :: Lens' Rule (Maybe Text)
- rule_scheduleExpression :: Lens' Rule (Maybe Text)
- rule_state :: Lens' Rule (Maybe RuleState)
Documentation
Contains information about a rule in Amazon EventBridge.
See: newRule smart constructor.
Constructors
| Rule' | |
Fields
| |
Instances
Create a value of Rule with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:Rule', rule_arn - The Amazon Resource Name (ARN) of the rule.
$sel:description:Rule', rule_description - The description of the rule.
$sel:eventBusName:Rule', rule_eventBusName - The name or ARN of the event bus associated with the rule. If you omit
this, the default event bus is used.
$sel:eventPattern:Rule', rule_eventPattern - The event pattern of the rule. For more information, see
Events and Event Patterns
in the Amazon EventBridge User Guide.
$sel:managedBy:Rule', 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.
$sel:name:Rule', rule_name - The name of the rule.
$sel:roleArn:Rule', rule_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.
$sel:scheduleExpression:Rule', rule_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.
$sel:state:Rule', rule_state - The state of the rule.
rule_eventBusName :: Lens' Rule (Maybe Text) Source #
The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.
rule_eventPattern :: Lens' Rule (Maybe Text) Source #
The event pattern of the rule. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.
rule_managedBy :: Lens' Rule (Maybe Text) Source #
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_roleArn :: Lens' Rule (Maybe Text) Source #
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_scheduleExpression :: Lens' Rule (Maybe Text) Source #
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.