Aws/opensearchserverless

@swamp/aws/opensearchserverlessv2026.06.12.1· 3d agoMODELS

01README

AWS OPENSEARCHSERVERLESS infrastructure models

02Release Notes

Updated: collection_group

03Models9

@swamp/aws/opensearchserverless/access-policyv2026.06.08.1access_policy.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?	string	no	AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?	string	no	AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?	string	no	AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?	string	no	AWS region; overrides AWS_REGION environment variable. Defaults to us-east-1.
Name	string	yes	The name of the policy
Type	enum	yes	The possible types for the access policy
Description?	string	no	The description of the policy
Policy	string	yes	The JSON policy document that is the content for the policy

fn create()

Create a OpenSearchServerless AccessPolicy

fn get(identifier: string)

Get a OpenSearchServerless AccessPolicy

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the OpenSearchServerless AccessPolicy

fn update()

Update a OpenSearchServerless AccessPolicy

fn delete(identifier: string)

Delete a OpenSearchServerless AccessPolicy

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the OpenSearchServerless AccessPolicy

fn sync()

Sync OpenSearchServerless AccessPolicy state from AWS

Resources

state(infinite)— OpenSearchServerless AccessPolicy resource state

@swamp/aws/opensearchserverless/collectionv2026.06.08.1collection.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?	string	no	AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?	string	no	AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?	string	no	AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?	string	no	AWS region; overrides AWS_REGION environment variable. Defaults to us-east-1.
Description?	string	no	The description of the collection
Name	string	yes	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 64 characters
Tags?	array	no	List of tags to be added to the resource
Type?	enum	no	The possible types for the collection
StandbyReplicas?	enum	no	The possible standby replicas for the collection
DeletionProtection?	enum	no	The deletion protection state of the collection
CollectionGroupName?	string	no	The name of the collection group to associate with the collection.
EncryptionConfig?	object	no	Encryption settings for the collection
VectorOptions?	object	no	Vector search configuration options for the collection

fn create()

Create a OpenSearchServerless Collection

fn get(identifier: string)

Get a OpenSearchServerless Collection

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the OpenSearchServerless Collection

fn update()

Update a OpenSearchServerless Collection

fn delete(identifier: string)

Delete a OpenSearchServerless Collection

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the OpenSearchServerless Collection

fn sync()

Sync OpenSearchServerless Collection state from AWS

Resources

state(infinite)— OpenSearchServerless Collection resource state

@swamp/aws/opensearchserverless/collection-groupv2026.06.12.1collection_group.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?	string	no	AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?	string	no	AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?	string	no	AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?	string	no	AWS region; overrides AWS_REGION environment variable. Defaults to us-east-1.
Name	string	yes	The name of the collection group.
Description?	string	no	The description of the collection group.
StandbyReplicas	enum	yes	Indicates whether standby replicas are used for the collection group.
Generation?	enum	no	The generation of Amazon OpenSearch Serverless for the collection group. Valid values are CLASSIC and NEXTGEN.
CapacityLimits?	object	no
Tags?	array	no	An array of key-value pairs to apply to this resource.

fn create()

Create a OpenSearchServerless CollectionGroup

fn get(identifier: string)

Get a OpenSearchServerless CollectionGroup

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the OpenSearchServerless CollectionGroup

fn update()

Update a OpenSearchServerless CollectionGroup

fn delete(identifier: string)

Delete a OpenSearchServerless CollectionGroup

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the OpenSearchServerless CollectionGroup

fn sync()

Sync OpenSearchServerless CollectionGroup state from AWS

Resources

state(infinite)— OpenSearchServerless CollectionGroup resource state

@swamp/aws/opensearchserverless/collection-indexv2026.06.08.1collection_index.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?	string	no	AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?	string	no	AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?	string	no	AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?	string	no	AWS region; overrides AWS_REGION environment variable. Defaults to us-east-1.
Id	string	yes	The identifier of the collection
IndexName	string	yes	The name of the collection index
IndexSchema?	string	no	The Mappings for the collection index

