Class CreateDomainConfigurationRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.iot.model.IotRequest
software.amazon.awssdk.services.iot.model.CreateDomainConfigurationRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateDomainConfigurationRequest.Builder,CreateDomainConfigurationRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateDomainConfigurationRequest extends IotRequest implements ToCopyableBuilder<CreateDomainConfigurationRequest.Builder,CreateDomainConfigurationRequest>

  • Method Details

    • domainConfigurationName

      public final String domainConfigurationName()

      The name of the domain configuration. This value must be unique to a region.

      Returns:
      The name of the domain configuration. This value must be unique to a region.

    • domainName

      public final String domainName()

      The name of the domain.

      Returns:
      The name of the domain.

    • hasServerCertificateArns

      public final boolean hasServerCertificateArns()
      For responses, this returns true if the service returned a value for the ServerCertificateArns property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • serverCertificateArns

      public final List<String> serverCertificateArns()

      The ARNs of the certificates that IoT passes to the device during the TLS handshake. Currently you can specify only one certificate ARN. This value is not required for Amazon Web Services-managed domains.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasServerCertificateArns() method.

      Returns:
      The ARNs of the certificates that IoT passes to the device during the TLS handshake. Currently you can specify only one certificate ARN. This value is not required for Amazon Web Services-managed domains.

    • validationCertificateArn

      public final String validationCertificateArn()

      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 Amazon Web Services-managed domains.

      Returns:
      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 Amazon Web Services-managed domains.

    • authorizerConfig

      public final AuthorizerConfig authorizerConfig()

      An object that specifies the authorization service for a domain.

      Returns:
      An object that specifies the authorization service for a domain.

    • serviceType

      public final ServiceType serviceType()

      The type of service delivered by the endpoint.

      Amazon Web Services IoT Core currently supports only the DATA service type.

      If the service returns an enum value that is not available in the current SDK version, serviceType will return ServiceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from serviceTypeAsString().

      Returns:
      The type of service delivered by the endpoint.

      Amazon Web Services IoT Core currently supports only the DATA service type.

      See Also:

    • serviceTypeAsString

      public final String serviceTypeAsString()

      The type of service delivered by the endpoint.

      Amazon Web Services IoT Core currently supports only the DATA service type.

      If the service returns an enum value that is not available in the current SDK version, serviceType will return ServiceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from serviceTypeAsString().

      Returns:
      The type of service delivered by the endpoint.

      Amazon Web Services IoT Core currently supports only the DATA service type.

      See Also:

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final List<Tag> tags()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      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

      public final TlsConfig tlsConfig()

      An object that specifies the TLS configuration for a domain.

      Returns:
      An object that specifies the TLS configuration for a domain.

    • serverCertificateConfig

      public final ServerCertificateConfig serverCertificateConfig()

      The server certificate configuration.

      Returns:
      The server certificate configuration.

    • authenticationType

      public final AuthenticationType authenticationType()

      An enumerated string that specifies the authentication type.

      • CUSTOM_AUTH_X509 - Use custom authentication and authorization with additional details from the X.509 client certificate.

      • AWS_X509 - Use X.509 client certificates without custom authentication and authorization. For more information, see X.509 client certificates.

      • DEFAULT - Use a combination of port and Application Layer Protocol Negotiation (ALPN) to specify authentication type. For more information, see Device communication protocols.

      If the service returns an enum value that is not available in the current SDK version, authenticationType will return AuthenticationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authenticationTypeAsString().

      Returns:
      An enumerated string that specifies the authentication type.

      • CUSTOM_AUTH_X509 - Use custom authentication and authorization with additional details from the X.509 client certificate.

      • AWS_X509 - Use X.509 client certificates without custom authentication and authorization. For more information, see X.509 client certificates.

      • DEFAULT - Use a combination of port and Application Layer Protocol Negotiation (ALPN) to specify authentication type. For more information, see Device communication protocols.

      See Also:

    • authenticationTypeAsString

      public final String authenticationTypeAsString()

      An enumerated string that specifies the authentication type.

      • CUSTOM_AUTH_X509 - Use custom authentication and authorization with additional details from the X.509 client certificate.

      • AWS_X509 - Use X.509 client certificates without custom authentication and authorization. For more information, see X.509 client certificates.

      • DEFAULT - Use a combination of port and Application Layer Protocol Negotiation (ALPN) to specify authentication type. For more information, see Device communication protocols.

      If the service returns an enum value that is not available in the current SDK version, authenticationType will return AuthenticationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authenticationTypeAsString().

      Returns:
      An enumerated string that specifies the authentication type.

      • CUSTOM_AUTH_X509 - Use custom authentication and authorization with additional details from the X.509 client certificate.

      • AWS_X509 - Use X.509 client certificates without custom authentication and authorization. For more information, see X.509 client certificates.

      • DEFAULT - Use a combination of port and Application Layer Protocol Negotiation (ALPN) to specify authentication type. For more information, see Device communication protocols.

      See Also:

    • applicationProtocol

      public final ApplicationProtocol applicationProtocol()

      An enumerated string that specifies the application-layer protocol.

      • SECURE_MQTT - MQTT over TLS.

      • MQTT_WSS - MQTT over WebSocket.

      • HTTPS - HTTP over TLS.

      • DEFAULT - Use a combination of port and Application Layer Protocol Negotiation (ALPN) to specify application_layer protocol. For more information, see Device communication protocols.

      If the service returns an enum value that is not available in the current SDK version, applicationProtocol will return ApplicationProtocol.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from applicationProtocolAsString().

      Returns:
      An enumerated string that specifies the application-layer protocol.

      • SECURE_MQTT - MQTT over TLS.

      • MQTT_WSS - MQTT over WebSocket.

      • HTTPS - HTTP over TLS.

      • DEFAULT - Use a combination of port and Application Layer Protocol Negotiation (ALPN) to specify application_layer protocol. For more information, see Device communication protocols.

      See Also:

    • applicationProtocolAsString

      public final String applicationProtocolAsString()

      An enumerated string that specifies the application-layer protocol.

      • SECURE_MQTT - MQTT over TLS.

      • MQTT_WSS - MQTT over WebSocket.

      • HTTPS - HTTP over TLS.

      • DEFAULT - Use a combination of port and Application Layer Protocol Negotiation (ALPN) to specify application_layer protocol. For more information, see Device communication protocols.

      If the service returns an enum value that is not available in the current SDK version, applicationProtocol will return ApplicationProtocol.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from applicationProtocolAsString().

      Returns:
      An enumerated string that specifies the application-layer protocol.

      • SECURE_MQTT - MQTT over TLS.

      • MQTT_WSS - MQTT over WebSocket.

      • HTTPS - HTTP over TLS.

      • DEFAULT - Use a combination of port and Application Layer Protocol Negotiation (ALPN) to specify application_layer protocol. For more information, see Device communication protocols.

      See Also:

    • clientCertificateConfig

      public final ClientCertificateConfig clientCertificateConfig()

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

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

    • toBuilder

      public CreateDomainConfigurationRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateDomainConfigurationRequest.Builder,CreateDomainConfigurationRequest>
      Specified by:
      toBuilder in class IotRequest
      Returns:
      a builder for type T

    • builder

      public static CreateDomainConfigurationRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateDomainConfigurationRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.