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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#event_bus_nameString

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

Returns:

  • (String)


4130
4131
4132
4133
4134
4135
4136
4137
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4130

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

#forceBoolean

If this is a managed rule, created by an Amazon Web Services service on your behalf, you must specify Force as True to remove targets. 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)


4130
4131
4132
4133
4134
4135
4136
4137
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4130

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

#idsArray<String>

The IDs of the targets to remove from the rule.

Returns:

  • (Array<String>)


4130
4131
4132
4133
4134
4135
4136
4137
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4130

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

#ruleString

The name of the rule.

Returns:

  • (String)


4130
4131
4132
4133
4134
4135
4136
4137
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4130

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