AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . cloudfront ]

create-realtime-log-config

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 .

See also: AWS API Documentation

Synopsis

  create-realtime-log-config
--end-points <value>
--fields <value>
--name <value>
--sampling-rate <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--end-points (list)

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

(structure)

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 -> (structure)

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.

Shorthand Syntax:

StreamType=string,KinesisStreamConfig={RoleARN=string,StreamARN=string} ...

JSON Syntax:

[
  {
    "StreamType": "string",
    "KinesisStreamConfig": {
      "RoleARN": "string",
      "StreamARN": "string"
    }
  }
  ...
]

--fields (list)

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)

Syntax:

"string" "string" ...

--name (string)

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

--sampling-rate (long)

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.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

RealtimeLogConfig -> (structure)

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 -> (long)

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.

(structure)

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 -> (structure)

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)