tape_pools

Creates, updates, deletes, gets or lists a tape_pools resource.

Overview

Name	`tape_pools`
Type	Resource
Id	`aws.storagegateway.tape_pools`

Fields

The following fields are returned by SELECT queries:

list_tape_pools

Name	Datatype	Description
`pool_arn`	`string`	The Amazon Resource Name (ARN) of the custom tape pool. Use the ListTapePools operation to return a list of custom tape pools for your account and Amazon Web Services Region.
`pool_name`	`string`	The name of the custom tape pool. PoolName can use all ASCII characters, except '/' and ''. (pattern: <code>^[ -.0-[]-~~][!-.0-[]-~~][ -.0-[]-~]$</code>)
`pool_status`	`string`	Status of the custom tape pool. Pool can be ACTIVE or DELETED. (ACTIVE, DELETED)
`retention_lock_time_in_days`	`integer`	Tape retention lock time is set in days. Tape retention lock can be enabled for up to 100 years (36,500 days).
`retention_lock_type`	`string`	Tape retention lock type, which can be configured in two modes. When configured in governance mode, Amazon Web Services accounts with specific IAM permissions are authorized to remove the tape retention lock from archived virtual tapes. When configured in compliance mode, the tape retention lock cannot be removed by any user, including the root Amazon Web Services account. (COMPLIANCE, GOVERNANCE, NONE)
`storage_class`	`string`	The storage class that is associated with the custom pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool. (DEEP_ARCHIVE, GLACIER)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Description
`list_tape_pools`	`select`	`region`	Lists custom tape pools. You specify custom tape pools to list by specifying one or more custom tape pool Amazon Resource Names (ARNs). If you don't specify a custom tape pool ARN, the operation lists all custom tape pools. This operation supports pagination. You can optionally specify the Limit parameter in the body to limit the number of tape pools in the response. If the number of tape pools returned in the response is truncated, the response includes a Marker element that you can use in your subsequent request to retrieve the next set of tape pools.
`create_tape_pool`	`insert`	`region`, `PoolName`, `StorageClass`	Creates a new custom tape pool. You can use custom tape pool to enable tape retention lock on tapes that are archived in the custom pool.
`assign_tape_pool`	`update`	`region`, `TapeARN`, `PoolId`	Assigns a tape to a tape pool for archiving. The tape assigned to a pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the S3 storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
`delete_tape_pool`	`delete`	`region`	Delete a custom tape pool. A custom tape pool can only be deleted if there are no tapes in the pool and if there are no automatic tape creation policies that reference the custom tape pool.

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

list_tape_pools

Lists custom tape pools. You specify custom tape pools to list by specifying one or more custom tape pool Amazon Resource Names (ARNs). If you don't specify a custom tape pool ARN, the operation lists all custom tape pools. This operation supports pagination. You can optionally specify the Limit parameter in the body to limit the number of tape pools in the response. If the number of tape pools returned in the response is truncated, the response includes a Marker element that you can use in your subsequent request to retrieve the next set of tape pools.

SELECT
pool_arn,
pool_name,
pool_status,
retention_lock_time_in_days,
retention_lock_type,
storage_class
FROM aws.storagegateway.tape_pools
WHERE region = '{{ region }}' -- required
;

`INSERT` examples

create_tape_pool
Manifest

Creates a new custom tape pool. You can use custom tape pool to enable tape retention lock on tapes that are archived in the custom pool.

INSERT INTO aws.storagegateway.tape_pools (
PoolName,
StorageClass,
RetentionLockType,
RetentionLockTimeInDays,
Tags,
region
)
SELECT 
'{{ PoolName }}' /* required */,
'{{ StorageClass }}' /* required */,
'{{ RetentionLockType }}',
{{ RetentionLockTimeInDays }},
'{{ Tags }}',
'{{ region }}'
RETURNING
pool_arn
;

# Description fields are for documentation purposes
- name: tape_pools
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the tape_pools resource.
  - name: PoolName
    value: "{{ PoolName }}"
    description: |
      The name of the new custom tape pool.
  - name: StorageClass
    value: "{{ StorageClass }}"
    description: |
      The storage class that is associated with the new custom pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
    valid_values: ['DEEP_ARCHIVE', 'GLACIER']
  - name: RetentionLockType
    value: "{{ RetentionLockType }}"
    description: |
      Tape retention lock can be configured in two modes. When configured in governance mode, Amazon Web Services accounts with specific IAM permissions are authorized to remove the tape retention lock from archived virtual tapes. When configured in compliance mode, the tape retention lock cannot be removed by any user, including the root Amazon Web Services account.
    valid_values: ['COMPLIANCE', 'GOVERNANCE', 'NONE']
  - name: RetentionLockTimeInDays
    value: {{ RetentionLockTimeInDays }}
    description: |
      Tape retention lock time is set in days. Tape retention lock can be enabled for up to 100 years (36,500 days).
  - name: Tags
    description: |
      A list of up to 50 tags that can be assigned to tape pool. Each tag is a key-value pair. Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

`UPDATE` examples

assign_tape_pool

Assigns a tape to a tape pool for archiving. The tape assigned to a pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the S3 storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

UPDATE aws.storagegateway.tape_pools
SET 
TapeARN = '{{ TapeARN }}',
PoolId = '{{ PoolId }}',
BypassGovernanceRetention = {{ BypassGovernanceRetention }}
WHERE 
region = '{{ region }}' --required
AND TapeARN = '{{ TapeARN }}' --required
AND PoolId = '{{ PoolId }}' --required
RETURNING
tape_arn;

`DELETE` examples

delete_tape_pool

Delete a custom tape pool. A custom tape pool can only be deleted if there are no tapes in the pool and if there are no automatic tape creation policies that reference the custom tape pool.

DELETE FROM aws.storagegateway.tape_pools
WHERE region = '{{ region }}' --required
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​