software.amazon.awssdk.services.servicediscovery.model

Class DnsConfig

java.lang.Object

software.amazon.awssdk.services.servicediscovery.model.DnsConfig

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DnsConfig.Builder,DnsConfig>

@Generated(value="software.amazon.awssdk:codegen")
public final class DnsConfig
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DnsConfig.Builder,DnsConfig>

A complex type that contains information about the Amazon Route 53 DNS records that you want Cloud Map to create when you register an instance.

The record types of a service can only be changed by deleting the service and recreating it with a new Dnsconfig.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DnsConfig.Builder

Method Summary

Modifier and Type	Method and Description
static DnsConfig.Builder	builder()
List<DnsRecord>	dnsRecords() An array that contains one DnsRecord object for each Route 53 DNS record that you want Cloud Map to create when you register an instance.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDnsRecords() For responses, this returns true if the service returned a value for the DnsRecords property.
int	hashCode()
String	namespaceId() Deprecated. Top level attribute in request should be used to reference namespace-id
RoutingPolicy	routingPolicy() The routing policy that you want to apply to all Route 53 DNS records that Cloud Map creates when you register an instance and specify this service.
String	routingPolicyAsString() The routing policy that you want to apply to all Route 53 DNS records that Cloud Map creates when you register an instance and specify this service.
List<SdkField<?>>	sdkFields()
static Class<? extends DnsConfig.Builder>	serializableBuilderClass()
DnsConfig.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

namespaceId

@Deprecated
public final String namespaceId()

Deprecated. Top level attribute in request should be used to reference namespace-id

Use NamespaceId in Service instead.

The ID of the namespace to use for DNS configuration.

Returns:

Use NamespaceId in Service instead.

The ID of the namespace to use for DNS configuration.

routingPolicy

public final RoutingPolicy routingPolicy()

The routing policy that you want to apply to all Route 53 DNS records that Cloud Map creates when you register an instance and specify this service.

If you want to use this service to register instances that create alias records, specify WEIGHTED for the routing policy.

You can specify the following values:

MULTIVALUE

If you define a health check for the service and the health check is healthy, Route 53 returns the applicable value for up to eight instances.

For example, suppose that the service includes configurations for one A record and a health check. You use the service to register 10 instances. Route 53 responds to DNS queries with IP addresses for up to eight healthy instances. If fewer than eight instances are healthy, Route 53 responds to every DNS query with the IP addresses for all of the healthy instances.

If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the values for up to eight instances.

For more information about the multivalue routing policy, see Multivalue Answer Routing in the Route 53 Developer Guide.

WEIGHTED

Route 53 returns the applicable value from one randomly selected instance from among the instances that you registered using the same service. Currently, all records have the same weight, so you can't route more or less traffic to any instances.

For example, suppose that the service includes configurations for one A record and a health check. You use the service to register 10 instances. Route 53 responds to DNS queries with the IP address for one randomly selected instance from among the healthy instances. If no instances are healthy, Route 53 responds to DNS queries as if all of the instances were healthy.

If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the applicable value for one randomly selected instance.

For more information about the weighted routing policy, see Weighted Routing in the Route 53 Developer Guide.

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

Returns:

The routing policy that you want to apply to all Route 53 DNS records that Cloud Map creates when you register an instance and specify this service.

If you want to use this service to register instances that create alias records, specify WEIGHTED for the routing policy.

You can specify the following values:

MULTIVALUE

If you define a health check for the service and the health check is healthy, Route 53 returns the applicable value for up to eight instances.

For example, suppose that the service includes configurations for one A record and a health check. You use the service to register 10 instances. Route 53 responds to DNS queries with IP addresses for up to eight healthy instances. If fewer than eight instances are healthy, Route 53 responds to every DNS query with the IP addresses for all of the healthy instances.

If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the values for up to eight instances.

For more information about the multivalue routing policy, see Multivalue Answer Routing in the Route 53 Developer Guide.

WEIGHTED

