Skip to content
v2.277.0

CfnRealtimeLogConfigProps Struct ​

Properties for defining a CfnRealtimeLogConfig.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cloudfront as cloudfront } from 'aws-cdk-lib';
const cfnRealtimeLogConfigProps: cloudfront.CfnRealtimeLogConfigProps = {
  endPoints: [{
    kinesisStreamConfig: {
      roleArn: 'roleArn',
      streamArn: 'streamArn',
    },
    streamType: 'streamType',
  }],
  fields: ['fields'],
  name: 'name',
  samplingRate: 123,
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_cloudfront as cloudfront

cfn_realtime_log_config_props = cloudfront.CfnRealtimeLogConfigProps(
    end_points=[cloudfront.CfnRealtimeLogConfig.EndPointProperty(
        kinesis_stream_config=cloudfront.CfnRealtimeLogConfig.KinesisStreamConfigProperty(
            role_arn="roleArn",
            stream_arn="streamArn"
        ),
        stream_type="streamType"
    )],
    fields=["fields"],
    name="name",
    sampling_rate=123
)
java
// 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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CloudFront;

var cfnRealtimeLogConfigProps = new CfnRealtimeLogConfigProps {
    EndPoints = new [] { new EndPointProperty {
        KinesisStreamConfig = new KinesisStreamConfigProperty {
            RoleArn = "roleArn",
            StreamArn = "streamArn"
        },
        StreamType = "streamType"
    } },
    Fields = new [] { "fields" },
    Name = "name",
    SamplingRate = 123
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnRealtimeLogConfigProps := &CfnRealtimeLogConfigProps{
	EndPoints: []interface{}{
		&EndPointProperty{
			KinesisStreamConfig: &KinesisStreamConfigProperty{
				RoleArn: jsii.String("roleArn"),
				StreamArn: jsii.String("streamArn"),
			},
			StreamType: jsii.String("streamType"),
		},
	},
	Fields: []*string{
		jsii.String("fields"),
	},
	Name: jsii.String("name"),
	SamplingRate: jsii.Number(123),
}

Properties ​

endPointsIResolvable | IResolvable | CfnRealtimeLogConfig.EndPointProperty[]end_pointstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, EndPointProperty]]]endPointsIResolvableEndPointsIResolvableEndPointsinterface{} required #
Contains information about the Amazon Kinesis data stream where you are sending real-time log data for this real-time log configuration.
fieldsstring[]fieldstyping.List[str]fieldsList<String>Fieldsstring[]Fields*[]*string required #
A list of fields that are included in each real-time log record.
notes

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 .

namestringnamestrnameStringNamestringName*string required #
The unique name of this real-time log configuration.
samplingRatenumbersampling_rateint | floatsamplingRateNumberSamplingRatedoubleSamplingRate*float64 required #
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.