storage_configurations

Creates, updates, deletes or gets a storage_configuration resource or lists storage_configurations in a region

Overview

Name	storage_configurations
Type	Resource
Description	Resource Type definition for AWS::IVS::StorageConfiguration
Id	aws.ivs.storage_configurations

Fields

Name	Datatype	Description
arn	string	Storage Configuration ARN is automatically generated on creation and assigned as the unique identifier.
name	string	Storage Configuration Name.
s3	object	A complex type that describes an S3 location where recorded videos will be stored.
tags	array	A list of key-value pairs that contain metadata for the asset model.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	S3, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all storage_configurations in a region.

SELECT
region,
arn,
name,
s3,
tags
FROM aws.ivs.storage_configurations
WHERE region = 'us-east-1';

Gets all properties from an individual storage_configuration.

SELECT
region,
arn,
name,
s3,
tags
FROM aws.ivs.storage_configurations
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

INSERT example

Use the following StackQL query and manifest file to create a new storage_configuration resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.ivs.storage_configurations (
 S3,
 region
)
SELECT 
'{{ S3 }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.ivs.storage_configurations (
 Name,
 S3,
 Tags,
 region
)
SELECT 
 '{{ Name }}',
 '{{ S3 }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: storage_configuration
    props:
      - name: Name
        value: '{{ Name }}'
      - name: S3
        value:
          BucketName: '{{ BucketName }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.ivs.storage_configurations
WHERE data__Identifier = '<Arn>'
AND region = 'us-east-1';

Permissions

To operate on the storage_configurations resource, the following permissions are required:

Create

ivs:CreateStorageConfiguration,
ivs:GetStorageConfiguration,
ivs:TagResource,
s3:GetBucketLocation,
s3:GetBucketPolicy,
s3:PutBucketPolicy

Read

ivs:GetStorageConfiguration,
ivs:ListTagsForResource,
s3:GetBucketLocation

Update

ivs:GetStorageConfiguration,
ivs:TagResource,
ivs:UntagResource,
ivs:ListTagsForResource

Delete

ivs:DeleteStorageConfiguration,
ivs:UntagResource,
s3:GetBucketPolicy,
s3:DeleteBucketPolicy,
s3:PutBucketPolicy

List

ivs:ListStorageConfigurations,
s3:GetBucketLocation,
ivs:ListTagsForResource