aws.ivs.RecordingConfiguration
Explore with Pulumi AI
Resource for managing an AWS IVS (Interactive Video) Recording Configuration.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.ivs.RecordingConfiguration("example", {
name: "recording_configuration-1",
destinationConfiguration: {
s3: {
bucketName: "ivs-stream-archive",
},
},
});
import pulumi
import pulumi_aws as aws
example = aws.ivs.RecordingConfiguration("example",
name="recording_configuration-1",
destination_configuration={
"s3": {
"bucket_name": "ivs-stream-archive",
},
})
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/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{
Name: pulumi.String("recording_configuration-1"),
DestinationConfiguration: &ivs.RecordingConfigurationDestinationConfigurationArgs{
S3: &ivs.RecordingConfigurationDestinationConfigurationS3Args{
BucketName: pulumi.String("ivs-stream-archive"),
},
},
})
if err != nil {
return err
}
return nil
})
}
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()
{
Name = "recording_configuration-1",
DestinationConfiguration = new Aws.Ivs.Inputs.RecordingConfigurationDestinationConfigurationArgs
{
S3 = new Aws.Ivs.Inputs.RecordingConfigurationDestinationConfigurationS3Args
{
BucketName = "ivs-stream-archive",
},
},
});
});
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()
.name("recording_configuration-1")
.destinationConfiguration(RecordingConfigurationDestinationConfigurationArgs.builder()
.s3(RecordingConfigurationDestinationConfigurationS3Args.builder()
.bucketName("ivs-stream-archive")
.build())
.build())
.build());
}
}
resources:
example:
type: aws:ivs:RecordingConfiguration
properties:
name: recording_configuration-1
destinationConfiguration:
s3:
bucketName: ivs-stream-archive
Create RecordingConfiguration Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new RecordingConfiguration(name: string, args: RecordingConfigurationArgs, opts?: CustomResourceOptions);
@overload
def RecordingConfiguration(resource_name: str,
args: RecordingConfigurationArgs,
opts: Optional[ResourceOptions] = None)
@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)
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.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var recordingConfigurationResource = new Aws.Ivs.RecordingConfiguration("recordingConfigurationResource", new()
{
DestinationConfiguration = new Aws.Ivs.Inputs.RecordingConfigurationDestinationConfigurationArgs
{
S3 = new Aws.Ivs.Inputs.RecordingConfigurationDestinationConfigurationS3Args
{
BucketName = "string",
},
},
Name = "string",
RecordingReconnectWindowSeconds = 0,
Tags =
{
{ "string", "string" },
},
ThumbnailConfiguration = new Aws.Ivs.Inputs.RecordingConfigurationThumbnailConfigurationArgs
{
RecordingMode = "string",
TargetIntervalSeconds = 0,
},
});
example, err := ivs.NewRecordingConfiguration(ctx, "recordingConfigurationResource", &ivs.RecordingConfigurationArgs{
DestinationConfiguration: &ivs.RecordingConfigurationDestinationConfigurationArgs{
S3: &ivs.RecordingConfigurationDestinationConfigurationS3Args{
BucketName: pulumi.String("string"),
},
},
Name: pulumi.String("string"),
RecordingReconnectWindowSeconds: pulumi.Int(0),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
ThumbnailConfiguration: &ivs.RecordingConfigurationThumbnailConfigurationArgs{
RecordingMode: pulumi.String("string"),
TargetIntervalSeconds: pulumi.Int(0),
},
})
var recordingConfigurationResource = new RecordingConfiguration("recordingConfigurationResource", RecordingConfigurationArgs.builder()
.destinationConfiguration(RecordingConfigurationDestinationConfigurationArgs.builder()
.s3(RecordingConfigurationDestinationConfigurationS3Args.builder()
.bucketName("string")
.build())
.build())
.name("string")
.recordingReconnectWindowSeconds(0)
.tags(Map.of("string", "string"))
.thumbnailConfiguration(RecordingConfigurationThumbnailConfigurationArgs.builder()
.recordingMode("string")
.targetIntervalSeconds(0)
.build())
.build());
recording_configuration_resource = aws.ivs.RecordingConfiguration("recordingConfigurationResource",
destination_configuration={
"s3": {
"bucket_name": "string",
},
},
name="string",
recording_reconnect_window_seconds=0,
tags={
"string": "string",
},
thumbnail_configuration={
"recording_mode": "string",
"target_interval_seconds": 0,
})
const recordingConfigurationResource = new aws.ivs.RecordingConfiguration("recordingConfigurationResource", {
destinationConfiguration: {
s3: {
bucketName: "string",
},
},
name: "string",
recordingReconnectWindowSeconds: 0,
tags: {
string: "string",
},
thumbnailConfiguration: {
recordingMode: "string",
targetIntervalSeconds: 0,
},
});
type: aws:ivs:RecordingConfiguration
properties:
destinationConfiguration:
s3:
bucketName: string
name: string
recordingReconnectWindowSeconds: 0
tags:
string: string
thumbnailConfiguration:
recordingMode: string
targetIntervalSeconds: 0
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The RecordingConfiguration resource accepts the following input properties:
- Destination
Configuration RecordingConfiguration Destination Configuration - Object containing destination configuration for where recorded video will be stored.
- Name string
- Recording Configuration name.
- Recording
Reconnect intWindow Seconds - If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together.
- 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. - Thumbnail
Configuration RecordingConfiguration Thumbnail Configuration - 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 RecordingConfiguration Destination Configuration Args - Object containing destination configuration for where recorded video will be stored.
- Name string
- Recording Configuration name.
- Recording
Reconnect intWindow Seconds - If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together.
- 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. - Thumbnail
Configuration RecordingConfiguration Thumbnail Configuration Args - 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 RecordingConfiguration Destination Configuration - Object containing destination configuration for where recorded video will be stored.
- name String
- Recording Configuration name.
- recording
Reconnect IntegerWindow Seconds - If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together.
- 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. - thumbnail
Configuration RecordingConfiguration Thumbnail Configuration - 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 RecordingConfiguration Destination Configuration - Object containing destination configuration for where recorded video will be stored.
- name string
- Recording Configuration name.
- recording
Reconnect numberWindow Seconds - If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together.
- {[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. - thumbnail
Configuration RecordingConfiguration Thumbnail Configuration - 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 RecordingConfiguration Destination Configuration Args - Object containing destination configuration for where recorded video will be stored.
- name str
- Recording Configuration name.
- recording_
reconnect_ intwindow_ seconds - If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together.
- 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 RecordingConfiguration Thumbnail Configuration Args - 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 Property Map - Object containing destination configuration for where recorded video will be stored.
- name String
- Recording Configuration name.
- recording
Reconnect NumberWindow Seconds - If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together.
- 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. - thumbnail
Configuration 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.
- 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.
- 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.
- 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.
- {[key: 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.
- 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.
- Arn string
- ARN of the Recording Configuration.
- Destination
Configuration RecordingConfiguration Destination Configuration - Object containing destination configuration for where recorded video will be stored.
- Name string
- Recording Configuration name.
- Recording
Reconnect intWindow Seconds - 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.
- 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. - Dictionary<string, string>
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - Thumbnail
Configuration RecordingConfiguration Thumbnail Configuration - 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.
- Destination
Configuration RecordingConfiguration Destination Configuration Args - Object containing destination configuration for where recorded video will be stored.
- Name string
- Recording Configuration name.
- Recording
Reconnect intWindow Seconds - 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.
- 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. - map[string]string
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - Thumbnail
Configuration RecordingConfiguration Thumbnail Configuration Args - 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.
- destination
Configuration RecordingConfiguration Destination Configuration - Object containing destination configuration for where recorded video will be stored.
- name String
- Recording Configuration name.
- recording
Reconnect IntegerWindow Seconds - 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.
- 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. - Map<String,String>
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - thumbnail
Configuration RecordingConfiguration Thumbnail Configuration - 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.
- destination
Configuration RecordingConfiguration Destination Configuration - Object containing destination configuration for where recorded video will be stored.
- name string
- Recording Configuration name.
- recording
Reconnect numberWindow Seconds - 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.
- {[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. - {[key: string]: string}
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - thumbnail
Configuration RecordingConfiguration Thumbnail Configuration - 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 RecordingConfiguration Destination Configuration Args - Object containing destination configuration for where recorded video will be stored.
- name str
- Recording Configuration name.
- recording_
reconnect_ intwindow_ seconds - 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.
- 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. - Mapping[str, str]
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - thumbnail_
configuration RecordingConfiguration Thumbnail Configuration Args - 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.
- destination
Configuration Property Map - Object containing destination configuration for where recorded video will be stored.
- name String
- Recording Configuration name.
- recording
Reconnect NumberWindow Seconds - 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.
- 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. - Map<String>
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - thumbnail
Configuration 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, RecordingConfigurationDestinationConfigurationArgs
- S3
Recording
Configuration Destination Configuration S3 - S3 destination configuration where recorded videos will be stored.
- S3
Recording
Configuration Destination Configuration S3 - S3 destination configuration where recorded videos will be stored.
- s3
Recording
Configuration Destination Configuration S3 - S3 destination configuration where recorded videos will be stored.
- s3
Recording
Configuration Destination Configuration S3 - S3 destination configuration where recorded videos will be stored.
- s3
Recording
Configuration Destination Configuration S3 - S3 destination configuration where recorded videos will be stored.
- s3 Property Map
- S3 destination configuration where recorded videos will be stored.
RecordingConfigurationDestinationConfigurationS3, RecordingConfigurationDestinationConfigurationS3Args
- Bucket
Name string S3 bucket name where recorded videos will be stored.
The following arguments are optional:
- Bucket
Name string S3 bucket name where recorded videos will be stored.
The following arguments are optional:
- bucket
Name String S3 bucket name where recorded videos will be stored.
The following arguments are optional:
- bucket
Name string S3 bucket name where recorded videos will be stored.
The following arguments are optional:
- bucket_
name str S3 bucket name where recorded videos will be stored.
The following arguments are optional:
- bucket
Name String S3 bucket name where recorded videos will be stored.
The following arguments are optional:
RecordingConfigurationThumbnailConfiguration, RecordingConfigurationThumbnailConfigurationArgs
- Recording
Mode string - Thumbnail recording mode. Valid values:
DISABLED
,INTERVAL
. - Target
Interval intSeconds - The targeted thumbnail-generation interval in seconds.
- Recording
Mode string - Thumbnail recording mode. Valid values:
DISABLED
,INTERVAL
. - Target
Interval intSeconds - The targeted thumbnail-generation interval in seconds.
- recording
Mode String - Thumbnail recording mode. Valid values:
DISABLED
,INTERVAL
. - target
Interval IntegerSeconds - The targeted thumbnail-generation interval in seconds.
- recording
Mode string - Thumbnail recording mode. Valid values:
DISABLED
,INTERVAL
. - target
Interval numberSeconds - The targeted thumbnail-generation interval in seconds.
- recording_
mode str - Thumbnail recording mode. Valid values:
DISABLED
,INTERVAL
. - target_
interval_ intseconds - The targeted thumbnail-generation interval in seconds.
- recording
Mode String - Thumbnail recording mode. Valid values:
DISABLED
,INTERVAL
. - target
Interval NumberSeconds - The targeted thumbnail-generation interval in seconds.
Import
Using pulumi import
, import IVS (Interactive Video) Recording Configuration using the ARN. For example:
$ pulumi import aws:ivs/recordingConfiguration:RecordingConfiguration example arn:aws:ivs:us-west-2:326937407773:recording-configuration/KAk1sHBl2L47
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.