Rule
Contains information about a rule in Amazon CloudWatch Events.
Contents
- Arn
-
The Amazon Resource Name (ARN) of the rule.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Required: No
- Description
-
The description of the rule.
Type: String
Length Constraints: Maximum length of 512.
Required: No
- EventPattern
-
The event pattern of the rule. For more information, see Events and Event Patterns in the Amazon CloudWatch Events User Guide.
Type: String
Required: No
- ManagedBy
-
If the rule was created on behalf of your account by an AWS service, this field displays the principal name of the service that created the rule.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: No
- Name
-
The name of the rule.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[\.\-_A-Za-z0-9]+Required: No
- RoleArn
-
The Amazon Resource Name (ARN) of the role that is used for target invocation.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Required: No
- ScheduleExpression
-
The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".
Type: String
Length Constraints: Maximum length of 256.
Required: No
- State
-
The state of the rule.
Type: String
Valid Values:
ENABLED | DISABLEDRequired: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
