RecordingConfiguration

class aws_cdk.aws_ivs_alpha.RecordingConfiguration(scope, id, *, bucket, recording_configuration_name=None, recording_reconnect_window=None, rendition_configuration=None, thumbnail_configuration=None)

Bases: Resource

(experimental) The IVS Recording configuration.

Stability:: experimental
Resource:: AWS::IVS::RecordingConfiguration
ExampleMetadata:: infused

Example:

# recording_bucket: s3.Bucket


recording_configuration = ivs.RecordingConfiguration(self, "RecordingConfiguration",
    bucket=recording_bucket,

    # set rendition configuration
    rendition_configuration=ivs.RenditionConfiguration.custom([ivs.Resolution.HD, ivs.Resolution.SD])
)

Parameters:

scope (Construct)
id (str)
bucket (IBucketRef) – (experimental) S3 bucket where recorded videos will be stored.
recording_configuration_name (Optional[str]) – (experimental) The name of the Recording configuration. The value does not need to be unique. Default: - auto generate
recording_reconnect_window (Optional[Duration]) – (experimental) 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 Default: - 0 seconds (means disabled)
rendition_configuration (Optional[RenditionConfiguration]) – (experimental) A rendition configuration describes which renditions should be recorded for a stream. Default: - no rendition configuration
thumbnail_configuration (Optional[ThumbnailConfiguration]) – (experimental) 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. Default: - no thumbnail configuration

Stability:

experimental

Methods

apply_removal_policy(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).

Parameters:: policy (RemovalPolicy)
Return type:: None

to_string()

Returns a string representation of this construct.

Return type:: str

Attributes

PROPERTY_INJECTION_ID = '@aws-cdk.aws-ivs-alpha.RecordingConfiguration'

env

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

node: The tree node.

recording_configuration_arn

(experimental) The ARN of the Recording configuration.

Stability:: experimental
Attribute:: true

recording_configuration_id

(experimental) The ID of the Recording configuration.

Stability:: experimental
Attribute:: true

stack: The stack in which this resource is defined.

Static Methods

classmethod from_arn(scope, id, recording_configuration_arn)

(experimental) Imports an IVS Recording Configuration from its ARN.

Parameters:

scope (Construct)
id (str)
recording_configuration_arn (str)

Stability:

experimental

Return type:

IRecordingConfiguration

classmethod from_recording_configuration_id(scope, id, recording_configuration_id)

(experimental) Imports an IVS Recording Configuration from attributes.

Parameters:

scope (Construct)
id (str)
recording_configuration_id (str)

Stability:

experimental

Return type:

IRecordingConfiguration

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

classmethod is_owned_resource(construct)

Returns true if the construct was created by CDK, and false otherwise.

Parameters:: construct (IConstruct)
Return type:: bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:: construct (IConstruct)
Return type:: bool