upload_buffers
Creates, updates, deletes, gets or lists a upload_buffers resource.
Overview
| Name | upload_buffers |
| Type | Resource |
| Id | aws.storagegateway.upload_buffers |
Fields
The following fields are returned by SELECT queries:
- describe_upload_buffer
| Name | Datatype | Description |
|---|---|---|
disk_ids | array | An array of the gateway's local disk IDs that are configured as working storage. Each local disk ID is specified as a string (minimum length of 1 and maximum length of 300). If no local disks are configured as working storage, then the DiskIds array is empty. |
gateway_arn | string | The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region. |
upload_buffer_allocated_in_bytes | integer (int64) | The total number of bytes allocated in the gateway's as upload buffer. |
upload_buffer_used_in_bytes | integer (int64) | The total number of bytes being used in the gateway's upload buffer. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_upload_buffer | select | region | Returns information about the upload buffer of a gateway. This operation is supported for the stored volume, cached volume, and tape gateway types. The response includes disk IDs that are configured as upload buffer space, and it includes the amount of upload buffer space allocated and used. | |
add_upload_buffer | update | region, GatewayARN, DiskIds | Configures one or more gateway local disks as upload buffer for a specified gateway. This operation is supported for the stored volume, cached volume, and tape gateway types. In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add upload buffer, and one or more disk IDs that you want to configure as upload buffer. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- describe_upload_buffer
Returns information about the upload buffer of a gateway. This operation is supported for the stored volume, cached volume, and tape gateway types. The response includes disk IDs that are configured as upload buffer space, and it includes the amount of upload buffer space allocated and used.
SELECT
disk_ids,
gateway_arn,
upload_buffer_allocated_in_bytes,
upload_buffer_used_in_bytes
FROM aws.storagegateway.upload_buffers
WHERE region = '{{ region }}' -- required
;
UPDATE examples
- add_upload_buffer
Configures one or more gateway local disks as upload buffer for a specified gateway. This operation is supported for the stored volume, cached volume, and tape gateway types. In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add upload buffer, and one or more disk IDs that you want to configure as upload buffer.
UPDATE aws.storagegateway.upload_buffers
SET
GatewayARN = '{{ GatewayARN }}',
DiskIds = '{{ DiskIds }}'
WHERE
region = '{{ region }}' --required
AND GatewayARN = '{{ GatewayARN }}' --required
AND DiskIds = '{{ DiskIds }}' --required
RETURNING
gateway_arn;