Class DomainNameConfiguration

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

The domain name configuration.

See Also:

  • Method Details

    • apiGatewayDomainName

      public final String apiGatewayDomainName()

      A domain name for the API.

      Returns:
      A domain name for the API.

    • certificateArn

      public final String certificateArn()

      An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

      Returns:
      An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

    • certificateName

      public final String certificateName()

      The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.

      Returns:
      The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.

    • certificateUploadDate

      public final Instant certificateUploadDate()

      The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

      Returns:
      The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

    • domainNameStatus

      public final DomainNameStatus domainNameStatus()

      The status of the domain name migration. The valid values are AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.

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

      Returns:
      The status of the domain name migration. The valid values are AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.
      See Also:

    • domainNameStatusAsString

      public final String domainNameStatusAsString()

      The status of the domain name migration. The valid values are AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.

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

      Returns:
      The status of the domain name migration. The valid values are AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.
      See Also:

    • domainNameStatusMessage

      public final String domainNameStatusMessage()

      An optional text message containing detailed information about status of the domain name migration.

      Returns:
      An optional text message containing detailed information about status of the domain name migration.

    • endpointType

      public final EndpointType endpointType()

      The endpoint type.

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

      Returns:
      The endpoint type.
      See Also:

    • endpointTypeAsString

      public final String endpointTypeAsString()

      The endpoint type.

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

      Returns:
      The endpoint type.
      See Also:

    • hostedZoneId

      public final String hostedZoneId()

      The Amazon Route 53 Hosted Zone ID of the endpoint.

      Returns:
      The Amazon Route 53 Hosted Zone ID of the endpoint.

    • securityPolicy

      public final SecurityPolicy securityPolicy()

      The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.

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

      Returns:
      The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.
      See Also:

    • securityPolicyAsString

      public final String securityPolicyAsString()

      The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.

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

      Returns:
      The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.
      See Also:

    • ownershipVerificationCertificateArn

      public final String ownershipVerificationCertificateArn()

      The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn

      Returns:
      The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn

    • toBuilder

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

    • builder

      public static DomainNameConfiguration.Builder builder()

    • serializableBuilderClass

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