software.amazon.awscdk.services.ivs

Class CfnRecordingConfiguration

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.ivs.CfnRecordingConfiguration

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-25T18:28:58.318Z")
public class CfnRecordingConfiguration
extends CfnResource
implements IInspectable

A CloudFormation `AWS::IVS::RecordingConfiguration`.

The AWS::IVS::RecordingConfiguration resource specifies an recording configuration. 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 Interactive Video Service API Reference .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ivs.*;
 CfnRecordingConfiguration cfnRecordingConfiguration = CfnRecordingConfiguration.Builder.create(this, "MyCfnRecordingConfiguration")
         .destinationConfiguration(DestinationConfigurationProperty.builder()
                 .s3(S3DestinationConfigurationProperty.builder()
                         .bucketName("bucketName")
                         .build())
                 .build())
         // the properties below are optional
         .name("name")
         .recordingReconnectWindowSeconds(123)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .thumbnailConfiguration(ThumbnailConfigurationProperty.builder()
                 .recordingMode("recordingMode")
                 // the properties below are optional
                 .targetIntervalSeconds(123)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnRecordingConfiguration.Builder A fluent builder for CfnRecordingConfiguration.
static interface	CfnRecordingConfiguration.DestinationConfigurationProperty The DestinationConfiguration property type describes the location where recorded videos will be stored.
static interface	CfnRecordingConfiguration.S3DestinationConfigurationProperty The S3DestinationConfiguration property type describes an S3 location where recorded videos will be stored.
static interface	CfnRecordingConfiguration.ThumbnailConfigurationProperty The ThumbnailConfiguration property type describes a configuration of thumbnails for recorded video.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnRecordingConfiguration(Construct scope, java.lang.String id, CfnRecordingConfigurationProps props) Create a new `AWS::IVS::RecordingConfiguration`.
protected	CfnRecordingConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnRecordingConfiguration(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrArn() The recording configuration ARN.
java.lang.String	getAttrState() Indicates the current state of the recording configuration.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.Object	getDestinationConfiguration() A destination configuration contains information about where recorded video will be stored.
java.lang.String	getName() Recording-configuration name.
java.lang.Number	getRecordingReconnectWindowSeconds() If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together.
TagManager	getTags() An array of key-value pairs to apply to this resource.
java.lang.Object	getThumbnailConfiguration() 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.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setDestinationConfiguration(CfnRecordingConfiguration.DestinationConfigurationProperty value) A destination configuration contains information about where recorded video will be stored.
void	setDestinationConfiguration(IResolvable value) A destination configuration contains information about where recorded video will be stored.
void	setName(java.lang.String value) Recording-configuration name.
void	setRecordingReconnectWindowSeconds(java.lang.Number value) If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together.
void	setThumbnailConfiguration(CfnRecordingConfiguration.ThumbnailConfigurationProperty value) 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.
void	setThumbnailConfiguration(IResolvable value) 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 inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnRecordingConfiguration

protected CfnRecordingConfiguration(software.amazon.jsii.JsiiObjectRef objRef)

CfnRecordingConfiguration

protected CfnRecordingConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnRecordingConfiguration

public CfnRecordingConfiguration(Construct scope,
                                 java.lang.String id,
                                 CfnRecordingConfigurationProps props)

Create a new `AWS::IVS::RecordingConfiguration`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

public java.lang.String getAttrArn()

The recording configuration ARN.

For example: arn:aws:ivs:us-west-2:123456789012:recording-configuration/abcdABCDefgh

getAttrState

public java.lang.String getAttrState()

Indicates the current state of the recording configuration.

When the state is ACTIVE , the configuration is ready to record a channel stream. Valid values: CREATING | CREATE_FAILED | ACTIVE .

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

An array of key-value pairs to apply to this resource.

For more information, see Tag .

getDestinationConfiguration

public java.lang.Object getDestinationConfiguration()

A destination configuration contains information about where recorded video will be stored.

See the DestinationConfiguration property type for more information.

setDestinationConfiguration

public void setDestinationConfiguration(IResolvable value)

A destination configuration contains information about where recorded video will be stored.

See the DestinationConfiguration property type for more information.

setDestinationConfiguration

public void setDestinationConfiguration(CfnRecordingConfiguration.DestinationConfigurationProperty value)

A destination configuration contains information about where recorded video will be stored.

See the DestinationConfiguration property type for more information.

getName

public java.lang.String getName()

Recording-configuration name.

The value does not need to be unique.

setName

public void setName(java.lang.String value)

Recording-configuration name.

The value does not need to be unique.

getRecordingReconnectWindowSeconds

public java.lang.Number getRecordingReconnectWindowSeconds()

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

setRecordingReconnectWindowSeconds

public void setRecordingReconnectWindowSeconds(java.lang.Number value)

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

getThumbnailConfiguration

public java.lang.Object getThumbnailConfiguration()

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.

See the ThumbnailConfiguration property type for more information.

setThumbnailConfiguration

public void setThumbnailConfiguration(IResolvable value)

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.

See the ThumbnailConfiguration property type for more information.

setThumbnailConfiguration

public void setThumbnailConfiguration(CfnRecordingConfiguration.ThumbnailConfigurationProperty value)

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.

See the ThumbnailConfiguration property type for more information.