60 lines
2.0 KiB
TypeScript
60 lines
2.0 KiB
TypeScript
import type { Construct } from 'constructs';
|
|
import type { IRealtimeLogConfigRef, RealtimeLogConfigReference } from './cloudfront.generated';
|
|
import type { Endpoint } from '../';
|
|
import type { IResource } from '../../core';
|
|
import { Resource } from '../../core';
|
|
/**
|
|
* Represents Realtime Log Configuration
|
|
*/
|
|
export interface IRealtimeLogConfig extends IResource, IRealtimeLogConfigRef {
|
|
/**
|
|
* The name of the realtime log config.
|
|
* @attribute
|
|
*/
|
|
readonly realtimeLogConfigName: string;
|
|
/**
|
|
* The arn of the realtime log config.
|
|
* @attribute
|
|
*/
|
|
readonly realtimeLogConfigArn: string;
|
|
}
|
|
/**
|
|
* Properties for defining a RealtimeLogConfig resource.
|
|
*/
|
|
export interface RealtimeLogConfigProps {
|
|
/**
|
|
* The unique name of this real-time log configuration.
|
|
*
|
|
* @default - the unique construct ID
|
|
*/
|
|
readonly realtimeLogConfigName?: string;
|
|
/**
|
|
* A list of fields that are included in each real-time log record.
|
|
*
|
|
* @see https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html#understand-real-time-log-config-fields
|
|
*/
|
|
readonly fields: string[];
|
|
/**
|
|
* The sampling rate for this real-time log configuration.
|
|
*/
|
|
readonly samplingRate: number;
|
|
/**
|
|
* Contains information about the Amazon Kinesis data stream where you are sending real-time log data for this real-time log configuration.
|
|
*/
|
|
readonly endPoints: Endpoint[];
|
|
}
|
|
/**
|
|
* A Realtime Log Config configuration
|
|
*
|
|
* @resource AWS::CloudFront::RealtimeLogConfig
|
|
*/
|
|
export declare class RealtimeLogConfig extends Resource implements IRealtimeLogConfig {
|
|
/** Uniquely identifies this class. */
|
|
static readonly PROPERTY_INJECTION_ID: string;
|
|
get realtimeLogConfigName(): string;
|
|
get realtimeLogConfigArn(): string;
|
|
readonly realtimeLogConfigRef: RealtimeLogConfigReference;
|
|
private readonly resource;
|
|
constructor(scope: Construct, id: string, props: RealtimeLogConfigProps);
|
|
}
|