Aws::Redshift::Model::Snapshot Class Reference

#include <Snapshot.h>

Public Member Functions
	Snapshot ()
	Snapshot (const Aws::Utils::Xml::XmlNode &xmlNode)
Snapshot &	operator= (const Aws::Utils::Xml::XmlNode &xmlNode)
void	OutputToStream (Aws::OStream &ostream, const char *location, unsigned index, const char *locationValue) const
void	OutputToStream (Aws::OStream &oStream, const char *location) const
const Aws::String &	GetSnapshotIdentifier () const
void	SetSnapshotIdentifier (const Aws::String &value)
void	SetSnapshotIdentifier (Aws::String &&value)
void	SetSnapshotIdentifier (const char *value)
Snapshot &	WithSnapshotIdentifier (const Aws::String &value)
Snapshot &	WithSnapshotIdentifier (Aws::String &&value)
Snapshot &	WithSnapshotIdentifier (const char *value)
const Aws::String &	GetClusterIdentifier () const
void	SetClusterIdentifier (const Aws::String &value)
void	SetClusterIdentifier (Aws::String &&value)
void	SetClusterIdentifier (const char *value)
Snapshot &	WithClusterIdentifier (const Aws::String &value)
Snapshot &	WithClusterIdentifier (Aws::String &&value)
Snapshot &	WithClusterIdentifier (const char *value)
const Aws::Utils::DateTime &	GetSnapshotCreateTime () const
void	SetSnapshotCreateTime (const Aws::Utils::DateTime &value)
void	SetSnapshotCreateTime (Aws::Utils::DateTime &&value)
Snapshot &	WithSnapshotCreateTime (const Aws::Utils::DateTime &value)
Snapshot &	WithSnapshotCreateTime (Aws::Utils::DateTime &&value)
const Aws::String &	GetStatus () const
void	SetStatus (const Aws::String &value)
void	SetStatus (Aws::String &&value)
void	SetStatus (const char *value)
Snapshot &	WithStatus (const Aws::String &value)
Snapshot &	WithStatus (Aws::String &&value)
Snapshot &	WithStatus (const char *value)
int	GetPort () const
void	SetPort (int value)
Snapshot &	WithPort (int value)
const Aws::String &	GetAvailabilityZone () const
void	SetAvailabilityZone (const Aws::String &value)
void	SetAvailabilityZone (Aws::String &&value)
void	SetAvailabilityZone (const char *value)
Snapshot &	WithAvailabilityZone (const Aws::String &value)
Snapshot &	WithAvailabilityZone (Aws::String &&value)
Snapshot &	WithAvailabilityZone (const char *value)
const Aws::Utils::DateTime &	GetClusterCreateTime () const
void	SetClusterCreateTime (const Aws::Utils::DateTime &value)
void	SetClusterCreateTime (Aws::Utils::DateTime &&value)
Snapshot &	WithClusterCreateTime (const Aws::Utils::DateTime &value)
Snapshot &	WithClusterCreateTime (Aws::Utils::DateTime &&value)
const Aws::String &	GetMasterUsername () const
void	SetMasterUsername (const Aws::String &value)
void	SetMasterUsername (Aws::String &&value)
void	SetMasterUsername (const char *value)
Snapshot &	WithMasterUsername (const Aws::String &value)
Snapshot &	WithMasterUsername (Aws::String &&value)
Snapshot &	WithMasterUsername (const char *value)
const Aws::String &	GetClusterVersion () const
void	SetClusterVersion (const Aws::String &value)
void	SetClusterVersion (Aws::String &&value)
void	SetClusterVersion (const char *value)
Snapshot &	WithClusterVersion (const Aws::String &value)
Snapshot &	WithClusterVersion (Aws::String &&value)
Snapshot &	WithClusterVersion (const char *value)
const Aws::String &	GetSnapshotType () const
void	SetSnapshotType (const Aws::String &value)
void	SetSnapshotType (Aws::String &&value)
void	SetSnapshotType (const char *value)
Snapshot &	WithSnapshotType (const Aws::String &value)
Snapshot &	WithSnapshotType (Aws::String &&value)
Snapshot &	WithSnapshotType (const char *value)
const Aws::String &	GetNodeType () const
void	SetNodeType (const Aws::String &value)
void	SetNodeType (Aws::String &&value)
void	SetNodeType (const char *value)
Snapshot &	WithNodeType (const Aws::String &value)
Snapshot &	WithNodeType (Aws::String &&value)
Snapshot &	WithNodeType (const char *value)
int	GetNumberOfNodes () const
void	SetNumberOfNodes (int value)
Snapshot &	WithNumberOfNodes (int value)
const Aws::String &	GetDBName () const
void	SetDBName (const Aws::String &value)
void	SetDBName (Aws::String &&value)
void	SetDBName (const char *value)
Snapshot &	WithDBName (const Aws::String &value)
Snapshot &	WithDBName (Aws::String &&value)
Snapshot &	WithDBName (const char *value)
const Aws::String &	GetVpcId () const
void	SetVpcId (const Aws::String &value)
void	SetVpcId (Aws::String &&value)
void	SetVpcId (const char *value)
Snapshot &	WithVpcId (const Aws::String &value)
Snapshot &	WithVpcId (Aws::String &&value)
Snapshot &	WithVpcId (const char *value)
bool	GetEncrypted () const
void	SetEncrypted (bool value)
Snapshot &	WithEncrypted (bool value)
const Aws::String &	GetKmsKeyId () const
void	SetKmsKeyId (const Aws::String &value)
void	SetKmsKeyId (Aws::String &&value)
void	SetKmsKeyId (const char *value)
Snapshot &	WithKmsKeyId (const Aws::String &value)
Snapshot &	WithKmsKeyId (Aws::String &&value)
Snapshot &	WithKmsKeyId (const char *value)
bool	GetEncryptedWithHSM () const
void	SetEncryptedWithHSM (bool value)
Snapshot &	WithEncryptedWithHSM (bool value)
const Aws::Vector< AccountWithRestoreAccess > &	GetAccountsWithRestoreAccess () const
void	SetAccountsWithRestoreAccess (const Aws::Vector< AccountWithRestoreAccess > &value)
void	SetAccountsWithRestoreAccess (Aws::Vector< AccountWithRestoreAccess > &&value)
Snapshot &	WithAccountsWithRestoreAccess (const Aws::Vector< AccountWithRestoreAccess > &value)
Snapshot &	WithAccountsWithRestoreAccess (Aws::Vector< AccountWithRestoreAccess > &&value)
Snapshot &	AddAccountsWithRestoreAccess (const AccountWithRestoreAccess &value)
Snapshot &	AddAccountsWithRestoreAccess (AccountWithRestoreAccess &&value)
const Aws::String &	GetOwnerAccount () const
void	SetOwnerAccount (const Aws::String &value)
void	SetOwnerAccount (Aws::String &&value)
void	SetOwnerAccount (const char *value)
Snapshot &	WithOwnerAccount (const Aws::String &value)
Snapshot &	WithOwnerAccount (Aws::String &&value)
Snapshot &	WithOwnerAccount (const char *value)
double	GetTotalBackupSizeInMegaBytes () const
void	SetTotalBackupSizeInMegaBytes (double value)
Snapshot &	WithTotalBackupSizeInMegaBytes (double value)
double	GetActualIncrementalBackupSizeInMegaBytes () const
void	SetActualIncrementalBackupSizeInMegaBytes (double value)
Snapshot &	WithActualIncrementalBackupSizeInMegaBytes (double value)
double	GetBackupProgressInMegaBytes () const
void	SetBackupProgressInMegaBytes (double value)
Snapshot &	WithBackupProgressInMegaBytes (double value)
double	GetCurrentBackupRateInMegaBytesPerSecond () const
void	SetCurrentBackupRateInMegaBytesPerSecond (double value)
Snapshot &	WithCurrentBackupRateInMegaBytesPerSecond (double value)
long long	GetEstimatedSecondsToCompletion () const
void	SetEstimatedSecondsToCompletion (long long value)
Snapshot &	WithEstimatedSecondsToCompletion (long long value)
long long	GetElapsedTimeInSeconds () const
void	SetElapsedTimeInSeconds (long long value)
Snapshot &	WithElapsedTimeInSeconds (long long value)
const Aws::String &	GetSourceRegion () const
void	SetSourceRegion (const Aws::String &value)
void	SetSourceRegion (Aws::String &&value)
void	SetSourceRegion (const char *value)
Snapshot &	WithSourceRegion (const Aws::String &value)
Snapshot &	WithSourceRegion (Aws::String &&value)
Snapshot &	WithSourceRegion (const char *value)
const Aws::Vector< Tag > &	GetTags () const
void	SetTags (const Aws::Vector< Tag > &value)
void	SetTags (Aws::Vector< Tag > &&value)
Snapshot &	WithTags (const Aws::Vector< Tag > &value)
Snapshot &	WithTags (Aws::Vector< Tag > &&value)
Snapshot &	AddTags (const Tag &value)
Snapshot &	AddTags (Tag &&value)
const Aws::Vector< Aws::String > &	GetRestorableNodeTypes () const
void	SetRestorableNodeTypes (const Aws::Vector< Aws::String > &value)
void	SetRestorableNodeTypes (Aws::Vector< Aws::String > &&value)
Snapshot &	WithRestorableNodeTypes (const Aws::Vector< Aws::String > &value)
Snapshot &	WithRestorableNodeTypes (Aws::Vector< Aws::String > &&value)
Snapshot &	AddRestorableNodeTypes (const Aws::String &value)
Snapshot &	AddRestorableNodeTypes (Aws::String &&value)
Snapshot &	AddRestorableNodeTypes (const char *value)

