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

Class: Aws::EventBridge::Types::RemoveTargetsRequest

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 RemoveTargetsRequest data as a hash:

{
  rule: "RuleName", # required
  event_bus_name: "EventBusName",
  ids: ["TargetId"], # required
  force: false,
}

Instance Attribute Summary collapse

Instance Attribute Details

#event_bus_nameString

The name of the event bus associated with the rule.

Returns:

  • (String)


2005
2006
2007
2008
2009
2010
2011
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 2005

class RemoveTargetsRequest < Struct.new(
  :rule,
  :event_bus_name,
  :ids,
  :force)
  include Aws::Structure
end

#forceBoolean

If this is a managed rule created by an AWS service on your behalf, you must specify Force as True to remove targets. This parameter is ignored for rules that aren't 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)


2005
2006
2007
2008
2009
2010
2011
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 2005

class RemoveTargetsRequest < Struct.new(
  :rule,
  :event_bus_name,
  :ids,
  :force)
  include Aws::Structure
end

#idsArray<String>

The IDs of the targets to remove from the rule.

Returns:

  • (Array<String>)


2005
2006
2007
2008
2009
2010
2011
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 2005

class RemoveTargetsRequest < Struct.new(
  :rule,
  :event_bus_name,
  :ids,
  :force)
  include Aws::Structure
end

#ruleString

The name of the rule.

Returns:

  • (String)


2005
2006
2007
2008
2009
2010
2011
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 2005

class RemoveTargetsRequest < Struct.new(
  :rule,
  :event_bus_name,
  :ids,
  :force)
  include Aws::Structure
end