class RecordingConfiguration (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Ivs.Alpha.RecordingConfiguration |
![]() | github.com/aws/aws-cdk-go/awscdkivsalpha/v2#RecordingConfiguration |
![]() | software.amazon.awscdk.services.ivs.alpha.RecordingConfiguration |
![]() | aws_cdk.aws_ivs_alpha.RecordingConfiguration |
![]() | @aws-cdk/aws-ivs-alpha ยป RecordingConfiguration |
Implements
IConstruct
, IDependable
, IResource
, IRecording
The IVS Recording configuration.
Example
declare const recordingBucket: s3.Bucket;
const recordingConfiguration= new ivs.RecordingConfiguration(this, 'RecordingConfiguration', {
bucket: recordingBucket,
// set rendition configuration
renditionConfiguration: ivs.RenditionConfiguration.custom([ivs.Resolution.HD, ivs.Resolution.SD]),
});
Initializer
new RecordingConfiguration(scope: Construct, id: string, props: RecordingConfigurationProps)
Parameters
- scope
Construct
- id
string
- props
Recording
Configuration Props
Construct Props
Name | Type | Description |
---|---|---|
bucket | IBucket | S3 bucket where recorded videos will be stored. |
recording | string | The name of the Recording configuration. |
recording | Duration | If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. |
rendition | Rendition | A rendition configuration describes which renditions should be recorded for a stream. |
thumbnail | Thumbnail | 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. |
bucket
Type:
IBucket
S3 bucket where recorded videos will be stored.
recordingConfigurationName?
Type:
string
(optional, default: auto generate)
The name of the Recording configuration.
The value does not need to be unique.
recordingReconnectWindow?
Type:
Duration
(optional, default: 0 seconds (means disabled))
If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together.
recordingReconnectWindow
must be between 0 and 300 seconds
renditionConfiguration?
Type:
Rendition
(optional, default: no rendition configuration)
A rendition configuration describes which renditions should be recorded for a stream.
thumbnailConfiguration?
Type:
Thumbnail
(optional, default: no thumbnail configuration)
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.
Properties
Name | Type | Description |
---|---|---|
env | Resource | The environment this resource belongs to. |
node | Node | The tree node. |
recording | string | The ARN of the Recording configuration. |
recording | string | The ID of the Recording configuration. |
stack | Stack | The stack in which this resource is defined. |
env
Type:
Resource
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
node
Type:
Node
The tree node.
recordingConfigurationArn
Type:
string
The ARN of the Recording configuration.
recordingConfigurationId
Type:
string
The ID of the Recording configuration.
stack
Type:
Stack
The stack in which this resource is defined.
Methods
Name | Description |
---|---|
apply | Apply the given removal policy to this resource. |
to | Returns a string representation of this construct. |
static from | Imports an IVS Recording Configuration from its ARN. |
static from | Imports an IVS Recording Configuration from attributes. |
applyRemovalPolicy(policy)
public applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
Removal
Policy
Apply the given removal policy to this resource.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY
), or left in your AWS
account for data recovery and cleanup later (RemovalPolicy.RETAIN
).
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.
static fromArn(scope, id, recordingConfigurationArn)
public static fromArn(scope: Construct, id: string, recordingConfigurationArn: string): IRecordingConfiguration
Parameters
- scope
Construct
- id
string
- recordingConfigurationArn
string
Returns
Imports an IVS Recording Configuration from its ARN.
static fromRecordingConfigurationId(scope, id, recordingConfigurationId)
public static fromRecordingConfigurationId(scope: Construct, id: string, recordingConfigurationId: string): IRecordingConfiguration
Parameters
- scope
Construct
- id
string
- recordingConfigurationId
string
Returns
Imports an IVS Recording Configuration from attributes.