Network.AWS.APIGateway.UpdateDomainName

Changes information about the DomainName resource.

Creating a Request

updateDomainName

Arguments

:: Text

udnDomainName

-> UpdateDomainName

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 the DomainName resource to be changed.

data UpdateDomainName

A request to change information about the DomainName resource.

See: updateDomainName smart constructor.

Instances

Eq UpdateDomainName

Methods

(==) :: UpdateDomainName -> UpdateDomainName -> Bool

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

Data UpdateDomainName

Methods

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

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

toConstr :: UpdateDomainName -> Constr

dataTypeOf :: UpdateDomainName -> DataType

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

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

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

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

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

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

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

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

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

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

Read UpdateDomainName

Methods

readsPrec :: Int -> ReadS UpdateDomainName

readList :: ReadS [UpdateDomainName]

readPrec :: ReadPrec UpdateDomainName

readListPrec :: ReadPrec [UpdateDomainName]

Show UpdateDomainName

Methods

showsPrec :: Int -> UpdateDomainName -> ShowS

show :: UpdateDomainName -> String

showList :: [UpdateDomainName] -> ShowS

Generic UpdateDomainName

Associated Types

type Rep UpdateDomainName :: * -> *

Methods

from :: UpdateDomainName -> Rep UpdateDomainName x

to :: Rep UpdateDomainName x -> UpdateDomainName

Hashable UpdateDomainName

Methods

hashWithSalt :: Int -> UpdateDomainName -> Int

hash :: UpdateDomainName -> Int

ToJSON UpdateDomainName

Methods

toJSON :: UpdateDomainName -> Value

toEncoding :: UpdateDomainName -> Encoding

toJSONList :: [UpdateDomainName] -> Value

toEncodingList :: [UpdateDomainName] -> Encoding

NFData UpdateDomainName

Methods

rnf :: UpdateDomainName -> ()

AWSRequest UpdateDomainName

Associated Types

type Rs UpdateDomainName :: *

Methods

request :: UpdateDomainName -> Request UpdateDomainName

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

ToHeaders UpdateDomainName

Methods

toHeaders :: UpdateDomainName -> [Header]

ToPath UpdateDomainName

Methods

toPath :: UpdateDomainName -> ByteString

ToQuery UpdateDomainName

Methods

toQuery :: UpdateDomainName -> QueryString

type Rep UpdateDomainName

type Rep UpdateDomainName = D1 * (MetaData "UpdateDomainName" "Network.AWS.APIGateway.UpdateDomainName" "amazonka-apigateway-1.6.0-JJ9NJtNe0aRBcVRYpJCEA2" False) (C1 * (MetaCons "UpdateDomainName'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_udnPatchOperations") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [PatchOperation]))) (S1 * (MetaSel (Just Symbol "_udnDomainName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))

type Rs UpdateDomainName

type Rs UpdateDomainName = DomainName

Request Lenses

udnPatchOperations :: Lens' UpdateDomainName [PatchOperation]

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

udnDomainName :: Lens' UpdateDomainName Text

Required

The name of the DomainName resource to be changed.

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

Methods

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

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

Data DomainName

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

Methods

readsPrec :: Int -> ReadS DomainName

readList :: ReadS [DomainName]

readPrec :: ReadPrec DomainName

readListPrec :: ReadPrec [DomainName]

Show DomainName

Methods

showsPrec :: Int -> DomainName -> ShowS

show :: DomainName -> String

showList :: [DomainName] -> ShowS

Generic DomainName

Associated Types

type Rep DomainName :: * -> *

Methods

from :: DomainName -> Rep DomainName x

to :: Rep DomainName x -> DomainName

Hashable DomainName

Methods

hashWithSalt :: Int -> DomainName -> Int

hash :: DomainName -> Int

FromJSON DomainName

Methods

parseJSON :: Value -> Parser DomainName

parseJSONList :: Value -> Parser [DomainName]

NFData DomainName

Methods

rnf :: DomainName -> ()

type Rep DomainName

type Rep DomainName = D1 * (MetaData "DomainName" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.6.0-JJ9NJtNe0aRBcVRYpJCEA2" False) (C1 * (MetaCons "DomainName'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_dnRegionalHostedZoneId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (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 "_dnDistributionHostedZoneId") 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

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.