The AWS::IVS::Stage resource specifies an Amazon IVS stage. A stage is a virtual space where participants can exchange video in real time. For more information, see CreateStage in the
Amazon IVS Real-Time Streaming API Reference.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{
"Type" : "AWS::IVS::Stage",
"Properties" : {
"AutoParticipantRecordingConfiguration" : AutoParticipantRecordingConfiguration,
"Name" : String,
"Tags" : [ Tag, ... ]
}
}
YAML
Type: AWS::IVS::Stage
Properties:
AutoParticipantRecordingConfiguration:
AutoParticipantRecordingConfiguration
Name: String
Tags:
- Tag
Properties
AutoParticipantRecordingConfigurationProperty description not available.
Required: No
Type: AutoParticipantRecordingConfiguration
Update requires: No interruption
Name-
Stage name.
Required: No
Type: String
Pattern:
^[a-zA-Z0-9-_]*$Minimum:
0Maximum:
128Update requires: No interruption
-
An array of key-value pairs to apply to this resource.
For more information, see Tag.
Required: No
Type: Array of Tag
Maximum:
50Update requires: No interruption
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the stage ARN. For example:
{ "Ref": "myStage" }
For the Amazon IVS stage
myStage, Ref returns the
stage ARN.
For more information about using the Ref function, see Ref.
Fn::GetAtt
The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.
For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.
ActiveSessionId-
ID of the active session within the stage. For example:
st-a1b2c3d4e5f6g Arn-
The stage ARN. For example:
arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh
Examples
Stage Template Examples
The following examples specify an Amazon IVS stage.
JSON
{
"AWSTemplateFormatVersion": "2010-09-09",
"Resources": {
"StorageConfiguration": {
"Type": "AWS::IVS::StorageConfiguration",
"Properties": {
"Name": "myStorageConfiguration",
"S3": { "BucketName": "my-bucket" },
"Tags": [
{
"Key": "MyKey",
"Value": "MyValue"
}
]
}
},
"Stage": {
"Type": "AWS::IVS::Stage",
"Properties": {
"Name": "myStage",
"AutoParticipantRecordingConfiguration": {
"MediaTypes": ["AUDIO_VIDEO"],
"StorageConfigurationArn": {
"Ref": "StorageConfiguration"
}
},
"Tags": [
{
"Key": "MyKey",
"Value": "MyValue"
}
]
}
}
}
}YAML
AWSTemplateFormatVersion: 2010-09-09
Resources:
StorageConfiguration:
Type: AWS::IVS::StorageConfiguration
Properties:
Name: myStorageConfiguration
S3:
BucketName: my-bucket
Tags:
- Key: myKey
Value: myValue
Stage:
Type: AWS::IVS::Stage
Properties:
Name: myStage
AutoParticipantRecordingConfiguration:
MediaTypes:
- AUDIO_VIDEO
StorageConfigurationArn: !Ref StorageConfiguration
Tags:
- Key: myKey
Value: myValue
See also
-
Stage data type
-
CreateStage API endpoint
