Class: Aws::EventBridge::Types::DeleteRuleRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::EventBridge::Types::DeleteRuleRequest
- Defined in:
- gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb
Overview
Note:
When making an API call, you may pass DeleteRuleRequest data as a hash:
{
name: "RuleName", # required
event_bus_name: "EventBusNameOrArn",
force: false,
}
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#event_bus_name ⇒ String
The name or ARN of the event bus associated with the rule.
-
#force ⇒ Boolean
If this is a managed rule, created by an Amazon Web Services service on your behalf, you must specify
Force
asTrue
to delete the rule. -
#name ⇒ String
The name of the rule.
Instance Attribute Details
#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.
1766 1767 1768 1769 1770 1771 1772 |
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 1766 class DeleteRuleRequest < Struct.new( :name, :event_bus_name, :force) SENSITIVE = [] include Aws::Structure end |
#force ⇒ Boolean
If this is a managed rule, created by an Amazon Web Services service
on your behalf, you must specify Force
as True
to delete the
rule. This parameter is ignored for rules that are not managed
rules. You can check whether a rule is a managed rule by using
DescribeRule
or ListRules
and checking the ManagedBy
field of
the response.
1766 1767 1768 1769 1770 1771 1772 |
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 1766 class DeleteRuleRequest < Struct.new( :name, :event_bus_name, :force) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
The name of the rule.
1766 1767 1768 1769 1770 1771 1772 |
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 1766 class DeleteRuleRequest < Struct.new( :name, :event_bus_name, :force) SENSITIVE = [] include Aws::Structure end |