Network.AWS.APIGateway.GetDomainName

Represents a domain name that is contained in a simpler, more intuitive URL that can be called.

Creating a Request

getDomainName

Arguments

:: Text

gdnDomainName

-> GetDomainName

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

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

• gdnDomainName - [Required] The name of the DomainName resource.

data GetDomainName

Request to get the name of a DomainName resource.

See: getDomainName smart constructor.

Instances

Eq GetDomainName

Defined in Network.AWS.APIGateway.GetDomainName

Methods

(==) :: GetDomainName -> GetDomainName -> Bool

(/=) :: GetDomainName -> GetDomainName -> Bool

Data GetDomainName

Defined in Network.AWS.APIGateway.GetDomainName

Methods

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

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

toConstr :: GetDomainName -> Constr

dataTypeOf :: GetDomainName -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c GetDomainName)

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

gmapT :: (forall b. Data b => b -> b) -> GetDomainName -> GetDomainName

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

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

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

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

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

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

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

Read GetDomainName

Defined in Network.AWS.APIGateway.GetDomainName

Methods

readsPrec :: Int -> ReadS GetDomainName

readList :: ReadS [GetDomainName]

readPrec :: ReadPrec GetDomainName

readListPrec :: ReadPrec [GetDomainName]

Show GetDomainName

Defined in Network.AWS.APIGateway.GetDomainName

Methods

showsPrec :: Int -> GetDomainName -> ShowS

show :: GetDomainName -> String

showList :: [GetDomainName] -> ShowS

Generic GetDomainName

Defined in Network.AWS.APIGateway.GetDomainName

Associated Types

type Rep GetDomainName :: Type -> Type

Methods

from :: GetDomainName -> Rep GetDomainName x

to :: Rep GetDomainName x -> GetDomainName

Hashable GetDomainName

Defined in Network.AWS.APIGateway.GetDomainName

Methods

hashWithSalt :: Int -> GetDomainName -> Int

hash :: GetDomainName -> Int

AWSRequest GetDomainName

Defined in Network.AWS.APIGateway.GetDomainName

Associated Types

type Rs GetDomainName :: Type

Methods

request :: GetDomainName -> Request GetDomainName

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy GetDomainName -> ClientResponse -> m (Response GetDomainName)

ToHeaders GetDomainName

Defined in Network.AWS.APIGateway.GetDomainName

Methods

toHeaders :: GetDomainName -> [Header]

ToPath GetDomainName

Defined in Network.AWS.APIGateway.GetDomainName

Methods

toPath :: GetDomainName -> ByteString

ToQuery GetDomainName

Defined in Network.AWS.APIGateway.GetDomainName

Methods

toQuery :: GetDomainName -> QueryString

NFData GetDomainName

Defined in Network.AWS.APIGateway.GetDomainName

Methods

rnf :: GetDomainName -> ()

type Rep GetDomainName

Defined in Network.AWS.APIGateway.GetDomainName

type Rep GetDomainName = D1 (MetaData "GetDomainName" "Network.AWS.APIGateway.GetDomainName" "amazonka-apigateway-1.6.1-BCCM2RP3l9Q2ENgHvKrj59" True) (C1 (MetaCons "GetDomainName'" PrefixI True) (S1 (MetaSel (Just "_gdnDomainName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

type Rs GetDomainName

Defined in Network.AWS.APIGateway.GetDomainName

type Rs GetDomainName = DomainName

Request Lenses

gdnDomainName :: Lens' GetDomainName Text

Required

The name of the DomainName resource.

Destructuring the Response

domainName :: DomainName

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 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 - 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 this DomainName showing the endpoint types of the domain name.

data DomainName

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

Eq DomainName

Defined in Network.AWS.APIGateway.Types.Product

Methods

(==) :: DomainName -> DomainName -> Bool

(/=) :: DomainName -> DomainName -> Bool

Data DomainName

Defined in Network.AWS.APIGateway.Types.Product

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

Defined in Network.AWS.APIGateway.Types.Product

Methods

readsPrec :: Int -> ReadS DomainName

readList :: ReadS [DomainName]

readPrec :: ReadPrec DomainName

readListPrec :: ReadPrec [DomainName]

Show DomainName

Defined in Network.AWS.APIGateway.Types.Product

Methods

showsPrec :: Int -> DomainName -> ShowS

show :: DomainName -> String

showList :: [DomainName] -> ShowS

Generic DomainName

Defined in Network.AWS.APIGateway.Types.Product

Associated Types

type Rep DomainName :: Type -> Type

Methods

from :: DomainName -> Rep DomainName x

to :: Rep DomainName x -> DomainName

Hashable DomainName

Defined in Network.AWS.APIGateway.Types.Product

Methods

hashWithSalt :: Int -> DomainName -> Int

hash :: DomainName -> Int

FromJSON DomainName

Defined in Network.AWS.APIGateway.Types.Product

Methods

parseJSON :: Value -> Parser DomainName

parseJSONList :: Value -> Parser [DomainName]

NFData DomainName

Defined in Network.AWS.APIGateway.Types.Product

Methods

rnf :: DomainName -> ()

type Rep DomainName

Defined in Network.AWS.APIGateway.Types.Product

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

Response Lenses

dnRegionalHostedZoneId :: Lens' DomainName (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 .

dnCertificateName :: Lens' DomainName (Maybe Text)

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

dnRegionalCertificateARN :: Lens' DomainName (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.

dnCertificateARN :: Lens' DomainName (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.

dnDistributionHostedZoneId :: Lens' DomainName (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 .

dnDomainName :: Lens' DomainName (Maybe Text)

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

dnRegionalCertificateName :: Lens' DomainName (Maybe Text)

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

dnRegionalDomainName :: Lens' DomainName (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.

dnCertificateUploadDate :: Lens' DomainName (Maybe UTCTime)

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

dnDistributionDomainName :: Lens' DomainName (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 .

dnEndpointConfiguration :: Lens' DomainName (Maybe EndpointConfiguration)

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