Package software.amazon.awscdk.services.kinesisvideo

Interface CfnStreamProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnStreamProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:09.034Z")
@Stability(Stable)
public interface CfnStreamProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnStream.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.kinesisvideo.*;
 CfnStreamProps cfnStreamProps = CfnStreamProps.builder()
         .dataRetentionInHours(123)
         .deviceName("deviceName")
         .kmsKeyId("kmsKeyId")
         .mediaType("mediaType")
         .name("name")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnStreamProps.Builder	A builder for CfnStreamProps
static final class	CfnStreamProps.Jsii$Proxy	An implementation for CfnStreamProps

Method Summary

Modifier and Type	Method	Description
static CfnStreamProps.Builder	builder()
default Number	getDataRetentionInHours()	How long the stream retains data, in hours.
default String	getDeviceName()	The name of the device that is associated with the stream.
default String	getKmsKeyId()	The ID of the AWS Key Management Service ( AWS KMS ) key that Kinesis Video Streams uses to encrypt data on the stream.
default String	getMediaType()	The MediaType of the stream.
default String	getName()	The name of the stream.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDataRetentionInHours

@Stability(Stable)
@Nullable
default Number getDataRetentionInHours()

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

getDeviceName

@Stability(Stable)
@Nullable
default String getDeviceName()

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

getKmsKeyId

@Stability(Stable)
@Nullable
default String getKmsKeyId()

The ID of the AWS Key Management Service ( AWS KMS ) 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

getMediaType

@Stability(Stable)
@Nullable
default String getMediaType()

The MediaType of the stream.

See Also:

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

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the stream.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

builder

@Stability(Stable)
static CfnStreamProps.Builder builder()

Returns:

a CfnStreamProps.Builder of CfnStreamProps