Aws/s3outposts
@swamp/aws/s3outpostsv2026.10.25.1
01README
AWS S3OUTPOSTS infrastructure models
02Behaviors
@swamp/aws/s3outposts/access-pointv2026.10.23.1access_point.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. |
| Bucket | string | The Amazon Resource Name (ARN) of the bucket you want to associate this AccessPoint with. |
| Name | string | A name for the AccessPoint. |
| VpcConfiguration | object | Virtual Private Cloud (VPC) from which requests can be made to the AccessPoint. |
| Policy? | record | The access point policy associated with this access point. |
fn create()
Create a S3Outposts AccessPoint
fn get(identifier: string)
Get a S3Outposts AccessPoint
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the S3Outposts AccessPoint |
fn update()
Update a S3Outposts AccessPoint
fn delete(identifier: string)
Delete a S3Outposts AccessPoint
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the S3Outposts AccessPoint |
fn sync()
Sync S3Outposts AccessPoint state from AWS
fn list(maxPages?: number, resourceModel?: string)
List S3Outposts AccessPoint 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)— S3Outposts AccessPoint resource state
@swamp/aws/s3outposts/bucketv2026.10.23.1bucket.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. |
| BucketName | string | A name for the bucket. |
| OutpostId | string | The id of the customer outpost on which the bucket resides. |
| Tags? | array | An arbitrary set of tags (key-value pairs) for this S3Outposts bucket. |
| LifecycleConfiguration? | object | Rules that define how Amazon S3Outposts manages objects during their lifetime. |
fn create()
Create a S3Outposts Bucket
fn get(identifier: string)
Get a S3Outposts Bucket
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the S3Outposts Bucket |
fn update()
Update a S3Outposts Bucket
fn delete(identifier: string)
Delete a S3Outposts Bucket
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the S3Outposts Bucket |
fn sync()
Sync S3Outposts Bucket state from AWS
fn list(maxPages?: number, resourceModel?: string)
List S3Outposts Bucket 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)— S3Outposts Bucket resource state
@swamp/aws/s3outposts/bucket-policyv2026.10.23.1bucket_policy.ts
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. |
| Bucket | string | The Amazon Resource Name (ARN) of the specified bucket. |
| PolicyDocument | record | A policy document containing permissions to add to the specified bucket. |
fn create()
Create a S3Outposts BucketPolicy
fn get(identifier: string)
Get a S3Outposts BucketPolicy
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the S3Outposts BucketPolicy |
fn update()
Update a S3Outposts BucketPolicy
fn delete(identifier: string)
Delete a S3Outposts BucketPolicy
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the S3Outposts BucketPolicy |
fn sync()
Sync S3Outposts BucketPolicy state from AWS
Resources
state(infinite)— S3Outposts BucketPolicy resource state
@swamp/aws/s3outposts/endpointv2026.10.23.1endpoint.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. |
| OutpostId | string | The id of the customer outpost on which the bucket resides. |
| SecurityGroupId | string | The ID of the security group to use with the endpoint. |
| SubnetId | string | The ID of the subnet in the selected VPC. The subnet must belong to the Outpost. |
| AccessType? | enum | The type of access for the on-premise network connectivity for the Outpost endpoint. To access endpoint from an on-premises network, you must specify the access type and provide the customer owned Ipv4 pool. |
| CustomerOwnedIpv4Pool? | string | The ID of the customer-owned IPv4 pool for the Endpoint. IP addresses will be allocated from this pool for the endpoint. |
| FailedReason? | object | The failure reason, if any, for a create or delete endpoint operation. |
fn create()
Create a S3Outposts Endpoint
fn get(identifier: string)
Get a S3Outposts Endpoint
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the S3Outposts Endpoint |
fn delete(identifier: string)
Delete a S3Outposts Endpoint
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the S3Outposts Endpoint |
fn sync()
Sync S3Outposts Endpoint state from AWS
fn list(maxPages?: number, resourceModel?: string)
List S3Outposts Endpoint 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)— S3Outposts Endpoint resource state
03Previous Versions
2026.10.24.1AGPL-3.0-or-later
2026.10.23.1AGPL-3.0-or-later(was none)
- Updated: access_point, bucket, bucket_policy, endpoint
2026.10.13.1
- Updated: access_point, bucket, bucket_policy, 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.21.1
2026.09.20.1
04Stats
A
100 / 100
Downloads
116
Archive size
824.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