Package software.amazon.awssdk.iot

Class AwsIotMqtt5ClientBuilder.MqttConnectCustomAuthConfig

java.lang.Object

software.amazon.awssdk.iot.AwsIotMqtt5ClientBuilder.MqttConnectCustomAuthConfig

Enclosing class:

AwsIotMqtt5ClientBuilder

public static final class AwsIotMqtt5ClientBuilder.MqttConnectCustomAuthConfig
extends Object

Configuration options specific to AWS IoT Core custom authentication features. For clients constructed by an AwsIotMqtt5ClientBuilder, all parameters associated with AWS IoT custom authentication are passed via the username and password properties in the CONNECT packet.

Field Summary

Fields

Modifier and Type	Field	Description
String	authorizerName	Name of the custom authorizer to use.
byte[]	password	The password to use with the custom authorizer.
String	tokenKeyName	Key used to extract the custom authorizer token from MQTT username query-string properties.
String	tokenSignature	The digital signature of the token value in the tokenValue property.
String	tokenValue	An opaque token value.
String	username	The username to use with the custom authorizer.

Constructor Summary

Constructors

Constructor	Description
MqttConnectCustomAuthConfig()

Method Summary

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

authorizerName

public String authorizerName

Name of the custom authorizer to use. Required if the endpoint does not have a default custom authorizer associated with it. It is strongly suggested to URL-encode this value; the SDK will not do so for you.

username

public String username

The username to use with the custom authorizer. Query-string elements of this property value will be unioned with the query-string elements implied by other properties in this object. For example, if you set this to: MyUsername?someKey=someValue and use authorizerName to specify the authorizer, the final username would look like: MyUsername?someKey=someValue&x-amz-customauthorizer-name=<your authorizer's name >&...

password

public byte[] password

The password to use with the custom authorizer. Becomes the MQTT5 CONNECT packet's password property. AWS IoT Core will base64 encode this binary data before passing it to the authorizer's lambda function.

tokenKeyName

public String tokenKeyName

Key used to extract the custom authorizer token from MQTT username query-string properties. Required if the custom authorizer has signing enabled. It is strongly suggested to URL-encode this value; the SDK will not do so for you.

tokenValue

public String tokenValue

An opaque token value. This value must be signed by the private key associated with the custom authorizer and the result placed in the tokenSignature property. Required if the custom authorizer has signing enabled.

tokenSignature

public String tokenSignature

The digital signature of the token value in the tokenValue property. The signature must be based on the private key associated with the custom authorizer. The signature must be base64 encoded. Required if the custom authorizer has signing enabled. It is strongly suggested to URL-encode this value; the SDK will not do so for you.

Constructor Details

MqttConnectCustomAuthConfig

public MqttConnectCustomAuthConfig()