storagegateway_create_tape_pool: Creates a new custom tape pool

Description Usage Arguments Value Request syntax

View source: R/storagegateway_operations.R

Description

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.

Usage

1
2
storagegateway_create_tape_pool(PoolName, StorageClass,
  RetentionLockType, RetentionLockTimeInDays, Tags)

Arguments

PoolName

[required] The name of the new custom tape pool.

StorageClass

[required] 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.

RetentionLockType

Tape retention lock can be configured in two modes. When configured in governance mode, AWS 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 AWS account.

RetentionLockTimeInDays

Tape retention lock time is set in days. Tape retention lock can be enabled for up to 100 years (36,500 days).

Tags

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

A list with the following syntax:

1
2
3
list(
  PoolARN = "string"
)

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
svc$create_tape_pool(
  PoolName = "string",
  StorageClass = "DEEP_ARCHIVE"|"GLACIER",
  RetentionLockType = "COMPLIANCE"|"GOVERNANCE"|"NONE",
  RetentionLockTimeInDays = 123,
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)

paws.storage documentation built on March 7, 2021, 5:07 p.m.