Route 53 returns the applicable value from one randomly selected instance from among the instances that you registered using the same service. Currently, all records have the same weight, so you can't route more or less traffic to any instances.

For example, suppose that the service includes configurations for one A record and a health check. You use the service to register 10 instances. Route 53 responds to DNS queries with the IP address for one randomly selected instance from among the healthy instances. If no instances are healthy, Route 53 responds to DNS queries as if all of the instances were healthy.

If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the applicable value for one randomly selected instance.

For more information about the weighted routing policy, see Weighted Routing in the Route 53 Developer Guide.

See Also:

RoutingPolicy

routingPolicyAsString

public final String routingPolicyAsString()

The routing policy that you want to apply to all Route 53 DNS records that Cloud Map creates when you register an instance and specify this service.

If you want to use this service to register instances that create alias records, specify WEIGHTED for the routing policy.

You can specify the following values:

MULTIVALUE

If you define a health check for the service and the health check is healthy, Route 53 returns the applicable value for up to eight instances.

For example, suppose that the service includes configurations for one A record and a health check. You use the service to register 10 instances. Route 53 responds to DNS queries with IP addresses for up to eight healthy instances. If fewer than eight instances are healthy, Route 53 responds to every DNS query with the IP addresses for all of the healthy instances.

If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the values for up to eight instances.

For more information about the multivalue routing policy, see Multivalue Answer Routing in the Route 53 Developer Guide.

WEIGHTED

Route 53 returns the applicable value from one randomly selected instance from among the instances that you registered using the same service. Currently, all records have the same weight, so you can't route more or less traffic to any instances.

For example, suppose that the service includes configurations for one A record and a health check. You use the service to register 10 instances. Route 53 responds to DNS queries with the IP address for one randomly selected instance from among the healthy instances. If no instances are healthy, Route 53 responds to DNS queries as if all of the instances were healthy.

If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the applicable value for one randomly selected instance.

For more information about the weighted routing policy, see Weighted Routing in the Route 53 Developer Guide.

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

Returns:

The routing policy that you want to apply to all Route 53 DNS records that Cloud Map creates when you register an instance and specify this service.

If you want to use this service to register instances that create alias records, specify WEIGHTED for the routing policy.

You can specify the following values:

MULTIVALUE

If you define a health check for the service and the health check is healthy, Route 53 returns the applicable value for up to eight instances.

For example, suppose that the service includes configurations for one A record and a health check. You use the service to register 10 instances. Route 53 responds to DNS queries with IP addresses for up to eight healthy instances. If fewer than eight instances are healthy, Route 53 responds to every DNS query with the IP addresses for all of the healthy instances.

If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the values for up to eight instances.

For more information about the multivalue routing policy, see Multivalue Answer Routing in the Route 53 Developer Guide.

WEIGHTED

Route 53 returns the applicable value from one randomly selected instance from among the instances that you registered using the same service. Currently, all records have the same weight, so you can't route more or less traffic to any instances.

For example, suppose that the service includes configurations for one A record and a health check. You use the service to register 10 instances. Route 53 responds to DNS queries with the IP address for one randomly selected instance from among the healthy instances. If no instances are healthy, Route 53 responds to DNS queries as if all of the instances were healthy.

If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the applicable value for one randomly selected instance.

For more information about the weighted routing policy, see Weighted Routing in the Route 53 Developer Guide.

See Also:

RoutingPolicy

hasDnsRecords

public final boolean hasDnsRecords()

For responses, this returns true if the service returned a value for the DnsRecords 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.

dnsRecords

public final List<DnsRecord> dnsRecords()

An array that contains one DnsRecord object for each Route 53 DNS record that you want Cloud Map to create when you register an instance.

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

Returns:

An array that contains one DnsRecord object for each Route 53 DNS record that you want Cloud Map to create when you register an instance.

toBuilder

public DnsConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DnsConfig.Builder,DnsConfig>

builder

public static DnsConfig.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo