Package 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:
IEnvironmentAware, IInspectable, ITaggable, IRecordingConfigurationRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-10T13:40:08.094Z") @Stability(Stable) public class CfnRecordingConfiguration extends CfnResource implements IInspectable, IRecordingConfigurationRef, ITaggable
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 IVS Low-Latency Streaming 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)
         .renditionConfiguration(RenditionConfigurationProperty.builder()
                 .renditions(List.of("renditions"))
                 .renditionSelection("renditionSelection")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .thumbnailConfiguration(ThumbnailConfigurationProperty.builder()
                 .recordingMode("recordingMode")
                 .resolution("resolution")
                 .storage(List.of("storage"))
                 .targetIntervalSeconds(123)
                 .build())
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnRecordingConfiguration

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

    • CfnRecordingConfiguration

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

    • CfnRecordingConfiguration

      @Stability(Stable) public CfnRecordingConfiguration(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnRecordingConfigurationProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(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(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(Stable) @NotNull public String getAttrArn()
      The recording configuration ARN.

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

    • getAttrState

      @Stability(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(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getRecordingConfigurationRef

      @Stability(Stable) @NotNull public RecordingConfigurationReference getRecordingConfigurationRef()
      A reference to a RecordingConfiguration resource.
      Specified by:
      getRecordingConfigurationRef in interface IRecordingConfigurationRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getDestinationConfiguration

      @Stability(Stable) @NotNull public Object getDestinationConfiguration()
      A destination configuration describes an S3 bucket where recorded video will be stored.

      Returns union: either IResolvable or CfnRecordingConfiguration.DestinationConfigurationProperty

    • setDestinationConfiguration

      @Stability(Stable) public void setDestinationConfiguration(@NotNull IResolvable value)
      A destination configuration describes an S3 bucket where recorded video will be stored.

    • setDestinationConfiguration

      @Stability(Stable) public void setDestinationConfiguration(@NotNull CfnRecordingConfiguration.DestinationConfigurationProperty value)
      A destination configuration describes an S3 bucket where recorded video will be stored.

    • getName

      @Stability(Stable) @Nullable public String getName()
      Recording-configuration name.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      Recording-configuration name.

    • getRecordingReconnectWindowSeconds

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

    • setRecordingReconnectWindowSeconds

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

    • getRenditionConfiguration

      @Stability(Stable) @Nullable public Object getRenditionConfiguration()
      A rendition configuration describes which renditions should be recorded for a stream.

      Returns union: either IResolvable or CfnRecordingConfiguration.RenditionConfigurationProperty

    • setRenditionConfiguration

      @Stability(Stable) public void setRenditionConfiguration(@Nullable IResolvable value)
      A rendition configuration describes which renditions should be recorded for a stream.

    • setRenditionConfiguration

      @Stability(Stable) public void setRenditionConfiguration(@Nullable CfnRecordingConfiguration.RenditionConfigurationProperty value)
      A rendition configuration describes which renditions should be recorded for a stream.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      An array of key-value pairs to apply to this resource.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to this resource.

    • getThumbnailConfiguration

      @Stability(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.

      Returns union: either IResolvable or CfnRecordingConfiguration.ThumbnailConfigurationProperty

    • setThumbnailConfiguration

      @Stability(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.

    • setThumbnailConfiguration

      @Stability(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.