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.<br />The name must meet the following criteria:<br />Unique to your account and AWS Region<br />Starts with a lowercase letter<br />Contains only lowercase letters a-z, the numbers 0-9 and the hyphen (-)<br />Contains between 3 and 32 characters<br />
▶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 = 'us-east-1' AND
  Identifier = '{{ id }}';

list (identifiers only)

Lists all collections in a region.

SELECT
  region,
  id
FROM awscc.opensearchserverless.collections_list_only
WHERE
  region = 'us-east-1';

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 }}';

All Properties

/*+ create */
INSERT INTO awscc.opensearchserverless.collections (
  Description,
  Name,
  Tags,
  Type,
  StandbyReplicas,
  region
)
SELECT
  '{{ description }}',
  '{{ name }}',
  '{{ tags }}',
  '{{ type }}',
  '{{ standby_replicas }}',
  '{{ region }}';

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 }}';

DELETE example

/*+ delete */
DELETE FROM awscc.opensearchserverless.collections
WHERE
  Identifier = '{{ id }}' AND
  region = 'us-east-1';

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