CfnRealtimeLogConfigPropsMixin

class aws_cdk.mixins_preview.aws_cloudfront.mixins.CfnRealtimeLogConfigPropsMixin(props, *, strategy=None)

Bases: Mixin

A real-time log configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-realtimelogconfig.html
CloudformationResource:: AWS::CloudFront::RealtimeLogConfig
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_cloudfront import mixins as cloudfront_mixins

cfn_realtime_log_config_props_mixin = cloudfront_mixins.CfnRealtimeLogConfigPropsMixin(cloudfront_mixins.CfnRealtimeLogConfigMixinProps(
    end_points=[cloudfront_mixins.CfnRealtimeLogConfigPropsMixin.EndPointProperty(
        kinesis_stream_config=cloudfront_mixins.CfnRealtimeLogConfigPropsMixin.KinesisStreamConfigProperty(
            role_arn="roleArn",
            stream_arn="streamArn"
        ),
        stream_type="streamType"
    )],
    fields=["fields"],
    name="name",
    sampling_rate=123
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::CloudFront::RealtimeLogConfig.

Parameters:

props (Union[CfnRealtimeLogConfigMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['endPoints', 'fields', 'name', 'samplingRate']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

EndPointProperty

class CfnRealtimeLogConfigPropsMixin.EndPointProperty(*, kinesis_stream_config=None, stream_type=None)

Bases: object

Contains information about the Amazon Kinesis data stream where you are sending real-time log data for this real-time log configuration.

Parameters:

kinesis_stream_config (Union[IResolvable, KinesisStreamConfigProperty, Dict[str, Any], None]) – Contains information about the Amazon Kinesis data stream where you are sending real-time log data in a real-time log configuration.
stream_type (Optional[str]) – The type of data stream where you are sending real-time log data. The only valid value is Kinesis .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-realtimelogconfig-endpoint.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_cloudfront import mixins as cloudfront_mixins

end_point_property = cloudfront_mixins.CfnRealtimeLogConfigPropsMixin.EndPointProperty(
    kinesis_stream_config=cloudfront_mixins.CfnRealtimeLogConfigPropsMixin.KinesisStreamConfigProperty(
        role_arn="roleArn",
        stream_arn="streamArn"
    ),
    stream_type="streamType"
)

Attributes

kinesis_stream_config

Contains information about the Amazon Kinesis data stream where you are sending real-time log data in a real-time log configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-realtimelogconfig-endpoint.html#cfn-cloudfront-realtimelogconfig-endpoint-kinesisstreamconfig

stream_type

The type of data stream where you are sending real-time log data.

The only valid value is Kinesis .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-realtimelogconfig-endpoint.html#cfn-cloudfront-realtimelogconfig-endpoint-streamtype

KinesisStreamConfigProperty

class CfnRealtimeLogConfigPropsMixin.KinesisStreamConfigProperty(*, role_arn=None, stream_arn=None)

Bases: object

Contains information about the Amazon Kinesis data stream where you are sending real-time log data.

Parameters:

role_arn (Optional[str]) – The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that CloudFront can use to send real-time log data to your Kinesis data stream. For more information the IAM role, see Real-time log configuration IAM role in the Amazon CloudFront Developer Guide .
stream_arn (Optional[str]) – The Amazon Resource Name (ARN) of the Kinesis data stream where you are sending real-time log data.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-realtimelogconfig-kinesisstreamconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_cloudfront import mixins as cloudfront_mixins

kinesis_stream_config_property = cloudfront_mixins.CfnRealtimeLogConfigPropsMixin.KinesisStreamConfigProperty(
    role_arn="roleArn",
    stream_arn="streamArn"
)

Attributes

role_arn

The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that CloudFront can use to send real-time log data to your Kinesis data stream.

For more information the IAM role, see Real-time log configuration IAM role in the Amazon CloudFront Developer Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-realtimelogconfig-kinesisstreamconfig.html#cfn-cloudfront-realtimelogconfig-kinesisstreamconfig-rolearn

stream_arn

The Amazon Resource Name (ARN) of the Kinesis data stream where you are sending real-time log data.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-realtimelogconfig-kinesisstreamconfig.html#cfn-cloudfront-realtimelogconfig-kinesisstreamconfig-streamarn