software.amazon.awssdk.services.iot.model

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(value="software.amazon.awssdk:codegen")
public final class CreateDomainConfigurationRequest
extends IotRequest
implements ToCopyableBuilder<CreateDomainConfigurationRequest.Builder,CreateDomainConfigurationRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateDomainConfigurationRequest.Builder

Method Summary

Modifier and Type	Method and Description
AuthorizerConfig	authorizerConfig() An object that specifies the authorization service for a domain.
static CreateDomainConfigurationRequest.Builder	builder()
String	domainConfigurationName() The name of the domain configuration.
String	domainName() The name of the domain.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasServerCertificateArns() Returns true if the ServerCertificateArns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
List<SdkField<?>>	sdkFields()
static Class<? extends CreateDomainConfigurationRequest.Builder>	serializableBuilderClass()
List<String>	serverCertificateArns() The ARNs of the certificates that AWS IoT passes to the device during the TLS handshake.
ServiceType	serviceType() The type of service delivered by the endpoint.
String	serviceTypeAsString() The type of service delivered by the endpoint.
List<Tag>	tags() Metadata which can be used to manage the domain configuration.
CreateDomainConfigurationRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	validationCertificateArn() The certificate used to validate the server certificate and prove domain name ownership.

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. 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()

Returns true if the ServerCertificateArns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

serverCertificateArns

public final List<String> serverCertificateArns()

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.

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

You can use hasServerCertificateArns() to see if a value was sent in this field.

Returns:

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.

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

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

AWS IoT Core currently supports only the DATA service type.

See Also:

ServiceType

serviceTypeAsString

public final String serviceTypeAsString()

The type of service delivered by the endpoint.

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

AWS IoT Core currently supports only the DATA service type.

See Also:

ServiceType

hasTags

public final boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasTags() to see if a value was sent in this field.

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

toBuilder

public CreateDomainConfigurationRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateDomainConfigurationRequest.Builder,CreateDomainConfigurationRequest>

Specified by:

toBuilder in class IotRequest

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)

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