CfnStreamPropsMixin

class aws_cdk.mixins_preview.aws_kinesisvideo.mixins.CfnStreamPropsMixin(props, *, strategy=None)

Bases: Mixin

Specifies a new Kinesis video stream.

When you create a new stream, Kinesis Video Streams assigns it a version number. When you change the stream’s metadata, Kinesis Video Streams updates the version.

CreateStream is an asynchronous operation.

For information about how the service works, see How it Works .

You must have permissions for the KinesisVideo:CreateStream action.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisvideo-stream.html
CloudformationResource:: AWS::KinesisVideo::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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_kinesisvideo import mixins as kinesisvideo_mixins

cfn_stream_props_mixin = kinesisvideo_mixins.CfnStreamPropsMixin(kinesisvideo_mixins.CfnStreamMixinProps(
    data_retention_in_hours=123,
    device_name="deviceName",
    kms_key_id="kmsKeyId",
    media_type="mediaType",
    name="name",
    stream_storage_configuration=kinesisvideo_mixins.CfnStreamPropsMixin.StreamStorageConfigurationProperty(
        default_storage_tier="defaultStorageTier"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnStreamMixinProps, 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 = ['dataRetentionInHours', 'deviceName', 'kmsKeyId', 'mediaType', 'name', 'streamStorageConfiguration', '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

StreamStorageConfigurationProperty

class CfnStreamPropsMixin.StreamStorageConfigurationProperty(*, default_storage_tier=None)

Bases: object

The configuration for stream storage, including the default storage tier for stream data.

This configuration determines how stream data is stored and accessed, with different tiers offering varying levels of performance and cost optimization.

Parameters:: default_storage_tier (Optional[str]) – The default storage tier for the stream data. This setting determines the storage class used for stream data, affecting both performance characteristics and storage costs. Available storage tiers: - HOT - Optimized for frequent access with the lowest latency and highest performance. Ideal for real-time applications and frequently accessed data. - WARM - Balanced performance and cost for moderately accessed data. Suitable for data that is accessed regularly but not continuously. Default: - “HOT”
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisvideo-stream-streamstorageconfiguration.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_kinesisvideo import mixins as kinesisvideo_mixins

stream_storage_configuration_property = kinesisvideo_mixins.CfnStreamPropsMixin.StreamStorageConfigurationProperty(
    default_storage_tier="defaultStorageTier"
)

Attributes

default_storage_tier

The default storage tier for the stream data.

This setting determines the storage class used for stream data, affecting both performance characteristics and storage costs.

Available storage tiers:

HOT - Optimized for frequent access with the lowest latency and highest performance. Ideal for real-time applications and frequently accessed data.
WARM - Balanced performance and cost for moderately accessed data. Suitable for data that is accessed regularly but not continuously.

Default:

“HOT”

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisvideo-stream-streamstorageconfiguration.html#cfn-kinesisvideo-stream-streamstorageconfiguration-defaultstoragetier