CfnChannelProps

class aws_cdk.aws_iotanalytics.CfnChannelProps(*, channel_name=None, channel_storage=None, retention_period=None, tags=None)

Bases: object

Properties for defining a CfnChannel.

Parameters:

• channel_name (Optional[str]) – The name of the channel.

• channel_storage (Union[IResolvable, ChannelStorageProperty, Dict[str, Any], None]) – Where channel data is stored.

• retention_period (Union[IResolvable, RetentionPeriodProperty, Dict[str, Any], None]) – How long, in days, message data is kept for the channel.

• tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Metadata which can be used to manage the channel. For more information, see Tag .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-channel.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 import aws_iotanalytics as iotanalytics

# service_managed_s3: Any

cfn_channel_props = iotanalytics.CfnChannelProps(
    channel_name="channelName",
    channel_storage=iotanalytics.CfnChannel.ChannelStorageProperty(
        customer_managed_s3=iotanalytics.CfnChannel.CustomerManagedS3Property(
            bucket="bucket",
            role_arn="roleArn",

            # the properties below are optional
            key_prefix="keyPrefix"
        ),
        service_managed_s3=service_managed_s3
    ),
    retention_period=iotanalytics.CfnChannel.RetentionPeriodProperty(
        number_of_days=123,
        unlimited=False
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

channel_name

The name of the channel.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-channel.html#cfn-iotanalytics-channel-channelname

channel_storage

Where channel data is stored.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-channel.html#cfn-iotanalytics-channel-channelstorage

retention_period

How long, in days, message data is kept for the channel.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-channel.html#cfn-iotanalytics-channel-retentionperiod

tags

Metadata which can be used to manage the channel.

For more information, see Tag .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-channel.html#cfn-iotanalytics-channel-tags