#include <DBSnapshot.h>

Public Member Functions
	DBSnapshot ()

	DBSnapshot (const Aws::Utils::Xml::XmlNode &xmlNode)

DBSnapshot &	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 &	GetDBSnapshotIdentifier () const

bool	DBSnapshotIdentifierHasBeenSet () const

void	SetDBSnapshotIdentifier (const Aws::String &value)

void	SetDBSnapshotIdentifier (Aws::String &&value)

void	SetDBSnapshotIdentifier (const char *value)

DBSnapshot &	WithDBSnapshotIdentifier (const Aws::String &value)

DBSnapshot &	WithDBSnapshotIdentifier (Aws::String &&value)

DBSnapshot &	WithDBSnapshotIdentifier (const char *value)

const Aws::String &	GetDBInstanceIdentifier () const

bool	DBInstanceIdentifierHasBeenSet () const

void	SetDBInstanceIdentifier (const Aws::String &value)

void	SetDBInstanceIdentifier (Aws::String &&value)

void	SetDBInstanceIdentifier (const char *value)

DBSnapshot &	WithDBInstanceIdentifier (const Aws::String &value)

DBSnapshot &	WithDBInstanceIdentifier (Aws::String &&value)

DBSnapshot &	WithDBInstanceIdentifier (const char *value)

const Aws::Utils::DateTime &	GetSnapshotCreateTime () const

bool	SnapshotCreateTimeHasBeenSet () const

void	SetSnapshotCreateTime (const Aws::Utils::DateTime &value)

void	SetSnapshotCreateTime (Aws::Utils::DateTime &&value)

DBSnapshot &	WithSnapshotCreateTime (const Aws::Utils::DateTime &value)

DBSnapshot &	WithSnapshotCreateTime (Aws::Utils::DateTime &&value)

const Aws::String &	GetEngine () const

bool	EngineHasBeenSet () const

void	SetEngine (const Aws::String &value)

void	SetEngine (Aws::String &&value)

void	SetEngine (const char *value)

DBSnapshot &	WithEngine (const Aws::String &value)

DBSnapshot &	WithEngine (Aws::String &&value)

DBSnapshot &	WithEngine (const char *value)

int	GetAllocatedStorage () const

bool	AllocatedStorageHasBeenSet () const

void	SetAllocatedStorage (int value)

DBSnapshot &	WithAllocatedStorage (int value)

const Aws::String &	GetStatus () const

bool	StatusHasBeenSet () const

void	SetStatus (const Aws::String &value)

void	SetStatus (Aws::String &&value)

void	SetStatus (const char *value)

DBSnapshot &	WithStatus (const Aws::String &value)

DBSnapshot &	WithStatus (Aws::String &&value)

DBSnapshot &	WithStatus (const char *value)

int	GetPort () const

bool	PortHasBeenSet () const

void	SetPort (int value)

DBSnapshot &	WithPort (int value)

const Aws::String &	GetAvailabilityZone () const

bool	AvailabilityZoneHasBeenSet () const

void	SetAvailabilityZone (const Aws::String &value)

void	SetAvailabilityZone (Aws::String &&value)

void	SetAvailabilityZone (const char *value)

DBSnapshot &	WithAvailabilityZone (const Aws::String &value)

DBSnapshot &	WithAvailabilityZone (Aws::String &&value)

DBSnapshot &	WithAvailabilityZone (const char *value)

const Aws::String &	GetVpcId () const

bool	VpcIdHasBeenSet () const

void	SetVpcId (const Aws::String &value)

void	SetVpcId (Aws::String &&value)

void	SetVpcId (const char *value)

DBSnapshot &	WithVpcId (const Aws::String &value)

DBSnapshot &	WithVpcId (Aws::String &&value)

DBSnapshot &	WithVpcId (const char *value)

const Aws::Utils::DateTime &	GetInstanceCreateTime () const

bool	InstanceCreateTimeHasBeenSet () const

void	SetInstanceCreateTime (const Aws::Utils::DateTime &value)

void	SetInstanceCreateTime (Aws::Utils::DateTime &&value)

DBSnapshot &	WithInstanceCreateTime (const Aws::Utils::DateTime &value)

DBSnapshot &	WithInstanceCreateTime (Aws::Utils::DateTime &&value)

const Aws::String &	GetMasterUsername () const

bool	MasterUsernameHasBeenSet () const

void	SetMasterUsername (const Aws::String &value)

void	SetMasterUsername (Aws::String &&value)

void	SetMasterUsername (const char *value)

DBSnapshot &	WithMasterUsername (const Aws::String &value)

DBSnapshot &	WithMasterUsername (Aws::String &&value)

DBSnapshot &	WithMasterUsername (const char *value)

const Aws::String &	GetEngineVersion () const

bool	EngineVersionHasBeenSet () const

void	SetEngineVersion (const Aws::String &value)

void	SetEngineVersion (Aws::String &&value)

void	SetEngineVersion (const char *value)

DBSnapshot &	WithEngineVersion (const Aws::String &value)

DBSnapshot &	WithEngineVersion (Aws::String &&value)

DBSnapshot &	WithEngineVersion (const char *value)

const Aws::String &	GetLicenseModel () const

bool	LicenseModelHasBeenSet () const

void	SetLicenseModel (const Aws::String &value)

void	SetLicenseModel (Aws::String &&value)

void	SetLicenseModel (const char *value)

DBSnapshot &	WithLicenseModel (const Aws::String &value)

DBSnapshot &	WithLicenseModel (Aws::String &&value)

DBSnapshot &	WithLicenseModel (const char *value)

const Aws::String &	GetSnapshotType () const

bool	SnapshotTypeHasBeenSet () const

void	SetSnapshotType (const Aws::String &value)

void	SetSnapshotType (Aws::String &&value)

void	SetSnapshotType (const char *value)

DBSnapshot &	WithSnapshotType (const Aws::String &value)

DBSnapshot &	WithSnapshotType (Aws::String &&value)

DBSnapshot &	WithSnapshotType (const char *value)

int	GetIops () const

bool	IopsHasBeenSet () const

void	SetIops (int value)

DBSnapshot &	WithIops (int value)

const Aws::String &	GetOptionGroupName () const

bool	OptionGroupNameHasBeenSet () const

void	SetOptionGroupName (const Aws::String &value)

void	SetOptionGroupName (Aws::String &&value)

void	SetOptionGroupName (const char *value)

DBSnapshot &	WithOptionGroupName (const Aws::String &value)

DBSnapshot &	WithOptionGroupName (Aws::String &&value)

DBSnapshot &	WithOptionGroupName (const char *value)

int	GetPercentProgress () const

bool	PercentProgressHasBeenSet () const

void	SetPercentProgress (int value)

DBSnapshot &	WithPercentProgress (int value)

const Aws::String &	GetSourceRegion () const

bool	SourceRegionHasBeenSet () const

void	SetSourceRegion (const Aws::String &value)

void	SetSourceRegion (Aws::String &&value)

void	SetSourceRegion (const char *value)

DBSnapshot &	WithSourceRegion (const Aws::String &value)

DBSnapshot &	WithSourceRegion (Aws::String &&value)

DBSnapshot &	WithSourceRegion (const char *value)

const Aws::String &	GetSourceDBSnapshotIdentifier () const

bool	SourceDBSnapshotIdentifierHasBeenSet () const

void	SetSourceDBSnapshotIdentifier (const Aws::String &value)

void	SetSourceDBSnapshotIdentifier (Aws::String &&value)

void	SetSourceDBSnapshotIdentifier (const char *value)

DBSnapshot &	WithSourceDBSnapshotIdentifier (const Aws::String &value)

DBSnapshot &	WithSourceDBSnapshotIdentifier (Aws::String &&value)

DBSnapshot &	WithSourceDBSnapshotIdentifier (const char *value)

const Aws::String &	GetStorageType () const

bool	StorageTypeHasBeenSet () const

void	SetStorageType (const Aws::String &value)

