in awsiot/mqtt_connection_builder.py [0:0]
def websockets_with_custom_authorizer(
region=None,
credentials_provider=None,
auth_username=None,
auth_authorizer_name=None,
auth_authorizer_signature=None,
auth_password=None,
auth_token_key_name=None,
auth_token_value=None,
**kwargs) -> awscrt.mqtt.Connection:
"""
This builder creates an :class:`awscrt.mqtt.Connection`, configured for an MQTT connection using a custom
authorizer using websockets. This function will set the username, port, and TLS options.
This function takes all :mod:`common arguments<awsiot.mqtt_connection_builder>`
described at the top of this doc, as well as...
Keyword Args:
region (str): AWS region to use when signing.
credentials_provider (awscrt.auth.AwsCredentialsProvider): Source of AWS credentials to use when signing.
auth_username (`str`): The username to use with the custom authorizer.
If provided, the username given will be passed when connecting to the custom authorizer.
If not provided, it will check to see if a username has already been set (via username="example")
and will use that instead. Custom authentication parameters will be appended as appropriate
to any supplied username value.
auth_password (`str`): The password to use with the custom authorizer.
If not provided, then no password will be sent in the initial CONNECT packet.
auth_authorizer_name (`str`): 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.
auth_authorizer_signature (`str`): The digital signature of the token value in the `auth_token_value`
parameter. 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.
auth_token_key_name (`str`): 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.
auth_token_value (`str`): An opaque token value. This value must be signed by the private key associated with
the custom authorizer and the result passed in via the `auth_authorizer_signature` parameter.
Required if the custom authorizer has signing enabled.
"""
return _with_custom_authorizer(
auth_username=auth_username,
auth_authorizer_name=auth_authorizer_name,
auth_authorizer_signature=auth_authorizer_signature,
auth_password=auth_password,
auth_token_key_name=auth_token_key_name,
auth_token_value=auth_token_value,
use_websockets=True,
websockets_region=region,
websockets_credentials_provider=credentials_provider,
**kwargs)