You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::APIGateway::Types::DomainName

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Represents a custom domain name as a user-friendly host name of an API (RestApi).

When you deploy an API, 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.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#certificate_arnString

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.

Returns:

  • (String)

    The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name.

#certificate_nameString

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

Returns:

  • (String)

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

#certificate_upload_dateTime

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

Returns:

  • (Time)

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

#distribution_domain_nameString

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 documentationtarget="_blank".

Returns:

  • (String)

    The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint.

#distribution_hosted_zone_idString

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:

  • (String)

    The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint.

#domain_nameString

The name of the DomainName resource.

Returns:

  • (String)

    The name of the DomainName resource.

#endpoint_configurationTypes::EndpointConfiguration

The endpoint configuration of this DomainName showing the endpoint types of the domain name.

Returns:

#regional_certificate_arnString

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.

Returns:

  • (String)

    The reference to an AWS-managed certificate that will be used for validating the regional domain name.

#regional_certificate_nameString

The name of the certificate that will be used for validating the regional domain name.

Returns:

  • (String)

    The name of the certificate that will be used for validating the regional domain name.

#regional_domain_nameString

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:

  • (String)

    The domain name associated with the regional endpoint for this custom domain name.

#regional_hosted_zone_idString

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:

  • (String)

    The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint.