Package 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.103.1 (build bef2dea)",
           date="2024-10-25T14:21:16.631Z")
@Stability(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()
         .applicationProtocol("applicationProtocol")
         .authenticationType("authenticationType")
         .authorizerConfig(AuthorizerConfigProperty.builder()
                 .allowAuthorizerOverride(false)
                 .defaultAuthorizerName("defaultAuthorizerName")
                 .build())
         .clientCertificateConfig(ClientCertificateConfigProperty.builder()
                 .clientCertificateCallbackArn("clientCertificateCallbackArn")
                 .build())
         .domainConfigurationName("domainConfigurationName")
         .domainConfigurationStatus("domainConfigurationStatus")
         .domainName("domainName")
         .serverCertificateArns(List.of("serverCertificateArns"))
         .serverCertificateConfig(ServerCertificateConfigProperty.builder()
                 .enableOcspCheck(false)
                 .build())
         .serviceType("serviceType")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .tlsConfig(TlsConfigProperty.builder()
                 .securityPolicy("securityPolicy")
                 .build())
         .validationCertificateArn("validationCertificateArn")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-domainconfiguration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDomainConfigurationProps.Builder	builder()
default String	getApplicationProtocol()	An enumerated string that specifies the application-layer protocol.
default String	getAuthenticationType()	An enumerated string that specifies the authentication type.
default Object	getAuthorizerConfig()	An object that specifies the authorization service for a domain.
default Object	getClientCertificateConfig()	An object that specifies the client certificate configuration 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 Object	getServerCertificateConfig()	The server certificate configuration.
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 Object	getTlsConfig()	An object that specifies the TLS configuration for a domain.
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 Details

getApplicationProtocol

@Stability(Stable)
@Nullable
default String getApplicationProtocol()

An enumerated string that specifies the application-layer protocol.

This property isn't available in China.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-domainconfiguration.html#cfn-iot-domainconfiguration-applicationprotocol

getAuthenticationType

@Stability(Stable)
@Nullable
default String getAuthenticationType()

An enumerated string that specifies the authentication type.

This property isn't available in China.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-domainconfiguration.html#cfn-iot-domainconfiguration-authenticationtype

getAuthorizerConfig

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

An object that specifies the authorization service for a domain.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-domainconfiguration.html#cfn-iot-domainconfiguration-authorizerconfig

getClientCertificateConfig

@Stability(Stable)
@Nullable
default Object getClientCertificateConfig()

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

This property isn't available in China.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-domainconfiguration.html#cfn-iot-domainconfiguration-clientcertificateconfig

getDomainConfigurationName

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

The name of the domain configuration.

This value must be unique to a region.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-domainconfiguration.html#cfn-iot-domainconfiguration-domainconfigurationname

getDomainConfigurationStatus

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

The status to which the domain configuration should be updated.

Valid values: ENABLED | DISABLED

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-domainconfiguration.html#cfn-iot-domainconfiguration-domainconfigurationstatus

getDomainName

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

The name of the domain.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-domainconfiguration.html#cfn-iot-domainconfiguration-domainname

getServerCertificateArns

@Stability(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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-domainconfiguration.html#cfn-iot-domainconfiguration-servercertificatearns

getServerCertificateConfig

@Stability(Stable)
@Nullable
default Object getServerCertificateConfig()

The server certificate configuration.

For more information, see Configurable endpoints from the AWS IoT Core Developer Guide.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-domainconfiguration.html#cfn-iot-domainconfiguration-servercertificateconfig

getServiceType

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

The type of service delivered by the endpoint.

AWS IoT Core currently supports only the DATA service type.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-domainconfiguration.html#cfn-iot-domainconfiguration-servicetype

getTags

@Stability(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..."

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-domainconfiguration.html#cfn-iot-domainconfiguration-tags

getTlsConfig

@Stability(Stable)
@Nullable
default Object getTlsConfig()

An object that specifies the TLS configuration for a domain.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-domainconfiguration.html#cfn-iot-domainconfiguration-tlsconfig

getValidationCertificateArn

@Stability(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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-domainconfiguration.html#cfn-iot-domainconfiguration-validationcertificatearn

builder

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

Returns:

a CfnDomainConfigurationProps.Builder of CfnDomainConfigurationProps