libZSservicesZSamazonka-cloudfrontZSamazonka-cloudfront
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CloudFront.UpdateRealtimeLogConfig

Description

Updates a real-time log configuration.

When you update a real-time log configuration, all the parameters are updated with the values provided in the request. You cannot update some parameters independent of others. To update a real-time log configuration:

  1. Call GetRealtimeLogConfig to get the current real-time log configuration.
  2. Locally modify the parameters in the real-time log configuration that you want to update.
  3. Call this API (UpdateRealtimeLogConfig) by providing the entire real-time log configuration, including the parameters that you modified and those that you didn’t.

You cannot update a real-time log configuration’s Name or ARN.

Synopsis

Creating a Request

data UpdateRealtimeLogConfig Source #

See: newUpdateRealtimeLogConfig smart constructor.

Constructors

UpdateRealtimeLogConfig' 

Fields

  • arn :: Maybe Text

    The Amazon Resource Name (ARN) for this real-time log configuration.

  • samplingRate :: Maybe Integer

    The sampling rate for this real-time log configuration. The sampling rate determines the percentage of viewer requests that are represented in the real-time log data. You must provide an integer between 1 and 100, inclusive.

  • name :: Maybe Text

    The name for this real-time log configuration.

  • endPoints :: Maybe [EndPoint]

    Contains information about the Amazon Kinesis data stream where you are sending real-time log data.

  • fields :: Maybe [Text]

    A list of fields to include in each real-time log record.

    For more information about fields, see Real-time log configuration fields in the Amazon CloudFront Developer Guide.

Instances

Instances details
Eq UpdateRealtimeLogConfig Source # 
Instance details

Defined in Amazonka.CloudFront.UpdateRealtimeLogConfig

Methods

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

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

Read UpdateRealtimeLogConfig Source # 
Instance details

Defined in Amazonka.CloudFront.UpdateRealtimeLogConfig

Methods

readsPrec :: Int -> ReadS UpdateRealtimeLogConfig #

readList :: ReadS [UpdateRealtimeLogConfig] #

readPrec :: ReadPrec UpdateRealtimeLogConfig #

readListPrec :: ReadPrec [UpdateRealtimeLogConfig] #

Show UpdateRealtimeLogConfig Source # 
Instance details

Defined in Amazonka.CloudFront.UpdateRealtimeLogConfig

Methods

showsPrec :: Int -> UpdateRealtimeLogConfig -> ShowS #

show :: UpdateRealtimeLogConfig -> String #

showList :: [UpdateRealtimeLogConfig] -> ShowS #

Generic UpdateRealtimeLogConfig Source # 
Instance details

Defined in Amazonka.CloudFront.UpdateRealtimeLogConfig

Associated Types

type Rep UpdateRealtimeLogConfig :: Type -> Type #

Methods

from :: UpdateRealtimeLogConfig -> Rep UpdateRealtimeLogConfig x #

to :: Rep UpdateRealtimeLogConfig x -> UpdateRealtimeLogConfig #

NFData UpdateRealtimeLogConfig Source # 
Instance details

Defined in Amazonka.CloudFront.UpdateRealtimeLogConfig

Methods

rnf :: UpdateRealtimeLogConfig -> () #

Hashable UpdateRealtimeLogConfig Source # 
Instance details

Defined in Amazonka.CloudFront.UpdateRealtimeLogConfig

Methods

hashWithSalt :: Int -> UpdateRealtimeLogConfig -> Int #

hash :: UpdateRealtimeLogConfig -> Int #

AWSRequest UpdateRealtimeLogConfig Source # 
Instance details

Defined in Amazonka.CloudFront.UpdateRealtimeLogConfig

Associated Types

type AWSResponse UpdateRealtimeLogConfig #

Methods

request :: UpdateRealtimeLogConfig -> Request UpdateRealtimeLogConfig #

