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	awscc.connect.instance_storage_configs

Fields

get (all properties)

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.

list (identifiers only)

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
region	string	AWS region.

For more information, see AWS::Connect::InstanceStorageConfig.

Methods

Name	Resource	Accessible by	Required Params
create_resource	instance_storage_configs	INSERT	InstanceArn, ResourceType, StorageType, region
delete_resource	instance_storage_configs	DELETE	Identifier, region
update_resource	instance_storage_configs	UPDATE	Identifier, PatchDocument, region
list_resources	instance_storage_configs_list_only	SELECT	region
get_resource	instance_storage_configs	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.connect.instance_storage_configs
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ instance_arn }}|{{ association_id }}|{{ resource_type }}';

list (identifiers only)

Lists all instance_storage_configs in a region.

SELECT
  region,
  instance_arn,
  association_id,
  resource_type
FROM awscc.connect.instance_storage_configs_list_only
WHERE
  region = '{{ region }}';

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 awscc.connect.instance_storage_configs (
  InstanceArn,
  ResourceType,
  StorageType,
  region
)
SELECT
  '{{ instance_arn }}',
  '{{ resource_type }}',
  '{{ storage_type }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.connect.instance_storage_configs (
  InstanceArn,
  ResourceType,
  StorageType,
  S3Config,
  KinesisVideoStreamConfig,
  KinesisStreamConfig,
  KinesisFirehoseConfig,
  region
)
SELECT
  '{{ instance_arn }}',
  '{{ resource_type }}',
  '{{ storage_type }}',
  '{{ s3_config }}',
  '{{ kinesis_video_stream_config }}',
  '{{ kinesis_stream_config }}',
  '{{ kinesis_firehose_config }}',
  '{{ 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: instance_storage_config
  props:
    - name: instance_arn
      value: '{{ instance_arn }}'
    - name: resource_type
      value: '{{ resource_type }}'
    - name: storage_type
      value: '{{ storage_type }}'
    - name: s3_config
      value:
        bucket_name: '{{ bucket_name }}'
        bucket_prefix: '{{ bucket_prefix }}'
        encryption_config:
          encryption_type: '{{ encryption_type }}'
          key_id: '{{ key_id }}'
    - name: kinesis_video_stream_config
      value:
        prefix: null
        retention_period_hours: null
        encryption_config: null
    - name: kinesis_stream_config
      value:
        stream_arn: '{{ stream_arn }}'
    - name: kinesis_firehose_config
      value:
        firehose_arn: '{{ firehose_arn }}'

UPDATE example

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

/*+ update */
UPDATE awscc.connect.instance_storage_configs
SET PatchDocument = string('{{ {
    "StorageType": storage_type,
    "S3Config": s3_config,
    "KinesisVideoStreamConfig": kinesis_video_stream_config,
    "KinesisStreamConfig": kinesis_stream_config,
    "KinesisFirehoseConfig": kinesis_firehose_config
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ instance_arn }}|{{ association_id }}|{{ resource_type }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.connect.instance_storage_configs
WHERE
  Identifier = '{{ instance_arn }}|{{ association_id }}|{{ resource_type }}' 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 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