opensearchserverless

v2026.04.23.3

AWS OPENSEARCHSERVERLESS infrastructure models

Repository

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

Platforms

linux-x86_64 linux-aarch64 darwin-x86_64 darwin-aarch64

Labels

awsopensearchserverlesscloudinfrastructure

models

Quality score

Verified by Swamp

How well-documented and verifiable this extension is.

Grade A

Has README or module doc2/2earned
README has a code example1/1earned
README is substantive1/1earned
Most symbols documented1/1earned
No slow types1/1earned
Has description1/1earned
At least one platform tag (or universal)1/1earned
Two or more platform tags (or universal)1/1earned
License declared1/1earned
Verified public repository2/2earned

Install

$ swamp extension pull @swamp/aws/opensearchserverless

@swamp/aws/opensearchserverless/access-policyv2026.04.23.2access_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)
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

createCreate a OpenSearchServerless AccessPolicy

getGet a OpenSearchServerless AccessPolicy

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

updateUpdate a OpenSearchServerless AccessPolicy

deleteDelete a OpenSearchServerless AccessPolicy

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

syncSync OpenSearchServerless AccessPolicy state from AWS

Resources

state(infinite)— OpenSearchServerless AccessPolicy resource state

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

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
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
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

createCreate a OpenSearchServerless Collection

getGet a OpenSearchServerless Collection

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

updateUpdate a OpenSearchServerless Collection

deleteDelete a OpenSearchServerless Collection

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

syncSync OpenSearchServerless Collection state from AWS

Resources

state(infinite)— OpenSearchServerless Collection resource state

@swamp/aws/opensearchserverless/collection-groupv2026.04.23.2collection_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)
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.
CapacityLimits?	object	no
Tags?	array	no	An array of key-value pairs to apply to this resource.

createCreate a OpenSearchServerless CollectionGroup

getGet a OpenSearchServerless CollectionGroup

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

updateUpdate a OpenSearchServerless CollectionGroup

deleteDelete a OpenSearchServerless CollectionGroup

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

syncSync OpenSearchServerless CollectionGroup state from AWS

Resources

state(infinite)— OpenSearchServerless CollectionGroup resource state

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

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
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

createCreate a OpenSearchServerless Index

getGet a OpenSearchServerless Index

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

updateUpdate a OpenSearchServerless Index

deleteDelete a OpenSearchServerless Index

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

syncSync OpenSearchServerless Index state from AWS

Resources

state(infinite)— OpenSearchServerless Index resource state

@swamp/aws/opensearchserverless/lifecycle-policyv2026.04.23.2lifecycle_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)
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

createCreate a OpenSearchServerless LifecyclePolicy

getGet a OpenSearchServerless LifecyclePolicy

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

updateUpdate a OpenSearchServerless LifecyclePolicy

deleteDelete a OpenSearchServerless LifecyclePolicy

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

syncSync OpenSearchServerless LifecyclePolicy state from AWS

Resources

state(infinite)— OpenSearchServerless LifecyclePolicy resource state

@swamp/aws/opensearchserverless/security-configv2026.04.23.2security_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)
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

createCreate a OpenSearchServerless SecurityConfig

getGet a OpenSearchServerless SecurityConfig

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

updateUpdate a OpenSearchServerless SecurityConfig

deleteDelete a OpenSearchServerless SecurityConfig

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

syncSync OpenSearchServerless SecurityConfig state from AWS

Resources

state(infinite)— OpenSearchServerless SecurityConfig resource state

@swamp/aws/opensearchserverless/security-policyv2026.04.23.2security_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)
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

createCreate a OpenSearchServerless SecurityPolicy

getGet a OpenSearchServerless SecurityPolicy

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

updateUpdate a OpenSearchServerless SecurityPolicy

deleteDelete a OpenSearchServerless SecurityPolicy

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

syncSync OpenSearchServerless SecurityPolicy state from AWS

Resources

state(infinite)— OpenSearchServerless SecurityPolicy resource state

@swamp/aws/opensearchserverless/vpc-endpointv2026.04.23.2vpc_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)
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.

createCreate a OpenSearchServerless VpcEndpoint

getGet a OpenSearchServerless VpcEndpoint

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

updateUpdate a OpenSearchServerless VpcEndpoint

deleteDelete a OpenSearchServerless VpcEndpoint

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

syncSync OpenSearchServerless VpcEndpoint state from AWS

Resources

state(infinite)— OpenSearchServerless VpcEndpoint resource state

2026.04.23.21.5 MBApr 23, 2026

AWS OPENSEARCHSERVERLESS infrastructure models

Release Notes

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

linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64

awsopensearchserverlesscloudinfrastructure

2026.04.20.11.5 MBApr 20, 2026

AWS OPENSEARCHSERVERLESS infrastructure models

Release Notes

Updated: collection

linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64

awsopensearchserverlesscloudinfrastructure

2026.04.03.21.5 MBApr 3, 2026

AWS OPENSEARCHSERVERLESS infrastructure models

Release Notes

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

linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64

awsopensearchserverlesscloudinfrastructure

2026.03.25.11.6 MBMar 25, 2026

AWS OPENSEARCHSERVERLESS infrastructure models

Release Notes

Updated: collection

linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64

awsopensearchserverlesscloudinfrastructure

2026.03.23.11.6 MBMar 23, 2026

AWS OPENSEARCHSERVERLESS infrastructure models

Release Notes

Updated: collection

linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64

awsopensearchserverlesscloudinfrastructure

2026.03.19.11.6 MBMar 19, 2026

AWS OPENSEARCHSERVERLESS infrastructure models

Release Notes

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

linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64

awsopensearchserverlesscloudinfrastructure

2026.03.16.11.6 MBMar 16, 2026

AWS OPENSEARCHSERVERLESS infrastructure models

Release Notes

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

linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64

awsopensearchserverlesscloudinfrastructure

2026.03.10.51.6 MBMar 10, 2026

AWS OPENSEARCHSERVERLESS infrastructure models

linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64

awsopensearchserverlesscloudinfrastructure

@swamp/aws/opensearchserverless

Repository

Platforms

Labels

Contents

Quality score

Install

Models8

Global Arguments

Resources

Global Arguments

Resources

Global Arguments

Resources

Global Arguments

Resources

Global Arguments

Resources

Global Arguments

Resources

Global Arguments

Resources

Global Arguments

Resources

Previous Versions8

Release Notes

Release Notes

Release Notes

Release Notes

Release Notes

Release Notes

Release Notes