Skip to content

Resource: awsIvsRecordingConfiguration

Terraform resource for managing an AWS IVS (Interactive Video) Recording Configuration.

Example Usage

Basic Usage

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.ivsRecordingConfiguration.IvsRecordingConfiguration(this, "example", {
  destinationConfiguration: {
    s3: {
      bucketName: "ivs-stream-archive",
    },
  },
  name: "recording_configuration-1",
});

Argument Reference

The following arguments are required:

  • destinationConfiguration - Object containing destination configuration for where recorded video will be stored.
  • s3 - S3 destination configuration where recorded videos will be stored.
    • bucketName - S3 bucket name where recorded videos will be stored.

The following arguments are optional:

  • name - (Optional) Recording Configuration name.
  • recordingReconnectWindowSeconds - (Optional) If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together.
  • tags - (Optional) A map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
  • thumbnailConfiguration - (Optional) Object containing information to enable/disable the recording of thumbnails for a live session and modify the interval at which thumbnails are generated for the live session.
  • recordingMode - (Optional) Thumbnail recording mode. Valid values: disabled, interval.
  • targetIntervalSeconds (Configurable [and required] only if recordingMode is interval) - The targeted thumbnail-generation interval in seconds.

Attributes Reference

In addition to all arguments above, the following attributes are exported:

  • arn - ARN of the Recording Configuration.
  • state - The current state of the Recording Configuration.
  • tagsAll - Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.

Timeouts

Configuration options:

  • create - (Default 10M)
  • delete - (Default 10M)

Import

IVS (Interactive Video) Recording Configuration can be imported using the ARN, e.g.,

$ terraform import aws_ivs_recording_configuration.example arn:aws:ivs:us-west-2:326937407773:recording-configuration/KAk1sHBl2L47