Package software.amazon.awscdk.services.iot

Class CfnDomainConfiguration

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.iot.CfnDomainConfiguration
All Implemented Interfaces:
IEnvironmentAware, IInspectable, ITaggable, IDomainConfigurationRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-10T13:40:07.559Z") @Stability(Stable) public class CfnDomainConfiguration extends CfnResource implements IInspectable, IDomainConfigurationRef, ITaggable
Specifies a domain configuration.

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.*;
 CfnDomainConfiguration cfnDomainConfiguration = CfnDomainConfiguration.Builder.create(this, "MyCfnDomainConfiguration")
         .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)
                 .ocspAuthorizedResponderArn("ocspAuthorizedResponderArn")
                 .ocspLambdaArn("ocspLambdaArn")
                 .build())
         .serviceType("serviceType")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .tlsConfig(TlsConfigProperty.builder()
                 .securityPolicy("securityPolicy")
                 .build())
         .validationCertificateArn("validationCertificateArn")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnDomainConfiguration

      protected CfnDomainConfiguration(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnDomainConfiguration

      protected CfnDomainConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnDomainConfiguration

      @Stability(Stable) public CfnDomainConfiguration(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnDomainConfigurationProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnDomainConfiguration

      @Stability(Stable) public CfnDomainConfiguration(@NotNull software.constructs.Construct scope, @NotNull String id)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.

  • Method Details

    • fromDomainConfigurationArn

      @Stability(Stable) @NotNull public static IDomainConfigurationRef fromDomainConfigurationArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IDomainConfigurationRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromDomainConfigurationName

      @Stability(Stable) @NotNull public static IDomainConfigurationRef fromDomainConfigurationName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String domainConfigurationName)
      Creates a new IDomainConfigurationRef from a domainConfigurationName.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      domainConfigurationName - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the domain configuration.

    • getAttrDomainType

      @Stability(Stable) @NotNull public String getAttrDomainType()
      The type of service delivered by the domain.

    • getAttrServerCertificates

      @Stability(Stable) @NotNull public IResolvable getAttrServerCertificates()
      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.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getDomainConfigurationRef

      @Stability(Stable) @NotNull public DomainConfigurationReference getDomainConfigurationRef()
      A reference to a DomainConfiguration resource.
      Specified by:
      getDomainConfigurationRef in interface IDomainConfigurationRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getApplicationProtocol

      @Stability(Stable) @Nullable public String getApplicationProtocol()
      An enumerated string that specifies the application-layer protocol.

    • setApplicationProtocol

      @Stability(Stable) public void setApplicationProtocol(@Nullable String value)
      An enumerated string that specifies the application-layer protocol.

    • getAuthenticationType

      @Stability(Stable) @Nullable public String getAuthenticationType()
      An enumerated string that specifies the authentication type.

    • setAuthenticationType

      @Stability(Stable) public void setAuthenticationType(@Nullable String value)
      An enumerated string that specifies the authentication type.

    • getAuthorizerConfig

      @Stability(Stable) @Nullable public Object getAuthorizerConfig()
      An object that specifies the authorization service for a domain.

      Returns union: either IResolvable or CfnDomainConfiguration.AuthorizerConfigProperty

    • setAuthorizerConfig

      @Stability(Stable) public void setAuthorizerConfig(@Nullable IResolvable value)
      An object that specifies the authorization service for a domain.

    • setAuthorizerConfig

      @Stability(Stable) public void setAuthorizerConfig(@Nullable CfnDomainConfiguration.AuthorizerConfigProperty value)
      An object that specifies the authorization service for a domain.

    • getClientCertificateConfig

      @Stability(Stable) @Nullable public Object getClientCertificateConfig()
      An object that specifies the client certificate configuration for a domain.

      Returns union: either IResolvable or CfnDomainConfiguration.ClientCertificateConfigProperty

    • setClientCertificateConfig

      @Stability(Stable) public void setClientCertificateConfig(@Nullable IResolvable value)
      An object that specifies the client certificate configuration for a domain.

    • setClientCertificateConfig

      @Stability(Stable) public void setClientCertificateConfig(@Nullable CfnDomainConfiguration.ClientCertificateConfigProperty value)
      An object that specifies the client certificate configuration for a domain.

    • getDomainConfigurationName

      @Stability(Stable) @Nullable public String getDomainConfigurationName()
      The name of the domain configuration.

    • setDomainConfigurationName

      @Stability(Stable) public void setDomainConfigurationName(@Nullable String value)
      The name of the domain configuration.

    • getDomainConfigurationStatus

      @Stability(Stable) @Nullable public String getDomainConfigurationStatus()
      The status to which the domain configuration should be updated.

    • setDomainConfigurationStatus

      @Stability(Stable) public void setDomainConfigurationStatus(@Nullable String value)
      The status to which the domain configuration should be updated.

    • getDomainName

      @Stability(Stable) @Nullable public String getDomainName()
      The name of the domain.

    • setDomainName

      @Stability(Stable) public void setDomainName(@Nullable String value)
      The name of the domain.

    • getServerCertificateArns

      @Stability(Stable) @Nullable public List<String> getServerCertificateArns()
      The ARNs of the certificates that AWS IoT passes to the device during the TLS handshake.

    • setServerCertificateArns

      @Stability(Stable) public void setServerCertificateArns(@Nullable List<String> value)
      The ARNs of the certificates that AWS IoT passes to the device during the TLS handshake.

    • getServerCertificateConfig

      @Stability(Stable) @Nullable public Object getServerCertificateConfig()
      The server certificate configuration.

      Returns union: either IResolvable or CfnDomainConfiguration.ServerCertificateConfigProperty

    • setServerCertificateConfig

      @Stability(Stable) public void setServerCertificateConfig(@Nullable IResolvable value)
      The server certificate configuration.

    • setServerCertificateConfig

      @Stability(Stable) public void setServerCertificateConfig(@Nullable CfnDomainConfiguration.ServerCertificateConfigProperty value)
      The server certificate configuration.

    • getServiceType

      @Stability(Stable) @Nullable public String getServiceType()
      The type of service delivered by the endpoint.

    • setServiceType

      @Stability(Stable) public void setServiceType(@Nullable String value)
      The type of service delivered by the endpoint.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      Metadata which can be used to manage the domain configuration.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      Metadata which can be used to manage the domain configuration.

    • getTlsConfig

      @Stability(Stable) @Nullable public Object getTlsConfig()
      An object that specifies the TLS configuration for a domain.

      Returns union: either IResolvable or CfnDomainConfiguration.TlsConfigProperty

    • setTlsConfig

      @Stability(Stable) public void setTlsConfig(@Nullable IResolvable value)
      An object that specifies the TLS configuration for a domain.

    • setTlsConfig

      @Stability(Stable) public void setTlsConfig(@Nullable CfnDomainConfiguration.TlsConfigProperty value)
      An object that specifies the TLS configuration for a domain.

    • getValidationCertificateArn

      @Stability(Stable) @Nullable public String getValidationCertificateArn()
      The certificate used to validate the server certificate and prove domain name ownership.

    • setValidationCertificateArn

      @Stability(Stable) public void setValidationCertificateArn(@Nullable String value)
      The certificate used to validate the server certificate and prove domain name ownership.