DeleteConnectionRequest Class | AWS SDK for .NET Version 4

Container for the parameters to the DeleteConnection operation. Disconnects a connected MQTT client from Amazon Web Services IoT Core. When you disconnect a client, Amazon Web Services IoT Core closes the client's network connection and optionally cleans the session state.

Requires permission to access the DeleteConnection action.

In this article ▶

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.IotData.AmazonIotDataRequest
      Amazon.IotData.Model.DeleteConnectionRequest

Namespace: Amazon.IotData.Model
Assembly: AWSSDK.IotData.dll
Version: 3.x.y.z

Syntax

public class DeleteConnectionRequest : AmazonIotDataRequest
         IAmazonWebServiceRequest

The DeleteConnectionRequest type exposes the following members

Constructors

	Name	Description
	DeleteConnectionRequest()

Properties

Name Type Description

Name	Type	Description
CleanSession	System.Nullable<System.Boolean>	Gets and sets the property CleanSession. Specifies whether to remove the client's persistent 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 for persistent sessions. For clean sessions this parameter will be ignored. By default, this is set to `FALSE` (preserves the session state).
ClientId	System.String	Gets and sets the property ClientId. The unique identifier of the MQTT client to disconnect. The client ID can't start with a dollar sign ($). MQTT client IDs must be URL encoded (percent-encoded) when they contain characters that are not valid in HTTP requests, such as spaces, forward slashes (/), and UTF-8 characters.
PreventWillMessage	System.Nullable<System.Boolean>	Gets and sets the property PreventWillMessage. 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 ensure that LWT is published. By default, this is set to `FALSE` (LWT message is published).

CleanSession

System.Nullable<System.Boolean>

Gets and sets the property CleanSession.

Specifies whether to remove the client's persistent 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 for persistent sessions. For clean sessions this parameter will be ignored. By default, this is set to FALSE (preserves the session state).

ClientId

System.String

Gets and sets the property ClientId.

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

MQTT client IDs must be URL encoded (percent-encoded) when they contain characters that are not valid in HTTP requests, such as spaces, forward slashes (/), and UTF-8 characters.

PreventWillMessage

System.Nullable<System.Boolean>

Gets and sets the property PreventWillMessage.

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 ensure that LWT is published. By default, this is set to FALSE (LWT message is published).

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer