aws-cdk-lib.aws_cloudfront.Endpoint

Endpoint Class

Represents the endpoints available for targetting within a realtime log config resource.

Source

aws-cloudfront/lib/endpoint.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,
  },
});

Methods

fromKinesisStream(stream: IStream, role?: IRole): Endpoint // chainable@staticmethod def from_kinesis_stream(stream: IStream, role: typing.Optional[IRole] = None) -> Endpointpublic static Endpoint fromKinesisStream(IStream stream, IRole role)public static Endpoint FromKinesisStream(IStream stream, IRole? role = null)func FromKinesisStream(Stream IStream, Role IRole) Endpointstatic#

Configure a Kinesis Stream Endpoint for Realtime Log Config.