iotdataplane/aws.sdk.kotlin.services.iotdataplane.model/GetConnectionResponse/Builder

Builder

Properties

Indicates whether the client is using a clean session. Returns true for clean sessions or false for persistent sessions.

clientId

var clientId: String?

The unique identifier of the MQTT client. This is the same client ID that was used when the client established the connection.

connected

var connected: Boolean

The connection state of the client. Returns true if the client is currently connected, or false if the client is not connected.

connectedSince

var connectedSince: Long

Unix timestamp (in milliseconds) indicating when the client connected. Present only when connected is true.

disconnectedSince

var disconnectedSince: Long

Unix timestamp (in milliseconds) indicating when the client disconnected. Present only when connected is false. This information is available for 30 minutes after the client disconnects.

disconnectReason

var disconnectReason: String?

The reason for the last disconnection, if the client is currently disconnected. See the developer guide for valid disconnect reasons.

keepAliveDuration

var keepAliveDuration: Int

The keep-alive interval in seconds that the client specified when establishing the connection.

sessionExpiry

var sessionExpiry: Long

The session expiry interval in seconds for the MQTT client connection. This is configured by the user. This value indicates how long the session will remain active after the client disconnects.

sourceIp

var sourceIp: String?

The IP address of the client that initiated the connection.

sourcePort

var sourcePort: Int

The client's source port.

targetIp

var targetIp: String?

The IP address of the Amazon Web Services IoT Core endpoint that the client connected to. For clients connected to VPC endpoints, this is the private IP address of the network interface the client is connected to.

targetPort

var targetPort: Int

The port number of the Amazon Web Services IoT Core endpoint that the client connected to.

thingName

var thingName: String?

The name of the thing associated with the principal of the MQTT client, if applicable.

vpcEndpointId

var vpcEndpointId: String?

The ID of the VPC endpoint. Present for clients connected to IoT Core via a VPC endpoint.