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

Inherits:

Struct

• Object
• Struct
• Aws::EventBridge::Types::RemoveTargetsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-eventbridge/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #event_bus_name ⇒ String

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

• #force ⇒ Boolean

  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.

• #ids ⇒ Array<String>

  The IDs of the targets to remove from the rule.

• #rule ⇒ String

  The name of the rule.

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)

# File 'lib/aws-sdk-eventbridge/types.rb', line 4483

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

#force ⇒ Boolean

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)

# File 'lib/aws-sdk-eventbridge/types.rb', line 4483

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

#ids ⇒ Array<String>

The IDs of the targets to remove from the rule.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-eventbridge/types.rb', line 4483

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

#rule ⇒ String

The name of the rule.

Returns:

• (String)

# File 'lib/aws-sdk-eventbridge/types.rb', line 4483

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