class Aws::APIGateway::Types::DomainName
Represents a custom domain name as a user-friendly host name of an API (RestApi
).
<div class=“Remarks” markdown=“1”> 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 `{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 `apis.examples.com/myApi`, where `myApi` is the base path mapping (BasePathMapping
) of your API under the custom domain name.
</div>
<div class=“seeAlso” markdown=“1”>
- Set a Custom Host Name for an API][1
-
</div>
[1]: docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html
@!attribute [rw] domain_name
The custom domain name as an API host name, for example, `my-api.example.com`. @return [String]
@!attribute [rw] certificate_name
The name of the certificate that will be used by edge-optimized endpoint for this domain name. @return [String]
@!attribute [rw] certificate_arn
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. @return [String]
@!attribute [rw] certificate_upload_date
The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded. @return [Time]
@!attribute [rw] regional_domain_name
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. @return [String]
@!attribute [rw] regional_hosted_zone_id
The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see [Set up a Regional Custom Domain Name][1] and [AWS Regions and Endpoints for API Gateway][2]. [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html [2]: https://docs.aws.amazon.com/general/latest/gr/rande.html#apigateway_region @return [String]
@!attribute [rw] regional_certificate_name
The name of the certificate that will be used for validating the regional domain name. @return [String]
@!attribute [rw] regional_certificate_arn
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. @return [String]
@!attribute [rw] distribution_domain_name
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][1]. [1]: https://aws.amazon.com/documentation/cloudfront/ @return [String]
@!attribute [rw] distribution_hosted_zone_id
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][1] and [AWS Regions and Endpoints for API Gateway][2]. [1]: https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html [2]: https://docs.aws.amazon.com/general/latest/gr/rande.html#apigateway_region @return [String]
@!attribute [rw] endpoint_configuration
The endpoint configuration of this DomainName showing the endpoint types of the domain name. @return [Types::EndpointConfiguration]
@!attribute [rw] domain_name_status
The status of the DomainName 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. @return [String]
@!attribute [rw] domain_name_status_message
An optional text message containing detailed information about status of the DomainName migration. @return [String]
@!attribute [rw] security_policy
The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are `TLS_1_0` and `TLS_1_2`. @return [String]
@!attribute [rw] tags
The collection of tags. Each tag element is associated with a given resource. @return [Hash<String,String>]
@!attribute [rw] mutual_tls_authentication
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. @return [Types::MutualTlsAuthentication]
@!attribute [rw] ownership_verification_certificate_arn
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. @return [String]
Constants
- SENSITIVE