amazonka-lightsail-2.0: Amazon Lightsail SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Lightsail.UpdateDistribution

Description

Updates an existing Amazon Lightsail content delivery network (CDN) distribution.

Use this action to update the configuration of your existing distribution.

Synopsis

Creating a Request

data UpdateDistribution Source #

See: newUpdateDistribution smart constructor.

Constructors

UpdateDistribution' 

Fields

  • cacheBehaviorSettings :: Maybe CacheSettings

    An object that describes the cache behavior settings for the distribution.

    The cacheBehaviorSettings specified in your UpdateDistributionRequest will replace your distribution's existing settings.

  • cacheBehaviors :: Maybe [CacheBehaviorPerPath]

    An array of objects that describe the per-path cache behavior for the distribution.

  • defaultCacheBehavior :: Maybe CacheBehavior

    An object that describes the default cache behavior for the distribution.

  • isEnabled :: Maybe Bool

    Indicates whether to enable the distribution.

  • origin :: Maybe InputOrigin

    An object that describes the origin resource for the distribution, such as a Lightsail instance, bucket, or load balancer.

    The distribution pulls, caches, and serves content from the origin.

  • distributionName :: Text

    The name of the distribution to update.

    Use the GetDistributions action to get a list of distribution names that you can specify.

Instances

Instances details
ToJSON UpdateDistribution Source # 
Instance details

Defined in Amazonka.Lightsail.UpdateDistribution

Methods

toJSON :: UpdateDistribution -> Value #

toEncoding :: UpdateDistribution -> Encoding #

toJSONList :: [UpdateDistribution] -> Value #

toEncodingList :: [UpdateDistribution] -> Encoding #

ToHeaders UpdateDistribution Source # 
Instance details

Defined in Amazonka.Lightsail.UpdateDistribution

Methods

toHeaders :: UpdateDistribution -> [Header] #

ToPath UpdateDistribution Source # 
Instance details

Defined in Amazonka.Lightsail.UpdateDistribution

Methods

toPath :: UpdateDistribution -> ByteString #

ToQuery UpdateDistribution Source # 
Instance details

Defined in Amazonka.Lightsail.UpdateDistribution

Methods

toQuery :: UpdateDistribution -> QueryString #

AWSRequest UpdateDistribution Source # 
Instance details

Defined in Amazonka.Lightsail.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.Lightsail.UpdateDistribution

Associated Types

type Rep UpdateDistribution :: Type -> Type #

Methods

from :: UpdateDistribution -> Rep UpdateDistribution x #

to :: Rep UpdateDistribution x -> UpdateDistribution #

Read UpdateDistribution Source # 
Instance details

Defined in Amazonka.Lightsail.UpdateDistribution

Methods

readsPrec :: Int -> ReadS UpdateDistribution #

readList :: ReadS [UpdateDistribution] #

readPrec :: ReadPrec UpdateDistribution #

readListPrec :: ReadPrec [UpdateDistribution] #

Show UpdateDistribution Source # 
Instance details

Defined in Amazonka.Lightsail.UpdateDistribution

Methods

showsPrec :: Int -> UpdateDistribution -> ShowS #

show :: UpdateDistribution -> String #

showList :: [UpdateDistribution] -> ShowS #

NFData UpdateDistribution Source # 
Instance details

Defined in Amazonka.Lightsail.UpdateDistribution

Methods

rnf :: UpdateDistribution -> () #

Eq UpdateDistribution Source # 
Instance details

Defined in Amazonka.Lightsail.UpdateDistribution

Methods

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

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

Hashable UpdateDistribution Source # 
Instance details

Defined in Amazonka.Lightsail.UpdateDistribution

Methods

hashWithSalt :: Int -> UpdateDistribution -> Int #

hash :: UpdateDistribution -> Int #

type AWSResponse UpdateDistribution Source # 
Instance details

Defined in Amazonka.Lightsail.UpdateDistribution

type AWSResponse UpdateDistribution = UpdateDistributionResponse
type Rep UpdateDistribution Source # 
Instance details

Defined in Amazonka.Lightsail.UpdateDistribution