void	SetStorageType (Aws::String &&value)

void	SetStorageType (const char *value)

DBSnapshot &	WithStorageType (const Aws::String &value)

DBSnapshot &	WithStorageType (Aws::String &&value)

DBSnapshot &	WithStorageType (const char *value)

const Aws::String &	GetTdeCredentialArn () const

bool	TdeCredentialArnHasBeenSet () const

void	SetTdeCredentialArn (const Aws::String &value)

void	SetTdeCredentialArn (Aws::String &&value)

void	SetTdeCredentialArn (const char *value)

DBSnapshot &	WithTdeCredentialArn (const Aws::String &value)

DBSnapshot &	WithTdeCredentialArn (Aws::String &&value)

DBSnapshot &	WithTdeCredentialArn (const char *value)

bool	GetEncrypted () const

bool	EncryptedHasBeenSet () const

void	SetEncrypted (bool value)

DBSnapshot &	WithEncrypted (bool value)

const Aws::String &	GetKmsKeyId () const

bool	KmsKeyIdHasBeenSet () const

void	SetKmsKeyId (const Aws::String &value)

void	SetKmsKeyId (Aws::String &&value)

void	SetKmsKeyId (const char *value)

DBSnapshot &	WithKmsKeyId (const Aws::String &value)

DBSnapshot &	WithKmsKeyId (Aws::String &&value)

DBSnapshot &	WithKmsKeyId (const char *value)

const Aws::String &	GetDBSnapshotArn () const

bool	DBSnapshotArnHasBeenSet () const

void	SetDBSnapshotArn (const Aws::String &value)

void	SetDBSnapshotArn (Aws::String &&value)

void	SetDBSnapshotArn (const char *value)

DBSnapshot &	WithDBSnapshotArn (const Aws::String &value)

DBSnapshot &	WithDBSnapshotArn (Aws::String &&value)

DBSnapshot &	WithDBSnapshotArn (const char *value)

const Aws::String &	GetTimezone () const

bool	TimezoneHasBeenSet () const

void	SetTimezone (const Aws::String &value)

void	SetTimezone (Aws::String &&value)

void	SetTimezone (const char *value)

DBSnapshot &	WithTimezone (const Aws::String &value)

DBSnapshot &	WithTimezone (Aws::String &&value)

DBSnapshot &	WithTimezone (const char *value)

bool	GetIAMDatabaseAuthenticationEnabled () const

bool	IAMDatabaseAuthenticationEnabledHasBeenSet () const

void	SetIAMDatabaseAuthenticationEnabled (bool value)

DBSnapshot &	WithIAMDatabaseAuthenticationEnabled (bool value)

const Aws::Vector< ProcessorFeature > &	GetProcessorFeatures () const

bool	ProcessorFeaturesHasBeenSet () const

void	SetProcessorFeatures (const Aws::Vector< ProcessorFeature > &value)

void	SetProcessorFeatures (Aws::Vector< ProcessorFeature > &&value)

DBSnapshot &	WithProcessorFeatures (const Aws::Vector< ProcessorFeature > &value)

DBSnapshot &	WithProcessorFeatures (Aws::Vector< ProcessorFeature > &&value)

DBSnapshot &	AddProcessorFeatures (const ProcessorFeature &value)

DBSnapshot &	AddProcessorFeatures (ProcessorFeature &&value)

const Aws::String &	GetDbiResourceId () const

bool	DbiResourceIdHasBeenSet () const

void	SetDbiResourceId (const Aws::String &value)

void	SetDbiResourceId (Aws::String &&value)

void	SetDbiResourceId (const char *value)

DBSnapshot &	WithDbiResourceId (const Aws::String &value)

DBSnapshot &	WithDbiResourceId (Aws::String &&value)

DBSnapshot &	WithDbiResourceId (const char *value)

const Aws::Vector< Tag > &	GetTagList () const

bool	TagListHasBeenSet () const

void	SetTagList (const Aws::Vector< Tag > &value)

void	SetTagList (Aws::Vector< Tag > &&value)

DBSnapshot &	WithTagList (const Aws::Vector< Tag > &value)

DBSnapshot &	WithTagList (Aws::Vector< Tag > &&value)

DBSnapshot &	AddTagList (const Tag &value)

DBSnapshot &	AddTagList (Tag &&value)

Detailed Description

Contains the details of an Amazon RDS DB snapshot.

This data type is used as a response element in the DescribeDBSnapshots action.

Constructor & Destructor Documentation

◆ DBSnapshot() [1/2]

Aws::RDS::Model::DBSnapshot::DBSnapshot ( )

◆ DBSnapshot() [2/2]

Aws::RDS::Model::DBSnapshot::DBSnapshot ( const Aws::Utils::Xml::XmlNode & xmlNode )

Member Function Documentation

◆ AddProcessorFeatures() [1/2]

DBSnapshot& Aws::RDS::Model::DBSnapshot::AddProcessorFeatures ( const ProcessorFeature & value )

inline

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.

Definition at line 1110 of file DBSnapshot.h.

◆ AddProcessorFeatures() [2/2]

DBSnapshot& Aws::RDS::Model::DBSnapshot::AddProcessorFeatures ( ProcessorFeature && value )

inline

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.

Definition at line 1116 of file DBSnapshot.h.

◆ AddTagList() [1/2]

DBSnapshot& Aws::RDS::Model::DBSnapshot::AddTagList ( const Tag & value )

inline

Definition at line 1187 of file DBSnapshot.h.

◆ AddTagList() [2/2]

DBSnapshot& Aws::RDS::Model::DBSnapshot::AddTagList ( Tag && value )

inline

Definition at line 1190 of file DBSnapshot.h.

◆ AllocatedStorageHasBeenSet()

bool Aws::RDS::Model::DBSnapshot::AllocatedStorageHasBeenSet ( ) const

inline

Specifies the allocated storage size in gibibytes (GiB).

Definition at line 224 of file DBSnapshot.h.

◆ AvailabilityZoneHasBeenSet()

bool Aws::RDS::Model::DBSnapshot::AvailabilityZoneHasBeenSet ( ) const

inline

Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.

Definition at line 313 of file DBSnapshot.h.

◆ DBInstanceIdentifierHasBeenSet()

bool Aws::RDS::Model::DBSnapshot::DBInstanceIdentifierHasBeenSet ( ) const

inline

Specifies the DB instance identifier of the DB instance this DB snapshot was created from.

Definition at line 99 of file DBSnapshot.h.

◆ DbiResourceIdHasBeenSet()

bool Aws::RDS::Model::DBSnapshot::DbiResourceIdHasBeenSet ( ) const

inline

The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region.

Definition at line 1129 of file DBSnapshot.h.

◆ DBSnapshotArnHasBeenSet()

bool Aws::RDS::Model::DBSnapshot::DBSnapshotArnHasBeenSet ( ) const

inline

The Amazon Resource Name (ARN) for the DB snapshot.

Definition at line 947 of file DBSnapshot.h.

◆ DBSnapshotIdentifierHasBeenSet()

bool Aws::RDS::Model::DBSnapshot::DBSnapshotIdentifierHasBeenSet ( ) const

inline

Specifies the identifier for the DB snapshot.

Definition at line 56 of file DBSnapshot.h.

◆ EncryptedHasBeenSet()

bool Aws::RDS::Model::DBSnapshot::EncryptedHasBeenSet ( ) const

inline

Specifies whether the DB snapshot is encrypted.

Definition at line 869 of file DBSnapshot.h.

◆ EngineHasBeenSet()

bool Aws::RDS::Model::DBSnapshot::EngineHasBeenSet ( ) const

inline

Specifies the name of the database engine.

Definition at line 183 of file DBSnapshot.h.

◆ EngineVersionHasBeenSet()

bool Aws::RDS::Model::DBSnapshot::EngineVersionHasBeenSet ( ) const

inline

Specifies the version of the database engine.

Definition at line 479 of file DBSnapshot.h.

