CfnRealtimeLogConfigProps

class aws_cdk.aws_cloudfront.CfnRealtimeLogConfigProps(*, end_points, fields, name, sampling_rate)

Bases: object

Properties for defining a CfnRealtimeLogConfig.

Parameters
  • end_points (Union[IResolvable, Sequence[Union[IResolvable, EndPointProperty, Dict[str, Any]]]]) – Contains information about the Amazon Kinesis data stream where you are sending real-time log data for this real-time log configuration.

  • fields (Sequence[str]) – 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 .

  • name (str) – The unique name of this real-time log configuration.

  • sampling_rate (Union[int, float]) – 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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-realtimelogconfig.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_cloudfront as cloudfront

cfn_realtime_log_config_props = cloudfront.CfnRealtimeLogConfigProps(
    end_points=[cloudfront.CfnRealtimeLogConfig.EndPointProperty(
        kinesis_stream_config=cloudfront.CfnRealtimeLogConfig.KinesisStreamConfigProperty(
            role_arn="roleArn",
            stream_arn="streamArn"
        ),
        stream_type="streamType"
    )],
    fields=["fields"],
    name="name",
    sampling_rate=123
)

Attributes

end_points

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-realtimelogconfig.html#cfn-cloudfront-realtimelogconfig-endpoints

Return type

Union[IResolvable, List[Union[IResolvable, EndPointProperty]]]

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 .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-realtimelogconfig.html#cfn-cloudfront-realtimelogconfig-fields

Return type

List[str]

name

The unique name of this real-time log configuration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-realtimelogconfig.html#cfn-cloudfront-realtimelogconfig-name

Return type

str

sampling_rate

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-realtimelogconfig.html#cfn-cloudfront-realtimelogconfig-samplingrate

Return type

Union[int, float]