software.amazon.awscdk.services.cloudfront

Interface CfnRealtimeLogConfigProps

All Known Implementing Classes:

CfnRealtimeLogConfigProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-25T18:29:07.281Z")
public interface CfnRealtimeLogConfigProps

Properties for defining a `CfnRealtimeLogConfig`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cloudfront.*;
 CfnRealtimeLogConfigProps cfnRealtimeLogConfigProps = CfnRealtimeLogConfigProps.builder()
         .endPoints(List.of(EndPointProperty.builder()
                 .kinesisStreamConfig(KinesisStreamConfigProperty.builder()
                         .roleArn("roleArn")
                         .streamArn("streamArn")
                         .build())
                 .streamType("streamType")
                 .build()))
         .fields(List.of("fields"))
         .name("name")
         .samplingRate(123)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

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

Method Detail

getEndPoints

java.lang.Object getEndPoints()

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

getFields

java.util.List<java.lang.String> getFields()

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

In an API response, the fields are provided in the same order in which they are sent to the Amazon Kinesis data stream.

For more information about fields, see Real-time log configuration fields in the Amazon CloudFront Developer Guide .

getName

java.lang.String getName()

The unique name of this real-time log configuration.

getSamplingRate

java.lang.Number getSamplingRate()

The sampling rate for this real-time log configuration.

The sampling rate determines the percentage of viewer requests that are represented in the real-time log data. The sampling rate is an integer between 1 and 100, inclusive.

builder

static CfnRealtimeLogConfigProps.Builder builder()

Returns:

a CfnRealtimeLogConfigProps.Builder of CfnRealtimeLogConfigProps