Class: Aws::ApplicationDiscoveryService::Types::DeleteAgent

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

Overview

An object representing the agent or data collector to be deleted along with the optional configurations for error handling.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#agent_idString

The ID of the agent or data collector to delete.

Returns:

  • (String)


744
745
746
747
748
749
# File 'gems/aws-sdk-applicationdiscoveryservice/lib/aws-sdk-applicationdiscoveryservice/types.rb', line 744

class DeleteAgent < Struct.new(
  :agent_id,
  :force)
  SENSITIVE = []
  include Aws::Structure
end

#forceBoolean

Optional flag used to force delete an agent or data collector. It is needed to delete any agent in HEALTHY/UNHEALTHY/RUNNING status. Note that deleting an agent that is actively reporting health causes it to be re-registered with a different agent ID after data collector re-connects with Amazon Web Services.

Returns:

  • (Boolean)


744
745
746
747
748
749
# File 'gems/aws-sdk-applicationdiscoveryservice/lib/aws-sdk-applicationdiscoveryservice/types.rb', line 744

class DeleteAgent < Struct.new(
  :agent_id,
  :force)
  SENSITIVE = []
  include Aws::Structure
end