Class DomainNameConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<DomainNameConfiguration.Builder,
DomainNameConfiguration>
The domain name configuration.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
A domain name for the API.builder()
final String
An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name.final String
The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.final Instant
The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.final DomainNameStatus
The status of the domain name migration.final String
The status of the domain name migration.final String
An optional text message containing detailed information about status of the domain name migration.final EndpointType
The endpoint type.final String
The endpoint type.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
The Amazon Route 53 Hosted Zone ID of the endpoint.final String
The ARN of the public certificate issued by ACM to validate ownership of your custom domain.final SecurityPolicy
The Transport Layer Security (TLS) version of the security policy for this domain name.final String
The Transport Layer Security (TLS) version of the security policy for this domain name.static Class
<? extends DomainNameConfiguration.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
apiGatewayDomainName
A domain name for the API.
- Returns:
- A domain name for the API.
-
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
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
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
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 returnDomainNameStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdomainNameStatusAsString()
.- 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
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 returnDomainNameStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdomainNameStatusAsString()
.- 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
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
The endpoint type.
If the service returns an enum value that is not available in the current SDK version,
endpointType
will returnEndpointType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromendpointTypeAsString()
.- Returns:
- The endpoint type.
- See Also:
-
endpointTypeAsString
The endpoint type.
If the service returns an enum value that is not available in the current SDK version,
endpointType
will returnEndpointType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromendpointTypeAsString()
.- Returns:
- The endpoint type.
- See Also:
-
hostedZoneId
The Amazon Route 53 Hosted Zone ID of the endpoint.
- Returns:
- The Amazon Route 53 Hosted Zone ID of the endpoint.
-
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 returnSecurityPolicy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsecurityPolicyAsString()
.- 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
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 returnSecurityPolicy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsecurityPolicyAsString()
.- 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
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
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 interfaceToCopyableBuilder<DomainNameConfiguration.Builder,
DomainNameConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-