◆ GetAllocatedStorage()

int Aws::RDS::Model::DBSnapshot::GetAllocatedStorage ( ) const

inline

Specifies the allocated storage size in gibibytes (GiB).

Definition at line 219 of file DBSnapshot.h.

◆ GetAvailabilityZone()

const Aws::String& Aws::RDS::Model::DBSnapshot::GetAvailabilityZone ( ) const

inline

Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.

Definition at line 307 of file DBSnapshot.h.

◆ GetDBInstanceIdentifier()

const Aws::String& Aws::RDS::Model::DBSnapshot::GetDBInstanceIdentifier ( ) const

inline

Specifies the DB instance identifier of the DB instance this DB snapshot was created from.

Definition at line 93 of file DBSnapshot.h.

◆ GetDbiResourceId()

const Aws::String& Aws::RDS::Model::DBSnapshot::GetDbiResourceId ( ) const

inline

The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region.

Definition at line 1123 of file DBSnapshot.h.

◆ GetDBSnapshotArn()

const Aws::String& Aws::RDS::Model::DBSnapshot::GetDBSnapshotArn ( ) const

inline

The Amazon Resource Name (ARN) for the DB snapshot.

Definition at line 942 of file DBSnapshot.h.

◆ GetDBSnapshotIdentifier()

const Aws::String& Aws::RDS::Model::DBSnapshot::GetDBSnapshotIdentifier ( ) const

inline

Specifies the identifier for the DB snapshot.

Definition at line 51 of file DBSnapshot.h.

◆ GetEncrypted()

bool Aws::RDS::Model::DBSnapshot::GetEncrypted ( ) const

inline

Specifies whether the DB snapshot is encrypted.

Definition at line 864 of file DBSnapshot.h.

◆ GetEngine()

const Aws::String& Aws::RDS::Model::DBSnapshot::GetEngine ( ) const

inline

Specifies the name of the database engine.

Definition at line 178 of file DBSnapshot.h.

◆ GetEngineVersion()

const Aws::String& Aws::RDS::Model::DBSnapshot::GetEngineVersion ( ) const

inline

Specifies the version of the database engine.

Definition at line 474 of file DBSnapshot.h.

◆ GetIAMDatabaseAuthenticationEnabled()

bool Aws::RDS::Model::DBSnapshot::GetIAMDatabaseAuthenticationEnabled ( ) const

inline

True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

Definition at line 1049 of file DBSnapshot.h.

◆ GetInstanceCreateTime()

const Aws::Utils::DateTime& Aws::RDS::Model::DBSnapshot::GetInstanceCreateTime ( ) const

inline

Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.

Definition at line 397 of file DBSnapshot.h.

◆ GetIops()

int Aws::RDS::Model::DBSnapshot::GetIops ( ) const

inline

Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.

Definition at line 598 of file DBSnapshot.h.

◆ GetKmsKeyId()

const Aws::String& Aws::RDS::Model::DBSnapshot::GetKmsKeyId ( ) const

inline

If Encrypted is true, the AWS KMS key identifier for the encrypted DB snapshot.

The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).

Definition at line 887 of file DBSnapshot.h.

◆ GetLicenseModel()

const Aws::String& Aws::RDS::Model::DBSnapshot::GetLicenseModel ( ) const

inline

License model information for the restored DB instance.

Definition at line 515 of file DBSnapshot.h.

◆ GetMasterUsername()

const Aws::String& Aws::RDS::Model::DBSnapshot::GetMasterUsername ( ) const

inline

Provides the master username for the DB snapshot.

Definition at line 433 of file DBSnapshot.h.

◆ GetOptionGroupName()

const Aws::String& Aws::RDS::Model::DBSnapshot::GetOptionGroupName ( ) const

inline

Provides the option group name for the DB snapshot.

Definition at line 622 of file DBSnapshot.h.

◆ GetPercentProgress()

int Aws::RDS::Model::DBSnapshot::GetPercentProgress ( ) const

inline

The percentage of the estimated data that has been transferred.

Definition at line 663 of file DBSnapshot.h.

◆ GetPort()

int Aws::RDS::Model::DBSnapshot::GetPort ( ) const

inline

Specifies the port that the database engine was listening on at the time of the snapshot.

Definition at line 282 of file DBSnapshot.h.

◆ GetProcessorFeatures()

const Aws::Vector<ProcessorFeature>& Aws::RDS::Model::DBSnapshot::GetProcessorFeatures ( ) const

inline

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.

Definition at line 1074 of file DBSnapshot.h.

◆ GetSnapshotCreateTime()

const Aws::Utils::DateTime& Aws::RDS::Model::DBSnapshot::GetSnapshotCreateTime ( ) const

inline

Specifies when the snapshot was taken in Coordinated Universal Time (UTC).

Definition at line 142 of file DBSnapshot.h.

◆ GetSnapshotType()

const Aws::String& Aws::RDS::Model::DBSnapshot::GetSnapshotType ( ) const

inline

Provides the type of the DB snapshot.

Definition at line 556 of file DBSnapshot.h.

◆ GetSourceDBSnapshotIdentifier()

const Aws::String& Aws::RDS::Model::DBSnapshot::GetSourceDBSnapshotIdentifier ( ) const

inline

The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has value in case of cross-customer or cross-region copy.

Definition at line 726 of file DBSnapshot.h.

◆ GetSourceRegion()

const Aws::String& Aws::RDS::Model::DBSnapshot::GetSourceRegion ( ) const

inline

The AWS Region that the DB snapshot was created in or copied from.

Definition at line 684 of file DBSnapshot.h.

◆ GetStatus()

const Aws::String& Aws::RDS::Model::DBSnapshot::GetStatus ( ) const

inline

Specifies the status of this DB snapshot.

Definition at line 240 of file DBSnapshot.h.

◆ GetStorageType()

const Aws::String& Aws::RDS::Model::DBSnapshot::GetStorageType ( ) const

inline

Specifies the storage type associated with DB snapshot.

Definition at line 774 of file DBSnapshot.h.

◆ GetTagList()

const Aws::Vector<Tag>& Aws::RDS::Model::DBSnapshot::GetTagList ( ) const

inline

Definition at line 1169 of file DBSnapshot.h.

◆ GetTdeCredentialArn()

const Aws::String& Aws::RDS::Model::DBSnapshot::GetTdeCredentialArn ( ) const

inline

The ARN from the key store with which to associate the instance for TDE encryption.

Definition at line 816 of file DBSnapshot.h.

◆ GetTimezone()

const Aws::String& Aws::RDS::Model::DBSnapshot::GetTimezone ( ) const

inline

The time zone of the DB snapshot. In most cases, the Timezone element is empty. Timezone content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.

Definition at line 986 of file DBSnapshot.h.

◆ GetVpcId()

const Aws::String& Aws::RDS::Model::DBSnapshot::GetVpcId ( ) const

inline

Provides the VPC ID associated with the DB snapshot.

Definition at line 355 of file DBSnapshot.h.

◆ IAMDatabaseAuthenticationEnabledHasBeenSet()

bool Aws::RDS::Model::DBSnapshot::IAMDatabaseAuthenticationEnabledHasBeenSet ( ) const

inline

True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

Definition at line 1055 of file DBSnapshot.h.

◆ InstanceCreateTimeHasBeenSet()

bool Aws::RDS::Model::DBSnapshot::InstanceCreateTimeHasBeenSet ( ) const

inline

Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.

Definition at line 403 of file DBSnapshot.h.

◆ IopsHasBeenSet()

bool Aws::RDS::Model::DBSnapshot::IopsHasBeenSet ( ) const

inline

Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.

Definition at line 604 of file DBSnapshot.h.

◆ KmsKeyIdHasBeenSet()

bool Aws::RDS::Model::DBSnapshot::KmsKeyIdHasBeenSet ( ) const

inline

If Encrypted is true, the AWS KMS key identifier for the encrypted DB snapshot.

The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).

Definition at line 894 of file DBSnapshot.h.

