CfnLoggingConfigurationPropsMixin

class aws_cdk.mixins_preview.aws_ivschat.mixins.CfnLoggingConfigurationPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::IVSChat::LoggingConfiguration resource specifies an logging configuration that allows clients to store and record sent messages.

For more information, see CreateLoggingConfiguration in the Amazon Interactive Video Service Chat API Reference .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivschat-loggingconfiguration.html
CloudformationResource:: AWS::IVSChat::LoggingConfiguration
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_ivschat import mixins as ivschat_mixins

cfn_logging_configuration_props_mixin = ivschat_mixins.CfnLoggingConfigurationPropsMixin(ivschat_mixins.CfnLoggingConfigurationMixinProps(
    destination_configuration=ivschat_mixins.CfnLoggingConfigurationPropsMixin.DestinationConfigurationProperty(
        cloud_watch_logs=ivschat_mixins.CfnLoggingConfigurationPropsMixin.CloudWatchLogsDestinationConfigurationProperty(
            log_group_name="logGroupName"
        ),
        firehose=ivschat_mixins.CfnLoggingConfigurationPropsMixin.FirehoseDestinationConfigurationProperty(
            delivery_stream_name="deliveryStreamName"
        ),
        s3=ivschat_mixins.CfnLoggingConfigurationPropsMixin.S3DestinationConfigurationProperty(
            bucket_name="bucketName"
        )
    ),
    name="name",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::IVSChat::LoggingConfiguration.

Parameters:

props (Union[CfnLoggingConfigurationMixinProps, 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 = ['destinationConfiguration', 'name', 'tags']

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

CloudWatchLogsDestinationConfigurationProperty

class CfnLoggingConfigurationPropsMixin.CloudWatchLogsDestinationConfigurationProperty(*, log_group_name=None)

Bases: object

The CloudWatchLogsDestinationConfiguration property type specifies a CloudWatch Logs location where chat logs will be stored.

Parameters:: log_group_name (Optional[str]) – Name of the Amazon Cloudwatch Logs destination where chat activity will be logged.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivschat-loggingconfiguration-cloudwatchlogsdestinationconfiguration.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_ivschat import mixins as ivschat_mixins

cloud_watch_logs_destination_configuration_property = ivschat_mixins.CfnLoggingConfigurationPropsMixin.CloudWatchLogsDestinationConfigurationProperty(
    log_group_name="logGroupName"
)

Attributes

log_group_name

Name of the Amazon Cloudwatch Logs destination where chat activity will be logged.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivschat-loggingconfiguration-cloudwatchlogsdestinationconfiguration.html#cfn-ivschat-loggingconfiguration-cloudwatchlogsdestinationconfiguration-loggroupname

DestinationConfigurationProperty

class CfnLoggingConfigurationPropsMixin.DestinationConfigurationProperty(*, cloud_watch_logs=None, firehose=None, s3=None)

Bases: object

The DestinationConfiguration property type describes a location where chat logs will be stored.

Each member represents the configuration of one log destination. For logging, you define only one type of destination.

Parameters:

cloud_watch_logs (Union[IResolvable, CloudWatchLogsDestinationConfigurationProperty, Dict[str, Any], None]) – An Amazon CloudWatch Logs destination configuration where chat activity will be logged.
firehose (Union[IResolvable, FirehoseDestinationConfigurationProperty, Dict[str, Any], None]) – An Amazon Kinesis Data Firehose destination configuration where chat activity will be logged.
s3 (Union[IResolvable, S3DestinationConfigurationProperty, Dict[str, Any], None]) – An Amazon S3 destination configuration where chat activity will be logged.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivschat-loggingconfiguration-destinationconfiguration.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_ivschat import mixins as ivschat_mixins

destination_configuration_property = ivschat_mixins.CfnLoggingConfigurationPropsMixin.DestinationConfigurationProperty(
    cloud_watch_logs=ivschat_mixins.CfnLoggingConfigurationPropsMixin.CloudWatchLogsDestinationConfigurationProperty(
        log_group_name="logGroupName"
    ),
    firehose=ivschat_mixins.CfnLoggingConfigurationPropsMixin.FirehoseDestinationConfigurationProperty(
        delivery_stream_name="deliveryStreamName"
    ),
    s3=ivschat_mixins.CfnLoggingConfigurationPropsMixin.S3DestinationConfigurationProperty(
        bucket_name="bucketName"
    )
)

Attributes

cloud_watch_logs

An Amazon CloudWatch Logs destination configuration where chat activity will be logged.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivschat-loggingconfiguration-destinationconfiguration.html#cfn-ivschat-loggingconfiguration-destinationconfiguration-cloudwatchlogs

firehose

An Amazon Kinesis Data Firehose destination configuration where chat activity will be logged.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivschat-loggingconfiguration-destinationconfiguration.html#cfn-ivschat-loggingconfiguration-destinationconfiguration-firehose

s3

An Amazon S3 destination configuration where chat activity will be logged.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivschat-loggingconfiguration-destinationconfiguration.html#cfn-ivschat-loggingconfiguration-destinationconfiguration-s3

FirehoseDestinationConfigurationProperty

class CfnLoggingConfigurationPropsMixin.FirehoseDestinationConfigurationProperty(*, delivery_stream_name=None)

Bases: object

The FirehoseDestinationConfiguration property type specifies a Kinesis Firehose location where chat logs will be stored.

Parameters:: delivery_stream_name (Optional[str]) – Name of the Amazon Kinesis Firehose delivery stream where chat activity will be logged.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivschat-loggingconfiguration-firehosedestinationconfiguration.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_ivschat import mixins as ivschat_mixins

firehose_destination_configuration_property = ivschat_mixins.CfnLoggingConfigurationPropsMixin.FirehoseDestinationConfigurationProperty(
    delivery_stream_name="deliveryStreamName"
)

Attributes

delivery_stream_name

Name of the Amazon Kinesis Firehose delivery stream where chat activity will be logged.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivschat-loggingconfiguration-firehosedestinationconfiguration.html#cfn-ivschat-loggingconfiguration-firehosedestinationconfiguration-deliverystreamname

S3DestinationConfigurationProperty

class CfnLoggingConfigurationPropsMixin.S3DestinationConfigurationProperty(*, bucket_name=None)

Bases: object

The S3DestinationConfiguration property type specifies an S3 location where chat logs will be stored.

Parameters:: bucket_name (Optional[str]) – Name of the Amazon S3 bucket where chat activity will be logged.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivschat-loggingconfiguration-s3destinationconfiguration.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_ivschat import mixins as ivschat_mixins

s3_destination_configuration_property = ivschat_mixins.CfnLoggingConfigurationPropsMixin.S3DestinationConfigurationProperty(
    bucket_name="bucketName"
)

Attributes

bucket_name

Name of the Amazon S3 bucket where chat activity will be logged.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivschat-loggingconfiguration-s3destinationconfiguration.html#cfn-ivschat-loggingconfiguration-s3destinationconfiguration-bucketname