Detailed Description

Describes a snapshot.

Definition at line 41 of file Snapshot.h.

Constructor & Destructor Documentation

Aws::Redshift::Model::Snapshot::Snapshot

(

)

Aws::Redshift::Model::Snapshot::Snapshot

(

const Aws::Utils::Xml::XmlNode &

xmlNode

)

Member Function Documentation

Snapshot& Aws::Redshift::Model::Snapshot::AddAccountsWithRestoreAccess ( const AccountWithRestoreAccess &  value )

inline

A list of the AWS customer accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.

Definition at line 653 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::AddAccountsWithRestoreAccess ( AccountWithRestoreAccess &&  value )

inline

A list of the AWS customer accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.

Definition at line 660 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::AddRestorableNodeTypes ( const Aws::String &  value )

inline

The list of node types that this cluster snapshot is able to restore into.

Definition at line 920 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::AddRestorableNodeTypes ( Aws::String &&  value )

inline

The list of node types that this cluster snapshot is able to restore into.

Definition at line 926 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::AddRestorableNodeTypes ( const char *  value )

inline

The list of node types that this cluster snapshot is able to restore into.

Definition at line 932 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::AddTags ( const Tag &  value )

inline

The list of tags for the cluster snapshot.

Definition at line 879 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::AddTags ( Tag &&  value )

