Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CloudFront.UpdateDistribution

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates the configuration for a CloudFront distribution.

The update process includes getting the current distribution configuration, updating it to make your changes, and then submitting an UpdateDistribution request to make the updates.

To update a web distribution using the CloudFront API

Use GetDistributionConfig to get the current configuration, including the version identifier (ETag).
Update the distribution configuration that was returned in the response. Note the following important requirements and restrictions:
- You must rename the ETag field to IfMatch, leaving the value unchanged. (Set the value of IfMatch to the value of ETag, then remove the ETag field.)
- You can't change the value of CallerReference.
Submit an UpdateDistribution request, providing the distribution configuration. The new configuration replaces the existing configuration. The values that you specify in an UpdateDistribution request are not merged into your existing configuration. Make sure to include all fields: the ones that you modified and also the ones that you didn't.

Synopsis

data UpdateDistribution = UpdateDistribution' {
- ifMatch :: Maybe Text
- distributionConfig :: DistributionConfig
- id :: Text
}
newUpdateDistribution :: DistributionConfig -> Text -> UpdateDistribution
updateDistribution_ifMatch :: Lens' UpdateDistribution (Maybe Text)
updateDistribution_distributionConfig :: Lens' UpdateDistribution DistributionConfig
updateDistribution_id :: Lens' UpdateDistribution Text
data UpdateDistributionResponse = UpdateDistributionResponse' {
- distribution :: Maybe Distribution
- eTag :: Maybe Text
- httpStatus :: Int
}
newUpdateDistributionResponse :: Int -> UpdateDistributionResponse
updateDistributionResponse_distribution :: Lens' UpdateDistributionResponse (Maybe Distribution)
updateDistributionResponse_eTag :: Lens' UpdateDistributionResponse (Maybe Text)
updateDistributionResponse_httpStatus :: Lens' UpdateDistributionResponse Int

Creating a Request

data UpdateDistribution Source #

The request to update a distribution.

See: newUpdateDistribution smart constructor.

Constructors

UpdateDistribution'
Fields ifMatch :: Maybe Text The value of the `ETag` header that you received when retrieving the distribution's configuration. For example: `E2QWRUHAPOMQZL`. distributionConfig :: DistributionConfig The distribution's configuration information. id :: Text The distribution's id.

Instances

Instances details

