instance_storage_configs

Creates, updates, deletes or gets an instance_storage_config resource or lists instance_storage_configs in a region

Overview

Name	instance_storage_configs
Type	Resource
Description	Resource Type definition for AWS::Connect::InstanceStorageConfig
Id	aws.connect.instance_storage_configs

Fields

Name	Datatype	Description
instance_arn	string	Connect Instance ID with which the storage config will be associated
resource_type	string	Specifies the type of storage resource available for the instance
association_id	string	An associationID is automatically generated when a storage config is associated with an instance
storage_type	string	Specifies the storage type to be associated with the instance
s3_config	object
kinesis_video_stream_config	object
kinesis_stream_config	object
kinesis_firehose_config	object
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	InstanceArn, ResourceType, StorageType, 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 instance_storage_configs in a region.

SELECT
region,
instance_arn,
resource_type,
association_id,
storage_type,
s3_config,
kinesis_video_stream_config,
kinesis_stream_config,
kinesis_firehose_config
FROM aws.connect.instance_storage_configs
WHERE region = 'us-east-1';

Gets all properties from an individual instance_storage_config.

SELECT
region,
instance_arn,
resource_type,
association_id,
storage_type,
s3_config,
kinesis_video_stream_config,
kinesis_stream_config,
kinesis_firehose_config
FROM aws.connect.instance_storage_configs
WHERE region = 'us-east-1' AND data__Identifier = '<InstanceArn>|<AssociationId>|<ResourceType>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.connect.instance_storage_configs (
 InstanceArn,
 ResourceType,
 StorageType,
 region
)
SELECT 
'{{ InstanceArn }}',
 '{{ ResourceType }}',
 '{{ StorageType }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.connect.instance_storage_configs (
 InstanceArn,
 ResourceType,
 StorageType,
 S3Config,
 KinesisVideoStreamConfig,
 KinesisStreamConfig,
 KinesisFirehoseConfig,
 region
)
SELECT 
 '{{ InstanceArn }}',
 '{{ ResourceType }}',
 '{{ StorageType }}',
 '{{ S3Config }}',
 '{{ KinesisVideoStreamConfig }}',
 '{{ KinesisStreamConfig }}',
 '{{ KinesisFirehoseConfig }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: instance_storage_config
    props:
      - name: InstanceArn
        value: '{{ InstanceArn }}'
      - name: ResourceType
        value: '{{ ResourceType }}'
      - name: StorageType
        value: '{{ StorageType }}'
      - name: S3Config
        value:
          BucketName: '{{ BucketName }}'
          BucketPrefix: '{{ BucketPrefix }}'
          EncryptionConfig:
            EncryptionType: '{{ EncryptionType }}'
            KeyId: '{{ KeyId }}'
      - name: KinesisVideoStreamConfig
        value:
          Prefix: null
          RetentionPeriodHours: null
          EncryptionConfig: null
      - name: KinesisStreamConfig
        value:
          StreamArn: '{{ StreamArn }}'
      - name: KinesisFirehoseConfig
        value:
          FirehoseArn: '{{ FirehoseArn }}'

DELETE example

/*+ delete */
DELETE FROM aws.connect.instance_storage_configs
WHERE data__Identifier = '<InstanceArn|AssociationId|ResourceType>'
AND region = 'us-east-1';

Permissions

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

Create

connect:AssociateInstanceStorageConfig,
connect:DescribeInstance,
ds:DescribeDirectories,
s3:GetBucketAcl,
s3:GetBucketLocation,
iam:PutRolePolicy,
kinesis:DescribeStream,
kms:DescribeKey,
kms:CreateGrant,
firehose:DescribeDeliveryStream

Read

connect:DescribeInstanceStorageConfig,
connect:ListInstanceStorageConfigs,
connect:DescribeInstance,
ds:DescribeDirectories,
s3:GetBucketAcl,
s3:GetBucketLocation

Update

connect:UpdateInstanceStorageConfig,
ds:DescribeDirectories,
s3:GetBucketAcl,
s3:GetBucketLocation,
kinesis:DescribeStream,
iam:PutRolePolicy,
kms:DescribeKey,
kms:CreateGrant,
kms:RetireGrant,
firehose:DescribeDeliveryStream

Delete

connect:DisassociateInstanceStorageConfig,
connect:DescribeInstance,
s3:GetBucketAcl,
s3:GetBucketLocation,
kms:RetireGrant

List

connect:DescribeInstance,
connect:ListInstanceStorageConfigs,
ds:DescribeDirectories