CreateRealtimeLogConfig
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.
Request Syntax
POST /2020-05-31/realtime-log-config HTTP/1.1
<?xml version="1.0" encoding="UTF-8"?>
<CreateRealtimeLogConfigRequest xmlns="http://cloudfront.amazonaws.com/doc/2020-05-31/">
<EndPoints>
<EndPoint>
<KinesisStreamConfig>
<RoleARN>string
</RoleARN>
<StreamARN>string
</StreamARN>
</KinesisStreamConfig>
<StreamType>string
</StreamType>
</EndPoint>
</EndPoints>
<Fields>
<Field>string
</Field>
</Fields>
<Name>string
</Name>
<SamplingRate>long
</SamplingRate>
</CreateRealtimeLogConfigRequest>
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in XML format.
- CreateRealtimeLogConfigRequest
-
Root level tag for the CreateRealtimeLogConfigRequest parameters.
Required: Yes
- EndPoints
-
Contains information about the Amazon Kinesis data stream where you are sending real-time log data.
Type: Array of EndPoint objects
Required: Yes
- 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.
Type: Array of strings
Required: Yes
- Name
-
A unique name to identify this real-time log configuration.
Type: String
Required: Yes
- SamplingRate
-
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.
Type: Long
Required: Yes
Response Syntax
HTTP/1.1 201
<?xml version="1.0" encoding="UTF-8"?>
<CreateRealtimeLogConfigResult>
<RealtimeLogConfig>
<ARN>string</ARN>
<EndPoints>
<EndPoint>
<KinesisStreamConfig>
<RoleARN>string</RoleARN>
<StreamARN>string</StreamARN>
</KinesisStreamConfig>
<StreamType>string</StreamType>
</EndPoint>
</EndPoints>
<Fields>
<Field>string</Field>
</Fields>
<Name>string</Name>
<SamplingRate>long</SamplingRate>
</RealtimeLogConfig>
</CreateRealtimeLogConfigResult>
Response Elements
If the action is successful, the service sends back an HTTP 201 response.
The following data is returned in XML format by the service.
- CreateRealtimeLogConfigResult
-
Root level tag for the CreateRealtimeLogConfigResult parameters.
Required: Yes
- RealtimeLogConfig
-
A real-time log configuration.
Type: RealtimeLogConfig object
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDenied
-
Access denied.
HTTP Status Code: 403
- InvalidArgument
-
An argument is invalid.
HTTP Status Code: 400
- RealtimeLogConfigAlreadyExists
-
A real-time log configuration with this name already exists. You must provide a unique name. To modify an existing real-time log configuration, use
UpdateRealtimeLogConfig
.HTTP Status Code: 409
- TooManyRealtimeLogConfigs
-
You have reached the maximum number of real-time log configurations for this Amazon Web Services account. For more information, see Quotas (formerly known as limits) in the Amazon CloudFront Developer Guide.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: