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: "EventBusNameOrArn",
  ids: ["TargetId"], # required
  force: false,
}

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)


4843
4844
4845
4846
4847
4848
4849
4850
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4843

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)


4843
4844
4845
4846
4847
4848
4849
4850
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4843

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>)


4843
4844
4845
4846
4847
4848
4849
4850
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4843

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

#ruleString

The name of the rule.

Returns:

  • (String)


4843
4844
4845
4846
4847
4848
4849
4850
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 4843

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