Package software.amazon.awscdk.services.iot

Class CfnDomainConfiguration

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.iot.CfnDomainConfiguration
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:57.538Z") @Stability(Stable) public class CfnDomainConfiguration extends CfnResource implements IInspectable
A CloudFormation AWS::IoT::DomainConfiguration.

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")
         .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()))
         .tlsConfig(TlsConfigProperty.builder()
                 .securityPolicy("securityPolicy")
                 .build())
         .validationCertificateArn("validationCertificateArn")
         .build();

  • 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 Construct scope, @NotNull String id, @Nullable CfnDomainConfigurationProps props)
      Create a new AWS::IoT::DomainConfiguration.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.

    • CfnDomainConfiguration

      @Stability(Stable) public CfnDomainConfiguration(@NotNull Construct scope, @NotNull String id)
      Create a new AWS::IoT::DomainConfiguration.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.

  • Method Details

    • 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

    • getTags

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

    • getAuthorizerConfig

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

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

    • getDomainConfigurationName

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

      This value must be unique to a region.

    • setDomainConfigurationName

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

      This value must be unique to a region.

    • getDomainConfigurationStatus

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

      Valid values: ENABLED | DISABLED

    • setDomainConfigurationStatus

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

      Valid values: ENABLED | DISABLED

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

      Currently you can specify only one certificate ARN. This value is not required for AWS -managed domains.

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

      Currently you can specify only one certificate ARN. This value is not required for AWS -managed domains.

    • getServiceType

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

      AWS IoT Core currently supports only the DATA service type.

    • setServiceType

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

      AWS IoT Core currently supports only the DATA service type.

    • getTlsConfig

      @Stability(Stable) @Nullable public Object getTlsConfig()
      AWS::IoT::DomainConfiguration.TlsConfig.

    • setTlsConfig

      @Stability(Stable) public void setTlsConfig(@Nullable IResolvable value)
      AWS::IoT::DomainConfiguration.TlsConfig.

    • setTlsConfig

      @Stability(Stable) public void setTlsConfig(@Nullable CfnDomainConfiguration.TlsConfigProperty value)
      AWS::IoT::DomainConfiguration.TlsConfig.

    • getValidationCertificateArn

      @Stability(Stable) @Nullable public 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.

    • setValidationCertificateArn

      @Stability(Stable) public void setValidationCertificateArn(@Nullable String value)
      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.