AWS::CloudFront::RealtimeLogConfig - AWS CloudFormation
SyntaxPropertiesReturn values

AWS::CloudFront::RealtimeLogConfig

A real-time log configuration.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::CloudFront::RealtimeLogConfig",
  "Properties" : {
      "EndPoints" : [ EndPoint, ... ],
      "Fields" : [ String, ... ],
      "Name" : String,
      "SamplingRate" : Number
    }
}

YAML

Type: AWS::CloudFront::RealtimeLogConfig
Properties:
  EndPoints: 
    - EndPoint
  Fields: 
    - String
  Name: String
  SamplingRate: Number

Properties

EndPoints

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

Required: Yes

Type: Array of EndPoint

Minimum: 1

Update requires: No interruption

Fields

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.

Required: Yes

Type: Array of String

Minimum: 1

Update requires: No interruption

Name

The unique name of this real-time log configuration.

Required: Yes

Type: String

Update requires: Replacement

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

Required: Yes

Type: Number

Minimum: 1

Maximum: 100

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the Amazon Resource Name (ARN) of the real-time log configuration. For example: arn:aws:cloudfront::111122223333:realtime-log-config/ExampleNameForRealtimeLogConfig.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn

The Amazon Resource Name (ARN) of the real-time log configuration. For example: arn:aws:cloudfront::111122223333:realtime-log-config/ExampleNameForRealtimeLogConfig.