class RealtimeLogConfig (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.CloudFront.RealtimeLogConfig |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awscloudfront#RealtimeLogConfig |
![]() | software.amazon.awscdk.services.cloudfront.RealtimeLogConfig |
![]() | aws_cdk.aws_cloudfront.RealtimeLogConfig |
![]() | aws-cdk-lib » aws_cloudfront » RealtimeLogConfig |
Implements
IConstruct
, IDependable
, IResource
, IRealtime
A Realtime Log Config configuration.
Example
// Adding realtime logs config to a Cloudfront Distribution on default behavior.
import * as kinesis from 'aws-cdk-lib/aws-kinesis';
declare const stream: kinesis.Stream;
const realTimeConfig = new cloudfront.RealtimeLogConfig(this, 'realtimeLog', {
endPoints: [
cloudfront.Endpoint.fromKinesisStream(stream),
],
fields: [
'timestamp',
'c-ip',
'time-to-first-byte',
'sc-status',
],
realtimeLogConfigName: 'my-delivery-stream',
samplingRate: 100,
});
new cloudfront.Distribution(this, 'myCdn', {
defaultBehavior: {
origin: new origins.HttpOrigin('www.example.com'),
realtimeLogConfig: realTimeConfig,
},
});
Initializer
new RealtimeLogConfig(scope: Construct, id: string, props: RealtimeLogConfigProps)
Parameters
- scope
Construct
- id
string
- props
Realtime
Log Config Props
Construct Props
Name | Type | Description |
---|---|---|
end | Endpoint [] | Contains information about the Amazon Kinesis data stream where you are sending real-time log data for this real-time log configuration. |
fields | string[] | A list of fields that are included in each real-time log record. |
sampling | number | The sampling rate for this real-time log configuration. |
realtime | string | The unique name of this real-time log configuration. |
endPoints
Type:
Endpoint
[]
Contains information about the Amazon Kinesis data stream where you are sending real-time log data for this real-time log configuration.
fields
Type:
string[]
A list of fields that are included in each real-time log record.
samplingRate
Type:
number
The sampling rate for this real-time log configuration.
realtimeLogConfigName?
Type:
string
(optional, default: the unique construct ID)
The unique name of this real-time log configuration.
Properties
Name | Type | Description |
---|---|---|
env | Resource | The environment this resource belongs to. |
node | Node | The tree node. |
realtime | string | The arn of the realtime log config. |
realtime | string | The name of the realtime log config. |
stack | Stack | The stack in which this resource is defined. |
env
Type:
Resource
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
node
Type:
Node
The tree node.
realtimeLogConfigArn
Type:
string
The arn of the realtime log config.
realtimeLogConfigName
Type:
string
The name of the realtime log config.
stack
Type:
Stack
The stack in which this resource is defined.
Methods
Name | Description |
---|---|
apply | Apply the given removal policy to this resource. |
to | Returns a string representation of this construct. |
applyRemovalPolicy(policy)
public applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
Removal
Policy
Apply the given removal policy to this resource.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY
), or left in your AWS
account for data recovery and cleanup later (RemovalPolicy.RETAIN
).
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.