Package software.amazon.awscdk.services.cloudfront

Class CfnRealtimeLogConfig

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.cloudfront.CfnRealtimeLogConfig
All Implemented Interfaces:
IInspectable, IRealtimeLogConfigRef, IEnvironmentAware, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-12-01T16:02:16.162Z") @Stability(Stable) public class CfnRealtimeLogConfig extends CfnResource implements IInspectable, IRealtimeLogConfigRef
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();

See Also:

  • 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 software.constructs.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 - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForRealtimeLogConfig

      @Stability(Stable) @NotNull public static String arnForRealtimeLogConfig(@NotNull IRealtimeLogConfigRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnRealtimeLogConfig

      @Stability(Stable) @NotNull public static Boolean isCfnRealtimeLogConfig(@NotNull Object x)
      Checks whether the given object is a CfnRealtimeLogConfig.

      Parameters:
      x - This parameter is required.

    • 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

    • getRealtimeLogConfigRef

      @Stability(Stable) @NotNull public RealtimeLogConfigReference getRealtimeLogConfigRef()
      A reference to a RealtimeLogConfig resource.
      Specified by:
      getRealtimeLogConfigRef in interface IRealtimeLogConfigRef

    • 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.

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

    • 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.

    • setFields

      @Stability(Stable) public void setFields(@NotNull List<String> value)
      A list of fields that are included in each real-time log record.

    • 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.

    • setSamplingRate

      @Stability(Stable) public void setSamplingRate(@NotNull Number value)
      The sampling rate for this real-time log configuration.