Class: Aws::IoTDataPlane::Types::DeleteConnectionRequest

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

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#clean_session ⇒ Boolean

Specifies whether to remove the client's session state when disconnecting. Set to TRUE to delete all session information, including subscriptions and queued messages. Set to FALSE to preserve the session state. By default, this is set to FALSE (preserves the session state).

Returns:

  • (Boolean) 


46
47
48
49
50
51
52
 
# File 'gems/aws-sdk-iotdataplane/lib/aws-sdk-iotdataplane/types.rb', line 46

class DeleteConnectionRequest < Struct.new(
  :client_id,
  :clean_session,
  :prevent_will_message)
  SENSITIVE = []
  include Aws::Structure
end

#client_id ⇒ String

The unique identifier of the MQTT client to disconnect. The client ID can't start with a dollar sign ($).

Returns:

  • (String) 


46
47
48
49
50
51
52
 
# File 'gems/aws-sdk-iotdataplane/lib/aws-sdk-iotdataplane/types.rb', line 46

class DeleteConnectionRequest < Struct.new(
  :client_id,
  :clean_session,
  :prevent_will_message)
  SENSITIVE = []
  include Aws::Structure
end

#prevent_will_message ⇒ Boolean

Controls if Amazon Web Services IoT Core publishes the client's Last Will and Testament (LWT) message upon disconnection. Set to TRUE to prevent publishing the LWT message. Set to FALSE to allow publishing. By default, this is set to FALSE (allows publishing the LWT message).

Returns:

  • (Boolean) 


46
47
48
49
50
51
52
 
# File 'gems/aws-sdk-iotdataplane/lib/aws-sdk-iotdataplane/types.rb', line 46

class DeleteConnectionRequest < Struct.new(
  :client_id,
  :clean_session,
  :prevent_will_message)
  SENSITIVE = []
  include Aws::Structure
end