Package software.amazon.awscdk.services.cloudfront

Interface RealtimeLogConfigProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

RealtimeLogConfigProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-02T15:58:22.550Z")
@Stability(Stable)
public interface RealtimeLogConfigProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a RealtimeLogConfig resource.

Example:

 // 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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	RealtimeLogConfigProps.Builder	A builder for RealtimeLogConfigProps
static final class	RealtimeLogConfigProps.Jsii$Proxy	An implementation for RealtimeLogConfigProps

Method Summary

Modifier and Type	Method	Description
static RealtimeLogConfigProps.Builder	builder()
List<Endpoint>	getEndPoints()	Contains information about the Amazon Kinesis data stream where you are sending real-time log data for this real-time log configuration.
List<String>	getFields()	A list of fields that are included in each real-time log record.
default String	getRealtimeLogConfigName()	The unique name of this real-time log configuration.
Number	getSamplingRate()	The sampling rate for this real-time log configuration.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEndPoints

@Stability(Stable)
@NotNull
List<Endpoint> getEndPoints()

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

getFields

@Stability(Stable)
@NotNull
List<String> getFields()

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

See Also:

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

getSamplingRate

@Stability(Stable)
@NotNull
Number getSamplingRate()

The sampling rate for this real-time log configuration.

getRealtimeLogConfigName

@Stability(Stable)
@Nullable
default String getRealtimeLogConfigName()

The unique name of this real-time log configuration.

Default: - the unique construct ID

builder

@Stability(Stable)
static RealtimeLogConfigProps.Builder builder()

Returns:

a RealtimeLogConfigProps.Builder of RealtimeLogConfigProps