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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing RemoveTargetsRequest as input to an Aws::Client method, you can use a vanilla Hash:

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

See Also:

Instance Attribute Summary collapse

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.

Returns:

  • (String) —

    The name or ARN of the event bus associated with the rule.

#force ⇒ Boolean

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

    If this is a managed rule, created by an AWS service on your behalf, you must specify Force as True to remove targets.

#ids ⇒ Array<String>

The IDs of the targets to remove from the rule.

Returns:

  • (Array<String>) —

    The IDs of the targets to remove from the rule.

#rule ⇒ String

The name of the rule.

Returns:

  • (String) —

    The name of the rule.