Copyright	(c) 2013-2021 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

Amazonka.APIGateway.UpdateDomainName

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Changes information about the DomainName resource.

Synopsis

data UpdateDomainName = UpdateDomainName' {
- patchOperations :: Maybe [PatchOperation]
- domainName :: Text
}
newUpdateDomainName :: Text -> UpdateDomainName
updateDomainName_patchOperations :: Lens' UpdateDomainName (Maybe [PatchOperation])
updateDomainName_domainName :: Lens' UpdateDomainName Text
data DomainName = DomainName' {
- regionalHostedZoneId :: Maybe Text
- certificateName :: Maybe Text
- ownershipVerificationCertificateArn :: Maybe Text
- regionalCertificateArn :: Maybe Text
- certificateArn :: Maybe Text
- distributionHostedZoneId :: Maybe Text
- securityPolicy :: Maybe SecurityPolicy
- domainName :: Maybe Text
- mutualTlsAuthentication :: Maybe MutualTlsAuthentication
- regionalCertificateName :: Maybe Text
- regionalDomainName :: Maybe Text
- certificateUploadDate :: Maybe POSIX
- distributionDomainName :: Maybe Text
- domainNameStatusMessage :: Maybe Text
- endpointConfiguration :: Maybe EndpointConfiguration
- domainNameStatus :: Maybe DomainNameStatus
- tags :: Maybe (HashMap Text Text)
}
newDomainName :: DomainName
domainName_regionalHostedZoneId :: Lens' DomainName (Maybe Text)
domainName_certificateName :: Lens' DomainName (Maybe Text)
domainName_ownershipVerificationCertificateArn :: Lens' DomainName (Maybe Text)
domainName_regionalCertificateArn :: Lens' DomainName (Maybe Text)
domainName_certificateArn :: Lens' DomainName (Maybe Text)
domainName_distributionHostedZoneId :: Lens' DomainName (Maybe Text)
domainName_securityPolicy :: Lens' DomainName (Maybe SecurityPolicy)
domainName_domainName :: Lens' DomainName (Maybe Text)
domainName_mutualTlsAuthentication :: Lens' DomainName (Maybe MutualTlsAuthentication)
domainName_regionalCertificateName :: Lens' DomainName (Maybe Text)
domainName_regionalDomainName :: Lens' DomainName (Maybe Text)
domainName_certificateUploadDate :: Lens' DomainName (Maybe UTCTime)
domainName_distributionDomainName :: Lens' DomainName (Maybe Text)
domainName_domainNameStatusMessage :: Lens' DomainName (Maybe Text)
domainName_endpointConfiguration :: Lens' DomainName (Maybe EndpointConfiguration)
domainName_domainNameStatus :: Lens' DomainName (Maybe DomainNameStatus)
domainName_tags :: Lens' DomainName (Maybe (HashMap Text Text))

Creating a Request

data UpdateDomainName Source #

A request to change information about the DomainName resource.

See: newUpdateDomainName smart constructor.

Constructors

UpdateDomainName'
Fields patchOperations :: Maybe [PatchOperation] A list of update operations to be applied to the specified resource and in the order specified in this list. domainName :: Text Required The name of the DomainName resource to be changed.

Instances

Instances details

