Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

AWS::IVS::StorageConfiguration

Focus mode
AWS::IVS::StorageConfiguration - AWS CloudFormation
Filter View

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) in the Amazon IVS Low-Latency Streaming User Guide.

Syntax

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

JSON

{ "Type" : "AWS::IVS::StorageConfiguration", "Properties" : { "Name" : String, "S3" : S3StorageConfiguration, "Tags" : [ Tag, ... ] } }

YAML

Type: AWS::IVS::StorageConfiguration Properties: Name: String S3: S3StorageConfiguration Tags: - Tag

Properties

Name

Storage cnfiguration name.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9-_]*$

Minimum: 0

Maximum: 128

Update requires: Replacement

S3

An S3 storage configuration contains information about where recorded video will be stored. See the S3StorageConfiguration property type for more information.

Required: Yes

Type: S3StorageConfiguration

Update requires: Replacement

Tags

An array of key-value pairs to apply to this resource.

For more information, see Tag.

Required: No

Type: Array of Tag

Maximum: 50

Update requires: No interruption

Return values

Ref

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 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.

Arn

The storage-configuration ARN. For example: arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh

Examples

StorageConfiguration Template Examples

The following examples specify an Amazon IVS storage configuration.

JSON

{ "AWSTemplateFormatVersion": "2010-09-09", "Resources": { "StorageConfiguration": { "Type": "AWS::IVS::StorageConfiguration", "Properties": { "Name": "myStorageConfiguration", "S3": { "BucketName": "my-bucket" }, "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

See also

PrivacySite termsCookie preferences
© 2025, Amazon Web Services, Inc. or its affiliates. All rights reserved.