collections

Creates, updates, deletes or gets a collection resource or lists collections in a region

Overview

Name	collections
Type	Resource
Description	Amazon OpenSearchServerless collection resource
Id	awscc.opensearchserverless.collections

Fields

get (all properties)

Name	Datatype	Description
description	string	The description of the collection
id	string	The identifier of the collection
name	string	The name of the collection. The name must meet the following criteria: Unique to your account and AWS Region Starts with a lowercase letter Contains only lowercase letters a-z, the numbers 0-9 and the hyphen (-) Contains between 3 and 32 characters
▶tags	array	List of tags to be added to the resource
arn	string	The Amazon Resource Name (ARN) of the collection.
collection_endpoint	string	The endpoint for the collection.
dashboard_endpoint	string	The OpenSearch Dashboards endpoint for the collection.
type	string	The possible types for the collection
standby_replicas	string	The possible standby replicas for the collection
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
id	string	The identifier of the collection
region	string	AWS region.

For more information, see AWS::OpenSearchServerless::Collection.

Methods

Name	Resource	Accessible by	Required Params
create_resource	collections	INSERT	Name, region
delete_resource	collections	DELETE	Identifier, region
update_resource	collections	UPDATE	Identifier, PatchDocument, region
list_resources	collections_list_only	SELECT	region
get_resource	collections	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual collection.

SELECT
  region,
  description,
  id,
  name,
  tags,
  arn,
  collection_endpoint,
  dashboard_endpoint,
  type,
  standby_replicas
FROM awscc.opensearchserverless.collections
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}';

list (identifiers only)

Lists all collections in a region.

SELECT
  region,
  id
FROM awscc.opensearchserverless.collections_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.opensearchserverless.collections (
  Name,
  region
)
SELECT
  '{{ name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.opensearchserverless.collections (
  Description,
  Name,
  Tags,
  Type,
  StandbyReplicas,
  region
)
SELECT
  '{{ description }}',
  '{{ name }}',
  '{{ tags }}',
  '{{ type }}',
  '{{ standby_replicas }}',
  '{{ 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: collection
  props:
    - name: description
      value: '{{ description }}'
    - name: name
      value: '{{ name }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'
    - name: type
      value: '{{ type }}'
    - name: standby_replicas
      value: '{{ standby_replicas }}'

UPDATE example

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

/*+ update */
UPDATE awscc.opensearchserverless.collections
SET PatchDocument = string('{{ {
    "Description": description,
    "StandbyReplicas": standby_replicas
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

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

Create

aoss:CreateCollection,
aoss:BatchGetCollection,
iam:CreateServiceLinkedRole

Delete

aoss:DeleteCollection,
aoss:BatchGetCollection

List

aoss:ListCollections

Read

aoss:BatchGetCollection

Update

aoss:UpdateCollection,
aoss:BatchGetCollection