Eq UpdateDomainName Source #
Instance details Defined in Amazonka.APIGateway.UpdateDomainName Methods (==) :: UpdateDomainName -> UpdateDomainName -> Bool # (/=) :: UpdateDomainName -> UpdateDomainName -> Bool #
Read UpdateDomainName Source #
Instance details Defined in Amazonka.APIGateway.UpdateDomainName Methods readsPrec :: Int -> ReadS UpdateDomainName # readList :: ReadS [UpdateDomainName] # readPrec :: ReadPrec UpdateDomainName # readListPrec :: ReadPrec [UpdateDomainName] #
Show UpdateDomainName Source #
Instance details Defined in Amazonka.APIGateway.UpdateDomainName Methods showsPrec :: Int -> UpdateDomainName -> ShowS # show :: UpdateDomainName -> String # showList :: [UpdateDomainName] -> ShowS #
Generic UpdateDomainName Source #
Instance details Defined in Amazonka.APIGateway.UpdateDomainName Associated Types type Rep UpdateDomainName :: Type -> Type # Methods from :: UpdateDomainName -> Rep UpdateDomainName x # to :: Rep UpdateDomainName x -> UpdateDomainName #
NFData UpdateDomainName Source #
Instance details Defined in Amazonka.APIGateway.UpdateDomainName Methods rnf :: UpdateDomainName -> () #
Hashable UpdateDomainName Source #
Instance details Defined in Amazonka.APIGateway.UpdateDomainName Methods hashWithSalt :: Int -> UpdateDomainName -> Int # hash :: UpdateDomainName -> Int #
ToJSON UpdateDomainName Source #
Instance details Defined in Amazonka.APIGateway.UpdateDomainName Methods toJSON :: UpdateDomainName -> Value # toEncoding :: UpdateDomainName -> Encoding # toJSONList :: [UpdateDomainName] -> Value # toEncodingList :: [UpdateDomainName] -> Encoding #
AWSRequest UpdateDomainName Source #
Instance details Defined in Amazonka.APIGateway.UpdateDomainName Associated Types type AWSResponse UpdateDomainName # Methods request :: UpdateDomainName -> Request UpdateDomainName # response :: MonadResource m => Logger -> Service -> Proxy UpdateDomainName -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateDomainName))) #
ToHeaders UpdateDomainName Source #
Instance details Defined in Amazonka.APIGateway.UpdateDomainName Methods toHeaders :: UpdateDomainName -> [Header] #
ToPath UpdateDomainName Source #
Instance details Defined in Amazonka.APIGateway.UpdateDomainName Methods toPath :: UpdateDomainName -> ByteString #
ToQuery UpdateDomainName Source #
Instance details Defined in Amazonka.APIGateway.UpdateDomainName Methods toQuery :: UpdateDomainName -> QueryString #
type Rep UpdateDomainName Source #
Instance details Defined in Amazonka.APIGateway.UpdateDomainName type Rep UpdateDomainName = D1 ('MetaData "UpdateDomainName" "Amazonka.APIGateway.UpdateDomainName" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "UpdateDomainName'" 'PrefixI 'True) (S1 ('MetaSel ('Just "patchOperations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PatchOperation])) :*: S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse UpdateDomainName Source #
Instance details Defined in Amazonka.APIGateway.UpdateDomainName type AWSResponse UpdateDomainName = DomainName

newUpdateDomainName Source #

Arguments

:: Text	`$sel:domainName:UpdateDomainName'`
-> UpdateDomainName

Create a value of UpdateDomainName with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:patchOperations:UpdateDomainName', updateDomainName_patchOperations - A list of update operations to be applied to the specified resource and in the order specified in this list.

$sel:domainName:UpdateDomainName', updateDomainName_domainName - [Required] The name of the DomainName resource to be changed.

Request Lenses

updateDomainName_patchOperations :: Lens' UpdateDomainName (Maybe [PatchOperation]) Source #

A list of update operations to be applied to the specified resource and in the order specified in this list.

updateDomainName_domainName :: Lens' UpdateDomainName Text Source #

Required: The name of the DomainName resource to be changed.

Destructuring the Response

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: newDomainName smart constructor.

Constructors

DomainName'

Fields

regionalHostedZoneId :: Maybe Text
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.
certificateName :: Maybe Text
The name of the certificate that will be used by edge-optimized endpoint for this domain name.
ownershipVerificationCertificateArn :: Maybe Text
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.
regionalCertificateArn :: Maybe Text
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.
certificateArn :: Maybe Text
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.
distributionHostedZoneId :: Maybe Text
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.
securityPolicy :: Maybe SecurityPolicy
The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.
domainName :: Maybe Text
The custom domain name as an API host name, for example, my-api.example.com.
mutualTlsAuthentication :: Maybe 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.
regionalCertificateName :: Maybe Text
The name of the certificate that will be used for validating the regional domain name.
regionalDomainName :: Maybe Text
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.
certificateUploadDate :: Maybe POSIX
The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
distributionDomainName :: Maybe Text
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.
domainNameStatusMessage :: Maybe Text
An optional text message containing detailed information about status of the DomainName migration.
endpointConfiguration :: Maybe EndpointConfiguration
The endpoint configuration of this DomainName showing the endpoint types of the domain name.
domainNameStatus :: Maybe DomainNameStatus
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.
tags :: Maybe (HashMap Text Text)
The collection of tags. Each tag element is associated with a given resource.

Instances

Instances details