◆ LicenseModelHasBeenSet()

bool Aws::RDS::Model::DBSnapshot::LicenseModelHasBeenSet ( ) const

inline

License model information for the restored DB instance.

Definition at line 520 of file DBSnapshot.h.

◆ MasterUsernameHasBeenSet()

bool Aws::RDS::Model::DBSnapshot::MasterUsernameHasBeenSet ( ) const

inline

Provides the master username for the DB snapshot.

Definition at line 438 of file DBSnapshot.h.

◆ operator=()

DBSnapshot& Aws::RDS::Model::DBSnapshot::operator= ( const Aws::Utils::Xml::XmlNode & xmlNode )

◆ OptionGroupNameHasBeenSet()

bool Aws::RDS::Model::DBSnapshot::OptionGroupNameHasBeenSet ( ) const

inline

Provides the option group name for the DB snapshot.

Definition at line 627 of file DBSnapshot.h.

◆ OutputToStream() [1/2]

void Aws::RDS::Model::DBSnapshot::OutputToStream	(	Aws::OStream &	oStream,
		const char *	location
	)		const

◆ OutputToStream() [2/2]

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

◆ PercentProgressHasBeenSet()

bool Aws::RDS::Model::DBSnapshot::PercentProgressHasBeenSet ( ) const

inline

The percentage of the estimated data that has been transferred.

Definition at line 668 of file DBSnapshot.h.

◆ PortHasBeenSet()

bool Aws::RDS::Model::DBSnapshot::PortHasBeenSet ( ) const

inline

Specifies the port that the database engine was listening on at the time of the snapshot.

Definition at line 288 of file DBSnapshot.h.

◆ ProcessorFeaturesHasBeenSet()

bool Aws::RDS::Model::DBSnapshot::ProcessorFeaturesHasBeenSet ( ) const

inline

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.

Definition at line 1080 of file DBSnapshot.h.

◆ SetAllocatedStorage()

void Aws::RDS::Model::DBSnapshot::SetAllocatedStorage ( int value )

inline

Specifies the allocated storage size in gibibytes (GiB).

Definition at line 229 of file DBSnapshot.h.

◆ SetAvailabilityZone() [1/3]

void Aws::RDS::Model::DBSnapshot::SetAvailabilityZone ( Aws::String && value )

inline

Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.

Definition at line 325 of file DBSnapshot.h.

◆ SetAvailabilityZone() [2/3]

void Aws::RDS::Model::DBSnapshot::SetAvailabilityZone ( const Aws::String & value )

inline

Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.

Definition at line 319 of file DBSnapshot.h.

◆ SetAvailabilityZone() [3/3]

void Aws::RDS::Model::DBSnapshot::SetAvailabilityZone ( const char * value )

inline

Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.

Definition at line 331 of file DBSnapshot.h.

◆ SetDBInstanceIdentifier() [1/3]

void Aws::RDS::Model::DBSnapshot::SetDBInstanceIdentifier ( Aws::String && value )

inline

Specifies the DB instance identifier of the DB instance this DB snapshot was created from.

Definition at line 111 of file DBSnapshot.h.

◆ SetDBInstanceIdentifier() [2/3]

void Aws::RDS::Model::DBSnapshot::SetDBInstanceIdentifier ( const Aws::String & value )

inline

Specifies the DB instance identifier of the DB instance this DB snapshot was created from.

Definition at line 105 of file DBSnapshot.h.

◆ SetDBInstanceIdentifier() [3/3]

void Aws::RDS::Model::DBSnapshot::SetDBInstanceIdentifier ( const char * value )

inline

Specifies the DB instance identifier of the DB instance this DB snapshot was created from.

Definition at line 117 of file DBSnapshot.h.

◆ SetDbiResourceId() [1/3]

void Aws::RDS::Model::DBSnapshot::SetDbiResourceId ( Aws::String && value )

inline

The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region.

Definition at line 1141 of file DBSnapshot.h.

◆ SetDbiResourceId() [2/3]

void Aws::RDS::Model::DBSnapshot::SetDbiResourceId ( const Aws::String & value )

inline

The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region.

Definition at line 1135 of file DBSnapshot.h.

◆ SetDbiResourceId() [3/3]

void Aws::RDS::Model::DBSnapshot::SetDbiResourceId ( const char * value )

inline

The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region.

Definition at line 1147 of file DBSnapshot.h.

◆ SetDBSnapshotArn() [1/3]

void Aws::RDS::Model::DBSnapshot::SetDBSnapshotArn ( Aws::String && value )

inline

The Amazon Resource Name (ARN) for the DB snapshot.

Definition at line 957 of file DBSnapshot.h.

◆ SetDBSnapshotArn() [2/3]

void Aws::RDS::Model::DBSnapshot::SetDBSnapshotArn ( const Aws::String & value )

inline

The Amazon Resource Name (ARN) for the DB snapshot.

Definition at line 952 of file DBSnapshot.h.

◆ SetDBSnapshotArn() [3/3]

void Aws::RDS::Model::DBSnapshot::SetDBSnapshotArn ( const char * value )

inline

The Amazon Resource Name (ARN) for the DB snapshot.

Definition at line 962 of file DBSnapshot.h.

◆ SetDBSnapshotIdentifier() [1/3]

void Aws::RDS::Model::DBSnapshot::SetDBSnapshotIdentifier ( Aws::String && value )

inline

Specifies the identifier for the DB snapshot.

Definition at line 66 of file DBSnapshot.h.

◆ SetDBSnapshotIdentifier() [2/3]

void Aws::RDS::Model::DBSnapshot::SetDBSnapshotIdentifier ( const Aws::String & value )

inline

Specifies the identifier for the DB snapshot.

Definition at line 61 of file DBSnapshot.h.

◆ SetDBSnapshotIdentifier() [3/3]

void Aws::RDS::Model::DBSnapshot::SetDBSnapshotIdentifier ( const char * value )

inline

Specifies the identifier for the DB snapshot.

Definition at line 71 of file DBSnapshot.h.

◆ SetEncrypted()

void Aws::RDS::Model::DBSnapshot::SetEncrypted ( bool value )

inline

Specifies whether the DB snapshot is encrypted.

Definition at line 874 of file DBSnapshot.h.

◆ SetEngine() [1/3]

void Aws::RDS::Model::DBSnapshot::SetEngine ( Aws::String && value )

inline

Specifies the name of the database engine.

Definition at line 193 of file DBSnapshot.h.

◆ SetEngine() [2/3]

void Aws::RDS::Model::DBSnapshot::SetEngine ( const Aws::String & value )

inline

Specifies the name of the database engine.

Definition at line 188 of file DBSnapshot.h.

◆ SetEngine() [3/3]

void Aws::RDS::Model::DBSnapshot::SetEngine ( const char * value )

inline

Specifies the name of the database engine.

Definition at line 198 of file DBSnapshot.h.

◆ SetEngineVersion() [1/3]

void Aws::RDS::Model::DBSnapshot::SetEngineVersion ( Aws::String && value )

inline

Specifies the version of the database engine.

Definition at line 489 of file DBSnapshot.h.

◆ SetEngineVersion() [2/3]

void Aws::RDS::Model::DBSnapshot::SetEngineVersion ( const Aws::String & value )

inline

Specifies the version of the database engine.

Definition at line 484 of file DBSnapshot.h.

◆ SetEngineVersion() [3/3]

void Aws::RDS::Model::DBSnapshot::SetEngineVersion ( const char * value )

inline

Specifies the version of the database engine.

Definition at line 494 of file DBSnapshot.h.

◆ SetIAMDatabaseAuthenticationEnabled()

void Aws::RDS::Model::DBSnapshot::SetIAMDatabaseAuthenticationEnabled ( bool value )

inline

True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

Definition at line 1061 of file DBSnapshot.h.

◆ SetInstanceCreateTime() [1/2]

void Aws::RDS::Model::DBSnapshot::SetInstanceCreateTime ( Aws::Utils::DateTime && value )

