amazonka-apigateway-1.5.0: Amazon API Gateway SDK.

Copyright(c) 2013-2017 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.APIGateway.CreateDomainName

Contents

Description

Creates a new domain name.

Synopsis

Creating a Request

createDomainName Source #

Creates a value of CreateDomainName with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • cdnCertificateName - The user-friendly name of the certificate that will be used by edge-optimized endpoint for this domain name.
  • cdnRegionalCertificateARN - The reference to an AWS-managed certificate that will be used by regional endpoint for this domain name. AWS Certificate Manager is the only supported source.
  • cdnCertificateARN - 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.
  • cdnCertificatePrivateKey - [Deprecated] Your edge-optimized endpoint's domain name certificate's private key.
  • cdnRegionalCertificateName - The user-friendly name of the certificate that will be used by regional endpoint for this domain name.
  • cdnCertificateBody - [Deprecated] The body of the server certificate that will be used by edge-optimized endpoint for this domain name provided by your certificate authority.
  • cdnCertificateChain - [Deprecated] The intermediate certificates and optionally the root certificate, one after the other without any blank lines, used by an edge-optimized endpoint for this domain name. If you include the root certificate, your certificate chain must start with intermediate certificates and end with the root certificate. Use the intermediate certificates that were provided by your certificate authority. Do not include any intermediaries that are not in the chain of trust path.
  • cdnEndpointConfiguration - The endpoint configuration of this DomainName showing the endpoint types of the domain name.
  • cdnDomainName - (Required) The name of the DomainName resource.

data CreateDomainName Source #

A request to create a new domain name.

See: createDomainName smart constructor.

Instances

Eq CreateDomainName Source # 
Data CreateDomainName Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateDomainName -> c CreateDomainName #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateDomainName #

toConstr :: CreateDomainName -> Constr #

dataTypeOf :: CreateDomainName -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateDomainName) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateDomainName) #

gmapT :: (forall b. Data b => b -> b) -> CreateDomainName -> CreateDomainName #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateDomainName -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateDomainName -> r #

gmapQ :: (forall d. Data d => d -> u) -> CreateDomainName -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateDomainName -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateDomainName -> m CreateDomainName #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateDomainName -> m CreateDomainName #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateDomainName -> m CreateDomainName #

Read CreateDomainName Source # 
Show CreateDomainName Source # 
Generic CreateDomainName Source # 
Hashable CreateDomainName Source # 
ToJSON CreateDomainName Source # 
NFData CreateDomainName Source # 

Methods

rnf :: CreateDomainName -> () #

AWSRequest CreateDomainName Source # 
ToQuery CreateDomainName Source # 
ToPath CreateDomainName Source # 
ToHeaders CreateDomainName Source # 
type Rep CreateDomainName Source # 
type Rep CreateDomainName = D1 (MetaData "CreateDomainName" "Network.AWS.APIGateway.CreateDomainName" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) (C1 (MetaCons "CreateDomainName'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cdnCertificateName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_cdnRegionalCertificateARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_cdnCertificateARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_cdnCertificatePrivateKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cdnRegionalCertificateName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_cdnCertificateBody") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_cdnCertificateChain") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_cdnEndpointConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe EndpointConfiguration))) (S1 (MetaSel (Just Symbol "_cdnDomainName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))))
type Rs CreateDomainName Source # 

Request Lenses

cdnCertificateName :: Lens' CreateDomainName (Maybe Text) Source #

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

cdnRegionalCertificateARN :: Lens' CreateDomainName (Maybe Text) Source #

The reference to an AWS-managed certificate that will be used by regional endpoint for this domain name. AWS Certificate Manager is the only supported source.

cdnCertificateARN :: Lens' CreateDomainName (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.

cdnCertificatePrivateKey :: Lens' CreateDomainName (Maybe Text) Source #

Deprecated
Your edge-optimized endpoint's domain name certificate's private key.

cdnRegionalCertificateName :: Lens' CreateDomainName (Maybe Text) Source #

The user-friendly name of the certificate that will be used by regional endpoint for this domain name.

cdnCertificateBody :: Lens' CreateDomainName (Maybe Text) Source #

Deprecated
The body of the server certificate that will be used by edge-optimized endpoint for this domain name provided by your certificate authority.

cdnCertificateChain :: Lens' CreateDomainName (Maybe Text) Source #

Deprecated
The intermediate certificates and optionally the root certificate, one after the other without any blank lines, used by an edge-optimized endpoint for this domain name. If you include the root certificate, your certificate chain must start with intermediate certificates and end with the root certificate. Use the intermediate certificates that were provided by your certificate authority. Do not include any intermediaries that are not in the chain of trust path.

cdnEndpointConfiguration :: Lens' CreateDomainName (Maybe EndpointConfiguration) Source #

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

cdnDomainName :: Lens' CreateDomainName Text Source #

(Required) The name of the DomainName resource.

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:

  • 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.
  • dnDomainName - The name of the DomainName resource.
  • 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 Amazon 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 this DomainName 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, 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.

Set a Custom Host Name for an API

See: domainName smart constructor.

Instances

Eq DomainName Source # 
Data DomainName Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DomainName -> c DomainName #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DomainName #

toConstr :: DomainName -> Constr #

dataTypeOf :: DomainName -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DomainName) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DomainName) #

gmapT :: (forall b. Data b => b -> b) -> DomainName -> DomainName #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DomainName -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DomainName -> r #

gmapQ :: (forall d. Data d => d -> u) -> DomainName -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DomainName -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DomainName -> m DomainName #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DomainName -> m DomainName #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DomainName -> m DomainName #

Read DomainName Source # 
Show DomainName Source # 
Generic DomainName Source # 

Associated Types

type Rep DomainName :: * -> * #

Hashable DomainName Source # 
FromJSON DomainName Source # 
NFData DomainName Source # 

Methods

rnf :: DomainName -> () #

type Rep DomainName Source # 
type Rep DomainName = D1 (MetaData "DomainName" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) (C1 (MetaCons "DomainName'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_dnCertificateName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dnRegionalCertificateARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_dnCertificateARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dnDomainName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_dnRegionalCertificateName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dnRegionalDomainName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_dnCertificateUploadDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX))) ((:*:) (S1 (MetaSel (Just Symbol "_dnDistributionDomainName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dnEndpointConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe EndpointConfiguration))))))))

Response Lenses

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.

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

The name of the DomainName resource.

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 Amazon 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.