Class: Aws::CodeStarNotifications::Types::DeleteTargetRequest

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

Overview

Note:

When making an API call, you may pass DeleteTargetRequest data as a hash:

{
  target_address: "TargetAddress", # required
  force_unsubscribe_all: false,
}

Constant Summary collapse

SENSITIVE =
[:target_address]

Instance Attribute Summary collapse

Instance Attribute Details

#force_unsubscribe_allBoolean

A Boolean value that can be used to delete all associations with this SNS topic. The default value is FALSE. If set to TRUE, all associations between that target and every notification rule in your AWS account are deleted.

Returns:

  • (Boolean)


213
214
215
216
217
218
# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/types.rb', line 213

class DeleteTargetRequest < Struct.new(
  :target_address,
  :force_unsubscribe_all)
  SENSITIVE = [:target_address]
  include Aws::Structure
end

#target_addressString

The Amazon Resource Name (ARN) of the SNS topic to delete.

Returns:

  • (String)


213
214
215
216
217
218
# File 'gems/aws-sdk-codestarnotifications/lib/aws-sdk-codestarnotifications/types.rb', line 213

class DeleteTargetRequest < Struct.new(
  :target_address,
  :force_unsubscribe_all)
  SENSITIVE = [:target_address]
  include Aws::Structure
end