Aws/storagegateway
@swamp/aws/storagegatewayv2026.10.25.1
01README
AWS STORAGEGATEWAY infrastructure models
02Behaviors
nfsfile_share.tsv2026.10.23.1
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. |
| GatewayARN | string | The ARN of the S3 File Gateway that hosts the share. |
| Role | string | The ARN of the IAM role the gateway assumes when it accesses the S3 location. |
| LocationARN | string | The ARN of the S3 bucket, or bucket prefix, the share exposes. |
| BucketRegion? | string | The Region of the S3 bucket, required when the bucket is reached through a VPC endpoint. |
| VPCEndpointDNSName? | string | The DNS name of the S3 VPC endpoint the gateway uses to reach the bucket. |
| EncryptionType? | enum | The server-side encryption the gateway applies to objects it writes. |
| KMSEncrypted? | boolean | Deprecated by the service in favour of EncryptionType; true selects KMS encryption. Retained because it remains readable and settable. |
| KMSKey? | string | The KMS key used for encryption, when EncryptionType selects KMS. Removing this property from a template leaves the share's current value: the service documents no value that resets it. |
| DefaultStorageClass? | string | The S3 storage class for new objects. The service accepts S3_STANDARD, S3_INTELLIGENT_TIERING, S3_STANDARD_IA and S3_ONEZONE_IA; it is a length-bounded string in the API model rather than an enumeration. |
| ObjectACL? | enum | The canned S3 ACL applied to objects the gateway writes. |
| ReadOnly? | boolean | Whether clients may write to the share. |
| GuessMIMETypeEnabled? | boolean | Whether the gateway infers the MIME type of uploaded objects from their extension. |
| RequesterPays? | boolean | Whether the bucket is a Requester Pays bucket. |
| FileShareName? | string | The name of the file share, which defaults to the bucket name when omitted. Removing this property from a template leaves the share's current value: the service documents no value that resets it. |
| CacheAttributes? | object | How long the directory contents cached by the gateway are considered valid. |
| NotificationPolicy? | string | The upload-notification settling period, as a JSON document. |
| AuditDestinationARN? | string | The ARN of the CloudWatch log group that receives the share's audit logs. Removing this property from a template detaches audit logging: the update sends the empty string, which the service treats as the reset. |
| Tags? | array | Tags assigned to the file share. |
| NFSFileShareDefaults? | object | The Unix file mode in the form nnnn. |
| ClientList? | array | The IPv4 or IPv6 addresses and CIDR blocks permitted to mount the NFS share. Removing this property from a template leaves the share's current value: the service documents no value that resets it. |
| Squash? | string | How the NFS share maps client user IDs. The service accepts RootSquash, NoSquash and AllSquash; it is a length-bounded string in the API model rather than an enumeration. |
fn create()
Create a StorageGateway NFSFileShare
fn get(identifier: string)
Get a StorageGateway NFSFileShare
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the StorageGateway NFSFileShare |
fn update()
Update a StorageGateway NFSFileShare
fn delete(identifier: string)
Delete a StorageGateway NFSFileShare
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the StorageGateway NFSFileShare |
fn sync()
Sync StorageGateway NFSFileShare state from AWS
fn list(maxPages?: number, resourceModel?: string)
List StorageGateway NFSFileShare 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)— StorageGateway NFSFileShare resource state
smbfile_share.tsv2026.10.23.1
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. |
| GatewayARN | string | The ARN of the S3 File Gateway that hosts the share. |
| Role | string | The ARN of the IAM role the gateway assumes when it accesses the S3 location. |
| LocationARN | string | The ARN of the S3 bucket, or bucket prefix, the share exposes. |
| BucketRegion? | string | The Region of the S3 bucket, required when the bucket is reached through a VPC endpoint. |
| VPCEndpointDNSName? | string | The DNS name of the S3 VPC endpoint the gateway uses to reach the bucket. |
| EncryptionType? | enum | The server-side encryption the gateway applies to objects it writes. |
| KMSEncrypted? | boolean | Deprecated by the service in favour of EncryptionType; true selects KMS encryption. Retained because it remains readable and settable. |
| KMSKey? | string | The KMS key used for encryption, when EncryptionType selects KMS. Removing this property from a template leaves the share's current value: the service documents no value that resets it. |
| DefaultStorageClass? | string | The S3 storage class for new objects. The service accepts S3_STANDARD, S3_INTELLIGENT_TIERING, S3_STANDARD_IA and S3_ONEZONE_IA; it is a length-bounded string in the API model rather than an enumeration. |
| ObjectACL? | enum | The canned S3 ACL applied to objects the gateway writes. |
| ReadOnly? | boolean | Whether clients may write to the share. |
| GuessMIMETypeEnabled? | boolean | Whether the gateway infers the MIME type of uploaded objects from their extension. |
| RequesterPays? | boolean | Whether the bucket is a Requester Pays bucket. |
| FileShareName? | string | The name of the file share, which defaults to the bucket name when omitted. Removing this property from a template leaves the share's current value: the service documents no value that resets it. |
| CacheAttributes? | object | How long the directory contents cached by the gateway are considered valid. |
| NotificationPolicy? | string | The upload-notification settling period, as a JSON document. |
| AuditDestinationARN? | string | The ARN of the CloudWatch log group that receives the share's audit logs. Removing this property from a template detaches audit logging: the update sends the empty string, which the service treats as the reset. |
| Tags? | array | Tags assigned to the file share. |
| SMBACLEnabled? | boolean | Whether the SMB share uses Windows ACLs rather than POSIX permissions. |
| AccessBasedEnumeration? | boolean | Whether clients see only the files and folders they may access. |
| AdminUserList? | array | Users and groups granted administrative privileges on the SMB share. |
| ValidUserList? | array | Users and groups permitted to access the SMB share. |
| InvalidUserList? | array | Users and groups denied access to the SMB share. |
| Authentication? | string | The authentication the SMB share uses. The service accepts ActiveDirectory and GuestAccess; it is a length-bounded string in the API model rather than an enumeration. |
| CaseSensitivity? | enum | Whether the SMB share is case sensitive or defers to the client. |
| OplocksEnabled? | boolean | Whether the SMB share grants opportunistic locks. Removing this property from a template leaves the live value unchanged rather than restoring the created default, because that default depends on the gateway's software version -- opportunistic locking is enabled by default only on appliances at 1.19.0.0 or above -- and the version is not part of this resource. Set the value explicitly rather than relying on removal. |
fn create()
Create a StorageGateway SMBFileShare
fn get(identifier: string)
Get a StorageGateway SMBFileShare
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the StorageGateway SMBFileShare |
fn update()
Update a StorageGateway SMBFileShare
fn delete(identifier: string)
Delete a StorageGateway SMBFileShare
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the StorageGateway SMBFileShare |
fn sync()
Sync StorageGateway SMBFileShare state from AWS
fn list(maxPages?: number, resourceModel?: string)
List StorageGateway SMBFileShare 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)— StorageGateway SMBFileShare resource state
tape.tsv2026.10.23.1
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. |
| GatewayARN | string | The Amazon Resource Name (ARN) of the Tape Gateway that hosts the virtual tape. |
| TapeBarcode? | string | The barcode that you want to assign to the virtual tape. Barcodes cannot be reused, even after a tape is deleted. |
| TapeSizeInBytes | number | The size, in bytes, of the virtual tape that you want to create. |
| KMSEncrypted? | boolean | Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional. |
| KMSKey? | string | The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. This value must be set if KMSEncrypted is true. |
| PoolId? | string | The ID of the pool that you want to add your tape to for archiving. Tapes in this pool are archived in the S3 storage class that is associated with the pool. |
| Worm? | boolean | Set to true to create a write-once-read-many (WORM) virtual tape. |
| Tags? | array | A list of up to 50 tags to assign to the virtual tape. |
fn create()
Create a StorageGateway Tape
fn get(identifier: string)
Get a StorageGateway Tape
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the StorageGateway Tape |
fn update()
Update a StorageGateway Tape
fn delete(identifier: string)
Delete a StorageGateway Tape
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the StorageGateway Tape |
fn sync()
Sync StorageGateway Tape state from AWS
fn list(maxPages?: number, resourceModel?: string)
List StorageGateway Tape 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)— StorageGateway Tape resource state
tape_pool.tsv2026.10.23.1
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. |
| PoolName | string | The name of the custom tape pool. |
| StorageClass | enum | The storage class associated with the custom pool (S3 Glacier or S3 Glacier Deep Archive). |
| RetentionLockType? | enum | Tape retention lock type. Governance mode allows authorized removal; compliance mode prevents all removal. |
| RetentionLockTimeInDays? | number | Tape retention lock time in days (up to 36,500 days / 100 years). |
| Tags? | array | A list of up to 50 tags for the tape pool. |
fn create()
Create a StorageGateway TapePool
fn get(identifier: string)
Get a StorageGateway TapePool
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the StorageGateway TapePool |
fn update()
Update a StorageGateway TapePool
fn delete(identifier: string)
Delete a StorageGateway TapePool
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the StorageGateway TapePool |
fn sync()
Sync StorageGateway TapePool state from AWS
fn list(maxPages?: number, resourceModel?: string)
List StorageGateway TapePool 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)— StorageGateway TapePool resource state
volume.tsv2026.10.23.1
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. |
| GatewayARN | string | The Amazon Resource Name (ARN) of the gateway on which to create the volume. |
| TargetName | string | The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. |
| NetworkInterfaceId | string | The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. |
| VolumeSizeInBytes | number | The size of the volume in bytes. |
| SnapshotId? | string | The snapshot ID of the snapshot to restore as the new cached volume (e.g., snap-1122aabb). |
| SourceVolumeARN? | string | The ARN of an existing volume from which to create the new volume. |
| KMSEncrypted? | boolean | Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3. |
| KMSKey? | string | The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. |
| Tags? | array | A list of up to 50 tags to assign to the volume. |
fn create()
Create a StorageGateway Volume
fn get(identifier: string)
Get a StorageGateway Volume
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the StorageGateway Volume |
fn update()
Update a StorageGateway Volume
fn delete(identifier: string)
Delete a StorageGateway Volume
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the StorageGateway Volume |
fn sync()
Sync StorageGateway Volume state from AWS
fn list(maxPages?: number, resourceModel?: string)
List StorageGateway Volume 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)— StorageGateway Volume resource state
03Previous Versions
2026.10.24.1AGPL-3.0-or-later
2026.10.23.1AGPL-3.0-or-later
- Updated: nfsfile_share, smbfile_share, tape, tape_pool, volume
2026.10.15.1AGPL-3.0-or-later(was none)
- Added: nfsfile_share, smbfile_share
Added 1, removed 3 behaviors
2026.10.13.1
- Updated: tape, tape_pool, volume
2026.10.08.1
2026.10.06.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
- Added: volume
Added 1 behaviors
2026.09.21.1
2026.09.20.1
04Stats
A
100 / 100
Downloads
93
Archive size
1.0 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
- 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