Experimental

@aws-cdk/aws-ivs-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

RecordingConfiguration L2 construct

The IVS Recording configuration.

Stability: Experimental
CloudFormation: AWS::IVS::RecordingConfiguration
L1 type: CfnRecordingConfiguration
Source: lib/recording-configuration.ts

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]),
});

python

# 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])
)

java

Bucket recordingBucket;


RecordingConfiguration recordingConfiguration = RecordingConfiguration.Builder.create(this, "RecordingConfiguration")
        .bucket(recordingBucket)

        // set rendition configuration
        .renditionConfiguration(RenditionConfiguration.custom(List.of(Resolution.HD, Resolution.SD)))
        .build();

csharp

// Install: dotnet add package Amazon.CDK.AWS.IVS.Alpha
Bucket recordingBucket;


var recordingConfiguration = new RecordingConfiguration(this, "RecordingConfiguration", new RecordingConfigurationProps {
    Bucket = recordingBucket,

    // set rendition configuration
    RenditionConfiguration = RenditionConfiguration.Custom(new [] { Resolution.HD, Resolution.SD })
});

// Install: go get github.com/aws/aws-cdk-go/awscdkivsalpha/v2
var recordingBucket Bucket


recordingConfiguration := ivs.NewRecordingConfiguration(this, jsii.String("RecordingConfiguration"), &RecordingConfigurationProps{
	Bucket: recordingBucket,

	// set rendition configuration
	RenditionConfiguration: ivs.RenditionConfiguration_Custom([]Resolution{
		ivs.Resolution_HD,
		ivs.Resolution_SD,
	}),
})

Initializer

new RecordingConfiguration(scope: Construct, id: string, props: RecordingConfigurationProps)

python

RecordingConfiguration(scope: Construct, id: str, props: RecordingConfigurationProps)

java

new RecordingConfiguration(Construct scope, String id, RecordingConfigurationProps props)

csharp

new RecordingConfiguration(Construct scope, string id, RecordingConfigurationProps props)

NewRecordingConfiguration(Scope Construct, Id *string, Props RecordingConfigurationProps)

Construct Props

bucketIBucketRefbucketIBucketRefbucketIBucketRefBucketIBucketRefBucketIBucketRefrequired#

S3 bucket where recorded videos will be stored.

recordingConfigurationNameoptionalstringrecording_configuration_nameoptionalstrrecordingConfigurationNameoptionalStringRecordingConfigurationNameoptionalstringRecordingConfigurationNameoptional*string#

The name of the Recording configuration.

Default: auto generate

The value does not need to be unique.

recordingReconnectWindowoptionalDurationrecording_reconnect_windowoptionalDurationrecordingReconnectWindowoptionalDurationRecordingReconnectWindowoptionalDurationRecordingReconnectWindowoptionalDuration#

If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together.

Default: 0 seconds (means disabled)

recordingReconnectWindow must be between 0 and 300 seconds

renditionConfigurationoptionalRenditionConfigurationrendition_configurationoptionalRenditionConfigurationrenditionConfigurationoptionalRenditionConfigurationRenditionConfigurationoptionalRenditionConfigurationRenditionConfigurationoptionalRenditionConfiguration#

A rendition configuration describes which renditions should be recorded for a stream.

Default: no rendition configuration

thumbnailConfigurationoptionalThumbnailConfigurationthumbnail_configurationoptionalThumbnailConfigurationthumbnailConfigurationoptionalThumbnailConfigurationThumbnailConfigurationoptionalThumbnailConfigurationThumbnailConfigurationoptionalThumbnailConfiguration#

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

Properties

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironment#

The environment this resource belongs to.

notes

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.

nodeNodenodeNodenodeNodeNodeNodeNodeNode#

The tree node.

PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringstatic#

Uniquely identifies this class.

recordingConfigurationArnstringrecording_configuration_arnstrrecordingConfigurationArnStringRecordingConfigurationArnstringRecordingConfigurationArn*string#

The ARN of the Recording configuration.

recordingConfigurationIdstringrecording_configuration_idstrrecordingConfigurationIdStringRecordingConfigurationIdstringRecordingConfigurationId*string#

The ID of the Recording configuration.

stackStackstackStackstackStackStackStackStackStack#

The stack in which this resource is defined.

Methods

applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#

Override the cross-stack reference strength for this resource.

notes · 1 parameter

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters

strengthstrengthstrengthstrengthStrength — - The reference strength to use for this resource.

applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#

Apply the given removal policy to this resource.

notes

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

fromArn(scope: Construct, id: string, recordingConfigurationArn: string): IRecordingConfiguration@staticmethod def from_arn(scope: Construct, id: str, recording_configuration_arn: str) -> IRecordingConfigurationpublic static IRecordingConfiguration fromArn(Construct scope, String id, String recordingConfigurationArn)public static IRecordingConfiguration FromArn(Construct scope, string id, string recordingConfigurationArn)func FromArn(Scope Construct, Id *string, RecordingConfigurationArn *string) IRecordingConfigurationstatic#

Imports an IVS Recording Configuration from its ARN.

fromRecordingConfigurationId(scope: Construct, id: string, recordingConfigurationId: string): IRecordingConfiguration

@staticmethod def from_recording_configuration_id(scope: Construct, id: str, recording_configuration_id: str) -> IRecordingConfiguration

public static IRecordingConfiguration fromRecordingConfigurationId(Construct scope, String id, String recordingConfigurationId)

public static IRecordingConfiguration FromRecordingConfigurationId(Construct scope, string id, string recordingConfigurationId)

func FromRecordingConfigurationId(Scope Construct, Id *string, RecordingConfigurationId *string) IRecordingConfigurationstatic#

Imports an IVS Recording Configuration from attributes.

isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#

Checks if `x` is a construct.

notes · 1 parameter · returns

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

xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#

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

isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#

Check whether the given construct is a Resource.

toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#

Returns a string representation of this construct.

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

RecordingConfiguration L2 construct ​

Example ​

Initializer ​

Construct Props ​

Properties ​

Methods ​