Skip to main content
← back to extensions

@swamp/aws/s3express

v2026.04.24.1

AWS S3EXPRESS infrastructure models

Repository

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

Platforms

linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64

Labels

awss3expresscloudinfrastructure

Contents

models

Quality score

Verified by Swamp

How well-documented and verifiable this extension is.

100%

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/s3express

Release Notes

  • Updated: directory_bucket

@swamp/aws/s3express/access-pointv2026.04.23.2access_point.ts

Global Arguments

ArgumentTypeDescription
Name?stringThe name you want to assign to this Access Point. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the access point name. For directory buckets, the access point name must consist of a base name that you provide and suffix that includes the ZoneID (AWS Availability Zone or Local Zone) of your bucket location, followed by --xa-s3.
BucketstringThe name of the bucket that you want to associate this Access Point with.
BucketAccountId?stringThe AWS account ID associated with the S3 bucket associated with this access point.
VpcConfiguration?objectIf you include this field, Amazon S3 restricts access to this Access Point to requests from the specified Virtual Private Cloud (VPC).
PublicAccessBlockConfiguration?objectThe PublicAccessBlock configuration that you want to apply to this Access Point.
Scope?objectFor directory buckets, you can filter access control to specific prefixes, API operations, or a combination of both.
Policy?stringThe Access Point Policy you want to apply to this access point.
Tags?array
createCreate a S3Express AccessPoint
getGet a S3Express AccessPoint
ArgumentTypeDescription
identifierstringThe primary identifier of the S3Express AccessPoint
updateUpdate a S3Express AccessPoint
deleteDelete a S3Express AccessPoint
ArgumentTypeDescription
identifierstringThe primary identifier of the S3Express AccessPoint
syncSync S3Express AccessPoint state from AWS

Resources

state(infinite)— S3Express AccessPoint resource state
@swamp/aws/s3express/bucket-policyv2026.04.23.2bucket_policy.ts

Global Arguments

ArgumentTypeDescription
BucketstringThe name of the S3 directory bucket to which the policy applies.
PolicyDocumentstringA policy document containing permissions to add to the specified bucket. In IAM, you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM.
createCreate a S3Express BucketPolicy
getGet a S3Express BucketPolicy
ArgumentTypeDescription
identifierstringThe primary identifier of the S3Express BucketPolicy
updateUpdate a S3Express BucketPolicy
deleteDelete a S3Express BucketPolicy
ArgumentTypeDescription
identifierstringThe primary identifier of the S3Express BucketPolicy
syncSync S3Express BucketPolicy state from AWS

Resources

state(infinite)— S3Express BucketPolicy resource state
@swamp/aws/s3express/directory-bucketv2026.04.24.1directory_bucket.ts

Global Arguments

ArgumentTypeDescription
BucketName?stringSpecifies a name for the bucket. The bucket name must contain only lowercase letters, numbers, and hyphens (-). A directory bucket name must be unique in the chosen Availability Zone or Local Zone. The bucket name must also follow the format 'bucket_base_name--zone_id--x-s3'. The zone_id can be the ID of an Availability Zone or a Local Zone. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name.
LocationNamestringSpecifies the Zone ID of the Availability Zone or Local Zone where the directory bucket will be created. An example Availability Zone ID value is 'use1-az5'.
DataRedundancyenumSpecifies the number of Availability Zone or Local Zone that's used for redundancy for the bucket.
BucketEncryption?objectSpecifies default encryption for a bucket using server-side encryption with Amazon S3 managed keys (SSE-S3) or AWS KMS keys (SSE-KMS).
LifecycleConfiguration?objectLifecycle rules that define how Amazon S3 Express manages objects during their lifetime.
Tags?array
MetricsConfigurations?arraySpecifies the metrics configurations for the Amazon S3 Express bucket.
InventoryConfigurations?arrayThe inventory configuration for an Amazon S3 Express bucket.
createCreate a S3Express DirectoryBucket
getGet a S3Express DirectoryBucket
ArgumentTypeDescription
identifierstringThe primary identifier of the S3Express DirectoryBucket
updateUpdate a S3Express DirectoryBucket
deleteDelete a S3Express DirectoryBucket
ArgumentTypeDescription
identifierstringThe primary identifier of the S3Express DirectoryBucket
syncSync S3Express DirectoryBucket state from AWS

Resources

state(infinite)— S3Express DirectoryBucket resource state