inline

The list of tags for the cluster snapshot.

Definition at line 884 of file Snapshot.h.

const Aws::Vector<AccountWithRestoreAccess>& Aws::Redshift::Model::Snapshot::GetAccountsWithRestoreAccess ( ) const

inline

A list of the AWS customer accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.

Definition at line 618 of file Snapshot.h.

double Aws::Redshift::Model::Snapshot::GetActualIncrementalBackupSizeInMegaBytes ( ) const

inline

The size of the incremental backup.

Definition at line 732 of file Snapshot.h.

const Aws::String& Aws::Redshift::Model::Snapshot::GetAvailabilityZone ( ) const

inline

The Availability Zone in which the cluster was created.

Definition at line 232 of file Snapshot.h.

double Aws::Redshift::Model::Snapshot::GetBackupProgressInMegaBytes ( ) const

inline

The number of megabytes that have been transferred to the snapshot backup.

Definition at line 748 of file Snapshot.h.

const Aws::Utils::DateTime& Aws::Redshift::Model::Snapshot::GetClusterCreateTime ( ) const

inline

The time (UTC) when the cluster was originally created.

Definition at line 267 of file Snapshot.h.

const Aws::String& Aws::Redshift::Model::Snapshot::GetClusterIdentifier ( ) const

inline

The identifier of the cluster for which the snapshot was taken.

Definition at line 89 of file Snapshot.h.

const Aws::String& Aws::Redshift::Model::Snapshot::GetClusterVersion ( ) const

inline