inline

Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.

Definition at line 415 of file DBSnapshot.h.

◆ SetInstanceCreateTime() [2/2]

void Aws::RDS::Model::DBSnapshot::SetInstanceCreateTime ( const Aws::Utils::DateTime & value )

inline

Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.

Definition at line 409 of file DBSnapshot.h.

◆ SetIops()

void Aws::RDS::Model::DBSnapshot::SetIops ( int value )

inline

Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.

Definition at line 610 of file DBSnapshot.h.

◆ SetKmsKeyId() [1/3]

void Aws::RDS::Model::DBSnapshot::SetKmsKeyId ( Aws::String && value )

inline

If Encrypted is true, the AWS KMS key identifier for the encrypted DB snapshot.

The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).

Definition at line 908 of file DBSnapshot.h.

◆ SetKmsKeyId() [2/3]

void Aws::RDS::Model::DBSnapshot::SetKmsKeyId ( const Aws::String & value )

inline

If Encrypted is true, the AWS KMS key identifier for the encrypted DB snapshot.

The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).

Definition at line 901 of file DBSnapshot.h.

◆ SetKmsKeyId() [3/3]

void Aws::RDS::Model::DBSnapshot::SetKmsKeyId ( const char * value )

inline

If Encrypted is true, the AWS KMS key identifier for the encrypted DB snapshot.

The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).

Definition at line 915 of file DBSnapshot.h.

◆ SetLicenseModel() [1/3]

void Aws::RDS::Model::DBSnapshot::SetLicenseModel ( Aws::String && value )

inline

License model information for the restored DB instance.

Definition at line 530 of file DBSnapshot.h.

◆ SetLicenseModel() [2/3]

void Aws::RDS::Model::DBSnapshot::SetLicenseModel ( const Aws::String & value )

inline

License model information for the restored DB instance.

Definition at line 525 of file DBSnapshot.h.

◆ SetLicenseModel() [3/3]

void Aws::RDS::Model::DBSnapshot::SetLicenseModel ( const char * value )

inline

License model information for the restored DB instance.

Definition at line 535 of file DBSnapshot.h.

◆ SetMasterUsername() [1/3]

void Aws::RDS::Model::DBSnapshot::SetMasterUsername ( Aws::String && value )

inline

Provides the master username for the DB snapshot.

Definition at line 448 of file DBSnapshot.h.

◆ SetMasterUsername() [2/3]

void Aws::RDS::Model::DBSnapshot::SetMasterUsername ( const Aws::String & value )

inline

Provides the master username for the DB snapshot.

Definition at line 443 of file DBSnapshot.h.

◆ SetMasterUsername() [3/3]

void Aws::RDS::Model::DBSnapshot::SetMasterUsername ( const char * value )

inline

Provides the master username for the DB snapshot.

Definition at line 453 of file DBSnapshot.h.

◆ SetOptionGroupName() [1/3]

void Aws::RDS::Model::DBSnapshot::SetOptionGroupName ( Aws::String && value )

inline

Provides the option group name for the DB snapshot.

Definition at line 637 of file DBSnapshot.h.

◆ SetOptionGroupName() [2/3]

void Aws::RDS::Model::DBSnapshot::SetOptionGroupName ( const Aws::String & value )

inline

Provides the option group name for the DB snapshot.

Definition at line 632 of file DBSnapshot.h.

◆ SetOptionGroupName() [3/3]

void Aws::RDS::Model::DBSnapshot::SetOptionGroupName ( const char * value )

inline

Provides the option group name for the DB snapshot.

Definition at line 642 of file DBSnapshot.h.

◆ SetPercentProgress()

void Aws::RDS::Model::DBSnapshot::SetPercentProgress ( int value )

inline

The percentage of the estimated data that has been transferred.

Definition at line 673 of file DBSnapshot.h.

◆ SetPort()

void Aws::RDS::Model::DBSnapshot::SetPort ( int value )

inline

Specifies the port that the database engine was listening on at the time of the snapshot.

Definition at line 294 of file DBSnapshot.h.

◆ SetProcessorFeatures() [1/2]

void Aws::RDS::Model::DBSnapshot::SetProcessorFeatures ( Aws::Vector< ProcessorFeature > && value )

inline

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.

Definition at line 1092 of file DBSnapshot.h.

◆ SetProcessorFeatures() [2/2]

void Aws::RDS::Model::DBSnapshot::SetProcessorFeatures ( const Aws::Vector< ProcessorFeature > & value )

inline

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.

Definition at line 1086 of file DBSnapshot.h.

◆ SetSnapshotCreateTime() [1/2]

void Aws::RDS::Model::DBSnapshot::SetSnapshotCreateTime ( Aws::Utils::DateTime && value )

inline

Specifies when the snapshot was taken in Coordinated Universal Time (UTC).

Definition at line 160 of file DBSnapshot.h.

◆ SetSnapshotCreateTime() [2/2]

void Aws::RDS::Model::DBSnapshot::SetSnapshotCreateTime ( const Aws::Utils::DateTime & value )

inline

Specifies when the snapshot was taken in Coordinated Universal Time (UTC).

Definition at line 154 of file DBSnapshot.h.

◆ SetSnapshotType() [1/3]

void Aws::RDS::Model::DBSnapshot::SetSnapshotType ( Aws::String && value )

inline

Provides the type of the DB snapshot.

Definition at line 571 of file DBSnapshot.h.

◆ SetSnapshotType() [2/3]

void Aws::RDS::Model::DBSnapshot::SetSnapshotType ( const Aws::String & value )

inline

Provides the type of the DB snapshot.

Definition at line 566 of file DBSnapshot.h.

◆ SetSnapshotType() [3/3]

void Aws::RDS::Model::DBSnapshot::SetSnapshotType ( const char * value )

inline

Provides the type of the DB snapshot.

Definition at line 576 of file DBSnapshot.h.

◆ SetSourceDBSnapshotIdentifier() [1/3]

void Aws::RDS::Model::DBSnapshot::SetSourceDBSnapshotIdentifier ( Aws::String && value )

inline

The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has value in case of cross-customer or cross-region copy.

Definition at line 744 of file DBSnapshot.h.

◆ SetSourceDBSnapshotIdentifier() [2/3]

void Aws::RDS::Model::DBSnapshot::SetSourceDBSnapshotIdentifier ( const Aws::String & value )

inline

The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has value in case of cross-customer or cross-region copy.

Definition at line 738 of file DBSnapshot.h.

◆ SetSourceDBSnapshotIdentifier() [3/3]

void Aws::RDS::Model::DBSnapshot::SetSourceDBSnapshotIdentifier ( const char * value )

inline

The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has value in case of cross-customer or cross-region copy.

Definition at line 750 of file DBSnapshot.h.

◆ SetSourceRegion() [1/3]

void Aws::RDS::Model::DBSnapshot::SetSourceRegion ( Aws::String && value )

inline

The AWS Region that the DB snapshot was created in or copied from.

Definition at line 699 of file DBSnapshot.h.

◆ SetSourceRegion() [2/3]

void Aws::RDS::Model::DBSnapshot::SetSourceRegion ( const Aws::String & value )

inline

The AWS Region that the DB snapshot was created in or copied from.

Definition at line 694 of file DBSnapshot.h.

◆ SetSourceRegion() [3/3]

void Aws::RDS::Model::DBSnapshot::SetSourceRegion ( const char * value )

inline

The AWS Region that the DB snapshot was created in or copied from.

Definition at line 704 of file DBSnapshot.h.

◆ SetStatus() [1/3]

void Aws::RDS::Model::DBSnapshot::SetStatus ( Aws::String && value )

inline

Specifies the status of this DB snapshot.

Definition at line 255 of file DBSnapshot.h.

◆ SetStatus() [2/3]

void Aws::RDS::Model::DBSnapshot::SetStatus ( const Aws::String & value )

inline

Specifies the status of this DB snapshot.

Definition at line 250 of file DBSnapshot.h.