type Rep UpdateDistribution = D1 ('MetaData "UpdateDistribution" "Amazonka.Lightsail.UpdateDistribution" "amazonka-lightsail-2.0-77hvsZhtZFxFduYae8QaN0" 'False) (C1 ('MetaCons "UpdateDistribution'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "cacheBehaviorSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CacheSettings)) :*: (S1 ('MetaSel ('Just "cacheBehaviors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CacheBehaviorPerPath])) :*: S1 ('MetaSel ('Just "defaultCacheBehavior") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CacheBehavior)))) :*: (S1 ('MetaSel ('Just "isEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "origin") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InputOrigin)) :*: S1 ('MetaSel ('Just "distributionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateDistribution Source #

Arguments

:: Text

$sel:distributionName: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:

UpdateDistribution, updateDistribution_cacheBehaviorSettings - An object that describes the cache behavior settings for the distribution.

The cacheBehaviorSettings specified in your UpdateDistributionRequest will replace your distribution's existing settings.

UpdateDistribution, updateDistribution_cacheBehaviors - An array of objects that describe the per-path cache behavior for the distribution.

UpdateDistribution, updateDistribution_defaultCacheBehavior - An object that describes the default cache behavior for the distribution.

UpdateDistribution, updateDistribution_isEnabled - Indicates whether to enable the distribution.

UpdateDistribution, updateDistribution_origin - An object that describes the origin resource for the distribution, such as a Lightsail instance, bucket, or load balancer.

The distribution pulls, caches, and serves content from the origin.

$sel:distributionName:UpdateDistribution', updateDistribution_distributionName - The name of the distribution to update.

Use the GetDistributions action to get a list of distribution names that you can specify.

Request Lenses

updateDistribution_cacheBehaviorSettings :: Lens' UpdateDistribution (Maybe CacheSettings) Source #

An object that describes the cache behavior settings for the distribution.

The cacheBehaviorSettings specified in your UpdateDistributionRequest will replace your distribution's existing settings.

updateDistribution_cacheBehaviors :: Lens' UpdateDistribution (Maybe [CacheBehaviorPerPath]) Source #

An array of objects that describe the per-path cache behavior for the distribution.

updateDistribution_defaultCacheBehavior :: Lens' UpdateDistribution (Maybe CacheBehavior) Source #

An object that describes the default cache behavior for the distribution.

updateDistribution_isEnabled :: Lens' UpdateDistribution (Maybe Bool) Source #

Indicates whether to enable the distribution.

updateDistribution_origin :: Lens' UpdateDistribution (Maybe InputOrigin) Source #

An object that describes the origin resource for the distribution, such as a Lightsail instance, bucket, or load balancer.

The distribution pulls, caches, and serves content from the origin.

updateDistribution_distributionName :: Lens' UpdateDistribution Text Source #

The name of the distribution to update.

Use the GetDistributions action to get a list of distribution names that you can specify.

Destructuring the Response

data UpdateDistributionResponse Source #

See: newUpdateDistributionResponse smart constructor.

Constructors

UpdateDistributionResponse' 

Fields

  • operation :: Maybe Operation

    An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic UpdateDistributionResponse Source # 
Instance details

Defined in Amazonka.Lightsail.UpdateDistribution

Associated Types

type Rep UpdateDistributionResponse :: Type -> Type #

Methods

from :: UpdateDistributionResponse -> Rep UpdateDistributionResponse x #

to :: Rep UpdateDistributionResponse x -> UpdateDistributionResponse #

Read UpdateDistributionResponse Source # 
Instance details

Defined in Amazonka.Lightsail.UpdateDistribution

Methods

readsPrec :: Int -> ReadS UpdateDistributionResponse #

readList :: ReadS [UpdateDistributionResponse] #

readPrec :: ReadPrec UpdateDistributionResponse #

readListPrec :: ReadPrec [UpdateDistributionResponse] #

Show UpdateDistributionResponse Source # 
Instance details

Defined in Amazonka.Lightsail.UpdateDistribution

Methods

showsPrec :: Int -> UpdateDistributionResponse -> ShowS #

show :: UpdateDistributionResponse -> String #

showList :: [UpdateDistributionResponse] -> ShowS #

NFData UpdateDistributionResponse Source # 
Instance details

Defined in Amazonka.Lightsail.UpdateDistribution

Methods

rnf :: UpdateDistributionResponse -> () #

Eq UpdateDistributionResponse Source # 
Instance details

Defined in Amazonka.Lightsail.UpdateDistribution

Methods

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

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

type Rep UpdateDistributionResponse Source # 
Instance details

Defined in Amazonka.Lightsail.UpdateDistribution

type Rep UpdateDistributionResponse = D1 ('MetaData "UpdateDistributionResponse" "Amazonka.Lightsail.UpdateDistribution" "amazonka-lightsail-2.0-77hvsZhtZFxFduYae8QaN0" 'False) (C1 ('MetaCons "UpdateDistributionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "operation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Operation)) :*: 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:operation:UpdateDistributionResponse', updateDistributionResponse_operation - An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

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

Response Lenses

updateDistributionResponse_operation :: Lens' UpdateDistributionResponse (Maybe Operation) Source #

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

updateDistributionResponse_httpStatus :: Lens' UpdateDistributionResponse Int Source #

The response's http status code.