The version ID of the Amazon Redshift engine that is running on the cluster.

Definition at line 328 of file Snapshot.h.

double Aws::Redshift::Model::Snapshot::GetCurrentBackupRateInMegaBytesPerSecond ( ) const

inline

The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.

Definition at line 766 of file Snapshot.h.

const Aws::String& Aws::Redshift::Model::Snapshot::GetDBName ( ) const

inline

The name of the database that was created when the cluster was created.

Definition at line 461 of file Snapshot.h.

long long Aws::Redshift::Model::Snapshot::GetElapsedTimeInSeconds ( ) const

inline

The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.

Definition at line 802 of file Snapshot.h.

bool Aws::Redshift::Model::Snapshot::GetEncrypted ( ) const

inline

If true, the data in the snapshot is encrypted at rest.

Definition at line 538 of file Snapshot.h.

bool Aws::Redshift::Model::Snapshot::GetEncryptedWithHSM ( ) const

inline

A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster. true indicates that the data is encrypted using HSM keys.

Definition at line 597 of file Snapshot.h.

long long Aws::Redshift::Model::Snapshot::GetEstimatedSecondsToCompletion ( ) const

inline

The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup.

Definition at line 784 of file Snapshot.h.

const Aws::String& Aws::Redshift::Model::Snapshot::GetKmsKeyId ( ) const

inline

The AWS Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.

Definition at line 554 of file Snapshot.h.

const Aws::String& Aws::Redshift::Model::Snapshot::GetMasterUsername ( ) const

inline

The master user name for the cluster.

Definition at line 292 of file Snapshot.h.

const Aws::String& Aws::Redshift::Model::Snapshot::GetNodeType ( ) const

inline

The node type of the nodes in the cluster.

Definition at line 411 of file Snapshot.h.

int Aws::Redshift::Model::Snapshot::GetNumberOfNodes ( ) const

inline

The number of nodes in the cluster.

Definition at line 446 of file Snapshot.h.

const Aws::String& Aws::Redshift::Model::Snapshot::GetOwnerAccount ( ) const

inline

For manual snapshots, the AWS customer account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.

Definition at line 667 of file Snapshot.h.

int Aws::Redshift::Model::Snapshot::GetPort ( ) const

inline

The port that the cluster is listening on.

Definition at line 217 of file Snapshot.h.

const Aws::Vector<Aws::String>& Aws::Redshift::Model::Snapshot::GetRestorableNodeTypes ( ) const

inline

The list of node types that this cluster snapshot is able to restore into.

Definition at line 890 of file Snapshot.h.

const Aws::Utils::DateTime& Aws::Redshift::Model::Snapshot::GetSnapshotCreateTime ( ) const

inline

The time (UTC) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.

Definition at line 125 of file Snapshot.h.

const Aws::String& Aws::Redshift::Model::Snapshot::GetSnapshotIdentifier ( ) const

inline

The snapshot identifier that is provided in the request.

Definition at line 54 of file Snapshot.h.

const Aws::String& Aws::Redshift::Model::Snapshot::GetSnapshotType ( ) const

inline

The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot will be of type "manual".

Definition at line 370 of file Snapshot.h.

const Aws::String& Aws::Redshift::Model::Snapshot::GetSourceRegion ( ) const

inline

The source region from which the snapshot was copied.

Definition at line 819 of file Snapshot.h.

const Aws::String& Aws::Redshift::Model::Snapshot::GetStatus ( ) const

inline

The snapshot status. The value of the status depends on the API operation used.

• CreateClusterSnapshot and CopyClusterSnapshot returns status as "creating".
• DescribeClusterSnapshots returns status as "creating", "available", "final snapshot", or "failed".
• DeleteClusterSnapshot returns status as "deleted".

Definition at line 158 of file Snapshot.h.

const Aws::Vector<Tag>& Aws::Redshift::Model::Snapshot::GetTags ( ) const

inline

The list of tags for the cluster snapshot.

Definition at line 854 of file Snapshot.h.

double Aws::Redshift::Model::Snapshot::GetTotalBackupSizeInMegaBytes ( ) const

inline

The size of the complete set of backup data that would be used to restore the cluster.

Definition at line 715 of file Snapshot.h.

const Aws::String& Aws::Redshift::Model::Snapshot::GetVpcId ( ) const

inline

The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.

Definition at line 497 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::operator=

(

const Aws::Utils::Xml::XmlNode &

xmlNode

)

void Aws::Redshift::Model::Snapshot::OutputToStream	(	Aws::OStream &	ostream,
		const char *	location,
		unsigned	index,
		const char *	locationValue
	)		const

void Aws::Redshift::Model::Snapshot::OutputToStream	(	Aws::OStream &	oStream,
		const char *	location
	)		const

void Aws::Redshift::Model::Snapshot::SetAccountsWithRestoreAccess ( const Aws::Vector< AccountWithRestoreAccess > &  value )

inline

A list of the AWS customer accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.

Definition at line 625 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetAccountsWithRestoreAccess ( Aws::Vector< AccountWithRestoreAccess > &&  value )

inline

A list of the AWS customer accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.

Definition at line 632 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetActualIncrementalBackupSizeInMegaBytes ( double  value )

inline

The size of the incremental backup.

Definition at line 737 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetAvailabilityZone ( const Aws::String &  value )

inline

The Availability Zone in which the cluster was created.

Definition at line 237 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetAvailabilityZone ( Aws::String &&  value )

inline

The Availability Zone in which the cluster was created.

Definition at line 242 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetAvailabilityZone ( const char *  value )

inline

The Availability Zone in which the cluster was created.

Definition at line 247 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetBackupProgressInMegaBytes ( double  value )

inline

The number of megabytes that have been transferred to the snapshot backup.

Definition at line 754 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetClusterCreateTime ( const Aws::Utils::DateTime &  value )

inline

The time (UTC) when the cluster was originally created.

Definition at line 272 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetClusterCreateTime ( Aws::Utils::DateTime &&  value )

inline

The time (UTC) when the cluster was originally created.

Definition at line 277 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetClusterIdentifier ( const Aws::String &  value )

inline

The identifier of the cluster for which the snapshot was taken.

Definition at line 94 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetClusterIdentifier ( Aws::String &&  value )

inline

The identifier of the cluster for which the snapshot was taken.

Definition at line 99 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetClusterIdentifier ( const char *  value )

inline

The identifier of the cluster for which the snapshot was taken.

Definition at line 104 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetClusterVersion ( const Aws::String &  value )

inline

The version ID of the Amazon Redshift engine that is running on the cluster.

Definition at line 334 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetClusterVersion ( Aws::String &&  value )

inline

The version ID of the Amazon Redshift engine that is running on the cluster.

Definition at line 340 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetClusterVersion ( const char *  value )

inline

The version ID of the Amazon Redshift engine that is running on the cluster.

Definition at line 346 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetCurrentBackupRateInMegaBytesPerSecond ( double  value )

inline

The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.

Definition at line 772 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetDBName ( const Aws::String &  value )

inline

The name of the database that was created when the cluster was created.

Definition at line 466 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetDBName ( Aws::String &&  value )

inline

The name of the database that was created when the cluster was created.

Definition at line 471 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetDBName ( const char *  value )

inline

The name of the database that was created when the cluster was created.

Definition at line 476 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetElapsedTimeInSeconds ( long long  value )

inline

The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.

Definition at line 808 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetEncrypted ( bool  value )

inline

If true, the data in the snapshot is encrypted at rest.

Definition at line 543 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetEncryptedWithHSM ( bool  value )

inline

A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster. true indicates that the data is encrypted using HSM keys.

Definition at line 604 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetEstimatedSecondsToCompletion ( long long  value )

inline

The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup.

Definition at line 790 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetKmsKeyId ( const Aws::String &  value )

inline

The AWS Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.

Definition at line 560 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetKmsKeyId ( Aws::String &&  value )

inline

The AWS Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.

Definition at line 566 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetKmsKeyId ( const char *  value )

inline

The AWS Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.

Definition at line 572 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetMasterUsername ( const Aws::String &  value )

inline

The master user name for the cluster.

Definition at line 297 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetMasterUsername ( Aws::String &&  value )

inline

The master user name for the cluster.

Definition at line 302 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetMasterUsername ( const char *  value )

inline

The master user name for the cluster.

