Class CfnStream
A CloudFormation AWS::KinesisVideo::Stream
.
Inherited Members
Namespace: Amazon.CDK.AWS.KinesisVideo
Assembly: Amazon.CDK.AWS.KinesisVideo.dll
Syntax (csharp)
public class CfnStream : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnStream
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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.
CloudformationResource: AWS::KinesisVideo::Stream
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisvideo-stream.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.KinesisVideo;
var cfnStream = new CfnStream(this, "MyCfnStream", new CfnStreamProps {
DataRetentionInHours = 123,
DeviceName = "deviceName",
KmsKeyId = "kmsKeyId",
MediaType = "mediaType",
Name = "name",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnStream(Construct, String, ICfnStreamProps) | Create a new |
CfnStream(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnStream(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrArn | The Amazon Resource Name (ARN) of the stream. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DataRetentionInHours | How long the stream retains data, in hours. |
DeviceName | The name of the device that is associated with the stream. |
KmsKeyId | The ID of the AWS Key Management Service ( AWS KMS ) key that Kinesis Video Streams uses to encrypt data on the stream. |
MediaType | The |
Name | The name of the stream. |
Tags | An array of key-value pairs to apply to this resource. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnStream(Construct, String, ICfnStreamProps)
Create a new AWS::KinesisVideo::Stream
.
public CfnStream(Construct scope, string id, ICfnStreamProps props = null)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnStreamProps
- resource properties.
CfnStream(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnStream(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnStream(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnStream(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrArn
The Amazon Resource Name (ARN) of the stream.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
DataRetentionInHours
How long the stream retains data, in hours.
public virtual Nullable<double> DataRetentionInHours { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
DeviceName
The name of the device that is associated with the stream.
public virtual string DeviceName { get; set; }
Property Value
System.String
Remarks
KmsKeyId
The ID of the AWS Key Management Service ( AWS KMS ) key that Kinesis Video Streams uses to encrypt data on the stream.
public virtual string KmsKeyId { get; set; }
Property Value
System.String
Remarks
MediaType
The MediaType
of the stream.
public virtual string MediaType { get; set; }
Property Value
System.String
Remarks
Name
The name of the stream.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
Tags
An array of key-value pairs to apply to this resource.
public virtual TagManager Tags { get; }
Property Value
Remarks
For more information, see Tag .
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>