Aws/s3
@swamp/aws/s3v2026.08.22.1
01README
AWS S3 infrastructure models
02Models
@swamp/aws/s3/access-grantv2026.08.17.2access_grant.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. |
| AccessGrantsLocationId | string | The custom S3 location to be accessed by the grantee |
| Tags? | array | |
| Permission | enum | The level of access to be afforded to the grantee |
| ApplicationArn? | string | The ARN of the application grantees will use to access the location |
| S3PrefixType? | enum | The type of S3SubPrefix. |
| Grantee | object | The principal who will be granted permission to access S3. |
| AccessGrantsLocationConfiguration? | object | The configuration options of the grant location, which is the S3 path to the data to which you are granting access. |
fn create()
Create a S3 AccessGrant
fn get(identifier: string)
Get a S3 AccessGrant
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the S3 AccessGrant |
fn update()
Update a S3 AccessGrant
fn delete(identifier: string)
Delete a S3 AccessGrant
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the S3 AccessGrant |
fn sync()
Sync S3 AccessGrant state from AWS
fn list(maxPages?: number, resourceModel?: string)
List S3 AccessGrant 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)— S3 AccessGrant resource state
@swamp/aws/s3/access-grants-instancev2026.08.17.2access_grants_instance.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. |
| IdentityCenterArn? | string | The Amazon Resource Name (ARN) of the specified AWS Identity Center. |
| Tags? | array |
fn create()
Create a S3 AccessGrantsInstance
fn get(identifier: string)
Get a S3 AccessGrantsInstance
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the S3 AccessGrantsInstance |
fn update()
Update a S3 AccessGrantsInstance
fn delete(identifier: string)
Delete a S3 AccessGrantsInstance
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the S3 AccessGrantsInstance |
fn sync()
Sync S3 AccessGrantsInstance state from AWS
fn list(maxPages?: number, resourceModel?: string)
List S3 AccessGrantsInstance 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)— S3 AccessGrantsInstance resource state
@swamp/aws/s3/access-grants-locationv2026.08.17.2access_grants_location.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. |
| IamRoleArn | string | The Amazon Resource Name (ARN) of the access grant location's associated IAM role. |
| LocationScope | string | Descriptor for where the location actually points |
| Tags? | array |
fn create()
Create a S3 AccessGrantsLocation
fn get(identifier: string)
Get a S3 AccessGrantsLocation
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the S3 AccessGrantsLocation |
fn update()
Update a S3 AccessGrantsLocation
fn delete(identifier: string)
Delete a S3 AccessGrantsLocation
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the S3 AccessGrantsLocation |
fn sync()
Sync S3 AccessGrantsLocation state from AWS
fn list(maxPages?: number, resourceModel?: string)
List S3 AccessGrantsLocation 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)— S3 AccessGrantsLocation resource state
@swamp/aws/s3/access-pointv2026.08.17.2access_point.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. |
| Name? | string | The 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. |
| Bucket | string | The name of the bucket that you want to associate this Access Point with. |
| BucketAccountId? | string | The AWS account ID associated with the S3 bucket associated with this access point. |
| VpcConfiguration? | object | If you include this field, Amazon S3 restricts access to this Access Point to requests from the specified Virtual Private Cloud (VPC). |
| PublicAccessBlockConfiguration? | object | The PublicAccessBlock configuration that you want to apply to this Access Point. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status 'The Meaning of Public' in the Amazon Simple Storage Service Developer Guide. |
| Policy? | record | The Access Point Policy you want to apply to this access point. |
| Tags? | array | An arbitrary set of tags (key-value pairs) for this S3 Access Point. |
fn create()
Create a S3 AccessPoint
fn get(identifier: string)
Get a S3 AccessPoint
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the S3 AccessPoint |
fn update()
Update a S3 AccessPoint
fn delete(identifier: string)
Delete a S3 AccessPoint
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the S3 AccessPoint |
fn sync()
Sync S3 AccessPoint state from AWS
fn list(maxPages?: number, resourceModel?: string)
List S3 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)— S3 AccessPoint resource state
@swamp/aws/s3/bucketv2026.08.17.2bucket.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. |
| BucketNamespace? | enum | |
| InventoryConfigurations? | array | Specifies the S3 Inventory configuration for an Amazon S3 bucket. For more information, see [GET Bucket inventory](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETInventoryConfig.html) in the *Amazon S3 API Reference*. |
| BucketNamePrefix? | string | |
| WebsiteConfiguration? | object | Information used to configure the bucket as a static website. For more information, see [Hosting Websites on Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html). |
| AccessControl? | enum | This is a legacy property, and it is not recommended for most use cases. A majority of modern use cases in Amazon S3 no longer require the use of ACLs, and we recommend that you keep ACLs disabled. For more information, see [Controlling object ownership](https://docs.aws.amazon.com//AmazonS3/latest/userguide/about-object-ownership.html) in the *Amazon S3 User Guide*. A canned access control list (ACL) that grants predefined permissions to the bucket. For more information about canned ACLs, see [ |
| MetadataTableConfiguration? | object | The metadata table configuration of an S3 general purpose bucket. |
| AnalyticsConfigurations? | array | Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket. |
| AbacStatus? | enum | The ABAC status of the general purpose bucket. When ABAC is enabled for the general purpose bucket, you can use tags to manage access to the general purpose buckets as well as for cost tracking purposes. When ABAC is disabled for the general purpose buckets, you can only use tags for cost tracking purposes. For more information, see [Using tags with S3 general purpose buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/buckets-tagging.html). |
| AccelerateConfiguration? | object | Configures the transfer acceleration state for an Amazon S3 bucket. For more information, see [Amazon S3 Transfer Acceleration](https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html) in the *Amazon S3 User Guide*. |
| PublicAccessBlockConfiguration? | object | Configuration that defines how Amazon S3 handles public access. |
| BucketName? | string | A name for the bucket. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the bucket name. The bucket name must contain only lowercase letters, numbers, periods (.), and dashes (-) and must follow [Amazon S3 bucket restrictions and limitations](https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html). For more information, see [Rules for naming Amazon S3 buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html) |
| OwnershipControls? | object | Configuration that defines how Amazon S3 handles Object Ownership rules. |
| ObjectLockConfiguration? | object | This operation is not supported for directory buckets. Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see [Locking Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). The DefaultRetention settings require both a mode and a period. The DefaultRetention period can be either Days or Years but you must select on |
| ObjectLockEnabled? | boolean | Indicates whether this bucket has an Object Lock configuration enabled. Enable ObjectLockEnabled when you apply ObjectLockConfiguration to a bucket. |
| LoggingConfiguration? | object | Settings that define where logs are stored. |
| MetadataConfiguration? | object | The S3 Metadata configuration for a general purpose bucket. |
| ReplicationConfiguration? | object | Configuration for replicating objects in an S3 bucket. To enable replication, you must also enable versioning by using the VersioningConfiguration property. Amazon S3 can store replicated objects in a single destination bucket or multiple destination buckets. The destination bucket or buckets must already exist. |
| Tags? | array | An arbitrary set of tags (key-value pairs) for this S3 bucket. |
| BucketEncryption? | object | Specifies default encryption for a bucket using server-side encryption with Amazon S3-managed keys (SSE-S3), AWS KMS-managed keys (SSE-KMS), or dual-layer server-side encryption with KMS-managed keys (DSSE-KMS). For information about the Amazon S3 default encryption feature, see [Amazon S3 Default Encryption for S3 Buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html) in the *Amazon S3 User Guide*. |
| NotificationConfiguration? | object | Configuration that defines how Amazon S3 handles bucket notifications. |
| LifecycleConfiguration? | object | Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see [Object Lifecycle Management](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) in the *Amazon S3 User Guide*. |
| VersioningConfiguration? | object | Enables multiple versions of all objects in this bucket. You might enable versioning to prevent objects from being deleted or overwritten by mistake or to archive objects so that you can retrieve previous versions of them. When you enable versioning on a bucket for the first time, it might take a short amount of time for the change to be fully propagated. We recommend that you wait for 15 minutes after enabling versioning before issuing write operations ( PUT or DELETE) on objects in the bucket. |
| MetricsConfigurations? | array | Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. For more information, see [PutBucketMetricsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTMetricConfiguration.html). |
| IntelligentTieringConfigurations? | array | Defines how Amazon S3 handles Intelligent-Tiering storage. |
| CorsConfiguration? | object | Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see [Enabling Cross-Origin Resource Sharing](https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) in the *Amazon S3 User Guide*. |
fn create()
Create a S3 Bucket
fn get(identifier: string)
Get a S3 Bucket
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the S3 Bucket |
fn update()
Update a S3 Bucket
fn delete(identifier: string)
Delete a S3 Bucket
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the S3 Bucket |
fn sync()
Sync S3 Bucket state from AWS
fn list(maxPages?: number, resourceModel?: string)
List S3 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)— S3 Bucket resource state
@swamp/aws/s3/bucket-policyv2026.08.17.2bucket_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 name of the Amazon S3 bucket to which the policy applies. |
| PolicyDocument | record | A 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. For more information, see the AWS::IAM::Policy [PolicyDocument](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html#cfn-iam-policy-policydocument) resource description in this gu |
fn create()
Create a S3 BucketPolicy
fn get(identifier: string)
Get a S3 BucketPolicy
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the S3 BucketPolicy |
fn update()
Update a S3 BucketPolicy
fn delete(identifier: string)
Delete a S3 BucketPolicy
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the S3 BucketPolicy |
fn sync()
Sync S3 BucketPolicy state from AWS
fn list(maxPages?: number, resourceModel?: string)
List S3 BucketPolicy 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)— S3 BucketPolicy resource state
@swamp/aws/s3/multi-region-access-pointv2026.08.17.2multi_region_access_point.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. |
| PublicAccessBlockConfiguration? | object | The PublicAccessBlock configuration that you want to apply to this Multi Region Access Point. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status 'The Meaning of Public' in the Amazon Simple Storage Service Developer Guide. |
| Regions | array | The list of buckets that you want to associate this Multi Region Access Point with. |
| Name? | string | The name you want to assign to this Multi Region Access Point. |
fn create()
Create a S3 MultiRegionAccessPoint
fn get(identifier: string)
Get a S3 MultiRegionAccessPoint
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the S3 MultiRegionAccessPoint |
fn delete(identifier: string)
Delete a S3 MultiRegionAccessPoint
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the S3 MultiRegionAccessPoint |
fn sync()
Sync S3 MultiRegionAccessPoint state from AWS
fn list(maxPages?: number, resourceModel?: string)
List S3 MultiRegionAccessPoint 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)— S3 MultiRegionAccessPoint resource state
@swamp/aws/s3/multi-region-access-point-policyv2026.08.17.2multi_region_access_point_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. |
| MrapName | string | The name of the Multi Region Access Point to apply policy |
| Policy | record | Policy document to apply to a Multi Region Access Point |
fn create()
Create a S3 MultiRegionAccessPointPolicy
fn get(identifier: string)
Get a S3 MultiRegionAccessPointPolicy
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the S3 MultiRegionAccessPointPolicy |
fn update()
Update a S3 MultiRegionAccessPointPolicy
fn delete(identifier: string)
Delete a S3 MultiRegionAccessPointPolicy
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the S3 MultiRegionAccessPointPolicy |
fn sync()
Sync S3 MultiRegionAccessPointPolicy state from AWS
fn list(maxPages?: number, resourceModel?: string)
List S3 MultiRegionAccessPointPolicy 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)— S3 MultiRegionAccessPointPolicy resource state
@swamp/aws/s3/storage-lensv2026.08.17.2storage_lens.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. |
| StorageLensConfiguration | object | Specifies the details of Amazon S3 Storage Lens configuration. |
| Tags? | array | A set of tags (key-value pairs) for this Amazon S3 Storage Lens configuration. |
fn create()
Create a S3 StorageLens
fn get(identifier: string)
Get a S3 StorageLens
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the S3 StorageLens |
fn update()
Update a S3 StorageLens
fn delete(identifier: string)
Delete a S3 StorageLens
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the S3 StorageLens |
fn sync()
Sync S3 StorageLens state from AWS
fn list(maxPages?: number, resourceModel?: string)
List S3 StorageLens 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)— S3 StorageLens resource state
@swamp/aws/s3/storage-lens-groupv2026.08.17.2storage_lens_group.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. |
| Name | string | The name that identifies the Amazon S3 Storage Lens Group. |
| Filter | object | Sets the Storage Lens Group filter. |
| Tags? | array | A set of tags (key-value pairs) for this Amazon S3 Storage Lens Group. |
fn create()
Create a S3 StorageLensGroup
fn get(identifier: string)
Get a S3 StorageLensGroup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the S3 StorageLensGroup |
fn update()
Update a S3 StorageLensGroup
fn delete(identifier: string)
Delete a S3 StorageLensGroup
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the S3 StorageLensGroup |
fn sync()
Sync S3 StorageLensGroup state from AWS
fn list(maxPages?: number, resourceModel?: string)
List S3 StorageLensGroup 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)— S3 StorageLensGroup resource state
03Previous Versions
2026.08.21.1
2026.08.20.1
2026.08.19.1
2026.08.18.1
2026.08.17.6
2026.08.17.5
Modified 10 models
2026.08.16.1
2026.08.15.1
2026.08.14.1
2026.08.11.1
2026.08.07.1
2026.08.06.1
2026.08.05.1
2026.08.04.1
2026.08.03.1
2026.08.02.1
2026.08.01.1
2026.07.31.1
2026.07.30.1
04Stats
A
100 / 100
Downloads
844
Archive size
2.3 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
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
05Platforms
06Labels