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	awscc.ivs.storage_configurations

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
arn	string	Storage Configuration ARN is automatically generated on creation and assigned as the unique identifier.
region	string	AWS region.

For more information, see AWS::IVS::StorageConfiguration.

Methods

Name	Resource	Accessible by	Required Params
create_resource	storage_configurations	INSERT	S3, region
delete_resource	storage_configurations	DELETE	Identifier, region
update_resource	storage_configurations	UPDATE	Identifier, PatchDocument, region
list_resources	storage_configurations_list_only	SELECT	region
get_resource	storage_configurations	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual storage_configuration.

SELECT
  region,
  arn,
  name,
  s3,
  tags
FROM awscc.ivs.storage_configurations
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all storage_configurations in a region.

SELECT
  region,
  arn
FROM awscc.ivs.storage_configurations_list_only
WHERE
  region = '{{ region }}';

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 awscc.ivs.storage_configurations (
  S3,
  region
)
SELECT
  '{{ s3 }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.ivs.storage_configurations (
  Name,
  S3,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ s3 }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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:
        bucket_name: '{{ bucket_name }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.ivs.storage_configurations
SET PatchDocument = string('{{ {
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.ivs.storage_configurations
WHERE
  Identifier = '{{ arn }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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