Aws/osis
@swamp/aws/osisv2026.10.25.1
01README
AWS OSIS infrastructure models
02Behaviors
@swamp/aws/osis/pipelinev2026.10.23.1pipeline.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. |
| BufferOptions? | object | Key-value pairs to configure buffering. |
| EncryptionAtRestOptions? | object | Key-value pairs to configure encryption at rest. |
| LogPublishingOptions? | object | Key-value pairs to configure log publishing. |
| MaxUnits | number | The maximum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs). |
| MinUnits | number | The minimum pipeline capacity, in Ingestion OpenSearch Compute Units (OCUs). |
| PipelineConfigurationBody | string | The Data Prepper pipeline configuration. |
| PipelineName | string | Name of the OpenSearch Ingestion Service pipeline to create. Pipeline names are unique across the pipelines owned by an account within an AWS Region. |
| Tags? | array | An array of key-value pairs to apply to this resource. |
| VpcOptions? | object | Container for the values required to configure VPC access for the pipeline. If you don't specify these values, OpenSearch Ingestion Service creates the pipeline with a public endpoint. |
| PipelineRoleArn? | string | The Pipeline Role (ARN) for the pipeline. |
| ResourcePolicy? | object |
fn create()
Create a OSIS Pipeline
fn get(identifier: string)
Get a OSIS Pipeline
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the OSIS Pipeline |
fn update()
Update a OSIS Pipeline
fn delete(identifier: string)
Delete a OSIS Pipeline
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the OSIS Pipeline |
fn sync()
Sync OSIS Pipeline state from AWS
fn list(maxPages?: number, resourceModel?: string)
List OSIS Pipeline 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)— OSIS Pipeline resource state
03Previous Versions
2026.10.24.1AGPL-3.0-or-later
2026.10.23.1AGPL-3.0-or-later(was none)
- Updated: pipeline
2026.10.13.1
- Updated: pipeline
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
04Stats
A
100 / 100
Downloads
197
Archive size
214.9 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