Skip to main content

rules_list_only

Lists rules in a region or regions, for all properties use rules

Overview

Namerules_list_only
TypeResource
DescriptionResource Type definition for AWS::Events::Rule
Idaws.events.rules_list_only

Fields

NameDatatypeDescription
event_bus_namestringThe name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.
event_patternobjectThe event pattern of the rule. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.
schedule_expressionstringThe scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)". For more information, see Creating an Amazon EventBridge rule that runs on a schedule.
descriptionstringThe description of the rule.
statestringThe state of the rule.
targetsarrayAdds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.
Targets are the resources that are invoked when a rule is triggered.
arnstringThe ARN of the rule, such as arn:aws:events:us-east-2:123456789012:rule/example.
role_arnstringThe Amazon Resource Name (ARN) of the role that is used for target invocation.
namestringThe name of the rule.
regionstringAWS region.

Methods

NameAccessible byRequired Params
list_resourcesSELECTregion

SELECT examples

Lists all rules in a region.

SELECT
region,
arn
FROM aws.events.rules_list_only
WHERE region = 'us-east-1';

Permissions

For permissions required to operate on the rules_list_only resource, see rules