Aws/opensearchservice
@swamp/aws/opensearchservicev2026.10.25.2
01README
AWS OPENSEARCHSERVICE infrastructure models
02Behaviors
application.tsv2026.10.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| 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. |
| IamIdentityCenterOptions? | object | Whether IAM Identity Center is enabled. |
| Name | string | The name of the application. |
| Endpoint? | string | The endpoint for the application. |
| AppConfigs? | array | List of application configurations. |
| KmsKeyArn? | string | The ARN of the KMS key used to encrypt the application. |
| DataSources? | array | List of data sources. |
| Tags? | array | An arbitrary set of tags (key-value pairs) for this application. |
fn create()
Create a OpenSearchService Application
fn get(identifier: string)
Get a OpenSearchService Application
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the OpenSearchService Application |
fn update()
Update a OpenSearchService Application
fn delete(identifier: string)
Delete a OpenSearchService Application
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the OpenSearchService Application |
fn sync()
Sync OpenSearchService Application state from AWS
fn list(maxPages?: number, resourceModel?: string)
List OpenSearchService Application 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)— OpenSearchService Application resource state
domain.tsv2026.10.25.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| 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. |
| ClusterConfig? | object | |
| DomainName? | string | |
| AccessPolicies? | record | |
| IPAddressType? | string | |
| EngineVersion? | string | |
| AdvancedOptions? | record | |
| LogPublishingOptions? | record | |
| SnapshotOptions? | object | |
| VPCOptions? | object | Controls whether egress traffic from the domain is routed through the customer VPC. |
| NodeToNodeEncryptionOptions? | object | |
| DomainEndpointOptions? | object | |
| CognitoOptions? | object | |
| AdvancedSecurityOptions? | object | |
| EBSOptions? | object | |
| EncryptionAtRestOptions? | object | The type of encryption at rest applied to the domain's data. Valid values are DISK and NATIVE. DISK is the default and uses volume-level encryption. NATIVE uses engine-native, index-level encryption and requires encryption at rest to be enabled and OpenSearch version 3.3 or later. After the mode is set to NATIVE, it can't be changed back to DISK. |
| Tags? | array | An arbitrary set of tags (key-value pairs) for this Domain. |
| ServiceSoftwareOptions? | object | |
| OffPeakWindowOptions? | object | |
| SoftwareUpdateOptions? | object | |
| SkipShardMigrationWait? | boolean | |
| IdentityCenterOptions? | object | Whether Identity Center is enabled. |
| AIMLOptions? | object | |
| DeploymentStrategyOptions? | object | |
| AutomatedSnapshotPauseOptions? | object | |
| EngineMode? | enum | The engine mode of the domain. Determines whether the domain runs the standard (GENERAL) engine or the optimized multi-engine (OPTIMIZED) engine. This value cannot be changed after the domain is created. |
| UseCase? | enum | The primary use case of the domain. Determines the default configuration tuned for the workload. For GENERAL engine-mode domains, this value can be changed after creation. For OPTIMIZED engine-mode domains, this value cannot be changed after creation. |
| AcceptedWarnings? | array | Warning codes to accept for this domain configuration update. Accepting a warning lets the update proceed past a validation that would otherwise block it. This property applies only to the current update and is not persisted on the domain. You can find warning codes in the ValidationFailures returned by DescribeDomainChangeProgress or DescribeDryRunProgress. |
fn create()
Create a OpenSearchService Domain
fn get(identifier: string)
Get a OpenSearchService Domain
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the OpenSearchService Domain |
fn update()
Update a OpenSearchService Domain
fn delete(identifier: string)
Delete a OpenSearchService Domain
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the OpenSearchService Domain |
fn sync()
Sync OpenSearchService Domain state from AWS
Resources
state(infinite)— OpenSearchService Domain resource state
03Previous Versions
2026.10.25.1AGPL-3.0-or-later
- Updated: domain
Added 1, removed 2 behaviors
2026.10.24.1AGPL-3.0-or-later
2026.10.23.1AGPL-3.0-or-later(was none)
- Updated: application, domain
2026.10.13.1
- Updated: application, domain
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
04Stats
A
100 / 100
Downloads
107
Archive size
420.7 KB
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
05Platforms
06Labels