This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::IVS::Stage
<a name="aws-resource-ivs-stage"></a>

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](https://docs.aws.amazon.com/ivs/latest/RealTimeAPIReference/API_CreateStage.html) in the *Amazon IVS Real-Time Streaming API Reference*.

## Syntax
<a name="aws-resource-ivs-stage-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-ivs-stage-syntax.json"></a>

```
{
  "Type" : "AWS::IVS::Stage",
  "Properties" : {
      "[AutoParticipantRecordingConfiguration](#cfn-ivs-stage-autoparticipantrecordingconfiguration)" : AutoParticipantRecordingConfiguration,
      "[Name](#cfn-ivs-stage-name)" : String,
      "[Tags](#cfn-ivs-stage-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-ivs-stage-syntax.yaml"></a>

```
Type: AWS::IVS::Stage
Properties:
  [AutoParticipantRecordingConfiguration](#cfn-ivs-stage-autoparticipantrecordingconfiguration): 
    AutoParticipantRecordingConfiguration
  [Name](#cfn-ivs-stage-name): String
  [Tags](#cfn-ivs-stage-tags): 
    - Tag
```

## Properties
<a name="aws-resource-ivs-stage-properties"></a>

`AutoParticipantRecordingConfiguration`  <a name="cfn-ivs-stage-autoparticipantrecordingconfiguration"></a>
Configuration object for individual participant recording.  
*Required*: No  
*Type*: [AutoParticipantRecordingConfiguration](aws-properties-ivs-stage-autoparticipantrecordingconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-ivs-stage-name"></a>
Stage name.  
*Required*: No  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9-_]*$`  
*Minimum*: `0`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-ivs-stage-tags"></a>
An array of key-value pairs to apply to this resource.  
For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-stage-tag.html).  
*Required*: No  
*Type*: Array of [Tag](aws-properties-ivs-stage-tag.md)  
*Maximum*: `50`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-ivs-stage-return-values"></a>

### Ref
<a name="aws-resource-ivs-stage-return-values-ref"></a>

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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-ivs-stage-return-values-fn--getatt"></a>

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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-ivs-stage-return-values-fn--getatt-fn--getatt"></a>

`ActiveSessionId`  <a name="ActiveSessionId-fn::getatt"></a>
ID of the active session within the stage. For example: `st-a1b2c3d4e5f6g`

`Arn`  <a name="Arn-fn::getatt"></a>
The stage ARN. For example: `arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh`

## Examples
<a name="aws-resource-ivs-stage--examples"></a>



### Stage Template Examples
<a name="aws-resource-ivs-stage--examples--Stage_Template_Examples"></a>

The following examples specify an Amazon IVS stage.

#### JSON
<a name="aws-resource-ivs-stage--examples--Stage_Template_Examples--json"></a>

```
{
    "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": {
                    "StorageConfigurationArn": {
                        "Ref": "StorageConfiguration"
                    },
                    "MediaTypes": [
                        "AUDIO_VIDEO"
                    ],
                    "HlsConfiguration": {
                        "ParticipantRecordingHlsConfiguration": {
                            "TargetSegmentDurationSeconds": 5
                        }
                    },
                    "RecordingReconnectWindowSeconds": 30,
                    "ThumbnailConfiguration": {
                        "ParticipantThumbnailConfiguration": {
                            "RecordingMode": "INTERVAL",
                            "TargetIntervalSeconds": 2,
                            "Storage": [
                                "SEQUENTIAL",
                                "LATEST"
                            ]
                        }
                    }
                },                     
                "Tags": [
                    {
                        "Key": "MyKey",
                        "Value": "MyValue"
                    }
                ]
            }
        }
    }
}
```

#### YAML
<a name="aws-resource-ivs-stage--examples--Stage_Template_Examples--yaml"></a>

```
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:
        HlsConfiguration:
          ParticipantRecordingHlsConfiguration:
            TargetSegmentDurationSeconds: 5
        MediaTypes:
          - AUDIO_VIDEO
        RecordingReconnectWindowSeconds: 30
        StorageConfigurationArn: !Ref StorageConfiguration
        ThumbnailConfiguration:
          ParticipantThumbnailConfiguration:
            RecordingMode: INTERVAL
            TargetIntervalSeconds: 2
            Storage:
              - SEQUENTIAL
              - LATEST
      Tags: 
        - Key: myKey
          Value: myValue
```

## See also
<a name="aws-resource-ivs-stage--seealso"></a>
+  [Getting Started with IVS Real-Time Streaming](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started.html) 
+ [Stage](https://docs.aws.amazon.com/ivs/latest/RealTimeAPIReference/API_Stage.html) data type
+ [CreateStage](https://docs.aws.amazon.com/ivs/latest/RealTimeAPIReference/API_CreateStage.html) API endpoint

# AWS::IVS::Stage AutoParticipantRecordingConfiguration
<a name="aws-properties-ivs-stage-autoparticipantrecordingconfiguration"></a>

The `AWS::IVS::AutoParticipantRecordingConfiguration` property type describes a configuration for individual participant recording. 

## Syntax
<a name="aws-properties-ivs-stage-autoparticipantrecordingconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-ivs-stage-autoparticipantrecordingconfiguration-syntax.json"></a>

```
{
  "[HlsConfiguration](#cfn-ivs-stage-autoparticipantrecordingconfiguration-hlsconfiguration)" : HlsConfiguration,
  "[MediaTypes](#cfn-ivs-stage-autoparticipantrecordingconfiguration-mediatypes)" : [ String, ... ],
  "[RecordingReconnectWindowSeconds](#cfn-ivs-stage-autoparticipantrecordingconfiguration-recordingreconnectwindowseconds)" : Integer,
  "[StorageConfigurationArn](#cfn-ivs-stage-autoparticipantrecordingconfiguration-storageconfigurationarn)" : String,
  "[ThumbnailConfiguration](#cfn-ivs-stage-autoparticipantrecordingconfiguration-thumbnailconfiguration)" : ThumbnailConfiguration
}
```

### YAML
<a name="aws-properties-ivs-stage-autoparticipantrecordingconfiguration-syntax.yaml"></a>

```
  [HlsConfiguration](#cfn-ivs-stage-autoparticipantrecordingconfiguration-hlsconfiguration): 
    HlsConfiguration
  [MediaTypes](#cfn-ivs-stage-autoparticipantrecordingconfiguration-mediatypes): 
    - String
  [RecordingReconnectWindowSeconds](#cfn-ivs-stage-autoparticipantrecordingconfiguration-recordingreconnectwindowseconds): Integer
  [StorageConfigurationArn](#cfn-ivs-stage-autoparticipantrecordingconfiguration-storageconfigurationarn): String
  [ThumbnailConfiguration](#cfn-ivs-stage-autoparticipantrecordingconfiguration-thumbnailconfiguration): 
    ThumbnailConfiguration
```

## Properties
<a name="aws-properties-ivs-stage-autoparticipantrecordingconfiguration-properties"></a>

`HlsConfiguration`  <a name="cfn-ivs-stage-autoparticipantrecordingconfiguration-hlsconfiguration"></a>
HLS configuration object for individual participant recording.  
*Required*: No  
*Type*: [HlsConfiguration](aws-properties-ivs-stage-hlsconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MediaTypes`  <a name="cfn-ivs-stage-autoparticipantrecordingconfiguration-mediatypes"></a>
Types of media to be recorded. Default: `AUDIO_VIDEO`.  
*Required*: No  
*Type*: Array of String  
*Allowed values*: `AUDIO_VIDEO | AUDIO_ONLY`  
*Minimum*: `0`  
*Maximum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RecordingReconnectWindowSeconds`  <a name="cfn-ivs-stage-autoparticipantrecordingconfiguration-recordingreconnectwindowseconds"></a>
If a stage publisher disconnects and then reconnects within the specified interval, the multiple recordings will be considered a single recording and merged together.  
The default value is 0, which disables merging.  
*Required*: No  
*Type*: Integer  
*Minimum*: `0`  
*Maximum*: `300`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`StorageConfigurationArn`  <a name="cfn-ivs-stage-autoparticipantrecordingconfiguration-storageconfigurationarn"></a>
ARN of the [StorageConfiguration](aws-resource-ivs-storageconfiguration.md) resource to use for individual participant recording. Default: "" (empty string, no storage configuration is specified). Individual participant recording cannot be started unless a storage configuration is specified, when a [Stage](aws-resource-ivs-stage.md) is created or updated.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^$|^arn:aws:ivs:[a-z0-9-]+:[0-9]+:storage-configuration/[a-zA-Z0-9-]+$`  
*Minimum*: `0`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ThumbnailConfiguration`  <a name="cfn-ivs-stage-autoparticipantrecordingconfiguration-thumbnailconfiguration"></a>
A complex type that allows you to enable/disable the recording of thumbnails for individual participant recording and modify the interval at which thumbnails are generated for the live session.  
*Required*: No  
*Type*: [ThumbnailConfiguration](aws-properties-ivs-stage-thumbnailconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::IVS::Stage HlsConfiguration
<a name="aws-properties-ivs-stage-hlsconfiguration"></a>

Object specifying an HLS configuration for individual participant recording.

## Syntax
<a name="aws-properties-ivs-stage-hlsconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-ivs-stage-hlsconfiguration-syntax.json"></a>

```
{
  "[ParticipantRecordingHlsConfiguration](#cfn-ivs-stage-hlsconfiguration-participantrecordinghlsconfiguration)" : ParticipantRecordingHlsConfiguration
}
```

### YAML
<a name="aws-properties-ivs-stage-hlsconfiguration-syntax.yaml"></a>

```
  [ParticipantRecordingHlsConfiguration](#cfn-ivs-stage-hlsconfiguration-participantrecordinghlsconfiguration): 
    ParticipantRecordingHlsConfiguration
```

## Properties
<a name="aws-properties-ivs-stage-hlsconfiguration-properties"></a>

`ParticipantRecordingHlsConfiguration`  <a name="cfn-ivs-stage-hlsconfiguration-participantrecordinghlsconfiguration"></a>
Object specifying a configuration of participant HLS recordings for individual participant recording.  
*Required*: No  
*Type*: [ParticipantRecordingHlsConfiguration](aws-properties-ivs-stage-participantrecordinghlsconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::IVS::Stage ParticipantRecordingHlsConfiguration
<a name="aws-properties-ivs-stage-participantrecordinghlsconfiguration"></a>

Object specifying a configuration of participant HLS recordings for individual participant recording.

## Syntax
<a name="aws-properties-ivs-stage-participantrecordinghlsconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-ivs-stage-participantrecordinghlsconfiguration-syntax.json"></a>

```
{
  "[TargetSegmentDurationSeconds](#cfn-ivs-stage-participantrecordinghlsconfiguration-targetsegmentdurationseconds)" : Integer
}
```

### YAML
<a name="aws-properties-ivs-stage-participantrecordinghlsconfiguration-syntax.yaml"></a>

```
  [TargetSegmentDurationSeconds](#cfn-ivs-stage-participantrecordinghlsconfiguration-targetsegmentdurationseconds): Integer
```

## Properties
<a name="aws-properties-ivs-stage-participantrecordinghlsconfiguration-properties"></a>

`TargetSegmentDurationSeconds`  <a name="cfn-ivs-stage-participantrecordinghlsconfiguration-targetsegmentdurationseconds"></a>
Defines the target duration for recorded segments generated when recording a stage participant. Segments may have durations longer than the specified value when needed to ensure each segment begins with a keyframe. Default: 6.  
*Required*: No  
*Type*: Integer  
*Minimum*: `2`  
*Maximum*: `10`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::IVS::Stage ParticipantThumbnailConfiguration
<a name="aws-properties-ivs-stage-participantthumbnailconfiguration"></a>

Object specifying a configuration of thumbnails for recorded video from an individual participant.

## Syntax
<a name="aws-properties-ivs-stage-participantthumbnailconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-ivs-stage-participantthumbnailconfiguration-syntax.json"></a>

```
{
  "[RecordingMode](#cfn-ivs-stage-participantthumbnailconfiguration-recordingmode)" : String,
  "[Storage](#cfn-ivs-stage-participantthumbnailconfiguration-storage)" : [ String, ... ],
  "[TargetIntervalSeconds](#cfn-ivs-stage-participantthumbnailconfiguration-targetintervalseconds)" : Integer
}
```

### YAML
<a name="aws-properties-ivs-stage-participantthumbnailconfiguration-syntax.yaml"></a>

```
  [RecordingMode](#cfn-ivs-stage-participantthumbnailconfiguration-recordingmode): String
  [Storage](#cfn-ivs-stage-participantthumbnailconfiguration-storage): 
    - String
  [TargetIntervalSeconds](#cfn-ivs-stage-participantthumbnailconfiguration-targetintervalseconds): Integer
```

## Properties
<a name="aws-properties-ivs-stage-participantthumbnailconfiguration-properties"></a>

`RecordingMode`  <a name="cfn-ivs-stage-participantthumbnailconfiguration-recordingmode"></a>
Thumbnail recording mode. Default: `DISABLED`.  
*Required*: No  
*Type*: String  
*Allowed values*: `INTERVAL | DISABLED`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Storage`  <a name="cfn-ivs-stage-participantthumbnailconfiguration-storage"></a>
Indicates the format in which thumbnails are recorded. `SEQUENTIAL` records all generated thumbnails in a serial manner, to the media/thumbnails/high directory. `LATEST` saves the latest thumbnail in media/latest\$1thumbnail/high/thumb.jpg and overwrites it at the interval specified by `targetIntervalSeconds`. You can enable both `SEQUENTIAL` and `LATEST`. Default: `SEQUENTIAL`.  
*Required*: No  
*Type*: Array of String  
*Allowed values*: `SEQUENTIAL | LATEST`  
*Minimum*: `0`  
*Maximum*: `2`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TargetIntervalSeconds`  <a name="cfn-ivs-stage-participantthumbnailconfiguration-targetintervalseconds"></a>
The targeted thumbnail-generation interval in seconds. This is configurable only if `recordingMode` is `INTERVAL`. Default: 60.  
*Required*: No  
*Type*: Integer  
*Minimum*: `1`  
*Maximum*: `86400`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::IVS::Stage Tag
<a name="aws-properties-ivs-stage-tag"></a>

A key-value pair that you can use to categorize and manage Amazon IVS Stages.

## Syntax
<a name="aws-properties-ivs-stage-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-ivs-stage-tag-syntax.json"></a>

```
{
  "[Key](#cfn-ivs-stage-tag-key)" : String,
  "[Value](#cfn-ivs-stage-tag-value)" : String
}
```

### YAML
<a name="aws-properties-ivs-stage-tag-syntax.yaml"></a>

```
  [Key](#cfn-ivs-stage-tag-key): String
  [Value](#cfn-ivs-stage-tag-value): String
```

## Properties
<a name="aws-properties-ivs-stage-tag-properties"></a>

`Key`  <a name="cfn-ivs-stage-tag-key"></a>
One part of a key-value pair that makes up a tag. A `key` is a general label that acts like a category for more specific tag values.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-ivs-stage-tag-value"></a>
The optional part of a key-value pair that makes up a tag. A `value` acts as a descriptor within a tag category (key).  
*Required*: Yes  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::IVS::Stage ThumbnailConfiguration
<a name="aws-properties-ivs-stage-thumbnailconfiguration"></a>

An object representing a configuration of thumbnails for recorded video.

## Syntax
<a name="aws-properties-ivs-stage-thumbnailconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-ivs-stage-thumbnailconfiguration-syntax.json"></a>

```
{
  "[ParticipantThumbnailConfiguration](#cfn-ivs-stage-thumbnailconfiguration-participantthumbnailconfiguration)" : ParticipantThumbnailConfiguration
}
```

### YAML
<a name="aws-properties-ivs-stage-thumbnailconfiguration-syntax.yaml"></a>

```
  [ParticipantThumbnailConfiguration](#cfn-ivs-stage-thumbnailconfiguration-participantthumbnailconfiguration): 
    ParticipantThumbnailConfiguration
```

## Properties
<a name="aws-properties-ivs-stage-thumbnailconfiguration-properties"></a>

`ParticipantThumbnailConfiguration`  <a name="cfn-ivs-stage-thumbnailconfiguration-participantthumbnailconfiguration"></a>
Object specifying a configuration of thumbnails for recorded video from an individual participant.  
*Required*: No  
*Type*: [ParticipantThumbnailConfiguration](aws-properties-ivs-stage-participantthumbnailconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)