response :: MonadResource m => Logger -> Service -> Proxy UpdateRealtimeLogConfig -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateRealtimeLogConfig))) #

ToHeaders UpdateRealtimeLogConfig Source # 
Instance details

Defined in Amazonka.CloudFront.UpdateRealtimeLogConfig

Methods

toHeaders :: UpdateRealtimeLogConfig -> [Header] #

ToPath UpdateRealtimeLogConfig Source # 
Instance details

Defined in Amazonka.CloudFront.UpdateRealtimeLogConfig

Methods

toPath :: UpdateRealtimeLogConfig -> ByteString #

ToQuery UpdateRealtimeLogConfig Source # 
Instance details

Defined in Amazonka.CloudFront.UpdateRealtimeLogConfig

Methods

toQuery :: UpdateRealtimeLogConfig -> QueryString #

ToElement UpdateRealtimeLogConfig Source # 
Instance details

Defined in Amazonka.CloudFront.UpdateRealtimeLogConfig

Methods

toElement :: UpdateRealtimeLogConfig -> Element #

ToXML UpdateRealtimeLogConfig Source # 
Instance details

Defined in Amazonka.CloudFront.UpdateRealtimeLogConfig

Methods

toXML :: UpdateRealtimeLogConfig -> XML #

type Rep UpdateRealtimeLogConfig Source # 
Instance details

Defined in Amazonka.CloudFront.UpdateRealtimeLogConfig

