Package software.amazon.awscdk.services.cloudfront

Class CfnRealtimeLogConfig

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.cloudfront.CfnRealtimeLogConfig
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:43.603Z") @Stability(Stable) public class CfnRealtimeLogConfig extends CfnResource implements IInspectable
A CloudFormation AWS::CloudFront::RealtimeLogConfig.

A real-time log configuration.

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.*;
 CfnRealtimeLogConfig cfnRealtimeLogConfig = CfnRealtimeLogConfig.Builder.create(this, "MyCfnRealtimeLogConfig")
         .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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnRealtimeLogConfig

      protected CfnRealtimeLogConfig(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnRealtimeLogConfig

      protected CfnRealtimeLogConfig(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnRealtimeLogConfig

      @Stability(Stable) public CfnRealtimeLogConfig(@NotNull Construct scope, @NotNull String id, @NotNull CfnRealtimeLogConfigProps props)
      Create a new AWS::CloudFront::RealtimeLogConfig.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the real-time log configuration.

      For example: arn:aws:cloudfront::111122223333:realtime-log-config/ExampleNameForRealtimeLogConfig .

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getEndPoints

      @Stability(Stable) @NotNull public Object getEndPoints()
      Contains information about the Amazon Kinesis data stream where you are sending real-time log data for this real-time log configuration.

    • setEndPoints

      @Stability(Stable) public void setEndPoints(@NotNull IResolvable value)
      Contains information about the Amazon Kinesis data stream where you are sending real-time log data for this real-time log configuration.

    • setEndPoints

      @Stability(Stable) public void setEndPoints(@NotNull List<Object> value)
      Contains information about the Amazon Kinesis data stream where you are sending real-time log data for this real-time log configuration.

    • getFields

      @Stability(Stable) @NotNull public 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 .

    • setFields

      @Stability(Stable) public void setFields(@NotNull List<String> value)
      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

      @Stability(Stable) @NotNull public String getName()
      The unique name of this real-time log configuration.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The unique name of this real-time log configuration.

    • getSamplingRate

      @Stability(Stable) @NotNull public 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.

    • setSamplingRate

      @Stability(Stable) public void setSamplingRate(@NotNull Number value)
      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.