interface CfnDomainConfigurationProps

Language	Type name
.NET	Amazon.CDK.AWS.IoT.CfnDomainConfigurationProps
Java	software.amazon.awscdk.services.iot.CfnDomainConfigurationProps
Python	aws_cdk.aws_iot.CfnDomainConfigurationProps
TypeScript	@aws-cdk/aws-iot » CfnDomainConfigurationProps

Properties for defining a CfnDomainConfiguration.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as iot from '@aws-cdk/aws-iot';
const cfnDomainConfigurationProps: iot.CfnDomainConfigurationProps = {
  authorizerConfig: {
    allowAuthorizerOverride: false,
    defaultAuthorizerName: 'defaultAuthorizerName',
  },
  domainConfigurationName: 'domainConfigurationName',
  domainConfigurationStatus: 'domainConfigurationStatus',
  domainName: 'domainName',
  serverCertificateArns: ['serverCertificateArns'],
  serviceType: 'serviceType',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  tlsConfig: {
    securityPolicy: 'securityPolicy',
  },
  validationCertificateArn: 'validationCertificateArn',
};

Properties

Name	Type	Description
authorizerConfig?	IResolvable | AuthorizerConfigProperty	An object that specifies the authorization service for a domain.
domainConfigurationName?	string	The name of the domain configuration.
domainConfigurationStatus?	string	The status to which the domain configuration should be updated.
domainName?	string	The name of the domain.
serverCertificateArns?	string[]	The ARNs of the certificates that AWS IoT passes to the device during the TLS handshake.
serviceType?	string	The type of service delivered by the endpoint.
tags?	CfnTag[]	Metadata which can be used to manage the domain configuration.
tlsConfig?	IResolvable | TlsConfigProperty	AWS::IoT::DomainConfiguration.TlsConfig.
validationCertificateArn?	string	The certificate used to validate the server certificate and prove domain name ownership.

---

authorizerConfig?

Type: IResolvable | AuthorizerConfigProperty (optional)

An object that specifies the authorization service for a domain.

---

domainConfigurationName?

Type: string (optional)

The name of the domain configuration.

This value must be unique to a region.

---

domainConfigurationStatus?

Type: string (optional)

The status to which the domain configuration should be updated.

Valid values: ENABLED | DISABLED

---

domainName?

Type: string (optional)

The name of the domain.

---

serverCertificateArns?

Type: string[] (optional)

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.

---

serviceType?

Type: string (optional)

The type of service delivered by the endpoint.

AWS IoT Core currently supports only the DATA service type.

---

tags?

Type: CfnTag[] (optional)

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?

Type: IResolvable | TlsConfigProperty (optional)

AWS::IoT::DomainConfiguration.TlsConfig.

---

validationCertificateArn?

Type: string (optional)

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.