type Rep UpdateRealtimeLogConfig = D1 ('MetaData "UpdateRealtimeLogConfig" "Amazonka.CloudFront.UpdateRealtimeLogConfig" "libZSservicesZSamazonka-cloudfrontZSamazonka-cloudfront" 'False) (C1 ('MetaCons "UpdateRealtimeLogConfig'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "samplingRate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "endPoints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EndPoint])) :*: S1 ('MetaSel ('Just "fields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))))
type AWSResponse UpdateRealtimeLogConfig Source # 
Instance details

Defined in Amazonka.CloudFront.UpdateRealtimeLogConfig

type AWSResponse UpdateRealtimeLogConfig = UpdateRealtimeLogConfigResponse

newUpdateRealtimeLogConfig :: UpdateRealtimeLogConfig Source #

Create a value of UpdateRealtimeLogConfig 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:arn:UpdateRealtimeLogConfig', updateRealtimeLogConfig_arn - The Amazon Resource Name (ARN) for this real-time log configuration.

$sel:samplingRate:UpdateRealtimeLogConfig', updateRealtimeLogConfig_samplingRate - The sampling rate for this real-time log configuration. The sampling rate determines the percentage of viewer requests that are represented in the real-time log data. You must provide an integer between 1 and 100, inclusive.

$sel:name:UpdateRealtimeLogConfig', updateRealtimeLogConfig_name - The name for this real-time log configuration.

$sel:endPoints:UpdateRealtimeLogConfig', updateRealtimeLogConfig_endPoints - Contains information about the Amazon Kinesis data stream where you are sending real-time log data.

$sel:fields:UpdateRealtimeLogConfig', updateRealtimeLogConfig_fields - A list of fields to include in each real-time log record.

For more information about fields, see Real-time log configuration fields in the Amazon CloudFront Developer Guide.

Request Lenses

updateRealtimeLogConfig_arn :: Lens' UpdateRealtimeLogConfig (Maybe Text) Source #

The Amazon Resource Name (ARN) for this real-time log configuration.

updateRealtimeLogConfig_samplingRate :: Lens' UpdateRealtimeLogConfig (Maybe Integer) Source #

The sampling rate for this real-time log configuration. The sampling rate determines the percentage of viewer requests that are represented in the real-time log data. You must provide an integer between 1 and 100, inclusive.

updateRealtimeLogConfig_name :: Lens' UpdateRealtimeLogConfig (Maybe Text) Source #

The name for this real-time log configuration.

updateRealtimeLogConfig_endPoints :: Lens' UpdateRealtimeLogConfig (Maybe [EndPoint]) Source #

Contains information about the Amazon Kinesis data stream where you are sending real-time log data.

updateRealtimeLogConfig_fields :: Lens' UpdateRealtimeLogConfig (Maybe [Text]) Source #

A list of fields to include in each real-time log record.

For more information about fields, see Real-time log configuration fields in the Amazon CloudFront Developer Guide.

Destructuring the Response

data UpdateRealtimeLogConfigResponse Source #

See: newUpdateRealtimeLogConfigResponse smart constructor.

Constructors

UpdateRealtimeLogConfigResponse' 

Fields

Instances

Instances details
Eq UpdateRealtimeLogConfigResponse Source # 
Instance details

Defined in Amazonka.CloudFront.UpdateRealtimeLogConfig

Methods

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

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

Read UpdateRealtimeLogConfigResponse Source # 
Instance details

Defined in Amazonka.CloudFront.UpdateRealtimeLogConfig

Methods

readsPrec :: Int -> ReadS UpdateRealtimeLogConfigResponse #

readList :: ReadS [UpdateRealtimeLogConfigResponse] #

readPrec :: ReadPrec UpdateRealtimeLogConfigResponse #

readListPrec :: ReadPrec [UpdateRealtimeLogConfigResponse] #

Show UpdateRealtimeLogConfigResponse Source # 
Instance details

Defined in Amazonka.CloudFront.UpdateRealtimeLogConfig

Methods

showsPrec :: Int -> UpdateRealtimeLogConfigResponse -> ShowS #

show :: UpdateRealtimeLogConfigResponse -> String #

showList :: [UpdateRealtimeLogConfigResponse] -> ShowS #

Generic UpdateRealtimeLogConfigResponse Source # 
Instance details

Defined in Amazonka.CloudFront.UpdateRealtimeLogConfig

Associated Types

type Rep UpdateRealtimeLogConfigResponse :: Type -> Type #

Methods

from :: UpdateRealtimeLogConfigResponse -> Rep UpdateRealtimeLogConfigResponse x #

to :: Rep UpdateRealtimeLogConfigResponse x -> UpdateRealtimeLogConfigResponse #

NFData UpdateRealtimeLogConfigResponse Source # 
Instance details

Defined in Amazonka.CloudFront.UpdateRealtimeLogConfig

Methods

rnf :: UpdateRealtimeLogConfigResponse -> () #

type Rep UpdateRealtimeLogConfigResponse Source # 
Instance details

Defined in Amazonka.CloudFront.UpdateRealtimeLogConfig

type Rep UpdateRealtimeLogConfigResponse = D1 ('MetaData "UpdateRealtimeLogConfigResponse" "Amazonka.CloudFront.UpdateRealtimeLogConfig" "libZSservicesZSamazonka-cloudfrontZSamazonka-cloudfront" 'False) (C1 ('MetaCons "UpdateRealtimeLogConfigResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "realtimeLogConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RealtimeLogConfig)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateRealtimeLogConfigResponse Source #

Arguments

:: Int

$sel:httpStatus:UpdateRealtimeLogConfigResponse'

-> UpdateRealtimeLogConfigResponse 

Create a value of UpdateRealtimeLogConfigResponse 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:realtimeLogConfig:UpdateRealtimeLogConfigResponse', updateRealtimeLogConfigResponse_realtimeLogConfig - A real-time log configuration.

$sel:httpStatus:UpdateRealtimeLogConfigResponse', updateRealtimeLogConfigResponse_httpStatus - The response's http status code.

Response Lenses

updateRealtimeLogConfigResponse_realtimeLogConfig :: Lens' UpdateRealtimeLogConfigResponse (Maybe RealtimeLogConfig) Source #

A real-time log configuration.

updateRealtimeLogConfigResponse_httpStatus :: Lens' UpdateRealtimeLogConfigResponse Int Source #

The response's http status code.