ToHeaders UpdateDistribution Source #
Instance details Defined in Amazonka.CloudFront.UpdateDistribution Methods toHeaders :: UpdateDistribution -> [Header] #
ToPath UpdateDistribution Source #
Instance details Defined in Amazonka.CloudFront.UpdateDistribution Methods toPath :: UpdateDistribution -> ByteString #
ToQuery UpdateDistribution Source #
Instance details Defined in Amazonka.CloudFront.UpdateDistribution Methods toQuery :: UpdateDistribution -> QueryString #
ToElement UpdateDistribution Source #
Instance details Defined in Amazonka.CloudFront.UpdateDistribution Methods toElement :: UpdateDistribution -> Element #
AWSRequest UpdateDistribution Source #
Instance details Defined in Amazonka.CloudFront.UpdateDistribution Associated Types type AWSResponse UpdateDistribution # Methods request :: (Service -> Service) -> UpdateDistribution -> Request UpdateDistribution # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateDistribution -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateDistribution))) #
Generic UpdateDistribution Source #
Instance details Defined in Amazonka.CloudFront.UpdateDistribution Associated Types type Rep UpdateDistribution :: Type -> Type # Methods from :: UpdateDistribution -> Rep UpdateDistribution x # to :: Rep UpdateDistribution x -> UpdateDistribution #
Show UpdateDistribution Source #
Instance details Defined in Amazonka.CloudFront.UpdateDistribution Methods showsPrec :: Int -> UpdateDistribution -> ShowS # show :: UpdateDistribution -> String # showList :: [UpdateDistribution] -> ShowS #
NFData UpdateDistribution Source #
Instance details Defined in Amazonka.CloudFront.UpdateDistribution Methods rnf :: UpdateDistribution -> () #
Eq UpdateDistribution Source #
Instance details Defined in Amazonka.CloudFront.UpdateDistribution Methods (==) :: UpdateDistribution -> UpdateDistribution -> Bool # (/=) :: UpdateDistribution -> UpdateDistribution -> Bool #
Hashable UpdateDistribution Source #
Instance details Defined in Amazonka.CloudFront.UpdateDistribution Methods hashWithSalt :: Int -> UpdateDistribution -> Int # hash :: UpdateDistribution -> Int #
type AWSResponse UpdateDistribution Source #
Instance details Defined in Amazonka.CloudFront.UpdateDistribution type AWSResponse UpdateDistribution = UpdateDistributionResponse
type Rep UpdateDistribution Source #
Instance details Defined in Amazonka.CloudFront.UpdateDistribution type Rep UpdateDistribution = D1 ('MetaData "UpdateDistribution" "Amazonka.CloudFront.UpdateDistribution" "amazonka-cloudfront-2.0-8Jb7luniAuUfLdUxCxW4K" 'False) (C1 ('MetaCons "UpdateDistribution'" 'PrefixI 'True) (S1 ('MetaSel ('Just "ifMatch") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "distributionConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DistributionConfig) :: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newUpdateDistribution Source #

Arguments

:: DistributionConfig	`UpdateDistribution`
-> Text	`UpdateDistribution`
-> UpdateDistribution

Create a value of UpdateDistribution 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:ifMatch:UpdateDistribution', updateDistribution_ifMatch - The value of the ETag header that you received when retrieving the distribution's configuration. For example: E2QWRUHAPOMQZL.

UpdateDistribution, updateDistribution_distributionConfig - The distribution's configuration information.

UpdateDistribution, updateDistribution_id - The distribution's id.

Request Lenses

updateDistribution_ifMatch :: Lens' UpdateDistribution (Maybe Text) Source #

The value of the ETag header that you received when retrieving the distribution's configuration. For example: E2QWRUHAPOMQZL.

updateDistribution_distributionConfig :: Lens' UpdateDistribution DistributionConfig Source #

The distribution's configuration information.

updateDistribution_id :: Lens' UpdateDistribution Text Source #

The distribution's id.

Destructuring the Response

data UpdateDistributionResponse Source #

The returned result of the corresponding request.

See: newUpdateDistributionResponse smart constructor.

Constructors

UpdateDistributionResponse'
Fields distribution :: Maybe Distribution The distribution's information. eTag :: Maybe Text The current version of the configuration. For example: `E2QWRUHAPOMQZL`. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic UpdateDistributionResponse Source #
Instance details Defined in Amazonka.CloudFront.UpdateDistribution Associated Types type Rep UpdateDistributionResponse :: Type -> Type # Methods from :: UpdateDistributionResponse -> Rep UpdateDistributionResponse x # to :: Rep UpdateDistributionResponse x -> UpdateDistributionResponse #
Show UpdateDistributionResponse Source #
Instance details Defined in Amazonka.CloudFront.UpdateDistribution Methods showsPrec :: Int -> UpdateDistributionResponse -> ShowS # show :: UpdateDistributionResponse -> String # showList :: [UpdateDistributionResponse] -> ShowS #
NFData UpdateDistributionResponse Source #
Instance details Defined in Amazonka.CloudFront.UpdateDistribution Methods rnf :: UpdateDistributionResponse -> () #
Eq UpdateDistributionResponse Source #
Instance details Defined in Amazonka.CloudFront.UpdateDistribution Methods (==) :: UpdateDistributionResponse -> UpdateDistributionResponse -> Bool # (/=) :: UpdateDistributionResponse -> UpdateDistributionResponse -> Bool #
type Rep UpdateDistributionResponse Source #
Instance details Defined in Amazonka.CloudFront.UpdateDistribution type Rep UpdateDistributionResponse = D1 ('MetaData "UpdateDistributionResponse" "Amazonka.CloudFront.UpdateDistribution" "amazonka-cloudfront-2.0-8Jb7luniAuUfLdUxCxW4K" 'False) (C1 ('MetaCons "UpdateDistributionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "distribution") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Distribution)) :: (S1 ('MetaSel ('Just "eTag") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newUpdateDistributionResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateDistributionResponse'`
-> UpdateDistributionResponse

Create a value of UpdateDistributionResponse 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:distribution:UpdateDistributionResponse', updateDistributionResponse_distribution - The distribution's information.

$sel:eTag:UpdateDistributionResponse', updateDistributionResponse_eTag - The current version of the configuration. For example: E2QWRUHAPOMQZL.

$sel:httpStatus:UpdateDistributionResponse', updateDistributionResponse_httpStatus - The response's http status code.

Response Lenses

updateDistributionResponse_distribution :: Lens' UpdateDistributionResponse (Maybe Distribution) Source #

The distribution's information.

updateDistributionResponse_eTag :: Lens' UpdateDistributionResponse (Maybe Text) Source #

The current version of the configuration. For example: E2QWRUHAPOMQZL.

updateDistributionResponse_httpStatus :: Lens' UpdateDistributionResponse Int Source #

The response's http status code.