RecordingConfiguration class
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", {
destinationConfiguration: {
s3: {
bucketName: "ivs-stream-archive",
},
},
name: "recording_configuration-1",
});
import pulumi
import pulumi_aws as aws
example = aws.ivs.RecordingConfiguration("example",
destination_configuration={
"s3": {
"bucket_name": "ivs-stream-archive",
},
},
name="recording_configuration-1")
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",
},
},
Name = "recording_configuration-1",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/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"),
},
},
Name: pulumi.String("recording_configuration-1"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_ivs_recordingconfiguration" "example" {
destination_configuration = {
s3 = {
bucket_name = "ivs-stream-archive"
}
}
name = "recording_configuration-1"
}
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.ArrayList;
import java.util.Arrays;
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())
.name("recording_configuration-1")
.build());
}
}
resources:
example:
type: aws:ivs:RecordingConfiguration
properties:
destinationConfiguration:
s3:
bucketName: ivs-stream-archive
name: recording_configuration-1
Import
Identity Schema
Required
arn(String) ARN of the IVS recording configuration.
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
Constructors
- RecordingConfiguration(String name, {RecordingConfigurationArgs? args, CustomResourceOptions? options})
-
Creates a new RecordingConfiguration.
nameThe Pulumi resource name.argsArguments used to configure this RecordingConfiguration. The set of arguments for RecordingConfiguration.optionsResource options controlling this resource's behavior. - RecordingConfiguration.reference(String urn)
- Creates a typed reference to an existing RecordingConfiguration resource.
Properties
-
arn
↔ Output<
String> -
ARN of the Recording Configuration.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
destinationConfiguration
↔ Output<
RecordingConfigurationDestinationConfiguration> -
Object containing destination configuration for where recorded video will be stored.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
name
↔ Output<
String> -
Recording Configuration name.
latefinal
-
recordingReconnectWindowSeconds
↔ Output<
int> -
If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
state
↔ Output<
String> -
The current state of the Recording Configuration.
latefinal
-
A map of tags to assign to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
thumbnailConfiguration
↔ Output<
RecordingConfigurationThumbnailConfiguration> -
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.
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {RecordingConfigurationState? state, CustomResourceOptions? options}) → RecordingConfiguration -
Gets an existing RecordingConfiguration resource's state with the given
nameandid.