Class DnsRecord

java.lang.Object
software.amazon.awssdk.services.servicediscovery.model.DnsRecord
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DnsRecord.Builder,DnsRecord>
@Generated("software.amazon.awssdk:codegen") public final class DnsRecord extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DnsRecord.Builder,DnsRecord>

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

See Also:

  • Method Details

    • type

      public final RecordType type()

      The type of the resource, which indicates the type of value that Route 53 returns in response to DNS queries. You can specify values for Type in the following combinations:

      • A

      • AAAA

      • A and AAAA

      • SRV

      • CNAME

      If you want Cloud Map to create a Route 53 alias record when you register an instance, specify A or AAAA for Type.

      You specify other settings, such as the IP address for A and AAAA records, when you register an instance. For more information, see RegisterInstance.

      The following values are supported:

      A

      Route 53 returns the IP address of the resource in IPv4 format, such as 192.0.2.44.

      AAAA

      Route 53 returns the IP address of the resource in IPv6 format, such as 2001:0db8:85a3:0000:0000:abcd:0001:2345.

      CNAME

      Route 53 returns the domain name of the resource, such as www.example.com. Note the following:

      • You specify the domain name that you want to route traffic to when you register an instance. For more information, see Attributes in the topic RegisterInstance.

      • You must specify WEIGHTED for the value of RoutingPolicy.

      • You can't specify both CNAME for Type and settings for HealthCheckConfig. If you do, the request will fail with an InvalidInput error.

      SRV

      Route 53 returns the value for an SRV record. The value for an SRV record uses the following values:

      priority weight port service-hostname

      Note the following about the values:

      • The values of priority and weight are both set to 1 and can't be changed.

      • The value of port comes from the value that you specify for the AWS_INSTANCE_PORT attribute when you submit a RegisterInstance request.

      • The value of service-hostname is a concatenation of the following values:

        • The value that you specify for InstanceId when you register an instance.

        • The name of the service.

        • The name of the namespace.

        For example, if the value of InstanceId is test, the name of the service is backend, and the name of the namespace is example.com, the value of service-hostname is the following:

        test.backend.example.com

      If you specify settings for an SRV record, note the following:

      • If you specify values for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both in the RegisterInstance request, Cloud Map automatically creates A and/or AAAA records that have the same name as the value of service-hostname in the SRV record. You can ignore these records.

      • If you're using a system that requires a specific SRV format, such as HAProxy, see the Name element in the documentation about CreateService for information about how to specify the correct name format.

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

      Returns:
      The type of the resource, which indicates the type of value that Route 53 returns in response to DNS queries. You can specify values for Type in the following combinations:

      • A

      • AAAA

      • A and AAAA

      • SRV

      • CNAME

      If you want Cloud Map to create a Route 53 alias record when you register an instance, specify A or AAAA for Type.

      You specify other settings, such as the IP address for A and AAAA records, when you register an instance. For more information, see RegisterInstance.

      The following values are supported:

      A

      Route 53 returns the IP address of the resource in IPv4 format, such as 192.0.2.44.

      AAAA

      Route 53 returns the IP address of the resource in IPv6 format, such as 2001:0db8:85a3:0000:0000:abcd:0001:2345.

      CNAME

      Route 53 returns the domain name of the resource, such as www.example.com. Note the following:

      • You specify the domain name that you want to route traffic to when you register an instance. For more information, see Attributes in the topic RegisterInstance.

      • You must specify WEIGHTED for the value of RoutingPolicy.

      • You can't specify both CNAME for Type and settings for HealthCheckConfig. If you do, the request will fail with an InvalidInput error.

      SRV

      Route 53 returns the value for an SRV record. The value for an SRV record uses the following values:

      priority weight port service-hostname

      Note the following about the values:

      • The values of priority and weight are both set to 1 and can't be changed.

      • The value of port comes from the value that you specify for the AWS_INSTANCE_PORT attribute when you submit a RegisterInstance request.

      • The value of service-hostname is a concatenation of the following values:

        • The value that you specify for InstanceId when you register an instance.

        • The name of the service.

        • The name of the namespace.

        For example, if the value of InstanceId is test, the name of the service is backend, and the name of the namespace is example.com, the value of service-hostname is the following:

        test.backend.example.com

      If you specify settings for an SRV record, note the following:

      • If you specify values for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both in the RegisterInstance request, Cloud Map automatically creates A and/or AAAA records that have the same name as the value of service-hostname in the SRV record. You can ignore these records.

      • If you're using a system that requires a specific SRV format, such as HAProxy, see the Name element in the documentation about CreateService for information about how to specify the correct name format.

      See Also:

    • typeAsString

      public final String typeAsString()

      The type of the resource, which indicates the type of value that Route 53 returns in response to DNS queries. You can specify values for Type in the following combinations:

      • A

      • AAAA

      • A and AAAA

      • SRV

      • CNAME

      If you want Cloud Map to create a Route 53 alias record when you register an instance, specify A or AAAA for Type.

      You specify other settings, such as the IP address for A and AAAA records, when you register an instance. For more information, see RegisterInstance.

      The following values are supported:

      A

      Route 53 returns the IP address of the resource in IPv4 format, such as 192.0.2.44.

      AAAA

      Route 53 returns the IP address of the resource in IPv6 format, such as 2001:0db8:85a3:0000:0000:abcd:0001:2345.

      CNAME

      Route 53 returns the domain name of the resource, such as www.example.com. Note the following:

      • You specify the domain name that you want to route traffic to when you register an instance. For more information, see Attributes in the topic RegisterInstance.

      • You must specify WEIGHTED for the value of RoutingPolicy.

      • You can't specify both CNAME for Type and settings for HealthCheckConfig. If you do, the request will fail with an InvalidInput error.

      SRV

      Route 53 returns the value for an SRV record. The value for an SRV record uses the following values:

      priority weight port service-hostname

      Note the following about the values:

      • The values of priority and weight are both set to 1 and can't be changed.

      • The value of port comes from the value that you specify for the AWS_INSTANCE_PORT attribute when you submit a RegisterInstance request.

      • The value of service-hostname is a concatenation of the following values:

        • The value that you specify for InstanceId when you register an instance.

        • The name of the service.

        • The name of the namespace.

        For example, if the value of InstanceId is test, the name of the service is backend, and the name of the namespace is example.com, the value of service-hostname is the following:

        test.backend.example.com

      If you specify settings for an SRV record, note the following:

      • If you specify values for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both in the RegisterInstance request, Cloud Map automatically creates A and/or AAAA records that have the same name as the value of service-hostname in the SRV record. You can ignore these records.

      • If you're using a system that requires a specific SRV format, such as HAProxy, see the Name element in the documentation about CreateService for information about how to specify the correct name format.

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

      Returns:
      The type of the resource, which indicates the type of value that Route 53 returns in response to DNS queries. You can specify values for Type in the following combinations:

      • A

      • AAAA

      • A and AAAA

      • SRV

      • CNAME

      If you want Cloud Map to create a Route 53 alias record when you register an instance, specify A or AAAA for Type.

      You specify other settings, such as the IP address for A and AAAA records, when you register an instance. For more information, see RegisterInstance.

      The following values are supported:

      A

      Route 53 returns the IP address of the resource in IPv4 format, such as 192.0.2.44.

      AAAA

      Route 53 returns the IP address of the resource in IPv6 format, such as 2001:0db8:85a3:0000:0000:abcd:0001:2345.

      CNAME

      Route 53 returns the domain name of the resource, such as www.example.com. Note the following:

      • You specify the domain name that you want to route traffic to when you register an instance. For more information, see Attributes in the topic RegisterInstance.

      • You must specify WEIGHTED for the value of RoutingPolicy.

      • You can't specify both CNAME for Type and settings for HealthCheckConfig. If you do, the request will fail with an InvalidInput error.

      SRV

      Route 53 returns the value for an SRV record. The value for an SRV record uses the following values:

      priority weight port service-hostname

      Note the following about the values:

      • The values of priority and weight are both set to 1 and can't be changed.

      • The value of port comes from the value that you specify for the AWS_INSTANCE_PORT attribute when you submit a RegisterInstance request.

      • The value of service-hostname is a concatenation of the following values:

        • The value that you specify for InstanceId when you register an instance.

        • The name of the service.

        • The name of the namespace.

        For example, if the value of InstanceId is test, the name of the service is backend, and the name of the namespace is example.com, the value of service-hostname is the following:

        test.backend.example.com

      If you specify settings for an SRV record, note the following:

      • If you specify values for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both in the RegisterInstance request, Cloud Map automatically creates A and/or AAAA records that have the same name as the value of service-hostname in the SRV record. You can ignore these records.

      • If you're using a system that requires a specific SRV format, such as HAProxy, see the Name element in the documentation about CreateService for information about how to specify the correct name format.

      See Also:

    • ttl

      public final Long ttl()

      The amount of time, in seconds, that you want DNS resolvers to cache the settings for this record.

      Alias records don't include a TTL because Route 53 uses the TTL for the Amazon Web Services resource that an alias record routes traffic to. If you include the AWS_ALIAS_DNS_NAME attribute when you submit a RegisterInstance request, the TTL value is ignored. Always specify a TTL for the service; you can use a service to register instances that create either alias or non-alias records.

      Returns:
      The amount of time, in seconds, that you want DNS resolvers to cache the settings for this record.

      Alias records don't include a TTL because Route 53 uses the TTL for the Amazon Web Services resource that an alias record routes traffic to. If you include the AWS_ALIAS_DNS_NAME attribute when you submit a RegisterInstance request, the TTL value is ignored. Always specify a TTL for the service; you can use a service to register instances that create either alias or non-alias records.

    • toBuilder

      public DnsRecord.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<DnsRecord.Builder,DnsRecord>
      Returns:
      a builder for type T

    • builder

      public static DnsRecord.Builder builder()

    • serializableBuilderClass

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

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.