CfnStreamPropsMixin

class aws_cdk.cfn_property_mixins.aws_iot.CfnStreamPropsMixin(props, *, strategy=None)

Bases: Mixin

Resource Type definition for AWS IoT Stream.

A stream is a publicly addressable resource that is an abstraction for a list of files that can be transferred to an IoT device.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-stream.html
CloudformationResource:: AWS::IoT::Stream
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.cfn_property_mixins import aws_iot as iot
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_stream_props_mixin = iot.CfnStreamPropsMixin(iot.CfnStreamMixinProps(
    description="description",
    files=[iot.CfnStreamPropsMixin.StreamFileProperty(
        file_id=123,
        s3_location=iot.CfnStreamPropsMixin.S3LocationProperty(
            bucket="bucket",
            key="key",
            version="version"
        )
    )],
    role_arn="roleArn",
    stream_id="streamId",
    tags=[cdk.CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::IoT::Stream.

Parameters:

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

Methods

apply_to(construct)

Apply the mixin properties to the construct.

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

supports(construct)

Check if this mixin supports the given construct.

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

Attributes

CFN_PROPERTY_KEYS = ['description', 'files', 'roleArn', 'streamId', 'tags']

Static Methods

classmethod is_mixin(x)

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.

S3LocationProperty

class CfnStreamPropsMixin.S3LocationProperty(*, bucket=None, key=None, version=None)

Bases: object

The location of the file in S3.

Parameters:

bucket (Optional[str]) – The S3 bucket.
key (Optional[str]) – The S3 key.
version (Optional[str]) – The S3 bucket version.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-stream-s3location.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.cfn_property_mixins import aws_iot as iot

s3_location_property = iot.CfnStreamPropsMixin.S3LocationProperty(
    bucket="bucket",
    key="key",
    version="version"
)

Attributes

bucket

The S3 bucket.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-stream-s3location.html#cfn-iot-stream-s3location-bucket

key

The S3 key.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-stream-s3location.html#cfn-iot-stream-s3location-key

version

The S3 bucket version.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-stream-s3location.html#cfn-iot-stream-s3location-version

StreamFileProperty

class CfnStreamPropsMixin.StreamFileProperty(*, file_id=None, s3_location=None)

Bases: object

Represents a file to stream.

Parameters:

file_id (Union[int, float, None]) – The file ID.
s3_location (Union[IResolvable, S3LocationProperty, Dict[str, Any], None]) – The location of the file in S3.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-stream-streamfile.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.cfn_property_mixins import aws_iot as iot

stream_file_property = iot.CfnStreamPropsMixin.StreamFileProperty(
    file_id=123,
    s3_location=iot.CfnStreamPropsMixin.S3LocationProperty(
        bucket="bucket",
        key="key",
        version="version"
    )
)

Attributes

file_id

The file ID.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-stream-streamfile.html#cfn-iot-stream-streamfile-fileid

s3_location

The location of the file in S3.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-stream-streamfile.html#cfn-iot-stream-streamfile-s3location