Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. ivs
  5. RecordingConfiguration

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.ivs.RecordingConfiguration

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::IVS::RecordingConfiguration

    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,
                           rendition_configuration: Optional[RecordingConfigurationRenditionConfigurationArgs] = None,
                           tags: Optional[Sequence[_root_inputs.TagArgs]] = 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-native: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.

    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:

    DestinationConfiguration Pulumi.AwsNative.Ivs.Inputs.RecordingConfigurationDestinationConfiguration
    A destination configuration describes an S3 bucket where recorded video will be stored. See the DestinationConfiguration property type for more information.
    Name string
    Recording Configuration Name.
    RecordingReconnectWindowSeconds int
    Recording Reconnect Window Seconds. (0 means disabled)
    RenditionConfiguration Pulumi.AwsNative.Ivs.Inputs.RecordingConfigurationRenditionConfiguration
    A rendition configuration describes which renditions should be recorded for a stream. See the RenditionConfiguration property type for more information.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    A list of key-value pairs that contain metadata for the asset model.
    ThumbnailConfiguration Pulumi.AwsNative.Ivs.Inputs.RecordingConfigurationThumbnailConfiguration
    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. See the ThumbnailConfiguration property type for more information.
    DestinationConfiguration RecordingConfigurationDestinationConfigurationArgs
    A destination configuration describes an S3 bucket where recorded video will be stored. See the DestinationConfiguration property type for more information.
    Name string
    Recording Configuration Name.
    RecordingReconnectWindowSeconds int
    Recording Reconnect Window Seconds. (0 means disabled)
    RenditionConfiguration RecordingConfigurationRenditionConfigurationArgs
    A rendition configuration describes which renditions should be recorded for a stream. See the RenditionConfiguration property type for more information.
    Tags TagArgs
    A list of key-value pairs that contain metadata for the asset model.
    ThumbnailConfiguration RecordingConfigurationThumbnailConfigurationArgs
    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. See the ThumbnailConfiguration property type for more information.
    destinationConfiguration RecordingConfigurationDestinationConfiguration
    A destination configuration describes an S3 bucket where recorded video will be stored. See the DestinationConfiguration property type for more information.
    name String
    Recording Configuration Name.
    recordingReconnectWindowSeconds Integer
    Recording Reconnect Window Seconds. (0 means disabled)
    renditionConfiguration RecordingConfigurationRenditionConfiguration
    A rendition configuration describes which renditions should be recorded for a stream. See the RenditionConfiguration property type for more information.
    tags List<Tag>
    A list of key-value pairs that contain metadata for the asset model.
    thumbnailConfiguration RecordingConfigurationThumbnailConfiguration
    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. See the ThumbnailConfiguration property type for more information.
    destinationConfiguration RecordingConfigurationDestinationConfiguration
    A destination configuration describes an S3 bucket where recorded video will be stored. See the DestinationConfiguration property type for more information.
    name string
    Recording Configuration Name.
    recordingReconnectWindowSeconds number
    Recording Reconnect Window Seconds. (0 means disabled)
    renditionConfiguration RecordingConfigurationRenditionConfiguration
    A rendition configuration describes which renditions should be recorded for a stream. See the RenditionConfiguration property type for more information.
    tags Tag[]
    A list of key-value pairs that contain metadata for the asset model.
    thumbnailConfiguration RecordingConfigurationThumbnailConfiguration
    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. See the ThumbnailConfiguration property type for more information.
    destination_configuration RecordingConfigurationDestinationConfigurationArgs
    A destination configuration describes an S3 bucket where recorded video will be stored. See the DestinationConfiguration property type for more information.
    name str
    Recording Configuration Name.
    recording_reconnect_window_seconds int
    Recording Reconnect Window Seconds. (0 means disabled)
    rendition_configuration RecordingConfigurationRenditionConfigurationArgs
    A rendition configuration describes which renditions should be recorded for a stream. See the RenditionConfiguration property type for more information.
    tags Sequence[TagArgs]
    A list of key-value pairs that contain metadata for the asset model.
    thumbnail_configuration RecordingConfigurationThumbnailConfigurationArgs
    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. See the ThumbnailConfiguration property type for more information.
    destinationConfiguration Property Map
    A destination configuration describes an S3 bucket where recorded video will be stored. See the DestinationConfiguration property type for more information.
    name String
    Recording Configuration Name.
    recordingReconnectWindowSeconds Number
    Recording Reconnect Window Seconds. (0 means disabled)
    renditionConfiguration Property Map
    A rendition configuration describes which renditions should be recorded for a stream. See the RenditionConfiguration property type for more information.
    tags List<Property Map>
    A list of key-value pairs that contain metadata for the asset model.
    thumbnailConfiguration Property Map
    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. See the ThumbnailConfiguration property type for more information.

    Outputs

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

    Arn string
    Recording Configuration ARN is automatically generated on creation and assigned as the unique identifier.
    Id string
    The provider-assigned unique ID for this managed resource.
    State Pulumi.AwsNative.Ivs.RecordingConfigurationState
    Recording Configuration State.
    Arn string
    Recording Configuration ARN is automatically generated on creation and assigned as the unique identifier.
    Id string
    The provider-assigned unique ID for this managed resource.
    State RecordingConfigurationStateEnum
    Recording Configuration State.
    arn String
    Recording Configuration ARN is automatically generated on creation and assigned as the unique identifier.
    id String
    The provider-assigned unique ID for this managed resource.
    state RecordingConfigurationState
    Recording Configuration State.
    arn string
    Recording Configuration ARN is automatically generated on creation and assigned as the unique identifier.
    id string
    The provider-assigned unique ID for this managed resource.
    state RecordingConfigurationState
    Recording Configuration State.
    arn str
    Recording Configuration ARN is automatically generated on creation and assigned as the unique identifier.
    id str
    The provider-assigned unique ID for this managed resource.
    state RecordingConfigurationState
    Recording Configuration State.
    arn String
    Recording Configuration ARN is automatically generated on creation and assigned as the unique identifier.
    id String
    The provider-assigned unique ID for this managed resource.
    state "CREATING" | "CREATE_FAILED" | "ACTIVE"
    Recording Configuration State.

    Supporting Types

    RecordingConfigurationDestinationConfiguration, RecordingConfigurationDestinationConfigurationArgs

    S3 Pulumi.AwsNative.Ivs.Inputs.RecordingConfigurationS3DestinationConfiguration
    An S3 destination configuration where recorded videos will be stored. See the S3DestinationConfiguration property type for more information.
    S3 RecordingConfigurationS3DestinationConfiguration
    An S3 destination configuration where recorded videos will be stored. See the S3DestinationConfiguration property type for more information.
    s3 RecordingConfigurationS3DestinationConfiguration
    An S3 destination configuration where recorded videos will be stored. See the S3DestinationConfiguration property type for more information.
    s3 RecordingConfigurationS3DestinationConfiguration
    An S3 destination configuration where recorded videos will be stored. See the S3DestinationConfiguration property type for more information.
    s3 RecordingConfigurationS3DestinationConfiguration
    An S3 destination configuration where recorded videos will be stored. See the S3DestinationConfiguration property type for more information.
    s3 Property Map
    An S3 destination configuration where recorded videos will be stored. See the S3DestinationConfiguration property type for more information.

    RecordingConfigurationRenditionConfiguration, RecordingConfigurationRenditionConfigurationArgs

    RenditionSelection Pulumi.AwsNative.Ivs.RecordingConfigurationRenditionConfigurationRenditionSelection
    Resolution Selection indicates which set of renditions are recorded for a stream.
    Renditions List<Pulumi.AwsNative.Ivs.RecordingConfigurationRenditionConfigurationRenditionsItem>
    Renditions indicates which renditions are recorded for a stream.
    RenditionSelection RecordingConfigurationRenditionConfigurationRenditionSelection
    Resolution Selection indicates which set of renditions are recorded for a stream.
    Renditions []RecordingConfigurationRenditionConfigurationRenditionsItem
    Renditions indicates which renditions are recorded for a stream.
    renditionSelection RecordingConfigurationRenditionConfigurationRenditionSelection
    Resolution Selection indicates which set of renditions are recorded for a stream.
    renditions List<RecordingConfigurationRenditionConfigurationRenditionsItem>
    Renditions indicates which renditions are recorded for a stream.
    renditionSelection RecordingConfigurationRenditionConfigurationRenditionSelection
    Resolution Selection indicates which set of renditions are recorded for a stream.
    renditions RecordingConfigurationRenditionConfigurationRenditionsItem[]
    Renditions indicates which renditions are recorded for a stream.
    rendition_selection RecordingConfigurationRenditionConfigurationRenditionSelection
    Resolution Selection indicates which set of renditions are recorded for a stream.
    renditions Sequence[RecordingConfigurationRenditionConfigurationRenditionsItem]
    Renditions indicates which renditions are recorded for a stream.
    renditionSelection "ALL" | "NONE" | "CUSTOM"
    Resolution Selection indicates which set of renditions are recorded for a stream.
    renditions List<"FULL_HD" | "HD" | "SD" | "LOWEST_RESOLUTION">
    Renditions indicates which renditions are recorded for a stream.

    RecordingConfigurationRenditionConfigurationRenditionSelection, RecordingConfigurationRenditionConfigurationRenditionSelectionArgs

    All
    ALL
    None
    NONE
    Custom
    CUSTOM
    RecordingConfigurationRenditionConfigurationRenditionSelectionAll
    ALL
    RecordingConfigurationRenditionConfigurationRenditionSelectionNone
    NONE
    RecordingConfigurationRenditionConfigurationRenditionSelectionCustom
    CUSTOM
    All
    ALL
    None
    NONE
    Custom
    CUSTOM
    All
    ALL
    None
    NONE
    Custom
    CUSTOM
    ALL
    ALL
    NONE
    NONE
    CUSTOM
    CUSTOM
    "ALL"
    ALL
    "NONE"
    NONE
    "CUSTOM"
    CUSTOM

    RecordingConfigurationRenditionConfigurationRenditionsItem, RecordingConfigurationRenditionConfigurationRenditionsItemArgs

    FullHd
    FULL_HD
    Hd
    HD
    Sd
    SD
    LowestResolution
    LOWEST_RESOLUTION
    RecordingConfigurationRenditionConfigurationRenditionsItemFullHd
    FULL_HD
    RecordingConfigurationRenditionConfigurationRenditionsItemHd
    HD
    RecordingConfigurationRenditionConfigurationRenditionsItemSd
    SD
    RecordingConfigurationRenditionConfigurationRenditionsItemLowestResolution
    LOWEST_RESOLUTION
    FullHd
    FULL_HD
    Hd
    HD
    Sd
    SD
    LowestResolution
    LOWEST_RESOLUTION
    FullHd
    FULL_HD
    Hd
    HD
    Sd
    SD
    LowestResolution
    LOWEST_RESOLUTION
    FULL_HD
    FULL_HD
    HD
    HD
    SD
    SD
    LOWEST_RESOLUTION
    LOWEST_RESOLUTION
    "FULL_HD"
    FULL_HD
    "HD"
    HD
    "SD"
    SD
    "LOWEST_RESOLUTION"
    LOWEST_RESOLUTION

    RecordingConfigurationS3DestinationConfiguration, RecordingConfigurationS3DestinationConfigurationArgs

    BucketName string
    Location (S3 bucket name) where recorded videos will be stored.
    BucketName string
    Location (S3 bucket name) where recorded videos will be stored.
    bucketName String
    Location (S3 bucket name) where recorded videos will be stored.
    bucketName string
    Location (S3 bucket name) where recorded videos will be stored.
    bucket_name str
    Location (S3 bucket name) where recorded videos will be stored.
    bucketName String
    Location (S3 bucket name) where recorded videos will be stored.

    RecordingConfigurationState, RecordingConfigurationStateArgs

    Creating
    CREATING
    CreateFailed
    CREATE_FAILED
    Active
    ACTIVE
    RecordingConfigurationStateCreating
    CREATING
    RecordingConfigurationStateCreateFailed
    CREATE_FAILED
    RecordingConfigurationStateActive
    ACTIVE
    Creating
    CREATING
    CreateFailed
    CREATE_FAILED
    Active
    ACTIVE
    Creating
    CREATING
    CreateFailed
    CREATE_FAILED
    Active
    ACTIVE
    CREATING
    CREATING
    CREATE_FAILED
    CREATE_FAILED
    ACTIVE
    ACTIVE
    "CREATING"
    CREATING
    "CREATE_FAILED"
    CREATE_FAILED
    "ACTIVE"
    ACTIVE

    RecordingConfigurationThumbnailConfiguration, RecordingConfigurationThumbnailConfigurationArgs

    RecordingMode Pulumi.AwsNative.Ivs.RecordingConfigurationThumbnailConfigurationRecordingMode
    Thumbnail Recording Mode, which determines whether thumbnails are recorded at an interval or are disabled.
    Resolution Pulumi.AwsNative.Ivs.RecordingConfigurationThumbnailConfigurationResolution
    Resolution indicates the desired resolution of recorded thumbnails.
    Storage List<Pulumi.AwsNative.Ivs.RecordingConfigurationThumbnailConfigurationStorageItem>
    Storage indicates the format in which thumbnails are recorded.
    TargetIntervalSeconds int
    Target Interval Seconds defines the interval at which thumbnails are recorded. This field is required if RecordingMode is INTERVAL.
    RecordingMode RecordingConfigurationThumbnailConfigurationRecordingMode
    Thumbnail Recording Mode, which determines whether thumbnails are recorded at an interval or are disabled.
    Resolution RecordingConfigurationThumbnailConfigurationResolution
    Resolution indicates the desired resolution of recorded thumbnails.
    Storage []RecordingConfigurationThumbnailConfigurationStorageItem
    Storage indicates the format in which thumbnails are recorded.
    TargetIntervalSeconds int
    Target Interval Seconds defines the interval at which thumbnails are recorded. This field is required if RecordingMode is INTERVAL.
    recordingMode RecordingConfigurationThumbnailConfigurationRecordingMode
    Thumbnail Recording Mode, which determines whether thumbnails are recorded at an interval or are disabled.
    resolution RecordingConfigurationThumbnailConfigurationResolution
    Resolution indicates the desired resolution of recorded thumbnails.
    storage List<RecordingConfigurationThumbnailConfigurationStorageItem>
    Storage indicates the format in which thumbnails are recorded.
    targetIntervalSeconds Integer
    Target Interval Seconds defines the interval at which thumbnails are recorded. This field is required if RecordingMode is INTERVAL.
    recordingMode RecordingConfigurationThumbnailConfigurationRecordingMode
    Thumbnail Recording Mode, which determines whether thumbnails are recorded at an interval or are disabled.
    resolution RecordingConfigurationThumbnailConfigurationResolution
    Resolution indicates the desired resolution of recorded thumbnails.
    storage RecordingConfigurationThumbnailConfigurationStorageItem[]
    Storage indicates the format in which thumbnails are recorded.
    targetIntervalSeconds number
    Target Interval Seconds defines the interval at which thumbnails are recorded. This field is required if RecordingMode is INTERVAL.
    recording_mode RecordingConfigurationThumbnailConfigurationRecordingMode
    Thumbnail Recording Mode, which determines whether thumbnails are recorded at an interval or are disabled.
    resolution RecordingConfigurationThumbnailConfigurationResolution
    Resolution indicates the desired resolution of recorded thumbnails.
    storage Sequence[RecordingConfigurationThumbnailConfigurationStorageItem]
    Storage indicates the format in which thumbnails are recorded.
    target_interval_seconds int
    Target Interval Seconds defines the interval at which thumbnails are recorded. This field is required if RecordingMode is INTERVAL.
    recordingMode "INTERVAL" | "DISABLED"
    Thumbnail Recording Mode, which determines whether thumbnails are recorded at an interval or are disabled.
    resolution "FULL_HD" | "HD" | "SD" | "LOWEST_RESOLUTION"
    Resolution indicates the desired resolution of recorded thumbnails.
    storage List<"SEQUENTIAL" | "LATEST">
    Storage indicates the format in which thumbnails are recorded.
    targetIntervalSeconds Number
    Target Interval Seconds defines the interval at which thumbnails are recorded. This field is required if RecordingMode is INTERVAL.

    RecordingConfigurationThumbnailConfigurationRecordingMode, RecordingConfigurationThumbnailConfigurationRecordingModeArgs

    Interval
    INTERVAL
    Disabled
    DISABLED
    RecordingConfigurationThumbnailConfigurationRecordingModeInterval
    INTERVAL
    RecordingConfigurationThumbnailConfigurationRecordingModeDisabled
    DISABLED
    Interval
    INTERVAL
    Disabled
    DISABLED
    Interval
    INTERVAL
    Disabled
    DISABLED
    INTERVAL
    INTERVAL
    DISABLED
    DISABLED
    "INTERVAL"
    INTERVAL
    "DISABLED"
    DISABLED

    RecordingConfigurationThumbnailConfigurationResolution, RecordingConfigurationThumbnailConfigurationResolutionArgs

    FullHd
    FULL_HD
    Hd
    HD
    Sd
    SD
    LowestResolution
    LOWEST_RESOLUTION
    RecordingConfigurationThumbnailConfigurationResolutionFullHd
    FULL_HD
    RecordingConfigurationThumbnailConfigurationResolutionHd
    HD
    RecordingConfigurationThumbnailConfigurationResolutionSd
    SD
    RecordingConfigurationThumbnailConfigurationResolutionLowestResolution
    LOWEST_RESOLUTION
    FullHd
    FULL_HD
    Hd
    HD
    Sd
    SD
    LowestResolution
    LOWEST_RESOLUTION
    FullHd
    FULL_HD
    Hd
    HD
    Sd
    SD
    LowestResolution
    LOWEST_RESOLUTION
    FULL_HD
    FULL_HD
    HD
    HD
    SD
    SD
    LOWEST_RESOLUTION
    LOWEST_RESOLUTION
    "FULL_HD"
    FULL_HD
    "HD"
    HD
    "SD"
    SD
    "LOWEST_RESOLUTION"
    LOWEST_RESOLUTION

    RecordingConfigurationThumbnailConfigurationStorageItem, RecordingConfigurationThumbnailConfigurationStorageItemArgs

    Sequential
    SEQUENTIAL
    Latest
    LATEST
    RecordingConfigurationThumbnailConfigurationStorageItemSequential
    SEQUENTIAL
    RecordingConfigurationThumbnailConfigurationStorageItemLatest
    LATEST
    Sequential
    SEQUENTIAL
    Latest
    LATEST
    Sequential
    SEQUENTIAL
    Latest
    LATEST
    SEQUENTIAL
    SEQUENTIAL
    LATEST
    LATEST
    "SEQUENTIAL"
    SEQUENTIAL
    "LATEST"
    LATEST

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native