CfnChannelPropsMixin

class aws_cdk.mixins_preview.aws_iotanalytics.mixins.CfnChannelPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::IoTAnalytics::Channel resource collects data from an MQTT topic and archives the raw, unprocessed messages before publishing the data to a pipeline.

For more information, see How to Use AWS IoT Analytics in the AWS IoT Analytics User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-channel.html
CloudformationResource:: AWS::IoTAnalytics::Channel
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_iotanalytics import mixins as iotanalytics_mixins

# service_managed_s3: Any

cfn_channel_props_mixin = iotanalytics_mixins.CfnChannelPropsMixin(iotanalytics_mixins.CfnChannelMixinProps(
    channel_name="channelName",
    channel_storage=iotanalytics_mixins.CfnChannelPropsMixin.ChannelStorageProperty(
        customer_managed_s3=iotanalytics_mixins.CfnChannelPropsMixin.CustomerManagedS3Property(
            bucket="bucket",
            key_prefix="keyPrefix",
            role_arn="roleArn"
        ),
        service_managed_s3=service_managed_s3
    ),
    retention_period=iotanalytics_mixins.CfnChannelPropsMixin.RetentionPeriodProperty(
        number_of_days=123,
        unlimited=False
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::IoTAnalytics::Channel.

Parameters:

props (Union[CfnChannelMixinProps, 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 = ['channelName', 'channelStorage', 'retentionPeriod', '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

ChannelStorageProperty

class CfnChannelPropsMixin.ChannelStorageProperty(*, customer_managed_s3=None, service_managed_s3=None)

Bases: object

Where channel data is stored.

You may choose one of serviceManagedS3 , customerManagedS3 storage. If not specified, the default is serviceManagedS3 . This can’t be changed after creation of the channel.

Parameters:

customer_managed_s3 (Union[IResolvable, CustomerManagedS3Property, Dict[str, Any], None]) – Used to store channel data in an S3 bucket that you manage. If customer managed storage is selected, the retentionPeriod parameter is ignored. You can’t change the choice of S3 storage after the data store is created.
service_managed_s3 (Any) – Used to store channel data in an S3 bucket managed by AWS IoT Analytics . You can’t change the choice of S3 storage after the data store is created.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-channel-channelstorage.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_iotanalytics import mixins as iotanalytics_mixins

# service_managed_s3: Any

channel_storage_property = iotanalytics_mixins.CfnChannelPropsMixin.ChannelStorageProperty(
    customer_managed_s3=iotanalytics_mixins.CfnChannelPropsMixin.CustomerManagedS3Property(
        bucket="bucket",
        key_prefix="keyPrefix",
        role_arn="roleArn"
    ),
    service_managed_s3=service_managed_s3
)

Attributes

customer_managed_s3

Used to store channel data in an S3 bucket that you manage.

If customer managed storage is selected, the retentionPeriod parameter is ignored. You can’t change the choice of S3 storage after the data store is created.

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

service_managed_s3

Used to store channel data in an S3 bucket managed by AWS IoT Analytics .

You can’t change the choice of S3 storage after the data store is created.

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

CustomerManagedS3Property

class CfnChannelPropsMixin.CustomerManagedS3Property(*, bucket=None, key_prefix=None, role_arn=None)

Bases: object

Used to store channel data in an S3 bucket that you manage.

Parameters:

bucket (Optional[str]) – The name of the S3 bucket in which channel data is stored.
key_prefix (Optional[str]) – (Optional) The prefix used to create the keys of the channel data objects. Each object in an S3 bucket has a key that is its unique identifier within the bucket (each object in a bucket has exactly one key). The prefix must end with a forward slash (/).
role_arn (Optional[str]) – The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 resources.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-channel-customermanageds3.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_iotanalytics import mixins as iotanalytics_mixins

customer_managed_s3_property = iotanalytics_mixins.CfnChannelPropsMixin.CustomerManagedS3Property(
    bucket="bucket",
    key_prefix="keyPrefix",
    role_arn="roleArn"
)

Attributes

bucket

The name of the S3 bucket in which channel data is stored.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-channel-customermanageds3.html#cfn-iotanalytics-channel-customermanageds3-bucket

key_prefix

(Optional) The prefix used to create the keys of the channel data objects.

Each object in an S3 bucket has a key that is its unique identifier within the bucket (each object in a bucket has exactly one key). The prefix must end with a forward slash (/).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-channel-customermanageds3.html#cfn-iotanalytics-channel-customermanageds3-keyprefix

role_arn

The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 resources.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-channel-customermanageds3.html#cfn-iotanalytics-channel-customermanageds3-rolearn

RetentionPeriodProperty

class CfnChannelPropsMixin.RetentionPeriodProperty(*, number_of_days=None, unlimited=None)

Bases: object

How long, in days, message data is kept.

Parameters:

number_of_days (Union[int, float, None]) – The number of days that message data is kept. The unlimited parameter must be false.
unlimited (Union[bool, IResolvable, None]) – If true, message data is kept indefinitely.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-channel-retentionperiod.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_iotanalytics import mixins as iotanalytics_mixins

retention_period_property = iotanalytics_mixins.CfnChannelPropsMixin.RetentionPeriodProperty(
    number_of_days=123,
    unlimited=False
)

Attributes

number_of_days

The number of days that message data is kept.

The unlimited parameter must be false.

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

unlimited

If true, message data is kept indefinitely.

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