◆ SetStatus() [3/3]

void Aws::RDS::Model::DBSnapshot::SetStatus ( const char * value )

inline

Specifies the status of this DB snapshot.

Definition at line 260 of file DBSnapshot.h.

◆ SetStorageType() [1/3]

void Aws::RDS::Model::DBSnapshot::SetStorageType ( Aws::String && value )

inline

Specifies the storage type associated with DB snapshot.

Definition at line 789 of file DBSnapshot.h.

◆ SetStorageType() [2/3]

void Aws::RDS::Model::DBSnapshot::SetStorageType ( const Aws::String & value )

inline

Specifies the storage type associated with DB snapshot.

Definition at line 784 of file DBSnapshot.h.

◆ SetStorageType() [3/3]

void Aws::RDS::Model::DBSnapshot::SetStorageType ( const char * value )

inline

Specifies the storage type associated with DB snapshot.

Definition at line 794 of file DBSnapshot.h.

◆ SetTagList() [1/2]

void Aws::RDS::Model::DBSnapshot::SetTagList ( Aws::Vector< Tag > && value )

inline

Definition at line 1178 of file DBSnapshot.h.

◆ SetTagList() [2/2]

void Aws::RDS::Model::DBSnapshot::SetTagList ( const Aws::Vector< Tag > & value )

inline

Definition at line 1175 of file DBSnapshot.h.

◆ SetTdeCredentialArn() [1/3]

void Aws::RDS::Model::DBSnapshot::SetTdeCredentialArn ( Aws::String && value )

inline

The ARN from the key store with which to associate the instance for TDE encryption.

Definition at line 834 of file DBSnapshot.h.

◆ SetTdeCredentialArn() [2/3]

void Aws::RDS::Model::DBSnapshot::SetTdeCredentialArn ( const Aws::String & value )

inline

The ARN from the key store with which to associate the instance for TDE encryption.

Definition at line 828 of file DBSnapshot.h.

◆ SetTdeCredentialArn() [3/3]

void Aws::RDS::Model::DBSnapshot::SetTdeCredentialArn ( const char * value )

inline

The ARN from the key store with which to associate the instance for TDE encryption.

Definition at line 840 of file DBSnapshot.h.

◆ SetTimezone() [1/3]

void Aws::RDS::Model::DBSnapshot::SetTimezone ( Aws::String && value )

inline

The time zone of the DB snapshot. In most cases, the Timezone element is empty. Timezone content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.

Definition at line 1010 of file DBSnapshot.h.

◆ SetTimezone() [2/3]

void Aws::RDS::Model::DBSnapshot::SetTimezone ( const Aws::String & value )

inline

The time zone of the DB snapshot. In most cases, the Timezone element is empty. Timezone content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.

Definition at line 1002 of file DBSnapshot.h.

◆ SetTimezone() [3/3]

void Aws::RDS::Model::DBSnapshot::SetTimezone ( const char * value )

inline

The time zone of the DB snapshot. In most cases, the Timezone element is empty. Timezone content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.

Definition at line 1018 of file DBSnapshot.h.

◆ SetVpcId() [1/3]

void Aws::RDS::Model::DBSnapshot::SetVpcId ( Aws::String && value )

inline

Provides the VPC ID associated with the DB snapshot.

Definition at line 370 of file DBSnapshot.h.

◆ SetVpcId() [2/3]

void Aws::RDS::Model::DBSnapshot::SetVpcId ( const Aws::String & value )

inline

Provides the VPC ID associated with the DB snapshot.

Definition at line 365 of file DBSnapshot.h.

◆ SetVpcId() [3/3]

void Aws::RDS::Model::DBSnapshot::SetVpcId ( const char * value )

inline

Provides the VPC ID associated with the DB snapshot.

Definition at line 375 of file DBSnapshot.h.

◆ SnapshotCreateTimeHasBeenSet()

bool Aws::RDS::Model::DBSnapshot::SnapshotCreateTimeHasBeenSet ( ) const

inline

Specifies when the snapshot was taken in Coordinated Universal Time (UTC).

Definition at line 148 of file DBSnapshot.h.

◆ SnapshotTypeHasBeenSet()

bool Aws::RDS::Model::DBSnapshot::SnapshotTypeHasBeenSet ( ) const

inline

Provides the type of the DB snapshot.

Definition at line 561 of file DBSnapshot.h.

◆ SourceDBSnapshotIdentifierHasBeenSet()

bool Aws::RDS::Model::DBSnapshot::SourceDBSnapshotIdentifierHasBeenSet ( ) const

inline

The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has value in case of cross-customer or cross-region copy.

Definition at line 732 of file DBSnapshot.h.

◆ SourceRegionHasBeenSet()

bool Aws::RDS::Model::DBSnapshot::SourceRegionHasBeenSet ( ) const

inline

The AWS Region that the DB snapshot was created in or copied from.

Definition at line 689 of file DBSnapshot.h.

◆ StatusHasBeenSet()

bool Aws::RDS::Model::DBSnapshot::StatusHasBeenSet ( ) const

inline

Specifies the status of this DB snapshot.

Definition at line 245 of file DBSnapshot.h.

◆ StorageTypeHasBeenSet()

bool Aws::RDS::Model::DBSnapshot::StorageTypeHasBeenSet ( ) const

inline

Specifies the storage type associated with DB snapshot.

Definition at line 779 of file DBSnapshot.h.

◆ TagListHasBeenSet()

bool Aws::RDS::Model::DBSnapshot::TagListHasBeenSet ( ) const

inline

Definition at line 1172 of file DBSnapshot.h.

◆ TdeCredentialArnHasBeenSet()

bool Aws::RDS::Model::DBSnapshot::TdeCredentialArnHasBeenSet ( ) const

inline

The ARN from the key store with which to associate the instance for TDE encryption.

Definition at line 822 of file DBSnapshot.h.

◆ TimezoneHasBeenSet()

bool Aws::RDS::Model::DBSnapshot::TimezoneHasBeenSet ( ) const

inline

The time zone of the DB snapshot. In most cases, the Timezone element is empty. Timezone content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.

Definition at line 994 of file DBSnapshot.h.

◆ VpcIdHasBeenSet()

bool Aws::RDS::Model::DBSnapshot::VpcIdHasBeenSet ( ) const

inline

Provides the VPC ID associated with the DB snapshot.

Definition at line 360 of file DBSnapshot.h.

◆ WithAllocatedStorage()

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithAllocatedStorage ( int value )

inline

Specifies the allocated storage size in gibibytes (GiB).

Definition at line 234 of file DBSnapshot.h.

