AWS SDK for C++  1.9.68
AWS SDK for C++
Public Member Functions | List of all members
Aws::StorageGateway::Model::PoolInfo Class Reference

#include <PoolInfo.h>

Public Member Functions

 PoolInfo ()
 
 PoolInfo (Aws::Utils::Json::JsonView jsonValue)
 
PoolInfooperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetPoolARN () const
 
bool PoolARNHasBeenSet () const
 
void SetPoolARN (const Aws::String &value)
 
void SetPoolARN (Aws::String &&value)
 
void SetPoolARN (const char *value)
 
PoolInfoWithPoolARN (const Aws::String &value)
 
PoolInfoWithPoolARN (Aws::String &&value)
 
PoolInfoWithPoolARN (const char *value)
 
const Aws::StringGetPoolName () const
 
bool PoolNameHasBeenSet () const
 
void SetPoolName (const Aws::String &value)
 
void SetPoolName (Aws::String &&value)
 
void SetPoolName (const char *value)
 
PoolInfoWithPoolName (const Aws::String &value)
 
PoolInfoWithPoolName (Aws::String &&value)
 
PoolInfoWithPoolName (const char *value)
 
const TapeStorageClassGetStorageClass () const
 
bool StorageClassHasBeenSet () const
 
void SetStorageClass (const TapeStorageClass &value)
 
void SetStorageClass (TapeStorageClass &&value)
 
PoolInfoWithStorageClass (const TapeStorageClass &value)
 
PoolInfoWithStorageClass (TapeStorageClass &&value)
 
const RetentionLockTypeGetRetentionLockType () const
 
bool RetentionLockTypeHasBeenSet () const
 
void SetRetentionLockType (const RetentionLockType &value)
 
void SetRetentionLockType (RetentionLockType &&value)
 
PoolInfoWithRetentionLockType (const RetentionLockType &value)
 
PoolInfoWithRetentionLockType (RetentionLockType &&value)
 
int GetRetentionLockTimeInDays () const
 
bool RetentionLockTimeInDaysHasBeenSet () const
 
void SetRetentionLockTimeInDays (int value)
 
PoolInfoWithRetentionLockTimeInDays (int value)
 
const PoolStatusGetPoolStatus () const
 
bool PoolStatusHasBeenSet () const
 
void SetPoolStatus (const PoolStatus &value)
 
void SetPoolStatus (PoolStatus &&value)
 
PoolInfoWithPoolStatus (const PoolStatus &value)
 
PoolInfoWithPoolStatus (PoolStatus &&value)
 

Detailed Description

Describes a custom tape pool.

See Also:

AWS API Reference

Definition at line 34 of file PoolInfo.h.

Constructor & Destructor Documentation

◆ PoolInfo() [1/2]

Aws::StorageGateway::Model::PoolInfo::PoolInfo ( )

◆ PoolInfo() [2/2]

Aws::StorageGateway::Model::PoolInfo::PoolInfo ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ GetPoolARN()

const Aws::String& Aws::StorageGateway::Model::PoolInfo::GetPoolARN ( ) const
inline

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 Region.

Definition at line 48 of file PoolInfo.h.

◆ GetPoolName()

const Aws::String& Aws::StorageGateway::Model::PoolInfo::GetPoolName ( ) const
inline

The name of the custom tape pool. PoolName can use all ASCII characters, except '/' and '\'.

Definition at line 104 of file PoolInfo.h.

◆ GetPoolStatus()

const PoolStatus& Aws::StorageGateway::Model::PoolInfo::GetPoolStatus ( ) const
inline

Status of the custom tape pool. Pool can be ACTIVE or DELETED.

Definition at line 282 of file PoolInfo.h.

◆ GetRetentionLockTimeInDays()

int Aws::StorageGateway::Model::PoolInfo::GetRetentionLockTimeInDays ( ) const
inline

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

Definition at line 257 of file PoolInfo.h.

◆ GetRetentionLockType()

const RetentionLockType& Aws::StorageGateway::Model::PoolInfo::GetRetentionLockType ( ) const
inline

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

Definition at line 205 of file PoolInfo.h.

◆ GetStorageClass()

