CfnChannelProps

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

Bases: object

Properties for defining a AWS::IoTAnalytics::Channel.

Parameters
  • channel_name (Optional[str]) – AWS::IoTAnalytics::Channel.ChannelName.

  • channel_storage (Union[IResolvable, ChannelStorageProperty, None]) – AWS::IoTAnalytics::Channel.ChannelStorage.

  • retention_period (Union[IResolvable, RetentionPeriodProperty, None]) – AWS::IoTAnalytics::Channel.RetentionPeriod.

  • tags (Optional[Sequence[CfnTag]]) – AWS::IoTAnalytics::Channel.Tags.

Link

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

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_iotanalytics as iotanalytics

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=iotanalytics.CfnChannel.ServiceManagedS3Property()
    ),
    retention_period=iotanalytics.CfnChannel.RetentionPeriodProperty(
        number_of_days=123,
        unlimited=False
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

channel_name

AWS::IoTAnalytics::Channel.ChannelName.

Link

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

Return type

Optional[str]

channel_storage

AWS::IoTAnalytics::Channel.ChannelStorage.

Link

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

Return type

Union[IResolvable, ChannelStorageProperty, None]

retention_period

AWS::IoTAnalytics::Channel.RetentionPeriod.

Link

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

Return type

Union[IResolvable, RetentionPeriodProperty, None]

tags

AWS::IoTAnalytics::Channel.Tags.

Link

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

Return type

Optional[List[CfnTag]]