cloudfront_create_realtime_log_config: Creates a real-time log configuration

Description Usage Arguments Value Request syntax

View source: R/cloudfront_operations.R

Description

Creates a real-time log configuration.

After you create a real-time log configuration, you can attach it to one or more cache behaviors to send real-time log data to the specified Amazon Kinesis data stream.

For more information about real-time log configurations, see Real-time logs in the Amazon CloudFront Developer Guide.

Usage

1
2
cloudfront_create_realtime_log_config(EndPoints, Fields, Name,
  SamplingRate)

Arguments

EndPoints

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

Fields

[required] 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

[required] A unique name to identify this real-time log configuration.

SamplingRate

[required] 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:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
svc$create_realtime_log_config(
  EndPoints = list(
    list(
      StreamType = "string",
      KinesisStreamConfig = list(
        RoleARN = "string",
        StreamARN = "string"
      )
    )
  ),
  Fields = list(
    "string"
  ),
  Name = "string",
  SamplingRate = 123
)

paws.networking documentation built on March 7, 2021, 5:08 p.m.