AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::IoT::DomainConfiguration

CfnDomainConfiguration

Specifies a domain configuration.

Import

import { CfnDomainConfiguration } from 'aws-cdk-lib/aws-iot';

Or use the module namespace:

import * as iot from 'aws-cdk-lib/aws-iot';
// iot.CfnDomainConfiguration

Properties

Configuration passed to the constructor as CfnDomainConfigurationProps.

applicationProtocolOptional
string

An enumerated string that specifies the application-layer protocol.

authenticationTypeOptional
string

An enumerated string that specifies the authentication type.

authorizerConfigOptional
IResolvable | AuthorizerConfigProperty

An object that specifies the authorization service for a domain.

clientCertificateConfigOptional
IResolvable | ClientCertificateConfigProperty

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

domainConfigurationNameOptional
string

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

domainConfigurationStatusOptional
string

The status to which the domain configuration should be updated. Valid values: `ENABLED` | `DISABLED`

domainNameOptional
string

The name of the domain.

serverCertificateArnsOptional
string[]

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

serverCertificateConfigOptional
IResolvable | ServerCertificateConfigProperty

The server certificate configuration. For more information, see [Configurable endpoints](https://docs.aws.amazon.com//iot/latest/developerguide/iot-custom-endpoints-configurable.html) from the AWS IoT Core Developer Guide.

serviceTypeOptional
string

The type of service delivered by the endpoint. > AWS IoT Core currently supports only the `DATA` service type.

tagsOptional
CfnTag[]

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..."

tlsConfigOptional
IResolvable | TlsConfigProperty

An object that specifies the TLS configuration for a domain.

validationCertificateArnOptional
string

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 AWS -managed domains.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::IoT::DomainConfigurationView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-iot
CFN TypeAWS::IoT::DomainConfiguration
Properties13

Related Constructs

Explore This Service

External Links