CloudFront / Client / create_realtime_log_config

create_realtime_log_config

CloudFront.Client.create_realtime_log_config(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.create_realtime_log_config(
    EndPoints=[
        {
            'StreamType': 'string',
            'KinesisStreamConfig': {
                'RoleARN': 'string',
                'StreamARN': 'string'
            }
        },
    ],
    Fields=[
        'string',
    ],
    Name='string',
    SamplingRate=123
)

Parameters:

• EndPoints (list) –

  [REQUIRED]

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

  • (dict) –

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

    • StreamType (string) – [REQUIRED]

      The type of data stream where you are sending real-time log data. The only valid value is Kinesis.

    • KinesisStreamConfig (dict) –

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

      • RoleARN (string) – [REQUIRED]

        The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFront can use to send real-time log data to your Kinesis data stream.

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

      • StreamARN (string) – [REQUIRED]

        The Amazon Resource Name (ARN) of the Kinesis data stream where you are sending real-time log data.

• Fields (list) –

  [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.

  • (string) –

• Name (string) –

  [REQUIRED]

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

• SamplingRate (integer) –

  [REQUIRED]

  The sampling rate for this real-time log configuration. You can specify a whole number between 1 and 100 (inclusive) to determine the percentage of viewer requests that are represented in the real-time log data.

Return type:

dict

Returns:

Response Syntax

{
    'RealtimeLogConfig': {
        'ARN': 'string',
        'Name': 'string',
        'SamplingRate': 123,
        'EndPoints': [
            {
                'StreamType': 'string',
                'KinesisStreamConfig': {
                    'RoleARN': 'string',
                    'StreamARN': 'string'
                }
            },
        ],
        'Fields': [
            'string',
        ]
    }
}

Response Structure

• (dict) –

  • RealtimeLogConfig (dict) –

    A real-time log configuration.

    • ARN (string) –

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

    • Name (string) –

      The unique name of this real-time log configuration.

    • SamplingRate (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. The sampling rate is an integer between 1 and 100, inclusive.

    • EndPoints (list) –

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

      • (dict) –

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

        • StreamType (string) –

          The type of data stream where you are sending real-time log data. The only valid value is Kinesis.

        • KinesisStreamConfig (dict) –

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

          • RoleARN (string) –

            The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFront can use to send real-time log data to your Kinesis data stream.

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

          • StreamARN (string) –

            The Amazon Resource Name (ARN) of the Kinesis data stream where you are sending real-time log data.

    • Fields (list) –

      A list of fields that are included in each real-time log record. In an API response, the fields are provided in the same order in which they are sent to the Amazon Kinesis data stream.

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

      • (string) –

Exceptions

• CloudFront.Client.exceptions.AccessDenied

• CloudFront.Client.exceptions.RealtimeLogConfigAlreadyExists

• CloudFront.Client.exceptions.TooManyRealtimeLogConfigs

• CloudFront.Client.exceptions.InvalidArgument