/AWS1/CL_EVBRULE¶
Contains information about a rule in Amazon EventBridge.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
IV_NAME TYPE /AWS1/EVBRULENAME /AWS1/EVBRULENAME¶
The name of the rule.
IV_ARN TYPE /AWS1/EVBRULEARN /AWS1/EVBRULEARN¶
The Amazon Resource Name (ARN) of the rule.
IV_EVENTPATTERN TYPE /AWS1/EVBEVENTPATTERN /AWS1/EVBEVENTPATTERN¶
The event pattern of the rule. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide .
IV_STATE TYPE /AWS1/EVBRULESTATE /AWS1/EVBRULESTATE¶
The state of the rule.
Valid values include:
DISABLED: The rule is disabled. EventBridge does not match any events against the rule.
ENABLED: The rule is enabled. EventBridge matches events against the rule, except for Amazon Web Services management events delivered through CloudTrail.
ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS: The rule is enabled for all events, including Amazon Web Services management events delivered through CloudTrail.Management events provide visibility into management operations that are performed on resources in your Amazon Web Services account. These are also known as control plane operations. For more information, see Logging management events in the CloudTrail User Guide, and Filtering management events from Amazon Web Services services in the Amazon EventBridge User Guide .
This value is only valid for rules on the default event bus or custom event buses. It does not apply to partner event buses.
IV_DESCRIPTION TYPE /AWS1/EVBRULEDESCRIPTION /AWS1/EVBRULEDESCRIPTION¶
The description of the rule.
IV_SCHEDULEEXPRESSION TYPE /AWS1/EVBSCHEDULEEXPRESSION /AWS1/EVBSCHEDULEEXPRESSION¶
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.
IV_ROLEARN TYPE /AWS1/EVBROLEARN /AWS1/EVBROLEARN¶
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
RoleArnwith proper permissions in theTargetstructure, instead of here in this parameter.
IV_MANAGEDBY TYPE /AWS1/EVBMANAGEDBY /AWS1/EVBMANAGEDBY¶
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.
IV_EVENTBUSNAME TYPE /AWS1/EVBEVENTBUSNAME /AWS1/EVBEVENTBUSNAME¶
The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.
Queryable Attributes¶
Name¶
The name of the rule.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NAME() |
Getter for NAME, with configurable default |
ASK_NAME() |
Getter for NAME w/ exceptions if field has no value |
HAS_NAME() |
Determine if NAME has a value |
Arn¶
The Amazon Resource Name (ARN) of the rule.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ARN() |
Getter for ARN, with configurable default |
ASK_ARN() |
Getter for ARN w/ exceptions if field has no value |
HAS_ARN() |
Determine if ARN has a value |
EventPattern¶
The event pattern of the rule. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide .
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_EVENTPATTERN() |
Getter for EVENTPATTERN, with configurable default |
ASK_EVENTPATTERN() |
Getter for EVENTPATTERN w/ exceptions if field has no value |
HAS_EVENTPATTERN() |
Determine if EVENTPATTERN has a value |
State¶
The state of the rule.
Valid values include:
DISABLED: The rule is disabled. EventBridge does not match any events against the rule.
ENABLED: The rule is enabled. EventBridge matches events against the rule, except for Amazon Web Services management events delivered through CloudTrail.
ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS: The rule is enabled for all events, including Amazon Web Services management events delivered through CloudTrail.Management events provide visibility into management operations that are performed on resources in your Amazon Web Services account. These are also known as control plane operations. For more information, see Logging management events in the CloudTrail User Guide, and Filtering management events from Amazon Web Services services in the Amazon EventBridge User Guide .
This value is only valid for rules on the default event bus or custom event buses. It does not apply to partner event buses.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATE() |
Getter for STATE, with configurable default |
ASK_STATE() |
Getter for STATE w/ exceptions if field has no value |
HAS_STATE() |
Determine if STATE has a value |
Description¶
The description of the rule.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DESCRIPTION() |
Getter for DESCRIPTION, with configurable default |
ASK_DESCRIPTION() |
Getter for DESCRIPTION w/ exceptions if field has no value |
HAS_DESCRIPTION() |
Determine if DESCRIPTION has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SCHEDULEEXPRESSION() |
Getter for SCHEDULEEXPRESSION, with configurable default |
ASK_SCHEDULEEXPRESSION() |
Getter for SCHEDULEEXPRESSION w/ exceptions if field has no |
HAS_SCHEDULEEXPRESSION() |
Determine if SCHEDULEEXPRESSION has a value |
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
RoleArnwith proper permissions in theTargetstructure, instead of here in this parameter.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ROLEARN() |
Getter for ROLEARN, with configurable default |
ASK_ROLEARN() |
Getter for ROLEARN w/ exceptions if field has no value |
HAS_ROLEARN() |
Determine if ROLEARN has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MANAGEDBY() |
Getter for MANAGEDBY, with configurable default |
ASK_MANAGEDBY() |
Getter for MANAGEDBY w/ exceptions if field has no value |
HAS_MANAGEDBY() |
Determine if MANAGEDBY has a value |
EventBusName¶
The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_EVENTBUSNAME() |
Getter for EVENTBUSNAME, with configurable default |
ASK_EVENTBUSNAME() |
Getter for EVENTBUSNAME w/ exceptions if field has no value |
HAS_EVENTBUSNAME() |
Determine if EVENTBUSNAME has a value |
Public Local Types In This Class¶
Internal table types, representing arrays and maps of this class, are defined as local types:
TT_RULERESPONSELIST¶
TYPES TT_RULERESPONSELIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_EVBRULE WITH DEFAULT KEY
.