Class CfnRealtimeLogConfig
A CloudFormation AWS::CloudFront::RealtimeLogConfig
.
Inherited Members
Namespace: Amazon.CDK.AWS.CloudFront
Assembly: Amazon.CDK.AWS.CloudFront.dll
Syntax (csharp)
public class CfnRealtimeLogConfig : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnRealtimeLogConfig
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
A real-time log configuration.
CloudformationResource: AWS::CloudFront::RealtimeLogConfig
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CloudFront;
var cfnRealtimeLogConfig = new CfnRealtimeLogConfig(this, "MyCfnRealtimeLogConfig", new CfnRealtimeLogConfigProps {
EndPoints = new [] { new EndPointProperty {
KinesisStreamConfig = new KinesisStreamConfigProperty {
RoleArn = "roleArn",
StreamArn = "streamArn"
},
StreamType = "streamType"
} },
Fields = new [] { "fields" },
Name = "name",
SamplingRate = 123
});
Synopsis
Constructors
CfnRealtimeLogConfig(Construct, String, ICfnRealtimeLogConfigProps) | Create a new |
CfnRealtimeLogConfig(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnRealtimeLogConfig(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrArn | The Amazon Resource Name (ARN) of the real-time log configuration. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
EndPoints | Contains information about the Amazon Kinesis data stream where you are sending real-time log data for this real-time log configuration. |
Fields | A list of fields that are included in each real-time log record. |
Name | The unique name of this real-time log configuration. |
SamplingRate | The sampling rate for this real-time log configuration. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnRealtimeLogConfig(Construct, String, ICfnRealtimeLogConfigProps)
Create a new AWS::CloudFront::RealtimeLogConfig
.
public CfnRealtimeLogConfig(Construct scope, string id, ICfnRealtimeLogConfigProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnRealtimeLogConfigProps
- resource properties.
CfnRealtimeLogConfig(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnRealtimeLogConfig(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnRealtimeLogConfig(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnRealtimeLogConfig(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrArn
The Amazon Resource Name (ARN) of the real-time log configuration.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
For example: arn:aws:cloudfront::111122223333:realtime-log-config/ExampleNameForRealtimeLogConfig
.
CloudformationAttribute: Arn
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
EndPoints
Contains information about the Amazon Kinesis data stream where you are sending real-time log data for this real-time log configuration.
public virtual object EndPoints { get; set; }
Property Value
System.Object
Remarks
Fields
A list of fields that are included in each real-time log record.
public virtual string[] Fields { get; set; }
Property Value
System.String[]
Remarks
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 .
Name
The unique name of this real-time log configuration.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
SamplingRate
The sampling rate for this real-time log configuration.
public virtual double SamplingRate { get; set; }
Property Value
System.Double
Remarks
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.
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>