Interface IRealtimeLogConfigProps

Properties for defining a RealtimeLogConfig resource.

Namespace: Amazon.CDK.AWS.CloudFront

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IRealtimeLogConfigProps

Syntax (vb)

Public Interface IRealtimeLogConfigProps

Remarks

ExampleMetadata: infused

Examples

// Adding realtime logs config to a Cloudfront Distribution on default behavior.
using Amazon.CDK.AWS.Kinesis;

Stream stream;


var realTimeConfig = new RealtimeLogConfig(this, "realtimeLog", new RealtimeLogConfigProps {
    EndPoints = new [] { Endpoint.FromKinesisStream(stream) },
    Fields = new [] { "timestamp", "c-ip", "time-to-first-byte", "sc-status" },
    RealtimeLogConfigName = "my-delivery-stream",
    SamplingRate = 100
});

new Distribution(this, "myCdn", new DistributionProps {
    DefaultBehavior = new BehaviorOptions {
        Origin = new HttpOrigin("www.example.com"),
        RealtimeLogConfig = realTimeConfig
    }
});

Synopsis

Properties

EndPoints	Contains information about the Amazon Kinesis data stream where you are sending real-time log data for this real-time log configuration.
Fields	A list of fields that are included in each real-time log record.
RealtimeLogConfigName	The unique name of this real-time log configuration.
SamplingRate	The sampling rate for this real-time log configuration.

Properties

EndPoints

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

Endpoint[] EndPoints { get; }

Property Value

Endpoint[]

Fields

A list of fields that are included in each real-time log record.

string[] Fields { get; }

Property Value

System.String[]

Remarks

See: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html#understand-real-time-log-config-fields

RealtimeLogConfigName

The unique name of this real-time log configuration.

virtual string RealtimeLogConfigName { get; }

Property Value

System.String

Remarks

Default: - the unique construct ID

SamplingRate

The sampling rate for this real-time log configuration.

double SamplingRate { get; }

Property Value

System.Double