@Generated(value="software.amazon.awssdk:codegen") public final class DomainName extends Object implements StructuredPojo, ToCopyableBuilder<DomainName.Builder,DomainName>
Represents a custom domain name as a user-friendly host name of an API (RestApi).
When you deploy an API, Amazon API Gateway creates a default host name for the API. This default API host name is of
the {restapi-id}.execute-api.{region}.amazonaws.com
format. With the default host name, you can access
the API's root resource with the URL of https://{restapi-id}.execute-api.{region}.amazonaws.com/{stage}/
. When you set up a custom domain name of apis.example.com
for this API, you can then access the same
resource using the URL of the https://apis.examples.com/myApi
, where myApi
is the base path
mapping (BasePathMapping) of your API under the custom domain name.
Modifier and Type | Class and Description |
---|---|
static interface |
DomainName.Builder |
Modifier and Type | Method and Description |
---|---|
static DomainName.Builder |
builder() |
String |
certificateArn()
The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name.
|
String |
certificateName()
The name of the certificate that will be used by edge-optimized endpoint for this domain name.
|
Instant |
certificateUploadDate()
The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
|
String |
distributionDomainName()
The domain name of the Amazon CloudFront distribution associated with this custom domain name for an
edge-optimized endpoint.
|
String |
distributionHostedZoneId()
The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint.
|
String |
domainName()
The name of the DomainName resource.
|
EndpointConfiguration |
endpointConfiguration()
The endpoint configuration of this DomainName showing the endpoint types of the domain name.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
String |
regionalCertificateArn()
The reference to an AWS-managed certificate that will be used for validating the regional domain name.
|
String |
regionalCertificateName()
The name of the certificate that will be used for validating the regional domain name.
|
String |
regionalDomainName()
The domain name associated with the regional endpoint for this custom domain name.
|
String |
regionalHostedZoneId()
The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint.
|
static Class<? extends DomainName.Builder> |
serializableBuilderClass() |
DomainName.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
copy
public String domainName()
The name of the DomainName resource.
public String certificateName()
The name of the certificate that will be used by edge-optimized endpoint for this domain name.
public String certificateArn()
The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.
public Instant certificateUploadDate()
The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
public String 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 Amazon API Gateway when you create a regional endpoint.
public String 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.
public String regionalCertificateName()
The name of the certificate that will be used for validating the regional domain name.
public String regionalCertificateArn()
The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.
public String 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.
public String 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.
Z2FDTNDATAQYW2
for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and
Endpoints for API Gateway.public EndpointConfiguration endpointConfiguration()
The endpoint configuration of this DomainName showing the endpoint types of the domain name.
public DomainName.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DomainName.Builder,DomainName>
public static DomainName.Builder builder()
public static Class<? extends DomainName.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.