Skip to content
v2.277.0

RealtimeLogConfigProps Struct ​

Properties for defining a RealtimeLogConfig resource.

Example ​

ts
// Adding realtime logs config to a Cloudfront Distribution on default behavior.
import * as kinesis from 'aws-cdk-lib/aws-kinesis';

declare const stream: kinesis.Stream;

const realTimeConfig = new cloudfront.RealtimeLogConfig(this, 'realtimeLog', {
  endPoints: [
    cloudfront.Endpoint.fromKinesisStream(stream),
  ],
  fields: [
    'timestamp',
    'c-ip',
    'time-to-first-byte',
    'sc-status',
  ],
  realtimeLogConfigName: 'my-delivery-stream',
  samplingRate: 100,
});

new cloudfront.Distribution(this, 'myCdn', {
  defaultBehavior: {
    origin: new origins.HttpOrigin('www.example.com'),
    realtimeLogConfig: realTimeConfig,
  },
});
python
# Adding realtime logs config to a Cloudfront Distribution on default behavior.
import aws_cdk.aws_kinesis as kinesis

# stream: kinesis.Stream


real_time_config = cloudfront.RealtimeLogConfig(self, "realtimeLog",
    end_points=[
        cloudfront.Endpoint.from_kinesis_stream(stream)
    ],
    fields=["timestamp", "c-ip", "time-to-first-byte", "sc-status"
    ],
    realtime_log_config_name="my-delivery-stream",
    sampling_rate=100
)

cloudfront.Distribution(self, "myCdn",
    default_behavior=cloudfront.BehaviorOptions(
        origin=origins.HttpOrigin("www.example.com"),
        realtime_log_config=real_time_config
    )
)
java
// Adding realtime logs config to a Cloudfront Distribution on default behavior.
import software.amazon.awscdk.services.kinesis.*;

Stream stream;


RealtimeLogConfig realTimeConfig = RealtimeLogConfig.Builder.create(this, "realtimeLog")
        .endPoints(List.of(Endpoint.fromKinesisStream(stream)))
        .fields(List.of("timestamp", "c-ip", "time-to-first-byte", "sc-status"))
        .realtimeLogConfigName("my-delivery-stream")
        .samplingRate(100)
        .build();

Distribution.Builder.create(this, "myCdn")
        .defaultBehavior(BehaviorOptions.builder()
                .origin(new HttpOrigin("www.example.com"))
                .realtimeLogConfig(realTimeConfig)
                .build())
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// 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
    }
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// Adding realtime logs config to a Cloudfront Distribution on default behavior.
import kinesis "github.com/aws/aws-cdk-go/awscdk"

var stream Stream


realTimeConfig := cloudfront.NewRealtimeLogConfig(this, jsii.String("realtimeLog"), &RealtimeLogConfigProps{
	EndPoints: []Endpoint{
		cloudfront.Endpoint_FromKinesisStream(stream),
	},
	Fields: []*string{
		jsii.String("timestamp"),
		jsii.String("c-ip"),
		jsii.String("time-to-first-byte"),
		jsii.String("sc-status"),
	},
	RealtimeLogConfigName: jsii.String("my-delivery-stream"),
	SamplingRate: jsii.Number(100),
})

cloudfront.NewDistribution(this, jsii.String("myCdn"), &DistributionProps{
	DefaultBehavior: &BehaviorOptions{
		Origin: origins.NewHttpOrigin(jsii.String("www.example.com")),
		RealtimeLogConfig: realTimeConfig,
	},
})

Properties ​

endPointsEndpoint[]end_pointstyping.List[Endpoint]endPointsList<Endpoint>EndPointsEndpoint[]EndPoints*[]Endpoint required #
Contains information about the Amazon Kinesis data stream where you are sending real-time log data for this real-time log configuration.
fieldsstring[]fieldstyping.List[str]fieldsList<String>Fieldsstring[]Fields*[]*string required #
A list of fields that are included in each real-time log record.
realtimeLogConfigNameoptionalstringrealtime_log_config_nameoptionalstrrealtimeLogConfigNameoptionalStringRealtimeLogConfigNameoptionalstringRealtimeLogConfigNameoptional*string #
The unique name of this real-time log configuration.

Default: the unique construct ID

samplingRatenumbersampling_rateint | floatsamplingRateNumberSamplingRatedoubleSamplingRate*float64 required #
The sampling rate for this real-time log configuration.