Skip to content

Update Realtime Log Config

cloudfront_update_realtime_log_config R Documentation

Updates a real-time log configuration

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 get_realtime_log_config 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 (update_realtime_log_config) 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.

Usage

cloudfront_update_realtime_log_config(EndPoints, Fields, Name, ARN,
  SamplingRate)

Arguments

EndPoints

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

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.

Name

The name for this real-time log configuration.

ARN

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

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.

Value

A list with the following syntax: 

list(
  RealtimeLogConfig = list(
    ARN = "string",
    Name = "string",
    SamplingRate = 123,
    EndPoints = list(
      list(
        StreamType = "string",
        KinesisStreamConfig = list(
          RoleARN = "string",
          StreamARN = "string"
        )
      )
    ),
    Fields = list(
      "string"
    )
  )
)

Request syntax

svc$update_realtime_log_config(
  EndPoints = list(
    list(
      StreamType = "string",
      KinesisStreamConfig = list(
        RoleARN = "string",
        StreamARN = "string"
      )
    )
  ),
  Fields = list(
    "string"
  ),
  Name = "string",
  ARN = "string",
  SamplingRate = 123
)