fn create()

Create a OpenSearchServerless CollectionIndex

fn get(identifier: string)

Get a OpenSearchServerless CollectionIndex

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the OpenSearchServerless CollectionIndex

fn update()

Update a OpenSearchServerless CollectionIndex

fn delete(identifier: string)

Delete a OpenSearchServerless CollectionIndex

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the OpenSearchServerless CollectionIndex

fn sync()

Sync OpenSearchServerless CollectionIndex state from AWS

Resources

state(infinite)— OpenSearchServerless CollectionIndex resource state

@swamp/aws/opensearchserverless/indexv2026.06.08.1index.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?	string	no	AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?	string	no	AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?	string	no	AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?	string	no	AWS region; overrides AWS_REGION environment variable. Defaults to us-east-1.
CollectionEndpoint	string	yes	The endpoint for the collection.
IndexName	string	yes	The name of the OpenSearch Serverless index.
Settings?	object	no	Index settings
Mappings?	object	no	Index Mappings

fn create()

Create a OpenSearchServerless Index

fn get(identifier: string)

Get a OpenSearchServerless Index

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the OpenSearchServerless Index

fn update()

Update a OpenSearchServerless Index

fn delete(identifier: string)

Delete a OpenSearchServerless Index

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the OpenSearchServerless Index

fn sync()

Sync OpenSearchServerless Index state from AWS

Resources

state(infinite)— OpenSearchServerless Index resource state

@swamp/aws/opensearchserverless/lifecycle-policyv2026.06.08.1lifecycle_policy.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?	string	no	AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?	string	no	AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?	string	no	AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?	string	no	AWS region; overrides AWS_REGION environment variable. Defaults to us-east-1.
Name	string	yes	The name of the policy
Type	enum	yes	The type of lifecycle policy
Description?	string	no	The description of the policy
Policy	string	yes	The JSON policy document that is the content for the policy

fn create()

Create a OpenSearchServerless LifecyclePolicy

fn get(identifier: string)

Get a OpenSearchServerless LifecyclePolicy

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the OpenSearchServerless LifecyclePolicy

fn update()

Update a OpenSearchServerless LifecyclePolicy

fn delete(identifier: string)

Delete a OpenSearchServerless LifecyclePolicy

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the OpenSearchServerless LifecyclePolicy

fn sync()

Sync OpenSearchServerless LifecyclePolicy state from AWS

Resources

state(infinite)— OpenSearchServerless LifecyclePolicy resource state

@swamp/aws/opensearchserverless/security-configv2026.06.08.1security_config.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?	string	no	AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?	string	no	AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?	string	no	AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?	string	no	AWS region; overrides AWS_REGION environment variable. Defaults to us-east-1.
Description?	string	no	Security config description
Name?	string	no	The friendly name of the security config
SamlOptions?	object	no	Describes saml options in form of key value map
IamIdentityCenterOptions?	object	no	Describes IAM Identity Center options for an OpenSearch Serverless security configuration in the form of a key-value map
IamFederationOptions?	object	no	Describe IAM federation options in form of key value map
Type?	enum	no	Config type for security config

fn create()

Create a OpenSearchServerless SecurityConfig

fn get(identifier: string)

Get a OpenSearchServerless SecurityConfig

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the OpenSearchServerless SecurityConfig

fn update()

Update a OpenSearchServerless SecurityConfig

fn delete(identifier: string)

Delete a OpenSearchServerless SecurityConfig

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the OpenSearchServerless SecurityConfig

fn sync()

Sync OpenSearchServerless SecurityConfig state from AWS

Resources

state(infinite)— OpenSearchServerless SecurityConfig resource state

@swamp/aws/opensearchserverless/security-policyv2026.06.08.1security_policy.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?	string	no	AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?	string	no	AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?	string	no	AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?	string	no	AWS region; overrides AWS_REGION environment variable. Defaults to us-east-1.
Description?	string	no	The description of the policy
Policy	string	yes	The JSON policy document that is the content for the policy
Name	string	yes	The name of the policy
Type	enum	yes	The possible types for the network policy

