Package software.amazon.awssdk.services.iot.model

Interface CreateDomainConfigurationRequest.Builder

    • Method Detail

      • domainConfigurationName

        CreateDomainConfigurationRequest.Builder domainConfigurationName​(String domainConfigurationName)

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

        Parameters:
        domainConfigurationName - The name of the domain configuration. This value must be unique to a region.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • domainName

        CreateDomainConfigurationRequest.Builder domainName​(String domainName)

        The name of the domain.

        Parameters:
        domainName - The name of the domain.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • serverCertificateArns

        CreateDomainConfigurationRequest.Builder serverCertificateArns​(Collection<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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • serverCertificateArns

        CreateDomainConfigurationRequest.Builder serverCertificateArns​(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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • validationCertificateArn

        CreateDomainConfigurationRequest.Builder validationCertificateArn​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • authorizerConfig

        CreateDomainConfigurationRequest.Builder authorizerConfig​(AuthorizerConfig authorizerConfig)

        An object that specifies the authorization service for a domain.

        Parameters:
        authorizerConfig - An object that specifies the authorization service for a domain.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • serviceType

        CreateDomainConfigurationRequest.Builder serviceType​(String serviceType)

        The type of service delivered by the endpoint.

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

        Parameters:
        serviceType - The type of service delivered by the endpoint.

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ServiceType, ServiceType

      • serviceType

        CreateDomainConfigurationRequest.Builder serviceType​(ServiceType serviceType)

        The type of service delivered by the endpoint.

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

        Parameters:
        serviceType - The type of service delivered by the endpoint.

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ServiceType, ServiceType

      • tags

        CreateDomainConfigurationRequest.Builder tags​(Collection<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..."

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateDomainConfigurationRequest.Builder tags​(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..."

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateDomainConfigurationRequest.Builder tags​(Consumer<Tag.Builder>... 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..."

        This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

        Parameters:
        tags - a consumer that will call methods on Tag.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #tags(java.util.Collection)

      • tlsConfig

        CreateDomainConfigurationRequest.Builder tlsConfig​(TlsConfig tlsConfig)

        An object that specifies the TLS configuration for a domain.

        Parameters:
        tlsConfig - An object that specifies the TLS configuration for a domain.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • serverCertificateConfig

        CreateDomainConfigurationRequest.Builder serverCertificateConfig​(ServerCertificateConfig serverCertificateConfig)

        The server certificate configuration.

        Parameters:
        serverCertificateConfig - The server certificate configuration.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • authenticationType

        CreateDomainConfigurationRequest.Builder authenticationType​(String 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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AuthenticationType, AuthenticationType

      • authenticationType

        CreateDomainConfigurationRequest.Builder authenticationType​(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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AuthenticationType, AuthenticationType

      • applicationProtocol

        CreateDomainConfigurationRequest.Builder applicationProtocol​(String 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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ApplicationProtocol, ApplicationProtocol

      • applicationProtocol

        CreateDomainConfigurationRequest.Builder applicationProtocol​(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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ApplicationProtocol, ApplicationProtocol

      • clientCertificateConfig

        CreateDomainConfigurationRequest.Builder clientCertificateConfig​(ClientCertificateConfig clientCertificateConfig)

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

        Parameters:
        clientCertificateConfig - An object that specifies the client certificate configuration for a domain.
        Returns:
        Returns a reference to this object so that method calls can be chained together.