You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::EventBridge::Types::DeleteRuleRequest

Inherits:
Struct
  • Object
show all
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: "EventBusName",
  force: false,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#event_bus_name ⇒ String

The event bus associated with the rule. If you omit this, the default event bus is used.

Returns:

  • (String) 


383
384
385
386
387
388
 
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 383

class DeleteRuleRequest < Struct.new(
  :name,
  :event_bus_name,
  :force)
  include Aws::Structure
end

#force ⇒ Boolean

If this is a managed rule, created by an AWS 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.

Returns:

  • (Boolean) 


383
384
385
386
387
388
 
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 383

class DeleteRuleRequest < Struct.new(
  :name,
  :event_bus_name,
  :force)
  include Aws::Structure
end

#name ⇒ String

The name of the rule.

Returns:

  • (String) 


383
384
385
386
387
388
 
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 383

class DeleteRuleRequest < Struct.new(
  :name,
  :event_bus_name,
  :force)
  include Aws::Structure
end