Eq DomainName Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainName Methods (==) :: DomainName -> DomainName -> Bool # (/=) :: DomainName -> DomainName -> Bool #
Read DomainName Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainName Methods readsPrec :: Int -> ReadS DomainName # readList :: ReadS [DomainName] # readPrec :: ReadPrec DomainName # readListPrec :: ReadPrec [DomainName] #
Show DomainName Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainName Methods showsPrec :: Int -> DomainName -> ShowS # show :: DomainName -> String # showList :: [DomainName] -> ShowS #
Generic DomainName Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainName Associated Types type Rep DomainName :: Type -> Type # Methods from :: DomainName -> Rep DomainName x # to :: Rep DomainName x -> DomainName #
NFData DomainName Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainName Methods rnf :: DomainName -> () #
Hashable DomainName Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainName Methods hashWithSalt :: Int -> DomainName -> Int # hash :: DomainName -> Int #
FromJSON DomainName Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainName Methods parseJSON :: Value -> Parser DomainName # parseJSONList :: Value -> Parser [DomainName] #
type Rep DomainName Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainName type Rep DomainName = D1 ('MetaData "DomainName" "Amazonka.APIGateway.Types.DomainName" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "DomainName'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "regionalHostedZoneId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "certificateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "ownershipVerificationCertificateArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "regionalCertificateArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "certificateArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "distributionHostedZoneId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "securityPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SecurityPolicy)) :: S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: (((S1 ('MetaSel ('Just "mutualTlsAuthentication") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MutualTlsAuthentication)) :: S1 ('MetaSel ('Just "regionalCertificateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "regionalDomainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "certificateUploadDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: ((S1 ('MetaSel ('Just "distributionDomainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "domainNameStatusMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "endpointConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointConfiguration)) :: (S1 ('MetaSel ('Just "domainNameStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DomainNameStatus)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))))))))

newDomainName :: DomainName Source #

Create a value of DomainName with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:regionalHostedZoneId:DomainName', domainName_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.

$sel:certificateName:DomainName', domainName_certificateName - The name of the certificate that will be used by edge-optimized endpoint for this domain name.

$sel:ownershipVerificationCertificateArn:DomainName', domainName_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.

$sel:regionalCertificateArn:DomainName', domainName_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.

$sel:certificateArn:DomainName', domainName_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.

$sel:distributionHostedZoneId:DomainName', domainName_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.

$sel:securityPolicy:DomainName', domainName_securityPolicy - The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.

$sel:domainName:DomainName', domainName_domainName - The custom domain name as an API host name, for example, my-api.example.com.

$sel:mutualTlsAuthentication:DomainName', domainName_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.

$sel:regionalCertificateName:DomainName', domainName_regionalCertificateName - The name of the certificate that will be used for validating the regional domain name.

$sel:regionalDomainName:DomainName', domainName_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.

$sel:certificateUploadDate:DomainName', domainName_certificateUploadDate - The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

$sel:distributionDomainName:DomainName', domainName_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.

$sel:domainNameStatusMessage:DomainName', domainName_domainNameStatusMessage - An optional text message containing detailed information about status of the DomainName migration.

$sel:endpointConfiguration:DomainName', domainName_endpointConfiguration - The endpoint configuration of this DomainName showing the endpoint types of the domain name.

$sel:domainNameStatus:DomainName', domainName_domainNameStatus - 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.

$sel:tags:DomainName', domainName_tags - The collection of tags. Each tag element is associated with a given resource.

Response Lenses

domainName_regionalHostedZoneId :: 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.

domainName_certificateName :: Lens' DomainName (Maybe Text) Source #

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

domainName_ownershipVerificationCertificateArn :: Lens' DomainName (Maybe Text) Source #

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.

domainName_regionalCertificateArn :: 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.

domainName_certificateArn :: 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.

domainName_distributionHostedZoneId :: 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.

domainName_securityPolicy :: Lens' DomainName (Maybe SecurityPolicy) Source #

The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.

domainName_domainName :: Lens' DomainName (Maybe Text) Source #

The custom domain name as an API host name, for example, my-api.example.com.

domainName_mutualTlsAuthentication :: Lens' DomainName (Maybe MutualTlsAuthentication) Source #

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.

domainName_regionalCertificateName :: Lens' DomainName (Maybe Text) Source #

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

domainName_regionalDomainName :: 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.

domainName_certificateUploadDate :: Lens' DomainName (Maybe UTCTime) Source #

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

domainName_distributionDomainName :: 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.

domainName_domainNameStatusMessage :: Lens' DomainName (Maybe Text) Source #

An optional text message containing detailed information about status of the DomainName migration.

domainName_endpointConfiguration :: Lens' DomainName (Maybe EndpointConfiguration) Source #

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

domainName_domainNameStatus :: Lens' DomainName (Maybe DomainNameStatus) Source #

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.

domainName_tags :: Lens' DomainName (Maybe (HashMap Text Text)) Source #

The collection of tags. Each tag element is associated with a given resource.