view_versions

Creates, updates, deletes or gets a view_version resource or lists view_versions in a region

Overview

Name	view_versions
Type	Resource
Description	Resource Type definition for AWS::Connect::ViewVersion
Id	awscc.connect.view_versions

Fields

get (all properties)

Name	Datatype	Description
view_arn	string	The Amazon Resource Name (ARN) of the view for which a version is being created.
view_version_arn	string	The Amazon Resource Name (ARN) of the created view version.
version_description	string	The description for the view version.
view_content_sha256	string	The view content hash to be checked.
version	integer	The version of the view.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
view_version_arn	string	The Amazon Resource Name (ARN) of the created view version.
version	integer	The version of the view.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	view_versions	INSERT	ViewArn, region
delete_resource	view_versions	DELETE	Identifier, region
list_resources	view_versions_list_only	SELECT	region
get_resource	view_versions	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual view_version.

SELECT
  region,
  view_arn,
  view_version_arn,
  version_description,
  view_content_sha256,
  version
FROM awscc.connect.view_versions
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ view_version_arn }}';

list (identifiers only)

Lists all view_versions in a region.

SELECT
  region,
  view_version_arn
FROM awscc.connect.view_versions_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.connect.view_versions (
  ViewArn,
  region
)
SELECT
  '{{ view_arn }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.connect.view_versions (
  ViewArn,
  VersionDescription,
  ViewContentSha256,
  region
)
SELECT
  '{{ view_arn }}',
  '{{ version_description }}',
  '{{ view_content_sha256 }}',
  '{{ 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: view_version
  props:
    - name: view_arn
      value: '{{ view_arn }}'
    - name: version_description
      value: '{{ version_description }}'
    - name: view_content_sha256
      value: '{{ view_content_sha256 }}'

DELETE example

/*+ delete */
DELETE FROM awscc.connect.view_versions
WHERE
  Identifier = '{{ view_version_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 view_versions resource, the following permissions are required:

Create

connect:CreateViewVersion

Read

connect:DescribeView

List

connect:ListViewVersions

Delete

connect:DeleteViewVersion