const TapeStorageClass& Aws::StorageGateway::Model::PoolInfo::GetStorageClass ( ) const
inline

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.

Definition at line 155 of file PoolInfo.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::StorageGateway::Model::PoolInfo::Jsonize ( ) const

◆ operator=()

PoolInfo& Aws::StorageGateway::Model::PoolInfo::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ PoolARNHasBeenSet()

bool Aws::StorageGateway::Model::PoolInfo::PoolARNHasBeenSet ( ) const
inline

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 Region.

Definition at line 55 of file PoolInfo.h.

◆ PoolNameHasBeenSet()

bool Aws::StorageGateway::Model::PoolInfo::PoolNameHasBeenSet ( ) const
inline

The name of the custom tape pool. PoolName can use all ASCII characters, except '/' and '\'.

Definition at line 110 of file PoolInfo.h.

◆ PoolStatusHasBeenSet()

bool Aws::StorageGateway::Model::PoolInfo::PoolStatusHasBeenSet ( ) const
inline

Status of the custom tape pool. Pool can be ACTIVE or DELETED.

Definition at line 288 of file PoolInfo.h.

◆ RetentionLockTimeInDaysHasBeenSet()

bool Aws::StorageGateway::Model::PoolInfo::RetentionLockTimeInDaysHasBeenSet ( ) const
inline

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

Definition at line 263 of file PoolInfo.h.

◆ RetentionLockTypeHasBeenSet()

bool Aws::StorageGateway::Model::PoolInfo::RetentionLockTypeHasBeenSet ( ) const
inline

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

Definition at line 214 of file PoolInfo.h.

◆ SetPoolARN() [1/3]

void Aws::StorageGateway::Model::PoolInfo::SetPoolARN ( Aws::String &&  value)
inline

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 Region.

Definition at line 69 of file PoolInfo.h.

◆ SetPoolARN() [2/3]

void Aws::StorageGateway::Model::PoolInfo::SetPoolARN ( const Aws::String value)
inline

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 Region.

Definition at line 62 of file PoolInfo.h.

◆ SetPoolARN() [3/3]

void Aws::StorageGateway::Model::PoolInfo::SetPoolARN ( const char *  value)
inline

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 Region.

Definition at line 76 of file PoolInfo.h.

◆ SetPoolName() [1/3]

void Aws::StorageGateway::Model::PoolInfo::SetPoolName ( Aws::String &&  value)
inline

The name of the custom tape pool. PoolName can use all ASCII characters, except '/' and '\'.

Definition at line 122 of file PoolInfo.h.

◆ SetPoolName() [2/3]

void Aws::StorageGateway::Model::PoolInfo::SetPoolName ( const Aws::String value)
inline

The name of the custom tape pool. PoolName can use all ASCII characters, except '/' and '\'.

Definition at line 116 of file PoolInfo.h.

◆ SetPoolName() [3/3]

void Aws::StorageGateway::Model::PoolInfo::SetPoolName ( const char *  value)
inline

The name of the custom tape pool. PoolName can use all ASCII characters, except '/' and '\'.

Definition at line 128 of file PoolInfo.h.

◆ SetPoolStatus() [1/2]

void Aws::StorageGateway::Model::PoolInfo::SetPoolStatus ( const PoolStatus value)
inline

Status of the custom tape pool. Pool can be ACTIVE or DELETED.

Definition at line 294 of file PoolInfo.h.

◆ SetPoolStatus() [2/2]

void Aws::StorageGateway::Model::PoolInfo::SetPoolStatus ( PoolStatus &&  value)
inline

Status of the custom tape pool. Pool can be ACTIVE or DELETED.

Definition at line 300 of file PoolInfo.h.

◆ SetRetentionLockTimeInDays()

void Aws::StorageGateway::Model::PoolInfo::SetRetentionLockTimeInDays ( int  value)
inline

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

Definition at line 269 of file PoolInfo.h.

◆ SetRetentionLockType() [1/2]

void Aws::StorageGateway::Model::PoolInfo::SetRetentionLockType ( const RetentionLockType value)
inline

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

Definition at line 223 of file PoolInfo.h.

◆ SetRetentionLockType() [2/2]