Definition at line 307 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetNodeType ( const Aws::String &  value )

inline

The node type of the nodes in the cluster.

Definition at line 416 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetNodeType ( Aws::String &&  value )

inline

The node type of the nodes in the cluster.

Definition at line 421 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetNodeType ( const char *  value )

inline

The node type of the nodes in the cluster.

Definition at line 426 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetNumberOfNodes ( int  value )

inline

The number of nodes in the cluster.

Definition at line 451 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetOwnerAccount ( const Aws::String &  value )

inline

For manual snapshots, the AWS customer account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.

Definition at line 674 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetOwnerAccount ( Aws::String &&  value )

inline

For manual snapshots, the AWS customer account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.

Definition at line 681 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetOwnerAccount ( const char *  value )

inline

For manual snapshots, the AWS customer account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.

Definition at line 688 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetPort ( int  value )

inline

The port that the cluster is listening on.

Definition at line 222 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetRestorableNodeTypes ( const Aws::Vector< Aws::String > &  value )

inline

The list of node types that this cluster snapshot is able to restore into.

Definition at line 896 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetRestorableNodeTypes ( Aws::Vector< Aws::String > &&  value )

inline

The list of node types that this cluster snapshot is able to restore into.

Definition at line 902 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetSnapshotCreateTime ( const Aws::Utils::DateTime &  value )

inline

The time (UTC) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.

Definition at line 131 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetSnapshotCreateTime ( Aws::Utils::DateTime &&  value )

inline

The time (UTC) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.

Definition at line 137 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetSnapshotIdentifier ( const Aws::String &  value )

inline

The snapshot identifier that is provided in the request.

Definition at line 59 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetSnapshotIdentifier ( Aws::String &&  value )

inline

The snapshot identifier that is provided in the request.

Definition at line 64 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetSnapshotIdentifier ( const char *  value )

inline

The snapshot identifier that is provided in the request.

Definition at line 69 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetSnapshotType ( const Aws::String &  value )

inline

The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot will be of type "manual".

Definition at line 376 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetSnapshotType ( Aws::String &&  value )

inline

The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot will be of type "manual".

Definition at line 382 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetSnapshotType ( const char *  value )

inline

The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot will be of type "manual".

Definition at line 388 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetSourceRegion ( const Aws::String &  value )

inline

The source region from which the snapshot was copied.

Definition at line 824 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetSourceRegion ( Aws::String &&  value )

inline

The source region from which the snapshot was copied.

Definition at line 829 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetSourceRegion ( const char *  value )

inline

The source region from which the snapshot was copied.

Definition at line 834 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetStatus ( const Aws::String &  value )

inline

The snapshot status. The value of the status depends on the API operation used.

• CreateClusterSnapshot and CopyClusterSnapshot returns status as "creating".
• DescribeClusterSnapshots returns status as "creating", "available", "final snapshot", or "failed".
• DeleteClusterSnapshot returns status as "deleted".

Definition at line 167 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetStatus ( Aws::String &&  value )

inline

The snapshot status. The value of the status depends on the API operation used.

• CreateClusterSnapshot and CopyClusterSnapshot returns status as "creating".
• DescribeClusterSnapshots returns status as "creating", "available", "final snapshot", or "failed".
• DeleteClusterSnapshot returns status as "deleted".

Definition at line 176 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetStatus ( const char *  value )

inline

The snapshot status. The value of the status depends on the API operation used.

• CreateClusterSnapshot and CopyClusterSnapshot returns status as "creating".
• DescribeClusterSnapshots returns status as "creating", "available", "final snapshot", or "failed".
• DeleteClusterSnapshot returns status as "deleted".

Definition at line 185 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetTags ( const Aws::Vector< Tag > &  value )

inline

The list of tags for the cluster snapshot.

Definition at line 859 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetTags ( Aws::Vector< Tag > &&  value )

inline

The list of tags for the cluster snapshot.

Definition at line 864 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetTotalBackupSizeInMegaBytes ( double  value )

inline

The size of the complete set of backup data that would be used to restore the cluster.

Definition at line 721 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetVpcId ( const Aws::String &  value )

inline

The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.

Definition at line 503 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetVpcId ( Aws::String &&  value )

inline

The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.