◆ WithAvailabilityZone() [1/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithAvailabilityZone ( Aws::String && value )

inline

Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.

Definition at line 343 of file DBSnapshot.h.

◆ WithAvailabilityZone() [2/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithAvailabilityZone ( const Aws::String & value )

inline

Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.

Definition at line 337 of file DBSnapshot.h.

◆ WithAvailabilityZone() [3/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithAvailabilityZone ( const char * value )

inline

Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.

Definition at line 349 of file DBSnapshot.h.

◆ WithDBInstanceIdentifier() [1/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithDBInstanceIdentifier ( Aws::String && value )

inline

Specifies the DB instance identifier of the DB instance this DB snapshot was created from.

Definition at line 129 of file DBSnapshot.h.

◆ WithDBInstanceIdentifier() [2/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithDBInstanceIdentifier ( const Aws::String & value )

inline

Specifies the DB instance identifier of the DB instance this DB snapshot was created from.

Definition at line 123 of file DBSnapshot.h.

◆ WithDBInstanceIdentifier() [3/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithDBInstanceIdentifier ( const char * value )

inline

Specifies the DB instance identifier of the DB instance this DB snapshot was created from.

Definition at line 135 of file DBSnapshot.h.

◆ WithDbiResourceId() [1/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithDbiResourceId ( Aws::String && value )

inline

The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region.

Definition at line 1159 of file DBSnapshot.h.

◆ WithDbiResourceId() [2/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithDbiResourceId ( const Aws::String & value )

inline

The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region.

Definition at line 1153 of file DBSnapshot.h.

◆ WithDbiResourceId() [3/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithDbiResourceId ( const char * value )

inline

The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region.

Definition at line 1165 of file DBSnapshot.h.

◆ WithDBSnapshotArn() [1/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithDBSnapshotArn ( Aws::String && value )

inline

The Amazon Resource Name (ARN) for the DB snapshot.

Definition at line 972 of file DBSnapshot.h.

◆ WithDBSnapshotArn() [2/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithDBSnapshotArn ( const Aws::String & value )

inline

The Amazon Resource Name (ARN) for the DB snapshot.

Definition at line 967 of file DBSnapshot.h.

◆ WithDBSnapshotArn() [3/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithDBSnapshotArn ( const char * value )

inline

The Amazon Resource Name (ARN) for the DB snapshot.

Definition at line 977 of file DBSnapshot.h.

◆ WithDBSnapshotIdentifier() [1/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithDBSnapshotIdentifier ( Aws::String && value )

inline

Specifies the identifier for the DB snapshot.

Definition at line 81 of file DBSnapshot.h.

◆ WithDBSnapshotIdentifier() [2/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithDBSnapshotIdentifier ( const Aws::String & value )

inline

Specifies the identifier for the DB snapshot.

Definition at line 76 of file DBSnapshot.h.

◆ WithDBSnapshotIdentifier() [3/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithDBSnapshotIdentifier ( const char * value )

inline

Specifies the identifier for the DB snapshot.

Definition at line 86 of file DBSnapshot.h.

◆ WithEncrypted()

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithEncrypted ( bool value )

inline

Specifies whether the DB snapshot is encrypted.

Definition at line 879 of file DBSnapshot.h.

◆ WithEngine() [1/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithEngine ( Aws::String && value )

inline

Specifies the name of the database engine.

Definition at line 208 of file DBSnapshot.h.

◆ WithEngine() [2/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithEngine ( const Aws::String & value )

inline

Specifies the name of the database engine.

Definition at line 203 of file DBSnapshot.h.

◆ WithEngine() [3/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithEngine ( const char * value )

inline

Specifies the name of the database engine.

Definition at line 213 of file DBSnapshot.h.

◆ WithEngineVersion() [1/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithEngineVersion ( Aws::String && value )

inline

Specifies the version of the database engine.

Definition at line 504 of file DBSnapshot.h.

◆ WithEngineVersion() [2/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithEngineVersion ( const Aws::String & value )

inline

Specifies the version of the database engine.

Definition at line 499 of file DBSnapshot.h.

◆ WithEngineVersion() [3/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithEngineVersion ( const char * value )

inline

Specifies the version of the database engine.

Definition at line 509 of file DBSnapshot.h.

◆ WithIAMDatabaseAuthenticationEnabled()

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithIAMDatabaseAuthenticationEnabled ( bool value )

inline

True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

Definition at line 1067 of file DBSnapshot.h.

◆ WithInstanceCreateTime() [1/2]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithInstanceCreateTime ( Aws::Utils::DateTime && value )

inline

Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.

Definition at line 427 of file DBSnapshot.h.

◆ WithInstanceCreateTime() [2/2]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithInstanceCreateTime ( const Aws::Utils::DateTime & value )

inline

Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.

Definition at line 421 of file DBSnapshot.h.

◆ WithIops()

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithIops ( int value )

inline

Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.

Definition at line 616 of file DBSnapshot.h.

◆ WithKmsKeyId() [1/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithKmsKeyId ( Aws::String && value )

inline

If Encrypted is true, the AWS KMS key identifier for the encrypted DB snapshot.

The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).

Definition at line 929 of file DBSnapshot.h.

◆ WithKmsKeyId() [2/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithKmsKeyId ( const Aws::String & value )

inline

If Encrypted is true, the AWS KMS key identifier for the encrypted DB snapshot.

The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).

Definition at line 922 of file DBSnapshot.h.

◆ WithKmsKeyId() [3/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithKmsKeyId ( const char * value )

inline

If Encrypted is true, the AWS KMS key identifier for the encrypted DB snapshot.

The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).

Definition at line 936 of file DBSnapshot.h.

◆ WithLicenseModel() [1/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithLicenseModel ( Aws::String && value )

inline

License model information for the restored DB instance.

Definition at line 545 of file DBSnapshot.h.

◆ WithLicenseModel() [2/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithLicenseModel ( const Aws::String & value )

inline

License model information for the restored DB instance.

Definition at line 540 of file DBSnapshot.h.

◆ WithLicenseModel() [3/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithLicenseModel ( const char * value )

inline

License model information for the restored DB instance.

Definition at line 550 of file DBSnapshot.h.

◆ WithMasterUsername() [1/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithMasterUsername ( Aws::String && value )

inline

Provides the master username for the DB snapshot.

Definition at line 463 of file DBSnapshot.h.

◆ WithMasterUsername() [2/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithMasterUsername ( const Aws::String & value )

inline

Provides the master username for the DB snapshot.

Definition at line 458 of file DBSnapshot.h.

◆ WithMasterUsername() [3/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithMasterUsername ( const char * value )

inline

Provides the master username for the DB snapshot.

Definition at line 468 of file DBSnapshot.h.

◆ WithOptionGroupName() [1/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithOptionGroupName ( Aws::String && value )

inline

Provides the option group name for the DB snapshot.

Definition at line 652 of file DBSnapshot.h.

◆ WithOptionGroupName() [2/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithOptionGroupName ( const Aws::String & value )

inline

Provides the option group name for the DB snapshot.

Definition at line 647 of file DBSnapshot.h.

◆ WithOptionGroupName() [3/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithOptionGroupName ( const char * value )

inline

Provides the option group name for the DB snapshot.

Definition at line 657 of file DBSnapshot.h.

◆ WithPercentProgress()

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithPercentProgress ( int value )

inline

The percentage of the estimated data that has been transferred.

Definition at line 678 of file DBSnapshot.h.

◆ WithPort()

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithPort ( int value )

inline

Specifies the port that the database engine was listening on at the time of the snapshot.

Definition at line 300 of file DBSnapshot.h.

◆ WithProcessorFeatures() [1/2]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithProcessorFeatures ( Aws::Vector< ProcessorFeature > && value )

inline

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.

Definition at line 1104 of file DBSnapshot.h.

◆ WithProcessorFeatures() [2/2]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithProcessorFeatures ( const Aws::Vector< ProcessorFeature > & value )

inline

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.

Definition at line 1098 of file DBSnapshot.h.

◆ WithSnapshotCreateTime() [1/2]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithSnapshotCreateTime ( Aws::Utils::DateTime && value )

inline

Specifies when the snapshot was taken in Coordinated Universal Time (UTC).

Definition at line 172 of file DBSnapshot.h.

◆ WithSnapshotCreateTime() [2/2]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithSnapshotCreateTime ( const Aws::Utils::DateTime & value )

inline

Specifies when the snapshot was taken in Coordinated Universal Time (UTC).

Definition at line 166 of file DBSnapshot.h.

◆ WithSnapshotType() [1/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithSnapshotType ( Aws::String && value )

inline

Provides the type of the DB snapshot.

Definition at line 586 of file DBSnapshot.h.

◆ WithSnapshotType() [2/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithSnapshotType ( const Aws::String & value )

inline

Provides the type of the DB snapshot.

Definition at line 581 of file DBSnapshot.h.

◆ WithSnapshotType() [3/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithSnapshotType ( const char * value )

inline

Provides the type of the DB snapshot.

Definition at line 591 of file DBSnapshot.h.

◆ WithSourceDBSnapshotIdentifier() [1/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithSourceDBSnapshotIdentifier ( Aws::String && value )

inline

The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has value in case of cross-customer or cross-region copy.

Definition at line 762 of file DBSnapshot.h.

◆ WithSourceDBSnapshotIdentifier() [2/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithSourceDBSnapshotIdentifier ( const Aws::String & value )

inline

The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has value in case of cross-customer or cross-region copy.

Definition at line 756 of file DBSnapshot.h.

◆ WithSourceDBSnapshotIdentifier() [3/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithSourceDBSnapshotIdentifier ( const char * value )

inline

The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has value in case of cross-customer or cross-region copy.

Definition at line 768 of file DBSnapshot.h.

◆ WithSourceRegion() [1/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithSourceRegion ( Aws::String && value )

inline

The AWS Region that the DB snapshot was created in or copied from.

Definition at line 714 of file DBSnapshot.h.

◆ WithSourceRegion() [2/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithSourceRegion ( const Aws::String & value )

inline

The AWS Region that the DB snapshot was created in or copied from.

Definition at line 709 of file DBSnapshot.h.

◆ WithSourceRegion() [3/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithSourceRegion ( const char * value )

inline

The AWS Region that the DB snapshot was created in or copied from.

Definition at line 719 of file DBSnapshot.h.

◆ WithStatus() [1/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithStatus ( Aws::String && value )

inline

Specifies the status of this DB snapshot.

Definition at line 270 of file DBSnapshot.h.

◆ WithStatus() [2/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithStatus ( const Aws::String & value )

inline

Specifies the status of this DB snapshot.

Definition at line 265 of file DBSnapshot.h.

◆ WithStatus() [3/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithStatus ( const char * value )

inline

Specifies the status of this DB snapshot.

Definition at line 275 of file DBSnapshot.h.

◆ WithStorageType() [1/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithStorageType ( Aws::String && value )

inline

Specifies the storage type associated with DB snapshot.

Definition at line 804 of file DBSnapshot.h.

◆ WithStorageType() [2/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithStorageType ( const Aws::String & value )

inline

Specifies the storage type associated with DB snapshot.

Definition at line 799 of file DBSnapshot.h.

◆ WithStorageType() [3/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithStorageType ( const char * value )

inline

Specifies the storage type associated with DB snapshot.

Definition at line 809 of file DBSnapshot.h.

◆ WithTagList() [1/2]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithTagList ( Aws::Vector< Tag > && value )

inline

Definition at line 1184 of file DBSnapshot.h.

◆ WithTagList() [2/2]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithTagList ( const Aws::Vector< Tag > & value )

inline

Definition at line 1181 of file DBSnapshot.h.

◆ WithTdeCredentialArn() [1/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithTdeCredentialArn ( Aws::String && value )

inline

The ARN from the key store with which to associate the instance for TDE encryption.

Definition at line 852 of file DBSnapshot.h.

◆ WithTdeCredentialArn() [2/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithTdeCredentialArn ( const Aws::String & value )

inline

The ARN from the key store with which to associate the instance for TDE encryption.

Definition at line 846 of file DBSnapshot.h.

◆ WithTdeCredentialArn() [3/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithTdeCredentialArn ( const char * value )

inline

The ARN from the key store with which to associate the instance for TDE encryption.

Definition at line 858 of file DBSnapshot.h.

◆ WithTimezone() [1/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithTimezone ( Aws::String && value )

inline

The time zone of the DB snapshot. In most cases, the Timezone element is empty. Timezone content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.

Definition at line 1034 of file DBSnapshot.h.

◆ WithTimezone() [2/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithTimezone ( const Aws::String & value )

inline

The time zone of the DB snapshot. In most cases, the Timezone element is empty. Timezone content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.

Definition at line 1026 of file DBSnapshot.h.

◆ WithTimezone() [3/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithTimezone ( const char * value )

inline

The time zone of the DB snapshot. In most cases, the Timezone element is empty. Timezone content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.

Definition at line 1042 of file DBSnapshot.h.

◆ WithVpcId() [1/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithVpcId ( Aws::String && value )

inline

Provides the VPC ID associated with the DB snapshot.

Definition at line 385 of file DBSnapshot.h.

◆ WithVpcId() [2/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithVpcId ( const Aws::String & value )

inline

Provides the VPC ID associated with the DB snapshot.

Definition at line 380 of file DBSnapshot.h.

◆ WithVpcId() [3/3]

DBSnapshot& Aws::RDS::Model::DBSnapshot::WithVpcId ( const char * value )

inline

Provides the VPC ID associated with the DB snapshot.

Definition at line 390 of file DBSnapshot.h.

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

aws-cpp-sdk-rds/include/aws/rds/model/DBSnapshot.h

Public Member Functions

Detailed Description

See Also:

Constructor & Destructor Documentation

◆ DBSnapshot() [1/2]

◆ DBSnapshot() [2/2]

Member Function Documentation

◆ AddProcessorFeatures() [1/2]

◆ AddProcessorFeatures() [2/2]

◆ AddTagList() [1/2]

◆ AddTagList() [2/2]

◆ AllocatedStorageHasBeenSet()

◆ AvailabilityZoneHasBeenSet()

◆ DBInstanceIdentifierHasBeenSet()

◆ DbiResourceIdHasBeenSet()

◆ DBSnapshotArnHasBeenSet()

◆ DBSnapshotIdentifierHasBeenSet()

◆ EncryptedHasBeenSet()

◆ EngineHasBeenSet()

◆ EngineVersionHasBeenSet()

◆ GetAllocatedStorage()

◆ GetAvailabilityZone()

◆ GetDBInstanceIdentifier()

◆ GetDbiResourceId()

◆ GetDBSnapshotArn()

◆ GetDBSnapshotIdentifier()

◆ GetEncrypted()

◆ GetEngine()

◆ GetEngineVersion()

◆ GetIAMDatabaseAuthenticationEnabled()

◆ GetInstanceCreateTime()

◆ GetIops()

◆ GetKmsKeyId()

◆ GetLicenseModel()

◆ GetMasterUsername()

◆ GetOptionGroupName()

◆ GetPercentProgress()

◆ GetPort()

◆ GetProcessorFeatures()

◆ GetSnapshotCreateTime()

◆ GetSnapshotType()

◆ GetSourceDBSnapshotIdentifier()

◆ GetSourceRegion()

◆ GetStatus()

◆ GetStorageType()

◆ GetTagList()

◆ GetTdeCredentialArn()

◆ GetTimezone()

◆ GetVpcId()

◆ IAMDatabaseAuthenticationEnabledHasBeenSet()

◆ InstanceCreateTimeHasBeenSet()

◆ IopsHasBeenSet()

◆ KmsKeyIdHasBeenSet()

◆ LicenseModelHasBeenSet()

◆ MasterUsernameHasBeenSet()

◆ operator=()

◆ OptionGroupNameHasBeenSet()

◆ OutputToStream() [1/2]

◆ OutputToStream() [2/2]

◆ PercentProgressHasBeenSet()

◆ PortHasBeenSet()

◆ ProcessorFeaturesHasBeenSet()

◆ SetAllocatedStorage()

◆ SetAvailabilityZone() [1/3]

◆ SetAvailabilityZone() [2/3]

◆ SetAvailabilityZone() [3/3]

◆ SetDBInstanceIdentifier() [1/3]

◆ SetDBInstanceIdentifier() [2/3]

◆ SetDBInstanceIdentifier() [3/3]

◆ SetDbiResourceId() [1/3]

◆ SetDbiResourceId() [2/3]

◆ SetDbiResourceId() [3/3]

◆ SetDBSnapshotArn() [1/3]

◆ SetDBSnapshotArn() [2/3]

◆ SetDBSnapshotArn() [3/3]

◆ SetDBSnapshotIdentifier() [1/3]

◆ SetDBSnapshotIdentifier() [2/3]

◆ SetDBSnapshotIdentifier() [3/3]

◆ SetEncrypted()

◆ SetEngine() [1/3]