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::StorageConfiguration
<a name="aws-resource-ivs-storageconfiguration"></a>

The `AWS::IVS::StorageConfiguration` resource specifies an Amazon IVS storage configuration. A storage configuration describes an S3 location where recorded videos will be stored. For more information, see [Auto-Record to Amazon S3 (Low-Latency Streaming)](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/record-to-s3.html) in the *Amazon IVS Low-Latency Streaming User Guide*.

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

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

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

```
{
  "Type" : "AWS::IVS::StorageConfiguration",
  "Properties" : {
      "[Name](#cfn-ivs-storageconfiguration-name)" : String,
      "[S3](#cfn-ivs-storageconfiguration-s3)" : S3StorageConfiguration,
      "[Tags](#cfn-ivs-storageconfiguration-tags)" : [ Tag, ... ]
    }
}
```

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

```
Type: AWS::IVS::StorageConfiguration
Properties:
  [Name](#cfn-ivs-storageconfiguration-name): String
  [S3](#cfn-ivs-storageconfiguration-s3): 
    S3StorageConfiguration
  [Tags](#cfn-ivs-storageconfiguration-tags): 
    - Tag
```

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

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

`S3`  <a name="cfn-ivs-storageconfiguration-s3"></a>
An S3 storage configuration contains information about where recorded video will be stored. See the [S3StorageConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-storageconfiguration-s3storageconfiguration.html) property type for more information.  
*Required*: Yes  
*Type*: [S3StorageConfiguration](aws-properties-ivs-storageconfiguration-s3storageconfiguration.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-ivs-storageconfiguration-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-storageconfiguration-tag.html).  
*Required*: No  
*Type*: Array of [Tag](aws-properties-ivs-storageconfiguration-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-storageconfiguration-return-values"></a>

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

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the storage-configuration ARN. For example:

 `{ "Ref": "myStorageConfiguration" }` 

For the Amazon IVS storage configuration `"myStorageConfiguration"`, `Ref` returns the storage-configuration 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-storageconfiguration-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-storageconfiguration-return-values-fn--getatt-fn--getatt"></a>

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

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



### StorageConfiguration Template Examples
<a name="aws-resource-ivs-storageconfiguration--examples--StorageConfiguration_Template_Examples"></a>

The following examples specify an Amazon IVS storage configuration.

#### JSON
<a name="aws-resource-ivs-storageconfiguration--examples--StorageConfiguration_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"
                    }
                ]
            }
        }
    }
}
```

#### YAML
<a name="aws-resource-ivs-storageconfiguration--examples--StorageConfiguration_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
```

## See also
<a name="aws-resource-ivs-storageconfiguration--seealso"></a>
+  [Getting Started with IVS Real-Time Streaming](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started.html) 
+  [ Server-Side Composition (Real-Time Streaming)](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/server-side-composition.html) 

# AWS::IVS::StorageConfiguration S3StorageConfiguration
<a name="aws-properties-ivs-storageconfiguration-s3storageconfiguration"></a>

The S3StorageConfiguration property type describes an S3 location where recorded videos will be stored.

## Syntax
<a name="aws-properties-ivs-storageconfiguration-s3storageconfiguration-syntax"></a>

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

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

```
{
  "[BucketName](#cfn-ivs-storageconfiguration-s3storageconfiguration-bucketname)" : String
}
```

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

```
  [BucketName](#cfn-ivs-storageconfiguration-s3storageconfiguration-bucketname): String
```

## Properties
<a name="aws-properties-ivs-storageconfiguration-s3storageconfiguration-properties"></a>

`BucketName`  <a name="cfn-ivs-storageconfiguration-s3storageconfiguration-bucketname"></a>
Name of the S3 bucket where recorded video will be stored.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-z0-9-.]+$`  
*Minimum*: `3`  
*Maximum*: `63`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

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

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

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

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

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

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

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

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

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

`Key`  <a name="cfn-ivs-storageconfiguration-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-storageconfiguration-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)