software.amazon.awscdk.services.kinesisvideo

Class CfnStream

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.kinesisvideo.CfnStream

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.312Z")
 @Stability(value=Stable)
public class CfnStream
extends CfnResource
implements IInspectable

A CloudFormation `AWS::KinesisVideo::Stream`.

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.

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.*;
 CfnStream cfnStream = CfnStream.Builder.create(this, "MyCfnStream")
         .dataRetentionInHours(123)
         .deviceName("deviceName")
         .kmsKeyId("kmsKeyId")
         .mediaType("mediaType")
         .name("name")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnStream.Builder A fluent builder for CfnStream.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnStream(software.constructs.Construct scope, String id) Create a new `AWS::KinesisVideo::Stream`.
	CfnStream(software.constructs.Construct scope, String id, CfnStreamProps props) Create a new `AWS::KinesisVideo::Stream`.
protected	CfnStream(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnStream(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The Amazon Resource Name (ARN) of the stream.
protected Map<String,Object>	getCfnProperties()
Number	getDataRetentionInHours() How long the stream retains data, in hours.
String	getDeviceName() The name of the device that is associated with the stream.
String	getKmsKeyId() The ID of the AWS Key Management Service ( AWS KMS ) key that Kinesis Video Streams uses to encrypt data on the stream.
String	getMediaType() The `MediaType` of the stream.
String	getName() The name of the stream.
TagManager	getTags() An array of key-value pairs to apply to this resource.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDataRetentionInHours(Number value) How long the stream retains data, in hours.
void	setDeviceName(String value) The name of the device that is associated with the stream.
void	setKmsKeyId(String value) The ID of the AWS Key Management Service ( AWS KMS ) key that Kinesis Video Streams uses to encrypt data on the stream.
void	setMediaType(String value) The `MediaType` of the stream.
void	setName(String value) The name of the stream.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnStream

protected CfnStream(software.amazon.jsii.JsiiObjectRef objRef)

CfnStream

protected CfnStream(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnStream

@Stability(value=Stable)
public CfnStream(@NotNull
                                          software.constructs.Construct scope,
                                          @NotNull
                                          String id,
                                          @Nullable
                                          CfnStreamProps props)

Create a new `AWS::KinesisVideo::Stream`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties.

CfnStream

@Stability(value=Stable)
public CfnStream(@NotNull
                                          software.constructs.Construct scope,
                                          @NotNull
                                          String id)

Create a new `AWS::KinesisVideo::Stream`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

The Amazon Resource Name (ARN) of the stream.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

For more information, see Tag .

getDataRetentionInHours

@Stability(value=Stable)
 @Nullable
public Number getDataRetentionInHours()

How long the stream retains data, in hours.

setDataRetentionInHours

@Stability(value=Stable)
public void setDataRetentionInHours(@Nullable
                                                             Number value)

How long the stream retains data, in hours.

getDeviceName

@Stability(value=Stable)
 @Nullable
public String getDeviceName()

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

setDeviceName

@Stability(value=Stable)
public void setDeviceName(@Nullable
                                                   String value)

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

getKmsKeyId

@Stability(value=Stable)
 @Nullable
public String getKmsKeyId()

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

setKmsKeyId

@Stability(value=Stable)
public void setKmsKeyId(@Nullable
                                                 String value)

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

getMediaType

@Stability(value=Stable)
 @Nullable
public String getMediaType()

The `MediaType` of the stream.

setMediaType

@Stability(value=Stable)
public void setMediaType(@Nullable
                                                  String value)

The `MediaType` of the stream.

getName

@Stability(value=Stable)
 @Nullable
public String getName()

The name of the stream.

setName

@Stability(value=Stable)
public void setName(@Nullable
                                             String value)

The name of the stream.