Amazonka.CloudFront.UpdateDistribution

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

1. Use GetDistributionConfig to get the current configuration, including the version identifier (ETag).

2. 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.
3. 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.

Creating a Request

data UpdateDistribution

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

ToHeaders UpdateDistribution

Defined in Amazonka.CloudFront.UpdateDistribution

Methods

toHeaders :: UpdateDistribution -> [Header]

ToPath UpdateDistribution

Defined in Amazonka.CloudFront.UpdateDistribution

Methods

toPath :: UpdateDistribution -> ByteString

ToQuery UpdateDistribution

Defined in Amazonka.CloudFront.UpdateDistribution

Methods

toQuery :: UpdateDistribution -> QueryString

ToElement UpdateDistribution

Defined in Amazonka.CloudFront.UpdateDistribution

Methods

toElement :: UpdateDistribution -> Element

AWSRequest UpdateDistribution

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

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

Defined in Amazonka.CloudFront.UpdateDistribution

Methods

showsPrec :: Int -> UpdateDistribution -> ShowS

show :: UpdateDistribution -> String

showList :: [UpdateDistribution] -> ShowS

NFData UpdateDistribution

Defined in Amazonka.CloudFront.UpdateDistribution

Methods

rnf :: UpdateDistribution -> ()

Eq UpdateDistribution

Defined in Amazonka.CloudFront.UpdateDistribution

Methods

(==) :: UpdateDistribution -> UpdateDistribution -> Bool

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

Hashable UpdateDistribution

Defined in Amazonka.CloudFront.UpdateDistribution

Methods

hashWithSalt :: Int -> UpdateDistribution -> Int

hash :: UpdateDistribution -> Int

type AWSResponse UpdateDistribution

Defined in Amazonka.CloudFront.UpdateDistribution

type AWSResponse UpdateDistribution = UpdateDistributionResponse

type Rep UpdateDistribution

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

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)

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

updateDistribution_distributionConfig :: Lens' UpdateDistribution DistributionConfig

The distribution's configuration information.

updateDistribution_id :: Lens' UpdateDistribution Text

The distribution's id.

Destructuring the Response

data UpdateDistributionResponse

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

Generic UpdateDistributionResponse

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

Defined in Amazonka.CloudFront.UpdateDistribution

Methods

showsPrec :: Int -> UpdateDistributionResponse -> ShowS

show :: UpdateDistributionResponse -> String

showList :: [UpdateDistributionResponse] -> ShowS

NFData UpdateDistributionResponse

Defined in Amazonka.CloudFront.UpdateDistribution

Methods

rnf :: UpdateDistributionResponse -> ()

Eq UpdateDistributionResponse

Defined in Amazonka.CloudFront.UpdateDistribution

Methods

(==) :: UpdateDistributionResponse -> UpdateDistributionResponse -> Bool

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

type Rep UpdateDistributionResponse

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

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)

The distribution's information.

updateDistributionResponse_eTag :: Lens' UpdateDistributionResponse (Maybe Text)

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

updateDistributionResponse_httpStatus :: Lens' UpdateDistributionResponse Int

The response's http status code.