Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Changes information about the DomainName
resource.
Synopsis
- updateDomainName :: Text -> UpdateDomainName
- data UpdateDomainName
- udnPatchOperations :: Lens' UpdateDomainName [PatchOperation]
- udnDomainName :: Lens' UpdateDomainName Text
- domainName :: DomainName
- data DomainName
- dnRegionalHostedZoneId :: Lens' DomainName (Maybe Text)
- dnCertificateName :: Lens' DomainName (Maybe Text)
- dnRegionalCertificateARN :: Lens' DomainName (Maybe Text)
- dnCertificateARN :: Lens' DomainName (Maybe Text)
- dnDistributionHostedZoneId :: Lens' DomainName (Maybe Text)
- dnDomainName :: Lens' DomainName (Maybe Text)
- dnRegionalCertificateName :: Lens' DomainName (Maybe Text)
- dnRegionalDomainName :: Lens' DomainName (Maybe Text)
- dnCertificateUploadDate :: Lens' DomainName (Maybe UTCTime)
- dnDistributionDomainName :: Lens' DomainName (Maybe Text)
- dnEndpointConfiguration :: Lens' DomainName (Maybe EndpointConfiguration)
Creating a Request
Creates a value of UpdateDomainName
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
udnPatchOperations
- A list of update operations to be applied to the specified resource and in the order specified in this list.udnDomainName
- [Required] The name of theDomainName
resource to be changed.
data UpdateDomainName Source #
A request to change information about the DomainName
resource.
See: updateDomainName
smart constructor.
Instances
Request Lenses
udnPatchOperations :: Lens' UpdateDomainName [PatchOperation] Source #
A list of update operations to be applied to the specified resource and in the order specified in this list.
udnDomainName :: Lens' UpdateDomainName Text Source #
- Required
- The name of the
DomainName
resource to be changed.
Destructuring the Response
domainName :: DomainName Source #
Creates a value of DomainName
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dnRegionalHostedZoneId
- 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 .dnCertificateName
- The name of the certificate that will be used by edge-optimized endpoint for this domain name.dnRegionalCertificateARN
- 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.dnCertificateARN
- 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.dnDistributionHostedZoneId
- The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value isZ2FDTNDATAQYW2
for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway .dnDomainName
- The custom domain name as an API host name, for example,my-api.example.com
.dnRegionalCertificateName
- The name of the certificate that will be used for validating the regional domain name.dnRegionalDomainName
- 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.dnCertificateUploadDate
- The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.dnDistributionDomainName
- 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 .dnEndpointConfiguration
- The endpoint configuration of thisDomainName
showing the endpoint types of the domain name.
data DomainName Source #
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.
Set a Custom Host Name for an API
See: domainName
smart constructor.
Instances
Response Lenses
dnRegionalHostedZoneId :: Lens' DomainName (Maybe Text) Source #
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 .
dnCertificateName :: Lens' DomainName (Maybe Text) Source #
The name of the certificate that will be used by edge-optimized endpoint for this domain name.
dnRegionalCertificateARN :: Lens' DomainName (Maybe Text) Source #
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.
dnCertificateARN :: Lens' DomainName (Maybe Text) Source #
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.
dnDistributionHostedZoneId :: Lens' DomainName (Maybe Text) Source #
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 .
dnDomainName :: Lens' DomainName (Maybe Text) Source #
The custom domain name as an API host name, for example, my-api.example.com
.
dnRegionalCertificateName :: Lens' DomainName (Maybe Text) Source #
The name of the certificate that will be used for validating the regional domain name.
dnRegionalDomainName :: Lens' DomainName (Maybe Text) Source #
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.
dnCertificateUploadDate :: Lens' DomainName (Maybe UTCTime) Source #
The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
dnDistributionDomainName :: Lens' DomainName (Maybe Text) Source #
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 .
dnEndpointConfiguration :: Lens' DomainName (Maybe EndpointConfiguration) Source #
The endpoint configuration of this DomainName
showing the endpoint types of the domain name.