@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)", date="2023-01-25T18:28:58.318Z") public class CfnRecordingConfiguration extends CfnResource implements IInspectable
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();
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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
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) |
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.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnRecordingConfiguration(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnRecordingConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnRecordingConfiguration(Construct scope, java.lang.String id, CfnRecordingConfigurationProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrArn()
For example: arn:aws:ivs:us-west-2:123456789012:recording-configuration/abcdABCDefgh
public java.lang.String getAttrState()
When the state is ACTIVE
, the configuration is ready to record a channel stream. Valid values: CREATING
| CREATE_FAILED
| ACTIVE
.
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
For more information, see Tag .
public java.lang.Object getDestinationConfiguration()
See the DestinationConfiguration property type for more information.
public void setDestinationConfiguration(IResolvable value)
See the DestinationConfiguration property type for more information.
public void setDestinationConfiguration(CfnRecordingConfiguration.DestinationConfigurationProperty value)
See the DestinationConfiguration property type for more information.
public java.lang.String getName()
The value does not need to be unique.
public void setName(java.lang.String value)
The value does not need to be unique.
public java.lang.Number getRecordingReconnectWindowSeconds()
Default : 0
public void setRecordingReconnectWindowSeconds(java.lang.Number value)
Default : 0
public java.lang.Object getThumbnailConfiguration()
See the ThumbnailConfiguration property type for more information.
public void setThumbnailConfiguration(IResolvable value)
See the ThumbnailConfiguration property type for more information.
public void setThumbnailConfiguration(CfnRecordingConfiguration.ThumbnailConfigurationProperty value)
See the ThumbnailConfiguration property type for more information.