Package software.amazon.awscdk.services.cloudfront

Interface CfnRealtimeLogConfigProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRealtimeLogConfigProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-24T21:00:26.659Z")
@Stability(Stable)
public interface CfnRealtimeLogConfigProps
extends software.amazon.jsii.JsiiSerializable

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

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	CfnRealtimeLogConfigProps.Builder	A builder for CfnRealtimeLogConfigProps
static final class	CfnRealtimeLogConfigProps.Jsii$Proxy	An implementation for CfnRealtimeLogConfigProps

Method Summary

Modifier and Type	Method	Description
static CfnRealtimeLogConfigProps.Builder	builder()
Object	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.
String	getName()	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
Object getEndPoints()

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

See Also:

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

getFields

@Stability(Stable)
@NotNull
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)
@NotNull
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)
@NotNull
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 CfnRealtimeLogConfigProps.Builder builder()

Returns:

a CfnRealtimeLogConfigProps.Builder of CfnRealtimeLogConfigProps