Class CfnRecordingConfiguration
The AWS::IVS::RecordingConfiguration
resource specifies an recording configuration.
Inherited Members
Namespace: Amazon.CDK.AWS.Ivs
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnRecordingConfiguration : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnRecordingConfiguration
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
A recording configuration enables the recording of a channel’s live streams to a data store. Multiple channels can reference the same recording configuration. For more information, see RecordingConfiguration in the Amazon IVS Low-Latency Streaming API Reference .
CloudformationResource: AWS::IVS::RecordingConfiguration
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.Ivs;
var cfnRecordingConfiguration = new CfnRecordingConfiguration(this, "MyCfnRecordingConfiguration", new CfnRecordingConfigurationProps {
DestinationConfiguration = new DestinationConfigurationProperty {
S3 = new S3DestinationConfigurationProperty {
BucketName = "bucketName"
}
},
// the properties below are optional
Name = "name",
RecordingReconnectWindowSeconds = 123,
RenditionConfiguration = new RenditionConfigurationProperty {
Renditions = new [] { "renditions" },
RenditionSelection = "renditionSelection"
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
ThumbnailConfiguration = new ThumbnailConfigurationProperty {
RecordingMode = "recordingMode",
Resolution = "resolution",
Storage = new [] { "storage" },
TargetIntervalSeconds = 123
}
});
Synopsis
Constructors
CfnRecordingConfiguration(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnRecordingConfiguration(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnRecordingConfiguration(Construct, String, ICfnRecordingConfigurationProps) |
Properties
AttrArn | The recording configuration ARN. |
AttrState | Indicates the current state of the recording configuration. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DestinationConfiguration | A destination configuration describes an S3 bucket where recorded video will be stored. |
Name | Recording-configuration name. |
RecordingReconnectWindowSeconds | If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. |
RenditionConfiguration | A rendition configuration describes which renditions should be recorded for a stream. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | An array of key-value pairs to apply to this resource. |
ThumbnailConfiguration | A thumbnail configuration enables/disables the recording of thumbnails for a live session and controls the interval at which thumbnails are generated for the live session. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnRecordingConfiguration(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnRecordingConfiguration(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnRecordingConfiguration(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnRecordingConfiguration(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnRecordingConfiguration(Construct, String, ICfnRecordingConfigurationProps)
public CfnRecordingConfiguration(Construct scope, string id, ICfnRecordingConfigurationProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnRecordingConfigurationProps
Resource properties.
Properties
AttrArn
The recording configuration ARN.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
For example: arn:aws:ivs:us-west-2:123456789012:recording-configuration/abcdABCDefgh
CloudformationAttribute: Arn
AttrState
Indicates the current state of the recording configuration.
public virtual string AttrState { get; }
Property Value
System.String
Remarks
When the state is ACTIVE
, the configuration is ready to record a channel stream. Valid values: CREATING
| CREATE_FAILED
| ACTIVE
.
CloudformationAttribute: State
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
DestinationConfiguration
A destination configuration describes an S3 bucket where recorded video will be stored.
public virtual object DestinationConfiguration { get; set; }
Property Value
System.Object
Name
Recording-configuration name.
public virtual string Name { get; set; }
Property Value
System.String
RecordingReconnectWindowSeconds
If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together.
public virtual Nullable<double> RecordingReconnectWindowSeconds { get; set; }
Property Value
System.Nullable<System.Double>
RenditionConfiguration
A rendition configuration describes which renditions should be recorded for a stream.
public virtual object RenditionConfiguration { get; set; }
Property Value
System.Object
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
An array of key-value pairs to apply to this resource.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
ThumbnailConfiguration
A thumbnail configuration enables/disables the recording of thumbnails for a live session and controls the interval at which thumbnails are generated for the live session.
public virtual object ThumbnailConfiguration { get; set; }
Property Value
System.Object
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>