software.amazon.awscdk.services.ivs

Class CfnRecordingConfiguration

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.ivs.CfnRecordingConfiguration

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.110Z")
 @Stability(value=Stable)
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")
         .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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnRecordingConfiguration(software.constructs.Construct scope, 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
String	getAttrArn() The recording configuration ARN.
String	getAttrState() Indicates the current state of the recording configuration.
protected Map<String,Object>	getCfnProperties()
Object	getDestinationConfiguration() A destination configuration contains information about where recorded video will be stored.
String	getName() Recording-configuration name.
TagManager	getTags() An array of key-value pairs to apply to this resource.
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 Map<String,Object>	renderProperties(Map<String,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(String value) Recording-configuration name.
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.CfnResource

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

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnRecordingConfiguration(@NotNull
                                                          software.constructs.Construct scope,
                                                          @NotNull
                                                          String id,
                                                          @NotNull
                                                          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

@Stability(value=Stable)
public void inspect(@NotNull
                                             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

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

The recording configuration ARN.

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

getAttrState

@Stability(value=Stable)
 @NotNull
public 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

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

For more information, see Tag .

getDestinationConfiguration

@Stability(value=Stable)
 @NotNull
public Object getDestinationConfiguration()

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

See the DestinationConfiguration property type for more information.

setDestinationConfiguration

@Stability(value=Stable)
public void setDestinationConfiguration(@NotNull
                                                                 CfnRecordingConfiguration.DestinationConfigurationProperty value)

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

See the DestinationConfiguration property type for more information.

setDestinationConfiguration

@Stability(value=Stable)
public void setDestinationConfiguration(@NotNull
                                                                 IResolvable value)

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

See the DestinationConfiguration property type for more information.

getName

@Stability(value=Stable)
 @Nullable
public String getName()

Recording-configuration name.

The value does not need to be unique.

setName

@Stability(value=Stable)
public void setName(@Nullable
                                             String value)

Recording-configuration name.

The value does not need to be unique.

getThumbnailConfiguration

@Stability(value=Stable)
 @Nullable
public 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

@Stability(value=Stable)
public void setThumbnailConfiguration(@Nullable
                                                               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.

setThumbnailConfiguration

@Stability(value=Stable)
public void setThumbnailConfiguration(@Nullable
                                                               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.