Class: Aws::CloudWatchEvents::Types::Rule
- Inherits:
-
Struct
- Object
- Struct
- Aws::CloudWatchEvents::Types::Rule
- Defined in:
- gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb
Overview
Contains information about a rule in Amazon EventBridge.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#arn ⇒ String
The Amazon Resource Name (ARN) of the rule.
-
#description ⇒ String
The description of the rule.
-
#event_bus_name ⇒ String
The name or ARN of the event bus associated with the rule.
-
#event_pattern ⇒ String
The event pattern of the rule.
-
#managed_by ⇒ String
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.
-
#name ⇒ String
The name of the rule.
-
#role_arn ⇒ String
The Amazon Resource Name (ARN) of the role that is used for target invocation.
-
#schedule_expression ⇒ String
The scheduling expression.
-
#state ⇒ String
The state of the rule.
Instance Attribute Details
#arn ⇒ String
The Amazon Resource Name (ARN) of the rule.
3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 3026 class Rule < Struct.new( :name, :arn, :event_pattern, :state, :description, :schedule_expression, :role_arn, :managed_by, :event_bus_name) SENSITIVE = [] include Aws::Structure end |
#description ⇒ String
The description of the rule.
3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 3026 class Rule < Struct.new( :name, :arn, :event_pattern, :state, :description, :schedule_expression, :role_arn, :managed_by, :event_bus_name) SENSITIVE = [] include Aws::Structure end |
#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.
3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 3026 class Rule < Struct.new( :name, :arn, :event_pattern, :state, :description, :schedule_expression, :role_arn, :managed_by, :event_bus_name) SENSITIVE = [] include Aws::Structure end |
#event_pattern ⇒ String
The event pattern of the rule. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.
3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 3026 class Rule < Struct.new( :name, :arn, :event_pattern, :state, :description, :schedule_expression, :role_arn, :managed_by, :event_bus_name) SENSITIVE = [] include Aws::Structure end |
#managed_by ⇒ String
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.
3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 3026 class Rule < Struct.new( :name, :arn, :event_pattern, :state, :description, :schedule_expression, :role_arn, :managed_by, :event_bus_name) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
The name of the rule.
3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 3026 class Rule < Struct.new( :name, :arn, :event_pattern, :state, :description, :schedule_expression, :role_arn, :managed_by, :event_bus_name) SENSITIVE = [] include Aws::Structure end |
#role_arn ⇒ String
The Amazon Resource Name (ARN) of the role that is used for target invocation.
3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 3026 class Rule < Struct.new( :name, :arn, :event_pattern, :state, :description, :schedule_expression, :role_arn, :managed_by, :event_bus_name) SENSITIVE = [] include Aws::Structure end |
#schedule_expression ⇒ String
The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".
3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 3026 class Rule < Struct.new( :name, :arn, :event_pattern, :state, :description, :schedule_expression, :role_arn, :managed_by, :event_bus_name) SENSITIVE = [] include Aws::Structure end |
#state ⇒ String
The state of the rule.
3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 |
# File 'gems/aws-sdk-cloudwatchevents/lib/aws-sdk-cloudwatchevents/types.rb', line 3026 class Rule < Struct.new( :name, :arn, :event_pattern, :state, :description, :schedule_expression, :role_arn, :managed_by, :event_bus_name) SENSITIVE = [] include Aws::Structure end |