Class UpdateDomainNameResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UpdateDomainNameResponse.Builder,
UpdateDomainNameResponse>
Represents a custom domain name as a user-friendly host name of an API (RestApi).
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The reference to an Amazon Web Services-managed certificate that will be used by edge-optimized endpoint for this domain name.final String
The name of the certificate that will be used by 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 String
The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint.final String
The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint.final String
The custom domain name as an API host name, for example,my-api.example.com
.final DomainNameStatus
The status of the DomainName migration.final String
The status of the DomainName migration.final String
An optional text message containing detailed information about status of the DomainName migration.final EndpointConfiguration
The endpoint configuration of this DomainName showing the endpoint types of the domain name.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) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final MutualTlsAuthentication
The mutual TLS authentication configuration for a custom domain name.final String
The ARN of the public certificate issued by ACM to validate ownership of your custom domain.final String
The reference to an Amazon Web Services-managed certificate that will be used for validating the regional domain name.final String
The name of the certificate that will be used for validating the regional domain name.final String
The domain name associated with the regional endpoint for this custom domain name.final String
The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint.final SecurityPolicy
The Transport Layer Security (TLS) version + cipher suite for this DomainName.final String
The Transport Layer Security (TLS) version + cipher suite for this DomainName.static Class
<? extends UpdateDomainNameResponse.Builder> tags()
The collection of tags.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 class software.amazon.awssdk.services.apigateway.model.ApiGatewayResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
domainName
The custom domain name as an API host name, for example,
my-api.example.com
.- Returns:
- The custom domain name as an API host name, for example,
my-api.example.com
.
-
certificateName
The name of the certificate that will be used by edge-optimized endpoint for this domain name.
- Returns:
- The name of the certificate that will be used by edge-optimized endpoint for this domain name.
-
certificateArn
The reference to an Amazon Web Services-managed certificate that will be used by edge-optimized endpoint for this domain name. Certificate Manager is the only supported source.
- Returns:
- The reference to an Amazon Web Services-managed certificate that will be used by edge-optimized endpoint for this domain name. Certificate Manager is the only supported source.
-
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.
-
regionalDomainName
The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.
- Returns:
- The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.
-
regionalHostedZoneId
The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.
- Returns:
- The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.
-
regionalCertificateName
The name of the certificate that will be used for validating the regional domain name.
- Returns:
- The name of the certificate that will be used for validating the regional domain name.
-
regionalCertificateArn
The reference to an Amazon Web Services-managed certificate that will be used for validating the regional domain name. Certificate Manager is the only supported source.
- Returns:
- The reference to an Amazon Web Services-managed certificate that will be used for validating the regional domain name. Certificate Manager is the only supported source.
-
distributionDomainName
The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.
- Returns:
- The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.
-
distributionHostedZoneId
The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is
Z2FDTNDATAQYW2
for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.- Returns:
- The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is
Z2FDTNDATAQYW2
for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.
-
endpointConfiguration
The endpoint configuration of this DomainName showing the endpoint types of the domain name.
- Returns:
- The endpoint configuration of this DomainName showing the endpoint types of the domain name.
-
domainNameStatus
The status of the DomainName migration. The valid values are
AVAILABLE
andUPDATING
. If the status isUPDATING
, the domain cannot be modified further until the existing operation is complete. If it isAVAILABLE
, 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 DomainName migration. The valid values are
AVAILABLE
andUPDATING
. If the status isUPDATING
, the domain cannot be modified further until the existing operation is complete. If it isAVAILABLE
, the domain can be updated. - See Also:
-
domainNameStatusAsString
The status of the DomainName migration. The valid values are
AVAILABLE
andUPDATING
. If the status isUPDATING
, the domain cannot be modified further until the existing operation is complete. If it isAVAILABLE
, 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 DomainName migration. The valid values are
AVAILABLE
andUPDATING
. If the status isUPDATING
, the domain cannot be modified further until the existing operation is complete. If it isAVAILABLE
, the domain can be updated. - See Also:
-
domainNameStatusMessage
An optional text message containing detailed information about status of the DomainName migration.
- Returns:
- An optional text message containing detailed information about status of the DomainName migration.
-
securityPolicy
The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are
TLS_1_0
andTLS_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 + cipher suite for this DomainName. The valid values are
TLS_1_0
andTLS_1_2
. - See Also:
-
securityPolicyAsString
The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are
TLS_1_0
andTLS_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 + cipher suite for this DomainName. The valid values are
TLS_1_0
andTLS_1_2
. - See Also:
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
tags
The collection of tags. Each tag element is associated with a given resource.
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
hasTags()
method.- Returns:
- The collection of tags. Each tag element is associated with a given resource.
-
mutualTlsAuthentication
The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.
- Returns:
- The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.
-
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<UpdateDomainNameResponse.Builder,
UpdateDomainNameResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
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
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-