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

Class UpdateDomainConfigurationRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateDomainConfigurationRequest.Builder,UpdateDomainConfigurationRequest>

@Generated("software.amazon.awssdk:codegen")
public final class UpdateDomainConfigurationRequest
extends IotRequest
implements ToCopyableBuilder<UpdateDomainConfigurationRequest.Builder,UpdateDomainConfigurationRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateDomainConfigurationRequest.Builder

Method Summary

Modifier and Type	Method	Description
ApplicationProtocol	applicationProtocol()	An enumerated string that specifies the application-layer protocol.
String	applicationProtocolAsString()	An enumerated string that specifies the application-layer protocol.
AuthenticationType	authenticationType()	An enumerated string that specifies the authentication type.
String	authenticationTypeAsString()	An enumerated string that specifies the authentication type.
AuthorizerConfig	authorizerConfig()	An object that specifies the authorization service for a domain.
static UpdateDomainConfigurationRequest.Builder	builder()
ClientCertificateConfig	clientCertificateConfig()	An object that specifies the client certificate configuration for a domain.
String	domainConfigurationName()	The name of the domain configuration to be updated.
DomainConfigurationStatus	domainConfigurationStatus()	The status to which the domain configuration should be updated.
String	domainConfigurationStatusAsString()	The status to which the domain configuration should be updated.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	removeAuthorizerConfig()	Removes the authorization configuration from a domain.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateDomainConfigurationRequest.Builder>	serializableBuilderClass()
ServerCertificateConfig	serverCertificateConfig()	The server certificate configuration.
TlsConfig	tlsConfig()	An object that specifies the TLS configuration for a domain.
UpdateDomainConfigurationRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

domainConfigurationName

public final String domainConfigurationName()

The name of the domain configuration to be updated.

Returns:

The name of the domain configuration to be updated.

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.

domainConfigurationStatus

public final DomainConfigurationStatus domainConfigurationStatus()

The status to which the domain configuration should be updated.

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

Returns:

The status to which the domain configuration should be updated.

See Also:

DomainConfigurationStatus

domainConfigurationStatusAsString

public final String domainConfigurationStatusAsString()

The status to which the domain configuration should be updated.

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

Returns:

The status to which the domain configuration should be updated.

See Also:

DomainConfigurationStatus

removeAuthorizerConfig

public final Boolean removeAuthorizerConfig()

Removes the authorization configuration from a domain.

Returns:

Removes the authorization configuration from a domain.

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.

• CUSTOM_AUTH - Use custom authentication and authorization. For more information, see Custom authentication and authorization.

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

• AWS_SIGV4 - Use Amazon Web Services Signature Version 4. For more information, see IAM users, groups, and roles.

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

• CUSTOM_AUTH - Use custom authentication and authorization. For more information, see Custom authentication and authorization.

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

• AWS_SIGV4 - Use Amazon Web Services Signature Version 4. For more information, see IAM users, groups, and roles.

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

AuthenticationType

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.

• CUSTOM_AUTH - Use custom authentication and authorization. For more information, see Custom authentication and authorization.

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

• AWS_SIGV4 - Use Amazon Web Services Signature Version 4. For more information, see IAM users, groups, and roles.

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

• CUSTOM_AUTH - Use custom authentication and authorization. For more information, see Custom authentication and authorization.

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

• AWS_SIGV4 - Use Amazon Web Services Signature Version 4. For more information, see IAM users, groups, and roles.

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

AuthenticationType

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:

ApplicationProtocol

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:

ApplicationProtocol

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 UpdateDomainConfigurationRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateDomainConfigurationRequest.Builder,UpdateDomainConfigurationRequest>

Specified by:

toBuilder in class IotRequest

builder

public static UpdateDomainConfigurationRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateDomainConfigurationRequest.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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo