Package software.amazon.awscdk.cfnpropertymixins.services.cloudfront

Interface CfnRealtimeLogConfigMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRealtimeLogConfigMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:57.106Z")
@Stability(Stable)
public interface CfnRealtimeLogConfigMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnRealtimeLogConfigPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.cloudfront.*;
 CfnRealtimeLogConfigMixinProps cfnRealtimeLogConfigMixinProps = CfnRealtimeLogConfigMixinProps.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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-realtimelogconfig.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnRealtimeLogConfigMixinProps.Builder	builder()
default Object	getEndPoints()	Contains information about the Amazon Kinesis data stream where you are sending real-time log data for this real-time log configuration.
default List<String>	getFields()	A list of fields that are included in each real-time log record.
default String	getName()	The unique name of this real-time log configuration.
default 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)
@Nullable
default Object getEndPoints()

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

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnRealtimeLogConfigPropsMixin.EndPointProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-realtimelogconfig.html#cfn-cloudfront-realtimelogconfig-endpoints

getFields

@Stability(Stable)
@Nullable
default List<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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-realtimelogconfig.html#cfn-cloudfront-realtimelogconfig-fields

getName

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

The unique name of this real-time log configuration.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-realtimelogconfig.html#cfn-cloudfront-realtimelogconfig-name

getSamplingRate

@Stability(Stable)
@Nullable
default 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-realtimelogconfig.html#cfn-cloudfront-realtimelogconfig-samplingrate

builder

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

Returns:

a CfnRealtimeLogConfigMixinProps.Builder of CfnRealtimeLogConfigMixinProps