void Aws::StorageGateway::Model::PoolInfo::SetRetentionLockType ( RetentionLockType &&  value)
inline

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

Definition at line 232 of file PoolInfo.h.

◆ SetStorageClass() [1/2]

void Aws::StorageGateway::Model::PoolInfo::SetStorageClass ( const TapeStorageClass value)
inline

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.

Definition at line 171 of file PoolInfo.h.

◆ SetStorageClass() [2/2]

void Aws::StorageGateway::Model::PoolInfo::SetStorageClass ( TapeStorageClass &&  value)
inline

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.

Definition at line 179 of file PoolInfo.h.

◆ StorageClassHasBeenSet()

bool Aws::StorageGateway::Model::PoolInfo::StorageClassHasBeenSet ( ) const
inline

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.

Definition at line 163 of file PoolInfo.h.

◆ WithPoolARN() [1/3]

PoolInfo& Aws::StorageGateway::Model::PoolInfo::WithPoolARN ( Aws::String &&  value)
inline

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 Region.

Definition at line 90 of file PoolInfo.h.

◆ WithPoolARN() [2/3]

PoolInfo& Aws::StorageGateway::Model::PoolInfo::WithPoolARN ( const Aws::String value)
inline

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 Region.

Definition at line 83 of file PoolInfo.h.

◆ WithPoolARN() [3/3]

PoolInfo& Aws::StorageGateway::Model::PoolInfo::WithPoolARN ( const char *  value)
inline

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 Region.

Definition at line 97 of file PoolInfo.h.

◆ WithPoolName() [1/3]

PoolInfo& Aws::StorageGateway::Model::PoolInfo::WithPoolName ( Aws::String &&  value)
inline

The name of the custom tape pool. PoolName can use all ASCII characters, except '/' and '\'.

Definition at line 140 of file PoolInfo.h.

◆ WithPoolName() [2/3]

PoolInfo& Aws::StorageGateway::Model::PoolInfo::WithPoolName ( const Aws::String value)
inline

The name of the custom tape pool. PoolName can use all ASCII characters, except '/' and '\'.

Definition at line 134 of file PoolInfo.h.

◆ WithPoolName() [3/3]

PoolInfo& Aws::StorageGateway::Model::PoolInfo::WithPoolName ( const char *  value)
inline

The name of the custom tape pool. PoolName can use all ASCII characters, except '/' and '\'.

Definition at line 146 of file PoolInfo.h.

◆ WithPoolStatus() [1/2]

PoolInfo& Aws::StorageGateway::Model::PoolInfo::WithPoolStatus ( const PoolStatus value)
inline

Status of the custom tape pool. Pool can be ACTIVE or DELETED.

Definition at line 306 of file PoolInfo.h.

◆ WithPoolStatus() [2/2]

PoolInfo& Aws::StorageGateway::Model::PoolInfo::WithPoolStatus ( PoolStatus &&  value)
inline

Status of the custom tape pool. Pool can be ACTIVE or DELETED.

Definition at line 312 of file PoolInfo.h.

◆ WithRetentionLockTimeInDays()

PoolInfo& Aws::StorageGateway::Model::PoolInfo::WithRetentionLockTimeInDays ( int  value)
inline

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

Definition at line 275 of file PoolInfo.h.

◆ WithRetentionLockType() [1/2]

PoolInfo& Aws::StorageGateway::Model::PoolInfo::WithRetentionLockType ( const RetentionLockType value)
inline

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

Definition at line 241 of file PoolInfo.h.

◆ WithRetentionLockType() [2/2]

PoolInfo& Aws::StorageGateway::Model::PoolInfo::WithRetentionLockType ( RetentionLockType &&  value)
inline

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

Definition at line 250 of file PoolInfo.h.

◆ WithStorageClass() [1/2]

PoolInfo& Aws::StorageGateway::Model::PoolInfo::WithStorageClass ( const TapeStorageClass value)
inline

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.

Definition at line 187 of file PoolInfo.h.

◆ WithStorageClass() [2/2]

PoolInfo& Aws::StorageGateway::Model::PoolInfo::WithStorageClass ( TapeStorageClass &&  value)
inline

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.

Definition at line 195 of file PoolInfo.h.


The documentation for this class was generated from the following file: