software.amazon.awscdk.services.iot

Interface CfnDomainConfigurationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDomainConfigurationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.857Z")
 @Stability(value=Stable)
public interface CfnDomainConfigurationProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.iot.*;
 CfnDomainConfigurationProps cfnDomainConfigurationProps = CfnDomainConfigurationProps.builder()
         .authorizerConfig(AuthorizerConfigProperty.builder()
                 .allowAuthorizerOverride(false)
                 .defaultAuthorizerName("defaultAuthorizerName")
                 .build())
         .domainConfigurationName("domainConfigurationName")
         .domainConfigurationStatus("domainConfigurationStatus")
         .domainName("domainName")
         .serverCertificateArns(List.of("serverCertificateArns"))
         .serviceType("serviceType")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .validationCertificateArn("validationCertificateArn")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnDomainConfigurationProps.Builder A builder for CfnDomainConfigurationProps
static class	CfnDomainConfigurationProps.Jsii$Proxy An implementation for CfnDomainConfigurationProps

Method Summary

Modifier and Type	Method and Description
static CfnDomainConfigurationProps.Builder	builder()
default Object	getAuthorizerConfig() An object that specifies the authorization service for a domain.
default String	getDomainConfigurationName() The name of the domain configuration.
default String	getDomainConfigurationStatus() The status to which the domain configuration should be updated.
default String	getDomainName() The name of the domain.
default List<String>	getServerCertificateArns() The ARNs of the certificates that AWS IoT passes to the device during the TLS handshake.
default String	getServiceType() The type of service delivered by the endpoint.
default List<CfnTag>	getTags() Metadata which can be used to manage the domain configuration.
default String	getValidationCertificateArn() The certificate used to validate the server certificate and prove domain name ownership.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAuthorizerConfig

@Stability(value=Stable)
 @Nullable
default Object getAuthorizerConfig()

An object that specifies the authorization service for a domain.

getDomainConfigurationName

@Stability(value=Stable)
 @Nullable
default String getDomainConfigurationName()

The name of the domain configuration.

This value must be unique to a region.

getDomainConfigurationStatus

@Stability(value=Stable)
 @Nullable
default String getDomainConfigurationStatus()

The status to which the domain configuration should be updated.

Valid values: ENABLED | DISABLED

getDomainName

@Stability(value=Stable)
 @Nullable
default String getDomainName()

The name of the domain.

getServerCertificateArns

@Stability(value=Stable)
 @Nullable
default List<String> getServerCertificateArns()

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.

getServiceType

@Stability(value=Stable)
 @Nullable
default String getServiceType()

The type of service delivered by the endpoint.

AWS IoT Core currently supports only the DATA service type.

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

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

getValidationCertificateArn

@Stability(value=Stable)
 @Nullable
default String getValidationCertificateArn()

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.

builder

@Stability(value=Stable)
static CfnDomainConfigurationProps.Builder builder()

Returns:

a CfnDomainConfigurationProps.Builder of CfnDomainConfigurationProps