rule

Gets an individual rule resource

Overview

Name	rule
Type	Resource
Description	rule
Id	awscc.events.rule

Fields

Name	Datatype	Description
event_bus_name	string	The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.
event_pattern	object	The event pattern of the rule. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.
schedule_expression	string	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.
description	string	The description of the rule.
state	string	The state of the rule.
targets	array	Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.<br/>Targets are the resources that are invoked when a rule is triggered.
arn	string	The ARN of the rule, such as arn:aws:events:us-east-2:123456789012:rule/example.
role_arn	string	The Amazon Resource Name (ARN) of the role that is used for target invocation.
name	string	The name of the rule.
region	string	AWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
event_bus_name,
event_pattern,
schedule_expression,
description,
state,
targets,
arn,
role_arn,
name
FROM awscc.events.rule
WHERE data__Identifier = '<Arn>';

Permissions

To operate on the rule resource, the following permissions are required:

Read

iam:PassRole,
events:DescribeRule,
events:ListTargetsByRule

Update

iam:PassRole,
events:DescribeRule,
events:PutRule,
events:RemoveTargets,
events:PutTargets

Delete

iam:PassRole,
events:DescribeRule,
events:DeleteRule,
events:RemoveTargets,
events:ListTargetsByRule