2.237.1

interface CfnStreamProps

LanguageType name
.NETAmazon.CDK.AWS.KinesisVideo.CfnStreamProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awskinesisvideo#CfnStreamProps
Javasoftware.amazon.awscdk.services.kinesisvideo.CfnStreamProps
Pythonaws_cdk.aws_kinesisvideo.CfnStreamProps
TypeScript aws-cdk-lib » aws_kinesisvideo » CfnStreamProps

Properties for defining a CfnStream.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_kinesisvideo as kinesisvideo } from 'aws-cdk-lib';
const cfnStreamProps: kinesisvideo.CfnStreamProps = {
  dataRetentionInHours: 123,
  deviceName: 'deviceName',
  kmsKeyId: 'kmsKeyId',
  mediaType: 'mediaType',
  name: 'name',
  streamStorageConfiguration: {
    defaultStorageTier: 'defaultStorageTier',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
dataRetentionInHours?numberHow long the stream retains data, in hours.
deviceName?stringThe name of the device that is associated with the stream.
kmsKeyId?stringThe ID of the AWS Key Management Service ( AWS ) key that Kinesis Video Streams uses to encrypt data on the stream.
mediaType?stringThe MediaType of the stream.
name?stringThe name of the stream.
streamStorageConfiguration?IResolvable | StreamStorageConfigurationPropertyThe configuration for stream storage, including the default storage tier for stream data.
tags?CfnTag[]An array of key-value pairs to apply to this resource.

dataRetentionInHours?

Type: number (optional)

How long the stream retains data, in hours.

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

deviceName?

Type: string (optional)

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

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

kmsKeyId?

Type: string (optional)

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

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

mediaType?

Type: string (optional)

The MediaType of the stream.

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

name?

Type: string (optional)

The name of the stream.

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

streamStorageConfiguration?

Type: IResolvable | StreamStorageConfigurationProperty (optional)

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.

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

tags?

Type: CfnTag[] (optional)

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

For more information, see Tag .

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

← PreviousNext →