Package software.amazon.awscdk.services.cloudfront

Class RealtimeLogConfig.Builder

java.lang.Object

software.amazon.awscdk.services.cloudfront.RealtimeLogConfig.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<RealtimeLogConfig>

Enclosing class:

RealtimeLogConfig

@Stability(Stable)
public static final class RealtimeLogConfig.Builder
extends Object
implements software.amazon.jsii.Builder<RealtimeLogConfig>

A fluent builder for RealtimeLogConfig.

Method Summary

Modifier and Type	Method	Description
RealtimeLogConfig	build()
static RealtimeLogConfig.Builder	create(software.constructs.Construct scope, String id)
RealtimeLogConfig.Builder	endPoints(List<? extends Endpoint> endPoints)	Contains information about the Amazon Kinesis data stream where you are sending real-time log data for this real-time log configuration.
RealtimeLogConfig.Builder	fields(List<String> fields)	A list of fields that are included in each real-time log record.
RealtimeLogConfig.Builder	realtimeLogConfigName(String realtimeLogConfigName)	The unique name of this real-time log configuration.
RealtimeLogConfig.Builder	samplingRate(Number samplingRate)	The sampling rate for this real-time log configuration.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static RealtimeLogConfig.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of RealtimeLogConfig.Builder.

endPoints

@Stability(Stable)
public RealtimeLogConfig.Builder endPoints(List<? extends Endpoint> endPoints)

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

Parameters:

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

Returns:

this

fields

@Stability(Stable)
public RealtimeLogConfig.Builder fields(List<String> fields)

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

Parameters:

fields - A list of fields that are included in each real-time log record. This parameter is required.

Returns:

this

See Also:

• https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html#understand-real-time-log-config-fields

samplingRate

@Stability(Stable)
public RealtimeLogConfig.Builder samplingRate(Number samplingRate)

The sampling rate for this real-time log configuration.

Parameters:

samplingRate - The sampling rate for this real-time log configuration. This parameter is required.

Returns:

this

realtimeLogConfigName

@Stability(Stable)
public RealtimeLogConfig.Builder realtimeLogConfigName(String realtimeLogConfigName)

The unique name of this real-time log configuration.

Default: - the unique construct ID

Parameters:

realtimeLogConfigName - The unique name of this real-time log configuration. This parameter is required.

Returns:

this

build

@Stability(Stable)
public RealtimeLogConfig build()

Specified by:

build in interface software.amazon.jsii.Builder<RealtimeLogConfig>

Returns:

a newly built instance of RealtimeLogConfig.