storage_configurations

Creates, updates, deletes, gets or lists a storage_configurations resource.

Overview

Name	storage_configurations
Type	Resource
Id	aws.ivs_realtime.storage_configurations

Fields

The following fields are returned by SELECT queries:

get_storage_configuration

Name	Datatype	Description
name	string	Name of the storage configuration. (pattern: <code>[a-zA-Z0-9-_]*</code>)
arn	string	ARN of the storage configuration. (pattern: <code>arn:aws:ivs:[a-z0-9-]+:[0-9]+:storage-configuration/[a-zA-Z0-9-]+</code>)
s_3	object	A complex type that describes an S3 location where recorded videos will be stored.
tags	object	Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.

list_storage_configurations

Name	Datatype	Description
next_token	string	If there are more storage configurations than maxResults, use nextToken in the request to get the next set. (pattern: <code>[a-zA-Z0-9+/=_-]*</code>)
storage_configurations	array	List of the matching storage configurations.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_storage_configuration	select	region		Gets the storage configuration for the specified ARN.
list_storage_configurations	select	region		Gets summary information about all storage configurations in your account, in the AWS region where the API request is processed.
create_storage_configuration	insert	region, s3		Creates a new storage configuration, used to enable recording to Amazon S3. When a StorageConfiguration is created, IVS will modify the S3 bucketPolicy of the provided bucket. This will ensure that IVS has sufficient permissions to write content to the provided bucket.
delete_storage_configuration	delete	region		Deletes the storage configuration for the specified ARN. If you try to delete a storage configuration that is used by a Composition, you will get an error (409 ConflictException). To avoid this, for all Compositions that reference the storage configuration, first use StopComposition and wait for it to complete, then use DeleteStorageConfiguration.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_storage_configuration

Gets the storage configuration for the specified ARN.

SELECT
name,
arn,
s_3,
tags
FROM aws.ivs_realtime.storage_configurations
WHERE region = '{{ region }}' -- required
;

list_storage_configurations

Gets summary information about all storage configurations in your account, in the AWS region where the API request is processed.

SELECT
next_token,
storage_configurations
FROM aws.ivs_realtime.storage_configurations
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_storage_configuration

Creates a new storage configuration, used to enable recording to Amazon S3. When a StorageConfiguration is created, IVS will modify the S3 bucketPolicy of the provided bucket. This will ensure that IVS has sufficient permissions to write content to the provided bucket.

INSERT INTO aws.ivs_realtime.storage_configurations (
name,
s3,
tags,
region
)
SELECT 
'{{ name }}',
'{{ s3 }}' /* required */,
'{{ tags }}',
'{{ region }}'
RETURNING
storage_configuration
;

Manifest

# Description fields are for documentation purposes
- name: storage_configurations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the storage_configurations resource.
  - name: name
    value: "{{ name }}"
  - name: s3
    description: |
      A complex type that describes an S3 location where recorded videos will be stored.
    value:
      bucketName: "{{ bucketName }}"
  - name: tags
    value: "{{ tags }}"

DELETE examples

delete_storage_configuration

Deletes the storage configuration for the specified ARN. If you try to delete a storage configuration that is used by a Composition, you will get an error (409 ConflictException). To avoid this, for all Compositions that reference the storage configuration, first use StopComposition and wait for it to complete, then use DeleteStorageConfiguration.

DELETE FROM aws.ivs_realtime.storage_configurations
WHERE region = '{{ region }}' --required
;