aws-cdk-lib.aws_cloudfront.RealtimeLogConfigProps

RealtimeLogConfigProps Struct

Properties for defining a RealtimeLogConfig resource.

RealtimeLogConfigProps

used as props by

• RealtimeLogConfig

Source

aws-cloudfront/lib/realtime-log-config.ts

Type last changed

v2.94.0 · 1 Sep 2023

Example

// 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,
  },
});

Properties

endPointsEndpoint[]end_pointstyping.List[Endpoint]endPointsList<Endpoint>EndPointsEndpoint[]EndPoints*[]Endpointrequired#

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*[]*stringrequired#

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

realtimeLogConfigNamestringrealtime_log_config_namestrrealtimeLogConfigNameStringRealtimeLogConfigNamestringRealtimeLogConfigName*string#

The unique name of this real-time log configuration.

Default: the unique construct ID

samplingRatenumbersampling_rateint | floatsamplingRateNumberSamplingRatedoubleSamplingRate*float64required#

The sampling rate for this real-time log configuration.