Class DnsOptionsSpecification

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

Describes the DNS options for an endpoint.

See Also:

  • Method Details

    • dnsRecordIpType

      public final DnsRecordIpType dnsRecordIpType()

      The DNS records created for the endpoint.

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

      Returns:
      The DNS records created for the endpoint.
      See Also:

    • dnsRecordIpTypeAsString

      public final String dnsRecordIpTypeAsString()

      The DNS records created for the endpoint.

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

      Returns:
      The DNS records created for the endpoint.
      See Also:

    • privateDnsOnlyForInboundResolverEndpoint

      public final Boolean privateDnsOnlyForInboundResolverEndpoint()

      Indicates whether to enable private DNS only for inbound endpoints. This option is available only for services that support both gateway and interface endpoints. It routes traffic that originates from the VPC to the gateway endpoint and traffic that originates from on-premises to the interface endpoint.

      Returns:
      Indicates whether to enable private DNS only for inbound endpoints. This option is available only for services that support both gateway and interface endpoints. It routes traffic that originates from the VPC to the gateway endpoint and traffic that originates from on-premises to the interface endpoint.

    • privateDnsPreference

      public final String privateDnsPreference()

      The preference for which private domains have a private hosted zone created for and associated with the specified VPC. Only supported when private DNS is enabled and when the VPC endpoint type is ServiceNetwork or Resource.

      • ALL_DOMAINS - VPC Lattice provisions private hosted zones for all custom domain names.

      • VERIFIED_DOMAINS_ONLY - VPC Lattice provisions a private hosted zone only if custom domain name has been verified by the provider.

      • VERIFIED_DOMAINS_AND_SPECIFIED_DOMAINS - VPC Lattice provisions private hosted zones for all verified custom domain names and other domain names that the resource consumer specifies. The resource consumer specifies the domain names in the PrivateDnsSpecifiedDomains parameter.

      • SPECIFIED_DOMAINS_ONLY - VPC Lattice provisions a private hosted zone for domain names specified by the resource consumer. The resource consumer specifies the domain names in the PrivateDnsSpecifiedDomains parameter.

      Returns:
      The preference for which private domains have a private hosted zone created for and associated with the specified VPC. Only supported when private DNS is enabled and when the VPC endpoint type is ServiceNetwork or Resource.

      • ALL_DOMAINS - VPC Lattice provisions private hosted zones for all custom domain names.

      • VERIFIED_DOMAINS_ONLY - VPC Lattice provisions a private hosted zone only if custom domain name has been verified by the provider.

      • VERIFIED_DOMAINS_AND_SPECIFIED_DOMAINS - VPC Lattice provisions private hosted zones for all verified custom domain names and other domain names that the resource consumer specifies. The resource consumer specifies the domain names in the PrivateDnsSpecifiedDomains parameter.

      • SPECIFIED_DOMAINS_ONLY - VPC Lattice provisions a private hosted zone for domain names specified by the resource consumer. The resource consumer specifies the domain names in the PrivateDnsSpecifiedDomains parameter.

    • hasPrivateDnsSpecifiedDomains

      public final boolean hasPrivateDnsSpecifiedDomains()
      For responses, this returns true if the service returned a value for the PrivateDnsSpecifiedDomains 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.

    • privateDnsSpecifiedDomains

      public final List<String> privateDnsSpecifiedDomains()

      Indicates which of the private domains to create private hosted zones for and associate with the specified VPC. Only supported when private DNS is enabled and the private DNS preference is verified-domains-and-specified-domains or specified-domains-only.

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

      Returns:
      Indicates which of the private domains to create private hosted zones for and associate with the specified VPC. Only supported when private DNS is enabled and the private DNS preference is verified-domains-and-specified-domains or specified-domains-only.

    • toBuilder

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

    • builder

      public static DnsOptionsSpecification.Builder builder()

    • serializableBuilderClass

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