Definition at line 509 of file Snapshot.h.

void Aws::Redshift::Model::Snapshot::SetVpcId ( const char *  value )

inline

The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.

Definition at line 515 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithAccountsWithRestoreAccess ( const Aws::Vector< AccountWithRestoreAccess > &  value )

inline

A list of the AWS customer accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.

Definition at line 639 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithAccountsWithRestoreAccess ( Aws::Vector< AccountWithRestoreAccess > &&  value )

inline

A list of the AWS customer accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.

Definition at line 646 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithActualIncrementalBackupSizeInMegaBytes ( double  value )

inline

The size of the incremental backup.

Definition at line 742 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithAvailabilityZone ( const Aws::String &  value )

inline

The Availability Zone in which the cluster was created.

Definition at line 252 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithAvailabilityZone ( Aws::String &&  value )

inline

The Availability Zone in which the cluster was created.

Definition at line 257 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithAvailabilityZone ( const char *  value )

inline

The Availability Zone in which the cluster was created.

Definition at line 262 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithBackupProgressInMegaBytes ( double  value )

inline

The number of megabytes that have been transferred to the snapshot backup.

Definition at line 760 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithClusterCreateTime ( const Aws::Utils::DateTime &  value )

inline

The time (UTC) when the cluster was originally created.

Definition at line 282 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithClusterCreateTime ( Aws::Utils::DateTime &&  value )

inline

The time (UTC) when the cluster was originally created.

Definition at line 287 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithClusterIdentifier ( const Aws::String &  value )

inline

The identifier of the cluster for which the snapshot was taken.

Definition at line 109 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithClusterIdentifier ( Aws::String &&  value )

inline

The identifier of the cluster for which the snapshot was taken.

Definition at line 114 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithClusterIdentifier ( const char *  value )

inline

The identifier of the cluster for which the snapshot was taken.

Definition at line 119 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithClusterVersion ( const Aws::String &  value )

inline

The version ID of the Amazon Redshift engine that is running on the cluster.

Definition at line 352 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithClusterVersion ( Aws::String &&  value )

inline

The version ID of the Amazon Redshift engine that is running on the cluster.

Definition at line 358 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithClusterVersion ( const char *  value )

inline

The version ID of the Amazon Redshift engine that is running on the cluster.

Definition at line 364 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithCurrentBackupRateInMegaBytesPerSecond ( double  value )

inline

The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.

Definition at line 778 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithDBName ( const Aws::String &  value )

inline

The name of the database that was created when the cluster was created.

Definition at line 481 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithDBName ( Aws::String &&  value )

inline

The name of the database that was created when the cluster was created.

Definition at line 486 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithDBName ( const char *  value )

inline

The name of the database that was created when the cluster was created.

Definition at line 491 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithElapsedTimeInSeconds ( long long  value )

inline

The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.

Definition at line 814 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithEncrypted ( bool  value )

inline

If true, the data in the snapshot is encrypted at rest.

Definition at line 548 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithEncryptedWithHSM ( bool  value )

inline

A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster. true indicates that the data is encrypted using HSM keys.

Definition at line 611 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithEstimatedSecondsToCompletion ( long long  value )

inline

The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup.

Definition at line 796 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithKmsKeyId ( const Aws::String &  value )

inline

The AWS Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.

Definition at line 578 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithKmsKeyId ( Aws::String &&  value )

inline

The AWS Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.

Definition at line 584 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithKmsKeyId ( const char *  value )

inline

The AWS Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.

Definition at line 590 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithMasterUsername ( const Aws::String &  value )

inline

The master user name for the cluster.

Definition at line 312 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithMasterUsername ( Aws::String &&  value )

inline

The master user name for the cluster.

Definition at line 317 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithMasterUsername ( const char *  value )

inline

The master user name for the cluster.

Definition at line 322 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithNodeType ( const Aws::String &  value )

inline

The node type of the nodes in the cluster.

Definition at line 431 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithNodeType ( Aws::String &&  value )

inline

The node type of the nodes in the cluster.

Definition at line 436 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithNodeType ( const char *  value )

inline

The node type of the nodes in the cluster.

Definition at line 441 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithNumberOfNodes ( int  value )

