Interface RealtimeLogConfigProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
RealtimeLogConfigProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-11-22T02:23:58.324Z")
@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
Modifier and TypeInterfaceDescriptionstatic final class
A builder forRealtimeLogConfigProps
static final class
An implementation forRealtimeLogConfigProps
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Contains information about the Amazon Kinesis data stream where you are sending real-time log data for this real-time log configuration.A list of fields that are included in each real-time log record.default String
The unique name of this real-time log configuration.The sampling rate for this real-time log configuration.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getEndPoints
Contains information about the Amazon Kinesis data stream where you are sending real-time log data for this real-time log configuration. -
getFields
A list of fields that are included in each real-time log record.- See Also:
-
getSamplingRate
The sampling rate for this real-time log configuration. -
getRealtimeLogConfigName
The unique name of this real-time log configuration.Default: - the unique construct ID
-
builder
- Returns:
- a
RealtimeLogConfigProps.Builder
ofRealtimeLogConfigProps
-