Class: Aws::EventBridge::Types::Rule
- Inherits:
-
Struct
- Object
- Struct
- Aws::EventBridge::Types::Rule
- Defined in:
- gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/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 Amazon Web Services 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.
4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 |
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4214 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.
4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 |
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4214 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.
4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 |
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4214 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.
4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 |
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4214 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 Amazon Web Services service, this field displays the principal name of the service that created the rule.
4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 |
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4214 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.
4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 |
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4214 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.
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 RoleArn
with proper permissions in the Target
structure,
instead of here in this parameter.
4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 |
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4214 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)". For more information, see Creating an Amazon EventBridge rule that runs on a schedule.
4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 |
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4214 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.
4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 |
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4214 class Rule < Struct.new( :name, :arn, :event_pattern, :state, :description, :schedule_expression, :role_arn, :managed_by, :event_bus_name) SENSITIVE = [] include Aws::Structure end |