@aws-sdk/client-iot

CreateDomainConfigurationCommandInput Interface

The input for CreateDomainConfigurationCommand.

Members

Name
Type
Details
domainConfigurationName Requiredstring | undefined

The name of the domain configuration. This value must be unique to a region.

applicationProtocol ApplicationProtocol | undefined

An enumerated string that specifies the application-layer protocol.

  • SECURE_MQTT - MQTT over TLS.

  • MQTT_WSS - MQTT over WebSocket.

  • HTTPS - HTTP over TLS.

  • DEFAULT - Use a combination of port and Application Layer Protocol Negotiation (ALPN) to specify application_layer protocol. For more information, see Device communication protocols .

authenticationType AuthenticationType | undefined

An enumerated string that specifies the authentication type.

  • CUSTOM_AUTH_X509 - Use custom authentication and authorization with additional details from the X.509 client certificate.

  • AWS_X509 - Use X.509 client certificates without custom authentication and authorization. For more information, see X.509 client certificates .

  • DEFAULT - Use a combination of port and Application Layer Protocol Negotiation (ALPN) to specify authentication type. For more information, see Device communication protocols .

authorizerConfig AuthorizerConfig | undefined

An object that specifies the authorization service for a domain.

clientCertificateConfig ClientCertificateConfig | undefined

An object that specifies the client certificate configuration for a domain.

domainName string | undefined

The name of the domain.

serverCertificateArns string[] | undefined

The ARNs of the certificates that IoT passes to the device during the TLS handshake. Currently you can specify only one certificate ARN. This value is not required for Amazon Web Services-managed domains.

serverCertificateConfig ServerCertificateConfig | undefined

The server certificate configuration.

serviceType ServiceType | undefined

The type of service delivered by the endpoint.

Amazon Web Services IoT Core currently supports only the DATA service type.

tags Tag[] | undefined

Metadata which can be used to manage the domain configuration.

For URI Request parameters use format: ...key1=value1&key2=value2...

For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."

For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

tlsConfig TlsConfig | undefined

An object that specifies the TLS configuration for a domain.

validationCertificateArn string | undefined

The certificate used to validate the server certificate and prove domain name ownership. This certificate must be signed by a public certificate authority. This value is not required for Amazon Web Services-managed domains.

Full Signature

export interface CreateDomainConfigurationCommandInput extends CreateDomainConfigurationRequest