AWS Classic v5.41.0, May 15 23

aws.ivs.RecordingConfiguration

Explore with Pulumi AI

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

Example Usage

Basic Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Ivs.RecordingConfiguration("example", new()
    {
        DestinationConfiguration = new Aws.Ivs.Inputs.RecordingConfigurationDestinationConfigurationArgs
        {
            S3 = new Aws.Ivs.Inputs.RecordingConfigurationDestinationConfigurationS3Args
            {
                BucketName = "ivs-stream-archive",
            },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/ivs"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ivs.NewRecordingConfiguration(ctx, "example", &ivs.RecordingConfigurationArgs{
			DestinationConfiguration: &ivs.RecordingConfigurationDestinationConfigurationArgs{
				S3: &ivs.RecordingConfigurationDestinationConfigurationS3Args{
					BucketName: pulumi.String("ivs-stream-archive"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ivs.RecordingConfiguration;
import com.pulumi.aws.ivs.RecordingConfigurationArgs;
import com.pulumi.aws.ivs.inputs.RecordingConfigurationDestinationConfigurationArgs;
import com.pulumi.aws.ivs.inputs.RecordingConfigurationDestinationConfigurationS3Args;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new RecordingConfiguration("example", RecordingConfigurationArgs.builder()        
            .destinationConfiguration(RecordingConfigurationDestinationConfigurationArgs.builder()
                .s3(RecordingConfigurationDestinationConfigurationS3Args.builder()
                    .bucketName("ivs-stream-archive")
                    .build())
                .build())
            .build());

    }
}

import pulumi
import pulumi_aws as aws

example = aws.ivs.RecordingConfiguration("example", destination_configuration=aws.ivs.RecordingConfigurationDestinationConfigurationArgs(
    s3=aws.ivs.RecordingConfigurationDestinationConfigurationS3Args(
        bucket_name="ivs-stream-archive",
    ),
))

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.ivs.RecordingConfiguration("example", {destinationConfiguration: {
    s3: {
        bucketName: "ivs-stream-archive",
    },
}});

resources:
  example:
    type: aws:ivs:RecordingConfiguration
    properties:
      destinationConfiguration:
        s3:
          bucketName: ivs-stream-archive

Create RecordingConfiguration Resource

new RecordingConfiguration(name: string, args: RecordingConfigurationArgs, opts?: CustomResourceOptions);

@overload
def RecordingConfiguration(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           destination_configuration: Optional[RecordingConfigurationDestinationConfigurationArgs] = None,
                           name: Optional[str] = None,
                           recording_reconnect_window_seconds: Optional[int] = None,
                           tags: Optional[Mapping[str, str]] = None,
                           thumbnail_configuration: Optional[RecordingConfigurationThumbnailConfigurationArgs] = None)
@overload
def RecordingConfiguration(resource_name: str,
                           args: RecordingConfigurationArgs,
                           opts: Optional[ResourceOptions] = None)

func NewRecordingConfiguration(ctx *Context, name string, args RecordingConfigurationArgs, opts ...ResourceOption) (*RecordingConfiguration, error)

public RecordingConfiguration(string name, RecordingConfigurationArgs args, CustomResourceOptions? opts = null)

public RecordingConfiguration(String name, RecordingConfigurationArgs args)
public RecordingConfiguration(String name, RecordingConfigurationArgs args, CustomResourceOptions options)

type: aws:ivs:RecordingConfiguration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args RecordingConfigurationArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args RecordingConfigurationArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args RecordingConfigurationArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args RecordingConfigurationArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args RecordingConfigurationArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

RecordingConfiguration Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The RecordingConfiguration resource accepts the following input properties:

DestinationConfiguration Pulumi.Aws.Ivs.Inputs.RecordingConfigurationDestinationConfigurationArgs: Object containing destination configuration for where recorded video will be stored.
Name string: Recording Configuration name.
RecordingReconnectWindowSeconds int: If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together.
Tags Dictionary<string, string>: A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
ThumbnailConfiguration Pulumi.Aws.Ivs.Inputs.RecordingConfigurationThumbnailConfigurationArgs: 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.

DestinationConfiguration RecordingConfigurationDestinationConfigurationArgs: Object containing destination configuration for where recorded video will be stored.
Name string: Recording Configuration name.
RecordingReconnectWindowSeconds int: If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together.
Tags map[string]string: A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
ThumbnailConfiguration RecordingConfigurationThumbnailConfigurationArgs: 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.

destinationConfiguration RecordingConfigurationDestinationConfigurationArgs: Object containing destination configuration for where recorded video will be stored.
name String: Recording Configuration name.
recordingReconnectWindowSeconds Integer: If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together.
tags Map<String,String>: A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
thumbnailConfiguration RecordingConfigurationThumbnailConfigurationArgs: 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.

destinationConfiguration RecordingConfigurationDestinationConfigurationArgs: Object containing destination configuration for where recorded video will be stored.
name string: Recording Configuration name.
recordingReconnectWindowSeconds number: If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together.
tags {[key: string]: string}: A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
thumbnailConfiguration RecordingConfigurationThumbnailConfigurationArgs: 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.

destination_configuration RecordingConfigurationDestinationConfigurationArgs: Object containing destination configuration for where recorded video will be stored.
name str: Recording Configuration name.
recording_reconnect_window_seconds int: If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together.
tags Mapping[str, str]: A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
thumbnail_configuration RecordingConfigurationThumbnailConfigurationArgs: 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.

destinationConfiguration Property Map: Object containing destination configuration for where recorded video will be stored.
name String: Recording Configuration name.
recordingReconnectWindowSeconds Number: If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together.
tags Map<String>: A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
thumbnailConfiguration Property Map: 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.

Outputs

All input properties are implicitly available as output properties. Additionally, the RecordingConfiguration resource produces the following output properties:

Arn string: ARN of the Recording Configuration.
Id string: The provider-assigned unique ID for this managed resource.
State string: The current state of the Recording Configuration.
TagsAll Dictionary<string, string>: Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Arn string: ARN of the Recording Configuration.
Id string: The provider-assigned unique ID for this managed resource.
State string: The current state of the Recording Configuration.
TagsAll map[string]string: Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String: ARN of the Recording Configuration.
id String: The provider-assigned unique ID for this managed resource.
state String: The current state of the Recording Configuration.
tagsAll Map<String,String>: Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn string: ARN of the Recording Configuration.
id string: The provider-assigned unique ID for this managed resource.
state string: The current state of the Recording Configuration.
tagsAll {[key: string]: string}: Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn str: ARN of the Recording Configuration.
id str: The provider-assigned unique ID for this managed resource.
state str: The current state of the Recording Configuration.
tags_all Mapping[str, str]: Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String: ARN of the Recording Configuration.
id String: The provider-assigned unique ID for this managed resource.
state String: The current state of the Recording Configuration.
tagsAll Map<String>: Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Look up Existing RecordingConfiguration Resource

Get an existing RecordingConfiguration resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: RecordingConfigurationState, opts?: CustomResourceOptions): RecordingConfiguration

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        destination_configuration: Optional[RecordingConfigurationDestinationConfigurationArgs] = None,
        name: Optional[str] = None,
        recording_reconnect_window_seconds: Optional[int] = None,
        state: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        thumbnail_configuration: Optional[RecordingConfigurationThumbnailConfigurationArgs] = None) -> RecordingConfiguration

func GetRecordingConfiguration(ctx *Context, name string, id IDInput, state *RecordingConfigurationState, opts ...ResourceOption) (*RecordingConfiguration, error)

public static RecordingConfiguration Get(string name, Input<string> id, RecordingConfigurationState? state, CustomResourceOptions? opts = null)

public static RecordingConfiguration get(String name, Output<String> id, RecordingConfigurationState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Arn string: ARN of the Recording Configuration.
DestinationConfiguration Pulumi.Aws.Ivs.Inputs.RecordingConfigurationDestinationConfigurationArgs: Object containing destination configuration for where recorded video will be stored.
Name string: Recording Configuration name.
RecordingReconnectWindowSeconds int: If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together.
State string: The current state of the Recording Configuration.
Tags Dictionary<string, string>: A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll Dictionary<string, string>: Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
ThumbnailConfiguration Pulumi.Aws.Ivs.Inputs.RecordingConfigurationThumbnailConfigurationArgs: 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.

Arn string: ARN of the Recording Configuration.
DestinationConfiguration RecordingConfigurationDestinationConfigurationArgs: Object containing destination configuration for where recorded video will be stored.
Name string: Recording Configuration name.
RecordingReconnectWindowSeconds int: If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together.
State string: The current state of the Recording Configuration.
Tags map[string]string: A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll map[string]string: Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
ThumbnailConfiguration RecordingConfigurationThumbnailConfigurationArgs: 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.

arn String: ARN of the Recording Configuration.
destinationConfiguration RecordingConfigurationDestinationConfigurationArgs: Object containing destination configuration for where recorded video will be stored.
name String: Recording Configuration name.
recordingReconnectWindowSeconds Integer: If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together.
state String: The current state of the Recording Configuration.
tags Map<String,String>: A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll Map<String,String>: Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
thumbnailConfiguration RecordingConfigurationThumbnailConfigurationArgs: 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.

arn string: ARN of the Recording Configuration.
destinationConfiguration RecordingConfigurationDestinationConfigurationArgs: Object containing destination configuration for where recorded video will be stored.
name string: Recording Configuration name.
recordingReconnectWindowSeconds number: If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together.
state string: The current state of the Recording Configuration.
tags {[key: string]: string}: A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll {[key: string]: string}: Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
thumbnailConfiguration RecordingConfigurationThumbnailConfigurationArgs: 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.

arn str: ARN of the Recording Configuration.
destination_configuration RecordingConfigurationDestinationConfigurationArgs: Object containing destination configuration for where recorded video will be stored.
name str: Recording Configuration name.
recording_reconnect_window_seconds int: If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together.
state str: The current state of the Recording Configuration.
tags Mapping[str, str]: A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tags_all Mapping[str, str]: Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
thumbnail_configuration RecordingConfigurationThumbnailConfigurationArgs: 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.

arn String: ARN of the Recording Configuration.
destinationConfiguration Property Map: Object containing destination configuration for where recorded video will be stored.
name String: Recording Configuration name.
recordingReconnectWindowSeconds Number: If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together.
state String: The current state of the Recording Configuration.
tags Map<String>: A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll Map<String>: Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
thumbnailConfiguration Property Map: 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.

Supporting Types

RecordingConfigurationDestinationConfiguration

S3 Pulumi.Aws.Ivs.Inputs.RecordingConfigurationDestinationConfigurationS3: S3 destination configuration where recorded videos will be stored.

S3 RecordingConfigurationDestinationConfigurationS3: S3 destination configuration where recorded videos will be stored.

s3 RecordingConfigurationDestinationConfigurationS3: S3 destination configuration where recorded videos will be stored.

s3 RecordingConfigurationDestinationConfigurationS3: S3 destination configuration where recorded videos will be stored.

s3 RecordingConfigurationDestinationConfigurationS3: S3 destination configuration where recorded videos will be stored.

s3 Property Map: S3 destination configuration where recorded videos will be stored.

RecordingConfigurationDestinationConfigurationS3

BucketName string: S3 bucket name where recorded videos will be stored.

BucketName string: S3 bucket name where recorded videos will be stored.

bucketName String: S3 bucket name where recorded videos will be stored.

bucketName string: S3 bucket name where recorded videos will be stored.

bucket_name str: S3 bucket name where recorded videos will be stored.

bucketName String: S3 bucket name where recorded videos will be stored.

RecordingConfigurationThumbnailConfiguration

RecordingMode string: Thumbnail recording mode. Valid values: DISABLED, INTERVAL.
TargetIntervalSeconds int: The targeted thumbnail-generation interval in seconds.

RecordingMode string: Thumbnail recording mode. Valid values: DISABLED, INTERVAL.
TargetIntervalSeconds int: The targeted thumbnail-generation interval in seconds.

recordingMode String: Thumbnail recording mode. Valid values: DISABLED, INTERVAL.
targetIntervalSeconds Integer: The targeted thumbnail-generation interval in seconds.

recordingMode string: Thumbnail recording mode. Valid values: DISABLED, INTERVAL.
targetIntervalSeconds number: The targeted thumbnail-generation interval in seconds.

recording_mode str: Thumbnail recording mode. Valid values: DISABLED, INTERVAL.
target_interval_seconds int: The targeted thumbnail-generation interval in seconds.

recordingMode String: Thumbnail recording mode. Valid values: DISABLED, INTERVAL.
targetIntervalSeconds Number: The targeted thumbnail-generation interval in seconds.

Import

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

 $ pulumi import aws:ivs/recordingConfiguration:RecordingConfiguration example arn:aws:ivs:us-west-2:326937407773:recording-configuration/KAk1sHBl2L47

Package Details

Repository: AWS Classic pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.