fn create()

Create a OpenSearchServerless SecurityPolicy

fn get(identifier: string)

Get a OpenSearchServerless SecurityPolicy

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the OpenSearchServerless SecurityPolicy

fn update()

Update a OpenSearchServerless SecurityPolicy

fn delete(identifier: string)

Delete a OpenSearchServerless SecurityPolicy

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the OpenSearchServerless SecurityPolicy

fn sync()

Sync OpenSearchServerless SecurityPolicy state from AWS

Resources

state(infinite)— OpenSearchServerless SecurityPolicy resource state

@swamp/aws/opensearchserverless/vpc-endpointv2026.06.08.1vpc_endpoint.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?	string	no	AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?	string	no	AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?	string	no	AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?	string	no	AWS region; overrides AWS_REGION environment variable. Defaults to us-east-1.
Name	string	yes	The name of the VPC Endpoint
SecurityGroupIds?	array	no	The ID of one or more security groups to associate with the endpoint network interface
SubnetIds	array	yes	The ID of one or more subnets in which to create an endpoint network interface
VpcId	string	yes	The ID of the VPC in which the endpoint will be used.

fn create()

Create a OpenSearchServerless VpcEndpoint

fn get(identifier: string)

Get a OpenSearchServerless VpcEndpoint

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the OpenSearchServerless VpcEndpoint

fn update()

Update a OpenSearchServerless VpcEndpoint

fn delete(identifier: string)

Delete a OpenSearchServerless VpcEndpoint

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the OpenSearchServerless VpcEndpoint

fn sync()

Sync OpenSearchServerless VpcEndpoint state from AWS

Resources

state(infinite)— OpenSearchServerless VpcEndpoint resource state

04Previous Versions14

2026.06.08.2Jun 8, 2026

Updated: access_policy, collection, collection_group, collection_index, index, lifecycle_policy, security_config, security_policy, vpc_endpoint

2026.06.06.1Jun 6, 2026

Updated: access_policy, collection, collection_group, collection_index, index, lifecycle_policy, security_config, security_policy, vpc_endpoint

2026.06.04.1Jun 4, 2026

Updated: collection

2026.05.31.1May 31, 2026

Added: collection_index

Added 1 models

2026.05.24.1May 24, 2026

Updated: collection

2026.04.23.3Apr 23, 2026

2026.04.23.2Apr 23, 2026

Updated: access_policy, collection, collection_group, index, lifecycle_policy, security_config, security_policy, vpc_endpoint

2026.04.20.1Apr 20, 2026

Updated: collection

2026.04.03.2Apr 3, 2026

Updated: access_policy, collection, collection_group, index, lifecycle_policy, security_config, security_policy, vpc_endpoint

2026.03.25.1Mar 25, 2026

Updated: collection

2026.03.23.1Mar 23, 2026

Updated: collection

2026.03.19.1Mar 19, 2026

Updated: access_policy, collection, collection_group, index, lifecycle_policy, security_config, security_policy, vpc_endpoint

2026.03.16.1Mar 16, 2026

Updated: access_policy, collection, collection_group, index, lifecycle_policy, security_config, security_policy, vpc_endpoint

2026.03.10.5Mar 10, 2026

05Stats

85 / 100

Downloads

Archive size

2.1 MB

Verified by Swamp

Has README or module doc2/2earned
README has a code example1/1earned
README is substantive1/1earned
Most symbols documented1/1earned
No slow types (deprecated)1/1earned
Dependencies pass trust audit0/2missing
Has description1/1earned
Platform support declared (or universal)2/2earned
License declared1/1earned
Verified public repository2/2earned

Repository

https://github.com/swamp-club/swamp-extensions

06Platforms

linux · x86_64 linux · aarch64 macOS · x86_64 macOS · aarch64

07Labels

#aws #opensearchserverless #cloud #infrastructure