inline

The number of nodes in the cluster.

Definition at line 456 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithOwnerAccount ( const Aws::String &  value )

inline

For manual snapshots, the AWS customer account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.

Definition at line 695 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithOwnerAccount ( Aws::String &&  value )

inline

For manual snapshots, the AWS customer account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.

Definition at line 702 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithOwnerAccount ( const char *  value )

inline

For manual snapshots, the AWS customer account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.

Definition at line 709 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithPort ( int  value )

inline

The port that the cluster is listening on.

Definition at line 227 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithRestorableNodeTypes ( const Aws::Vector< Aws::String > &  value )

inline

The list of node types that this cluster snapshot is able to restore into.

Definition at line 908 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithRestorableNodeTypes ( Aws::Vector< Aws::String > &&  value )

inline

The list of node types that this cluster snapshot is able to restore into.

Definition at line 914 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithSnapshotCreateTime ( const Aws::Utils::DateTime &  value )

inline

The time (UTC) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.

Definition at line 143 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithSnapshotCreateTime ( Aws::Utils::DateTime &&  value )

inline

The time (UTC) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.

Definition at line 149 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithSnapshotIdentifier ( const Aws::String &  value )

inline

The snapshot identifier that is provided in the request.

Definition at line 74 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithSnapshotIdentifier ( Aws::String &&  value )

inline

The snapshot identifier that is provided in the request.

Definition at line 79 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithSnapshotIdentifier ( const char *  value )

inline

The snapshot identifier that is provided in the request.

Definition at line 84 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithSnapshotType ( const Aws::String &  value )

inline

The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot will be of type "manual".

Definition at line 394 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithSnapshotType ( Aws::String &&  value )

inline

The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot will be of type "manual".

Definition at line 400 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithSnapshotType ( const char *  value )

inline

The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot will be of type "manual".

Definition at line 406 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithSourceRegion ( const Aws::String &  value )

inline

The source region from which the snapshot was copied.

Definition at line 839 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithSourceRegion ( Aws::String &&  value )

inline

The source region from which the snapshot was copied.

Definition at line 844 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithSourceRegion ( const char *  value )

inline

The source region from which the snapshot was copied.

Definition at line 849 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithStatus ( const Aws::String &  value )

inline

The snapshot status. The value of the status depends on the API operation used.

• CreateClusterSnapshot and CopyClusterSnapshot returns status as "creating".
• DescribeClusterSnapshots returns status as "creating", "available", "final snapshot", or "failed".
• DeleteClusterSnapshot returns status as "deleted".

Definition at line 194 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithStatus ( Aws::String &&  value )

inline

The snapshot status. The value of the status depends on the API operation used.

• CreateClusterSnapshot and CopyClusterSnapshot returns status as "creating".
• DescribeClusterSnapshots returns status as "creating", "available", "final snapshot", or "failed".
• DeleteClusterSnapshot returns status as "deleted".

Definition at line 203 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithStatus ( const char *  value )

inline

The snapshot status. The value of the status depends on the API operation used.

• CreateClusterSnapshot and CopyClusterSnapshot returns status as "creating".
• DescribeClusterSnapshots returns status as "creating", "available", "final snapshot", or "failed".
• DeleteClusterSnapshot returns status as "deleted".

Definition at line 212 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithTags ( const Aws::Vector< Tag > &  value )

inline

The list of tags for the cluster snapshot.

Definition at line 869 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithTags ( Aws::Vector< Tag > &&  value )

inline

The list of tags for the cluster snapshot.

Definition at line 874 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithTotalBackupSizeInMegaBytes ( double  value )

inline

The size of the complete set of backup data that would be used to restore the cluster.

Definition at line 727 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithVpcId ( const Aws::String &  value )

inline

The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.

Definition at line 521 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithVpcId ( Aws::String &&  value )

inline

The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.

Definition at line 527 of file Snapshot.h.

Snapshot& Aws::Redshift::Model::Snapshot::WithVpcId ( const char *  value )

inline

The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.

Definition at line 533 of file Snapshot.h.

---

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

• aws-cpp-sdk-redshift/include/aws/redshift/model/Snapshot.h