CfnStreamProps

class aws_cdk.aws_kinesisvideo.CfnStreamProps(*, data_retention_in_hours=None, device_name=None, kms_key_id=None, media_type=None, name=None, tags=None)

Bases: object

Properties for defining a CfnStream.

Parameters:
  • data_retention_in_hours (Union[int, float, None]) – How long the stream retains data, in hours.

  • device_name (Optional[str]) – The name of the device that is associated with the stream.

  • kms_key_id (Optional[str]) – The ID of the AWS Key Management Service ( AWS KMS ) key that Kinesis Video Streams uses to encrypt data on the stream.

  • media_type (Optional[str]) – The MediaType of the stream.

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

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of key-value pairs to apply to this resource. For more information, see Tag .

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisvideo-stream.html

ExampleMetadata:

fixture=_generated

Example:

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

cfn_stream_props = kinesisvideo.CfnStreamProps(
    data_retention_in_hours=123,
    device_name="deviceName",
    kms_key_id="kmsKeyId",
    media_type="mediaType",
    name="name",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

data_retention_in_hours

How long the stream retains data, in hours.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisvideo-stream.html#cfn-kinesisvideo-stream-dataretentioninhours

device_name

The name of the device that is associated with the stream.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisvideo-stream.html#cfn-kinesisvideo-stream-devicename

kms_key_id

The ID of the AWS Key Management Service ( AWS KMS ) key that Kinesis Video Streams uses to encrypt data on the stream.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisvideo-stream.html#cfn-kinesisvideo-stream-kmskeyid

media_type

The MediaType of the stream.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisvideo-stream.html#cfn-kinesisvideo-stream-mediatype

name

The name of the stream.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisvideo-stream.html#cfn-kinesisvideo-stream-name

tags

An array of key-value pairs to apply to this resource.

For more information, see Tag .

Link:

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