Aws/opensearchserverless
@swamp/aws/opensearchserverlessv2026.10.25.1
01README
AWS OPENSEARCHSERVERLESS infrastructure models
02Release Notes
- Updated: collection, index, security_config
03Behaviors
@swamp/aws/opensearchserverless/access-policyv2026.10.23.1access_policy.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | 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 | 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 | 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 | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| Name | string | The name of the policy |
| Type | enum | The possible types for the access policy |
| Description? | string | The description of the policy |
| Policy | string | 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 | Description |
|---|---|---|
| identifier | string | The primary identifier of the OpenSearchServerless AccessPolicy |
fn update()
Update a OpenSearchServerless AccessPolicy
fn delete(identifier: string)
Delete a OpenSearchServerless AccessPolicy
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the OpenSearchServerless AccessPolicy |
fn sync()
Sync OpenSearchServerless AccessPolicy state from AWS
fn list(maxPages?: number, resourceModel?: string)
List OpenSearchServerless AccessPolicy resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— OpenSearchServerless AccessPolicy resource state
@swamp/aws/opensearchserverless/collectionv2026.10.25.1collection.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | 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 | 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 | 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 | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| Description? | string | The description 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 64 characters |
| Tags? | array | List of tags to be added to the resource |
| Type? | enum | The possible types for the collection |
| StandbyReplicas? | enum | The possible standby replicas for the collection |
| DeletionProtection? | enum | The deletion protection state of the collection |
| CollectionGroupName? | string | The name of the collection group to associate with the collection. |
| EncryptionConfig? | object | Encryption settings for the collection |
| VectorOptions? | object | Vector search configuration options for the collection |
| FipsEndpoints? | object |
fn create()
Create a OpenSearchServerless Collection
fn get(identifier: string)
Get a OpenSearchServerless Collection
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the OpenSearchServerless Collection |
fn update()
Update a OpenSearchServerless Collection
fn delete(identifier: string)
Delete a OpenSearchServerless Collection
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the OpenSearchServerless Collection |
fn sync()
Sync OpenSearchServerless Collection state from AWS
fn list(maxPages?: number, resourceModel?: string)
List OpenSearchServerless Collection resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— OpenSearchServerless Collection resource state
@swamp/aws/opensearchserverless/collection-groupv2026.10.23.1collection_group.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | 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 | 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 | 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 | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| Name | string | The name of the collection group. |
| Description? | string | The description of the collection group. |
| StandbyReplicas | enum | Indicates whether standby replicas are used for the collection group. |
| Generation? | enum | The generation of Amazon OpenSearch Serverless for the collection group. Valid values are CLASSIC and NEXTGEN. |
| CapacityLimits? | object | |
| Tags? | array | 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 | Description |
|---|---|---|
| identifier | string | The primary identifier of the OpenSearchServerless CollectionGroup |
fn update()
Update a OpenSearchServerless CollectionGroup
fn delete(identifier: string)
Delete a OpenSearchServerless CollectionGroup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the OpenSearchServerless CollectionGroup |
fn sync()
Sync OpenSearchServerless CollectionGroup state from AWS
fn list(maxPages?: number, resourceModel?: string)
List OpenSearchServerless CollectionGroup resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— OpenSearchServerless CollectionGroup resource state
@swamp/aws/opensearchserverless/collection-indexv2026.10.23.1collection_index.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | 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 | 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 | 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 | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| Id | string | The identifier of the collection |
| IndexName | string | The name of the collection index |
| IndexSchema? | string | The Mappings for the collection index |
fn create()
Create a OpenSearchServerless CollectionIndex
fn get(identifier: string)
Get a OpenSearchServerless CollectionIndex
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the OpenSearchServerless CollectionIndex |
fn update()
Update a OpenSearchServerless CollectionIndex
fn delete(identifier: string)
Delete a OpenSearchServerless CollectionIndex
| Argument | Type | Description |
|---|---|---|
| identifier | string | 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.10.25.1index.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | 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 | 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 | 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 | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| CollectionEndpoint | string | The endpoint for the collection. |
| IndexName | string | The name of the OpenSearch Serverless index. |
| Settings? | object | Index settings |
| Mappings? | object | Index Mappings |
fn create()
Create a OpenSearchServerless Index
fn get(identifier: string)
Get a OpenSearchServerless Index
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the OpenSearchServerless Index |
fn update()
Update a OpenSearchServerless Index
fn delete(identifier: string)
Delete a OpenSearchServerless Index
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the OpenSearchServerless Index |
fn sync()
Sync OpenSearchServerless Index state from AWS
fn list(maxPages?: number, resourceModel?: string)
List OpenSearchServerless Index resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— OpenSearchServerless Index resource state
@swamp/aws/opensearchserverless/lifecycle-policyv2026.10.23.1lifecycle_policy.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | 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 | 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 | 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 | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| Name | string | The name of the policy |
| Type | enum | The type of lifecycle policy |
| Description? | string | The description of the policy |
| Policy | string | 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 | Description |
|---|---|---|
| identifier | string | The primary identifier of the OpenSearchServerless LifecyclePolicy |
fn update()
Update a OpenSearchServerless LifecyclePolicy
fn delete(identifier: string)
Delete a OpenSearchServerless LifecyclePolicy
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the OpenSearchServerless LifecyclePolicy |
fn sync()
Sync OpenSearchServerless LifecyclePolicy state from AWS
fn list(maxPages?: number, resourceModel?: string)
List OpenSearchServerless LifecyclePolicy resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— OpenSearchServerless LifecyclePolicy resource state
@swamp/aws/opensearchserverless/security-configv2026.10.25.1security_config.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | 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 | 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 | 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 | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| Description? | string | Security config description |
| Name? | string | The friendly name of the security config |
| SamlOptions? | object | Describes saml options in form of key value map |
| IamIdentityCenterOptions? | object | Describes IAM Identity Center options for an OpenSearch Serverless security configuration in the form of a key-value map |
| IamFederationOptions? | object | Describe IAM federation options in form of key value map |
| Type? | enum | Config type for security config |
fn create()
Create a OpenSearchServerless SecurityConfig
fn get(identifier: string)
Get a OpenSearchServerless SecurityConfig
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the OpenSearchServerless SecurityConfig |
fn update()
Update a OpenSearchServerless SecurityConfig
fn delete(identifier: string)
Delete a OpenSearchServerless SecurityConfig
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the OpenSearchServerless SecurityConfig |
fn sync()
Sync OpenSearchServerless SecurityConfig state from AWS
fn list(maxPages?: number, resourceModel?: string)
List OpenSearchServerless SecurityConfig resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— OpenSearchServerless SecurityConfig resource state
@swamp/aws/opensearchserverless/security-policyv2026.10.23.1security_policy.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | 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 | 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 | 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 | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| Description? | string | The description of the policy |
| Policy | string | The JSON policy document that is the content for the policy |
| Name | string | The name of the policy |
| Type | enum | The possible types for the network policy |
fn create()
Create a OpenSearchServerless SecurityPolicy
fn get(identifier: string)
Get a OpenSearchServerless SecurityPolicy
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the OpenSearchServerless SecurityPolicy |
fn update()
Update a OpenSearchServerless SecurityPolicy
fn delete(identifier: string)
Delete a OpenSearchServerless SecurityPolicy
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the OpenSearchServerless SecurityPolicy |
fn sync()
Sync OpenSearchServerless SecurityPolicy state from AWS
fn list(maxPages?: number, resourceModel?: string)
List OpenSearchServerless SecurityPolicy resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— OpenSearchServerless SecurityPolicy resource state
@swamp/aws/opensearchserverless/vpc-endpointv2026.10.23.1vpc_endpoint.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | 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 | 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 | 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 | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| Name | string | The name of the VPC Endpoint |
| SecurityGroupIds? | array | The ID of one or more security groups to associate with the endpoint network interface |
| SubnetIds | array | The ID of one or more subnets in which to create an endpoint network interface |
| VpcId | string | 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 | Description |
|---|---|---|
| identifier | string | The primary identifier of the OpenSearchServerless VpcEndpoint |
fn update()
Update a OpenSearchServerless VpcEndpoint
fn delete(identifier: string)
Delete a OpenSearchServerless VpcEndpoint
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the OpenSearchServerless VpcEndpoint |
fn sync()
Sync OpenSearchServerless VpcEndpoint state from AWS
fn list(maxPages?: number, resourceModel?: string)
List OpenSearchServerless VpcEndpoint resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— OpenSearchServerless VpcEndpoint resource state
04Previous Versions
2026.10.24.1AGPL-3.0-or-later
2026.10.23.1AGPL-3.0-or-later(was none)
- Updated: access_policy, collection, collection_group, collection_index, index, lifecycle_policy, security_config, security_policy, vpc_endpoint
2026.10.13.1
- Updated: access_policy, collection, collection_group, collection_index, index, lifecycle_policy, security_config, security_policy, vpc_endpoint
2026.10.08.1
2026.10.06.1
2026.10.04.1
2026.10.03.1
2026.10.02.1
2026.10.01.1
2026.09.30.1
2026.09.29.1
2026.09.28.1
2026.09.27.1
2026.09.26.1
2026.09.25.1
2026.09.24.1
2026.09.23.1
2026.09.22.1
2026.09.21.1
05Stats
A
100 / 100
Downloads
136
Archive size
1.8 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 audit2/2earned
- Docs keep secrets in a vault1/1earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License2/2earned
- Verified public repository2/2earned
06Platforms
07Labels