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

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

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.ivs.Stage

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource Definition for type AWS::IVS::Stage.

    Create Stage Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Stage(name: string, args?: StageArgs, opts?: CustomResourceOptions);
    @overload
def Stage(resource_name: str,
          args: Optional[StageArgs] = None,
          opts: Optional[ResourceOptions] = None)

@overload
def Stage(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          auto_participant_recording_configuration: Optional[StageAutoParticipantRecordingConfigurationArgs] = None,
          name: Optional[str] = None,
          tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewStage(ctx *Context, name string, args *StageArgs, opts ...ResourceOption) (*Stage, error)
    public Stage(string name, StageArgs? args = null, CustomResourceOptions? opts = null)
    public Stage(String name, StageArgs args)
public Stage(String name, StageArgs args, CustomResourceOptions options)

    type: aws-native:ivs:Stage
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 StageArgs
    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 StageArgs
    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 StageArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args StageArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args StageArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Stage 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 Stage resource accepts the following input properties:

    AutoParticipantRecordingConfiguration StageAutoParticipantRecordingConfigurationArgs
    Name string
    Stage name
    Tags TagArgs
    An array of key-value pairs to apply to this resource.
    autoParticipantRecordingConfiguration StageAutoParticipantRecordingConfiguration
    name String
    Stage name
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    autoParticipantRecordingConfiguration StageAutoParticipantRecordingConfiguration
    name string
    Stage name
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    autoParticipantRecordingConfiguration Property Map
    name String
    Stage name
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.

    Outputs

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

    ActiveSessionId string
    ID of the active session within the stage.
    Arn string
    Stage ARN is automatically generated on creation and assigned as the unique identifier.
    Id string
    The provider-assigned unique ID for this managed resource.
    ActiveSessionId string
    ID of the active session within the stage.
    Arn string
    Stage ARN is automatically generated on creation and assigned as the unique identifier.
    Id string
    The provider-assigned unique ID for this managed resource.
    activeSessionId String
    ID of the active session within the stage.
    arn String
    Stage ARN is automatically generated on creation and assigned as the unique identifier.
    id String
    The provider-assigned unique ID for this managed resource.
    activeSessionId string
    ID of the active session within the stage.
    arn string
    Stage ARN is automatically generated on creation and assigned as the unique identifier.
    id string
    The provider-assigned unique ID for this managed resource.
    active_session_id str
    ID of the active session within the stage.
    arn str
    Stage ARN is automatically generated on creation and assigned as the unique identifier.
    id str
    The provider-assigned unique ID for this managed resource.
    activeSessionId String
    ID of the active session within the stage.
    arn String
    Stage ARN is automatically generated on creation and assigned as the unique identifier.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    StageAutoParticipantRecordingConfiguration, StageAutoParticipantRecordingConfigurationArgs

    StorageConfigurationArn string
    ARN of the StorageConfiguration resource to use for individual participant recording.
    MediaTypes List<Pulumi.AwsNative.Ivs.StageAutoParticipantRecordingConfigurationMediaTypesItem>
    Types of media to be recorded. Default: AUDIO_VIDEO.
    StorageConfigurationArn string
    ARN of the StorageConfiguration resource to use for individual participant recording.
    MediaTypes []StageAutoParticipantRecordingConfigurationMediaTypesItem
    Types of media to be recorded. Default: AUDIO_VIDEO.
    storageConfigurationArn String
    ARN of the StorageConfiguration resource to use for individual participant recording.
    mediaTypes List<StageAutoParticipantRecordingConfigurationMediaTypesItem>
    Types of media to be recorded. Default: AUDIO_VIDEO.
    storageConfigurationArn string
    ARN of the StorageConfiguration resource to use for individual participant recording.
    mediaTypes StageAutoParticipantRecordingConfigurationMediaTypesItem[]
    Types of media to be recorded. Default: AUDIO_VIDEO.
    storage_configuration_arn str
    ARN of the StorageConfiguration resource to use for individual participant recording.
    media_types Sequence[StageAutoParticipantRecordingConfigurationMediaTypesItem]
    Types of media to be recorded. Default: AUDIO_VIDEO.
    storageConfigurationArn String
    ARN of the StorageConfiguration resource to use for individual participant recording.
    mediaTypes List<"AUDIO_VIDEO" | "AUDIO_ONLY">
    Types of media to be recorded. Default: AUDIO_VIDEO.

    StageAutoParticipantRecordingConfigurationMediaTypesItem, StageAutoParticipantRecordingConfigurationMediaTypesItemArgs

    AudioVideo
    AUDIO_VIDEO
    AudioOnly
    AUDIO_ONLY
    StageAutoParticipantRecordingConfigurationMediaTypesItemAudioVideo
    AUDIO_VIDEO
    StageAutoParticipantRecordingConfigurationMediaTypesItemAudioOnly
    AUDIO_ONLY
    AudioVideo
    AUDIO_VIDEO
    AudioOnly
    AUDIO_ONLY
    AudioVideo
    AUDIO_VIDEO
    AudioOnly
    AUDIO_ONLY
    AUDIO_VIDEO
    AUDIO_VIDEO
    AUDIO_ONLY
    AUDIO_ONLY
    "AUDIO_VIDEO"
    AUDIO_VIDEO
    "AUDIO_ONLY"
    AUDIO_ONLY

    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 Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
    pulumi/pulumi-aws-native