AWS SDK for C++  1.8.182
AWS SDK for C++
Public Member Functions | List of all members
Aws::RDS::Model::DBInstance Class Reference

#include <DBInstance.h>

Public Member Functions

 DBInstance ()
 
 DBInstance (const Aws::Utils::Xml::XmlNode &xmlNode)
 
DBInstanceoperator= (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::StringGetDBInstanceIdentifier () const
 
bool DBInstanceIdentifierHasBeenSet () const
 
void SetDBInstanceIdentifier (const Aws::String &value)
 
void SetDBInstanceIdentifier (Aws::String &&value)
 
void SetDBInstanceIdentifier (const char *value)
 
DBInstanceWithDBInstanceIdentifier (const Aws::String &value)
 
DBInstanceWithDBInstanceIdentifier (Aws::String &&value)
 
DBInstanceWithDBInstanceIdentifier (const char *value)
 
const Aws::StringGetDBInstanceClass () const
 
bool DBInstanceClassHasBeenSet () const
 
void SetDBInstanceClass (const Aws::String &value)
 
void SetDBInstanceClass (Aws::String &&value)
 
void SetDBInstanceClass (const char *value)
 
DBInstanceWithDBInstanceClass (const Aws::String &value)
 
DBInstanceWithDBInstanceClass (Aws::String &&value)
 
DBInstanceWithDBInstanceClass (const char *value)
 
const Aws::StringGetEngine () const
 
bool EngineHasBeenSet () const
 
void SetEngine (const Aws::String &value)
 
void SetEngine (Aws::String &&value)
 
void SetEngine (const char *value)
 
DBInstanceWithEngine (const Aws::String &value)
 
DBInstanceWithEngine (Aws::String &&value)
 
DBInstanceWithEngine (const char *value)
 
const Aws::StringGetDBInstanceStatus () const
 
bool DBInstanceStatusHasBeenSet () const
 
void SetDBInstanceStatus (const Aws::String &value)
 
void SetDBInstanceStatus (Aws::String &&value)
 
void SetDBInstanceStatus (const char *value)
 
DBInstanceWithDBInstanceStatus (const Aws::String &value)
 
DBInstanceWithDBInstanceStatus (Aws::String &&value)
 
DBInstanceWithDBInstanceStatus (const char *value)
 
const Aws::StringGetMasterUsername () const
 
bool MasterUsernameHasBeenSet () const
 
void SetMasterUsername (const Aws::String &value)
 
void SetMasterUsername (Aws::String &&value)
 
void SetMasterUsername (const char *value)
 
DBInstanceWithMasterUsername (const Aws::String &value)
 
DBInstanceWithMasterUsername (Aws::String &&value)
 
DBInstanceWithMasterUsername (const char *value)
 
const Aws::StringGetDBName () const
 
bool DBNameHasBeenSet () const
 
void SetDBName (const Aws::String &value)
 
void SetDBName (Aws::String &&value)
 
void SetDBName (const char *value)
 
DBInstanceWithDBName (const Aws::String &value)
 
DBInstanceWithDBName (Aws::String &&value)
 
DBInstanceWithDBName (const char *value)
 
const EndpointGetEndpoint () const
 
bool EndpointHasBeenSet () const
 
void SetEndpoint (const Endpoint &value)
 
void SetEndpoint (Endpoint &&value)
 
DBInstanceWithEndpoint (const Endpoint &value)
 
DBInstanceWithEndpoint (Endpoint &&value)
 
int GetAllocatedStorage () const
 
bool AllocatedStorageHasBeenSet () const
 
void SetAllocatedStorage (int value)
 
DBInstanceWithAllocatedStorage (int value)
 
const Aws::Utils::DateTimeGetInstanceCreateTime () const
 
bool InstanceCreateTimeHasBeenSet () const
 
void SetInstanceCreateTime (const Aws::Utils::DateTime &value)
 
void SetInstanceCreateTime (Aws::Utils::DateTime &&value)
 
DBInstanceWithInstanceCreateTime (const Aws::Utils::DateTime &value)
 
DBInstanceWithInstanceCreateTime (Aws::Utils::DateTime &&value)
 
const Aws::StringGetPreferredBackupWindow () const
 
bool PreferredBackupWindowHasBeenSet () const
 
void SetPreferredBackupWindow (const Aws::String &value)
 
void SetPreferredBackupWindow (Aws::String &&value)
 
void SetPreferredBackupWindow (const char *value)
 
DBInstanceWithPreferredBackupWindow (const Aws::String &value)
 
DBInstanceWithPreferredBackupWindow (Aws::String &&value)
 
DBInstanceWithPreferredBackupWindow (const char *value)
 
int GetBackupRetentionPeriod () const
 
bool BackupRetentionPeriodHasBeenSet () const
 
void SetBackupRetentionPeriod (int value)
 
DBInstanceWithBackupRetentionPeriod (int value)
 
const Aws::Vector< DBSecurityGroupMembership > & GetDBSecurityGroups () const
 
bool DBSecurityGroupsHasBeenSet () const
 
void SetDBSecurityGroups (const Aws::Vector< DBSecurityGroupMembership > &value)
 
void SetDBSecurityGroups (Aws::Vector< DBSecurityGroupMembership > &&value)
 
DBInstanceWithDBSecurityGroups (const Aws::Vector< DBSecurityGroupMembership > &value)
 
DBInstanceWithDBSecurityGroups (Aws::Vector< DBSecurityGroupMembership > &&value)
 
DBInstanceAddDBSecurityGroups (const DBSecurityGroupMembership &value)
 
DBInstanceAddDBSecurityGroups (DBSecurityGroupMembership &&value)
 
const Aws::Vector< VpcSecurityGroupMembership > & GetVpcSecurityGroups () const
 
bool VpcSecurityGroupsHasBeenSet () const
 
void SetVpcSecurityGroups (const Aws::Vector< VpcSecurityGroupMembership > &value)
 
void SetVpcSecurityGroups (Aws::Vector< VpcSecurityGroupMembership > &&value)
 
DBInstanceWithVpcSecurityGroups (const Aws::Vector< VpcSecurityGroupMembership > &value)
 
DBInstanceWithVpcSecurityGroups (Aws::Vector< VpcSecurityGroupMembership > &&value)
 
DBInstanceAddVpcSecurityGroups (const VpcSecurityGroupMembership &value)
 
DBInstanceAddVpcSecurityGroups (VpcSecurityGroupMembership &&value)
 
const Aws::Vector< DBParameterGroupStatus > & GetDBParameterGroups () const
 
bool DBParameterGroupsHasBeenSet () const
 
void SetDBParameterGroups (const Aws::Vector< DBParameterGroupStatus > &value)
 
void SetDBParameterGroups (Aws::Vector< DBParameterGroupStatus > &&value)
 
DBInstanceWithDBParameterGroups (const Aws::Vector< DBParameterGroupStatus > &value)
 
DBInstanceWithDBParameterGroups (Aws::Vector< DBParameterGroupStatus > &&value)
 
DBInstanceAddDBParameterGroups (const DBParameterGroupStatus &value)
 
DBInstanceAddDBParameterGroups (DBParameterGroupStatus &&value)
 
const Aws::StringGetAvailabilityZone () const
 
bool AvailabilityZoneHasBeenSet () const
 
void SetAvailabilityZone (const Aws::String &value)
 
void SetAvailabilityZone (Aws::String &&value)
 
void SetAvailabilityZone (const char *value)
 
DBInstanceWithAvailabilityZone (const Aws::String &value)
 
DBInstanceWithAvailabilityZone (Aws::String &&value)
 
DBInstanceWithAvailabilityZone (const char *value)
 
const DBSubnetGroupGetDBSubnetGroup () const
 
bool DBSubnetGroupHasBeenSet () const
 
void SetDBSubnetGroup (const DBSubnetGroup &value)
 
void SetDBSubnetGroup (DBSubnetGroup &&value)
 
DBInstanceWithDBSubnetGroup (const DBSubnetGroup &value)
 
DBInstanceWithDBSubnetGroup (DBSubnetGroup &&value)
 
const Aws::StringGetPreferredMaintenanceWindow () const
 
bool PreferredMaintenanceWindowHasBeenSet () const
 
void SetPreferredMaintenanceWindow (const Aws::String &value)
 
void SetPreferredMaintenanceWindow (Aws::String &&value)
 
void SetPreferredMaintenanceWindow (const char *value)
 
DBInstanceWithPreferredMaintenanceWindow (const Aws::String &value)
 
DBInstanceWithPreferredMaintenanceWindow (Aws::String &&value)
 
DBInstanceWithPreferredMaintenanceWindow (const char *value)
 
const PendingModifiedValuesGetPendingModifiedValues () const
 
bool PendingModifiedValuesHasBeenSet () const
 
void SetPendingModifiedValues (const PendingModifiedValues &value)
 
void SetPendingModifiedValues (PendingModifiedValues &&value)
 
DBInstanceWithPendingModifiedValues (const PendingModifiedValues &value)
 
DBInstanceWithPendingModifiedValues (PendingModifiedValues &&value)
 
const Aws::Utils::DateTimeGetLatestRestorableTime () const
 
bool LatestRestorableTimeHasBeenSet () const
 
void SetLatestRestorableTime (const Aws::Utils::DateTime &value)
 
void SetLatestRestorableTime (Aws::Utils::DateTime &&value)
 
DBInstanceWithLatestRestorableTime (const Aws::Utils::DateTime &value)
 
DBInstanceWithLatestRestorableTime (Aws::Utils::DateTime &&value)
 
bool GetMultiAZ () const
 
bool MultiAZHasBeenSet () const
 
void SetMultiAZ (bool value)
 
DBInstanceWithMultiAZ (bool value)
 
const Aws::StringGetEngineVersion () const
 
bool EngineVersionHasBeenSet () const
 
void SetEngineVersion (const Aws::String &value)
 
void SetEngineVersion (Aws::String &&value)
 
void SetEngineVersion (const char *value)
 
DBInstanceWithEngineVersion (const Aws::String &value)
 
DBInstanceWithEngineVersion (Aws::String &&value)
 
DBInstanceWithEngineVersion (const char *value)
 
bool GetAutoMinorVersionUpgrade () const
 
bool AutoMinorVersionUpgradeHasBeenSet () const
 
void SetAutoMinorVersionUpgrade (bool value)
 
DBInstanceWithAutoMinorVersionUpgrade (bool value)
 
const Aws::StringGetReadReplicaSourceDBInstanceIdentifier () const
 
bool ReadReplicaSourceDBInstanceIdentifierHasBeenSet () const
 
void SetReadReplicaSourceDBInstanceIdentifier (const Aws::String &value)
 
void SetReadReplicaSourceDBInstanceIdentifier (Aws::String &&value)
 
void SetReadReplicaSourceDBInstanceIdentifier (const char *value)
 
DBInstanceWithReadReplicaSourceDBInstanceIdentifier (const Aws::String &value)
 
DBInstanceWithReadReplicaSourceDBInstanceIdentifier (Aws::String &&value)
 
DBInstanceWithReadReplicaSourceDBInstanceIdentifier (const char *value)
 
const Aws::Vector< Aws::String > & GetReadReplicaDBInstanceIdentifiers () const
 
bool ReadReplicaDBInstanceIdentifiersHasBeenSet () const
 
void SetReadReplicaDBInstanceIdentifiers (const Aws::Vector< Aws::String > &value)
 
void SetReadReplicaDBInstanceIdentifiers (Aws::Vector< Aws::String > &&value)
 
DBInstanceWithReadReplicaDBInstanceIdentifiers (const Aws::Vector< Aws::String > &value)
 
DBInstanceWithReadReplicaDBInstanceIdentifiers (Aws::Vector< Aws::String > &&value)
 
DBInstanceAddReadReplicaDBInstanceIdentifiers (const Aws::String &value)
 
DBInstanceAddReadReplicaDBInstanceIdentifiers (Aws::String &&value)
 
DBInstanceAddReadReplicaDBInstanceIdentifiers (const char *value)
 
const Aws::Vector< Aws::String > & GetReadReplicaDBClusterIdentifiers () const
 
bool ReadReplicaDBClusterIdentifiersHasBeenSet () const
 
void SetReadReplicaDBClusterIdentifiers (const Aws::Vector< Aws::String > &value)
 
void SetReadReplicaDBClusterIdentifiers (Aws::Vector< Aws::String > &&value)
 
DBInstanceWithReadReplicaDBClusterIdentifiers (const Aws::Vector< Aws::String > &value)
 
DBInstanceWithReadReplicaDBClusterIdentifiers (Aws::Vector< Aws::String > &&value)
 
DBInstanceAddReadReplicaDBClusterIdentifiers (const Aws::String &value)
 
DBInstanceAddReadReplicaDBClusterIdentifiers (Aws::String &&value)
 
DBInstanceAddReadReplicaDBClusterIdentifiers (const char *value)
 
const ReplicaModeGetReplicaMode () const
 
bool ReplicaModeHasBeenSet () const
 
void SetReplicaMode (const ReplicaMode &value)
 
void SetReplicaMode (ReplicaMode &&value)
 
DBInstanceWithReplicaMode (const ReplicaMode &value)
 
DBInstanceWithReplicaMode (ReplicaMode &&value)
 
const Aws::StringGetLicenseModel () const
 
bool LicenseModelHasBeenSet () const
 
void SetLicenseModel (const Aws::String &value)
 
void SetLicenseModel (Aws::String &&value)
 
void SetLicenseModel (const char *value)
 
DBInstanceWithLicenseModel (const Aws::String &value)
 
DBInstanceWithLicenseModel (Aws::String &&value)
 
DBInstanceWithLicenseModel (const char *value)
 
int GetIops () const
 
bool IopsHasBeenSet () const
 
void SetIops (int value)
 
DBInstanceWithIops (int value)
 
const Aws::Vector< OptionGroupMembership > & GetOptionGroupMemberships () const
 
bool OptionGroupMembershipsHasBeenSet () const
 
void SetOptionGroupMemberships (const Aws::Vector< OptionGroupMembership > &value)
 
void SetOptionGroupMemberships (Aws::Vector< OptionGroupMembership > &&value)
 
DBInstanceWithOptionGroupMemberships (const Aws::Vector< OptionGroupMembership > &value)
 
DBInstanceWithOptionGroupMemberships (Aws::Vector< OptionGroupMembership > &&value)
 
DBInstanceAddOptionGroupMemberships (const OptionGroupMembership &value)
 
DBInstanceAddOptionGroupMemberships (OptionGroupMembership &&value)
 
const Aws::StringGetCharacterSetName () const
 
bool CharacterSetNameHasBeenSet () const
 
void SetCharacterSetName (const Aws::String &value)
 
void SetCharacterSetName (Aws::String &&value)
 
void SetCharacterSetName (const char *value)
 
DBInstanceWithCharacterSetName (const Aws::String &value)
 
DBInstanceWithCharacterSetName (Aws::String &&value)
 
DBInstanceWithCharacterSetName (const char *value)
 
const Aws::StringGetNcharCharacterSetName () const
 
bool NcharCharacterSetNameHasBeenSet () const
 
void SetNcharCharacterSetName (const Aws::String &value)
 
void SetNcharCharacterSetName (Aws::String &&value)
 
void SetNcharCharacterSetName (const char *value)
 
DBInstanceWithNcharCharacterSetName (const Aws::String &value)
 
DBInstanceWithNcharCharacterSetName (Aws::String &&value)
 
DBInstanceWithNcharCharacterSetName (const char *value)
 
const Aws::StringGetSecondaryAvailabilityZone () const
 
bool SecondaryAvailabilityZoneHasBeenSet () const
 
void SetSecondaryAvailabilityZone (const Aws::String &value)
 
void SetSecondaryAvailabilityZone (Aws::String &&value)
 
void SetSecondaryAvailabilityZone (const char *value)
 
DBInstanceWithSecondaryAvailabilityZone (const Aws::String &value)
 
DBInstanceWithSecondaryAvailabilityZone (Aws::String &&value)
 
DBInstanceWithSecondaryAvailabilityZone (const char *value)
 
bool GetPubliclyAccessible () const
 
bool PubliclyAccessibleHasBeenSet () const
 
void SetPubliclyAccessible (bool value)
 
DBInstanceWithPubliclyAccessible (bool value)
 
const Aws::Vector< DBInstanceStatusInfo > & GetStatusInfos () const
 
bool StatusInfosHasBeenSet () const
 
void SetStatusInfos (const Aws::Vector< DBInstanceStatusInfo > &value)
 
void SetStatusInfos (Aws::Vector< DBInstanceStatusInfo > &&value)
 
DBInstanceWithStatusInfos (const Aws::Vector< DBInstanceStatusInfo > &value)
 
DBInstanceWithStatusInfos (Aws::Vector< DBInstanceStatusInfo > &&value)
 
DBInstanceAddStatusInfos (const DBInstanceStatusInfo &value)
 
DBInstanceAddStatusInfos (DBInstanceStatusInfo &&value)
 
const Aws::StringGetStorageType () const
 
bool StorageTypeHasBeenSet () const
 
void SetStorageType (const Aws::String &value)
 
void SetStorageType (Aws::String &&value)
 
void SetStorageType (const char *value)
 
DBInstanceWithStorageType (const Aws::String &value)
 
DBInstanceWithStorageType (Aws::String &&value)
 
DBInstanceWithStorageType (const char *value)
 
const Aws::StringGetTdeCredentialArn () const
 
bool TdeCredentialArnHasBeenSet () const
 
void SetTdeCredentialArn (const Aws::String &value)
 
void SetTdeCredentialArn (Aws::String &&value)
 
void SetTdeCredentialArn (const char *value)
 
DBInstanceWithTdeCredentialArn (const Aws::String &value)
 
DBInstanceWithTdeCredentialArn (Aws::String &&value)
 
DBInstanceWithTdeCredentialArn (const char *value)
 
int GetDbInstancePort () const
 
bool DbInstancePortHasBeenSet () const
 
void SetDbInstancePort (int value)
 
DBInstanceWithDbInstancePort (int value)
 
const Aws::StringGetDBClusterIdentifier () const
 
bool DBClusterIdentifierHasBeenSet () const
 
void SetDBClusterIdentifier (const Aws::String &value)
 
void SetDBClusterIdentifier (Aws::String &&value)
 
void SetDBClusterIdentifier (const char *value)
 
DBInstanceWithDBClusterIdentifier (const Aws::String &value)
 
DBInstanceWithDBClusterIdentifier (Aws::String &&value)
 
DBInstanceWithDBClusterIdentifier (const char *value)
 
bool GetStorageEncrypted () const
 
bool StorageEncryptedHasBeenSet () const
 
void SetStorageEncrypted (bool value)
 
DBInstanceWithStorageEncrypted (bool value)
 
const Aws::StringGetKmsKeyId () const
 
bool KmsKeyIdHasBeenSet () const
 
void SetKmsKeyId (const Aws::String &value)
 
void SetKmsKeyId (Aws::String &&value)
 
void SetKmsKeyId (const char *value)
 
DBInstanceWithKmsKeyId (const Aws::String &value)
 
DBInstanceWithKmsKeyId (Aws::String &&value)
 
DBInstanceWithKmsKeyId (const char *value)
 
const Aws::StringGetDbiResourceId () const
 
bool DbiResourceIdHasBeenSet () const
 
void SetDbiResourceId (const Aws::String &value)
 
void SetDbiResourceId (Aws::String &&value)
 
void SetDbiResourceId (const char *value)
 
DBInstanceWithDbiResourceId (const Aws::String &value)
 
DBInstanceWithDbiResourceId (Aws::String &&value)
 
DBInstanceWithDbiResourceId (const char *value)
 
const Aws::StringGetCACertificateIdentifier () const
 
bool CACertificateIdentifierHasBeenSet () const
 
void SetCACertificateIdentifier (const Aws::String &value)
 
void SetCACertificateIdentifier (Aws::String &&value)
 
void SetCACertificateIdentifier (const char *value)
 
DBInstanceWithCACertificateIdentifier (const Aws::String &value)
 
DBInstanceWithCACertificateIdentifier (Aws::String &&value)
 
DBInstanceWithCACertificateIdentifier (const char *value)
 
const Aws::Vector< DomainMembership > & GetDomainMemberships () const
 
bool DomainMembershipsHasBeenSet () const
 
void SetDomainMemberships (const Aws::Vector< DomainMembership > &value)
 
void SetDomainMemberships (Aws::Vector< DomainMembership > &&value)
 
DBInstanceWithDomainMemberships (const Aws::Vector< DomainMembership > &value)
 
DBInstanceWithDomainMemberships (Aws::Vector< DomainMembership > &&value)
 
DBInstanceAddDomainMemberships (const DomainMembership &value)
 
DBInstanceAddDomainMemberships (DomainMembership &&value)
 
bool GetCopyTagsToSnapshot () const
 
bool CopyTagsToSnapshotHasBeenSet () const
 
void SetCopyTagsToSnapshot (bool value)
 
DBInstanceWithCopyTagsToSnapshot (bool value)
 
int GetMonitoringInterval () const
 
bool MonitoringIntervalHasBeenSet () const
 
void SetMonitoringInterval (int value)
 
DBInstanceWithMonitoringInterval (int value)
 
const Aws::StringGetEnhancedMonitoringResourceArn () const
 
bool EnhancedMonitoringResourceArnHasBeenSet () const
 
void SetEnhancedMonitoringResourceArn (const Aws::String &value)
 
void SetEnhancedMonitoringResourceArn (Aws::String &&value)
 
void SetEnhancedMonitoringResourceArn (const char *value)
 
DBInstanceWithEnhancedMonitoringResourceArn (const Aws::String &value)
 
DBInstanceWithEnhancedMonitoringResourceArn (Aws::String &&value)
 
DBInstanceWithEnhancedMonitoringResourceArn (const char *value)
 
const Aws::StringGetMonitoringRoleArn () const
 
bool MonitoringRoleArnHasBeenSet () const
 
void SetMonitoringRoleArn (const Aws::String &value)
 
void SetMonitoringRoleArn (Aws::String &&value)
 
void SetMonitoringRoleArn (const char *value)
 
DBInstanceWithMonitoringRoleArn (const Aws::String &value)
 
DBInstanceWithMonitoringRoleArn (Aws::String &&value)
 
DBInstanceWithMonitoringRoleArn (const char *value)
 
int GetPromotionTier () const
 
bool PromotionTierHasBeenSet () const
 
void SetPromotionTier (int value)
 
DBInstanceWithPromotionTier (int value)
 
const Aws::StringGetDBInstanceArn () const
 
bool DBInstanceArnHasBeenSet () const
 
void SetDBInstanceArn (const Aws::String &value)
 
void SetDBInstanceArn (Aws::String &&value)
 
void SetDBInstanceArn (const char *value)
 
DBInstanceWithDBInstanceArn (const Aws::String &value)
 
DBInstanceWithDBInstanceArn (Aws::String &&value)
 
DBInstanceWithDBInstanceArn (const char *value)
 
const Aws::StringGetTimezone () const
 
bool TimezoneHasBeenSet () const
 
void SetTimezone (const Aws::String &value)
 
void SetTimezone (Aws::String &&value)
 
void SetTimezone (const char *value)
 
DBInstanceWithTimezone (const Aws::String &value)
 
DBInstanceWithTimezone (Aws::String &&value)
 
DBInstanceWithTimezone (const char *value)
 
bool GetIAMDatabaseAuthenticationEnabled () const
 
bool IAMDatabaseAuthenticationEnabledHasBeenSet () const
 
void SetIAMDatabaseAuthenticationEnabled (bool value)
 
DBInstanceWithIAMDatabaseAuthenticationEnabled (bool value)
 
bool GetPerformanceInsightsEnabled () const
 
bool PerformanceInsightsEnabledHasBeenSet () const
 
void SetPerformanceInsightsEnabled (bool value)
 
DBInstanceWithPerformanceInsightsEnabled (bool value)
 
const Aws::StringGetPerformanceInsightsKMSKeyId () const
 
bool PerformanceInsightsKMSKeyIdHasBeenSet () const
 
void SetPerformanceInsightsKMSKeyId (const Aws::String &value)
 
void SetPerformanceInsightsKMSKeyId (Aws::String &&value)
 
void SetPerformanceInsightsKMSKeyId (const char *value)
 
DBInstanceWithPerformanceInsightsKMSKeyId (const Aws::String &value)
 
DBInstanceWithPerformanceInsightsKMSKeyId (Aws::String &&value)
 
DBInstanceWithPerformanceInsightsKMSKeyId (const char *value)
 
int GetPerformanceInsightsRetentionPeriod () const
 
bool PerformanceInsightsRetentionPeriodHasBeenSet () const
 
void SetPerformanceInsightsRetentionPeriod (int value)
 
DBInstanceWithPerformanceInsightsRetentionPeriod (int value)
 
const Aws::Vector< Aws::String > & GetEnabledCloudwatchLogsExports () const
 
bool EnabledCloudwatchLogsExportsHasBeenSet () const
 
void SetEnabledCloudwatchLogsExports (const Aws::Vector< Aws::String > &value)
 
void SetEnabledCloudwatchLogsExports (Aws::Vector< Aws::String > &&value)
 
DBInstanceWithEnabledCloudwatchLogsExports (const Aws::Vector< Aws::String > &value)
 
DBInstanceWithEnabledCloudwatchLogsExports (Aws::Vector< Aws::String > &&value)
 
DBInstanceAddEnabledCloudwatchLogsExports (const Aws::String &value)
 
DBInstanceAddEnabledCloudwatchLogsExports (Aws::String &&value)
 
DBInstanceAddEnabledCloudwatchLogsExports (const char *value)
 
const Aws::Vector< ProcessorFeature > & GetProcessorFeatures () const
 
bool ProcessorFeaturesHasBeenSet () const
 
void SetProcessorFeatures (const Aws::Vector< ProcessorFeature > &value)
 
void SetProcessorFeatures (Aws::Vector< ProcessorFeature > &&value)
 
DBInstanceWithProcessorFeatures (const Aws::Vector< ProcessorFeature > &value)
 
DBInstanceWithProcessorFeatures (Aws::Vector< ProcessorFeature > &&value)
 
DBInstanceAddProcessorFeatures (const ProcessorFeature &value)
 
DBInstanceAddProcessorFeatures (ProcessorFeature &&value)
 
bool GetDeletionProtection () const
 
bool DeletionProtectionHasBeenSet () const
 
void SetDeletionProtection (bool value)
 
DBInstanceWithDeletionProtection (bool value)
 
const Aws::Vector< DBInstanceRole > & GetAssociatedRoles () const
 
bool AssociatedRolesHasBeenSet () const
 
void SetAssociatedRoles (const Aws::Vector< DBInstanceRole > &value)
 
void SetAssociatedRoles (Aws::Vector< DBInstanceRole > &&value)
 
DBInstanceWithAssociatedRoles (const Aws::Vector< DBInstanceRole > &value)
 
DBInstanceWithAssociatedRoles (Aws::Vector< DBInstanceRole > &&value)
 
DBInstanceAddAssociatedRoles (const DBInstanceRole &value)
 
DBInstanceAddAssociatedRoles (DBInstanceRole &&value)
 
const EndpointGetListenerEndpoint () const
 
bool ListenerEndpointHasBeenSet () const
 
void SetListenerEndpoint (const Endpoint &value)
 
void SetListenerEndpoint (Endpoint &&value)
 
DBInstanceWithListenerEndpoint (const Endpoint &value)
 
DBInstanceWithListenerEndpoint (Endpoint &&value)
 
int GetMaxAllocatedStorage () const
 
bool MaxAllocatedStorageHasBeenSet () const
 
void SetMaxAllocatedStorage (int value)
 
DBInstanceWithMaxAllocatedStorage (int value)
 
const Aws::Vector< Tag > & GetTagList () const
 
bool TagListHasBeenSet () const
 
void SetTagList (const Aws::Vector< Tag > &value)
 
void SetTagList (Aws::Vector< Tag > &&value)
 
DBInstanceWithTagList (const Aws::Vector< Tag > &value)
 
DBInstanceWithTagList (Aws::Vector< Tag > &&value)
 
DBInstanceAddTagList (const Tag &value)
 
DBInstanceAddTagList (Tag &&value)
 
const Aws::Vector< DBInstanceAutomatedBackupsReplication > & GetDBInstanceAutomatedBackupsReplications () const
 
bool DBInstanceAutomatedBackupsReplicationsHasBeenSet () const
 
void SetDBInstanceAutomatedBackupsReplications (const Aws::Vector< DBInstanceAutomatedBackupsReplication > &value)
 
void SetDBInstanceAutomatedBackupsReplications (Aws::Vector< DBInstanceAutomatedBackupsReplication > &&value)
 
DBInstanceWithDBInstanceAutomatedBackupsReplications (const Aws::Vector< DBInstanceAutomatedBackupsReplication > &value)
 
DBInstanceWithDBInstanceAutomatedBackupsReplications (Aws::Vector< DBInstanceAutomatedBackupsReplication > &&value)
 
DBInstanceAddDBInstanceAutomatedBackupsReplications (const DBInstanceAutomatedBackupsReplication &value)
 
DBInstanceAddDBInstanceAutomatedBackupsReplications (DBInstanceAutomatedBackupsReplication &&value)
 
bool GetCustomerOwnedIpEnabled () const
 
bool CustomerOwnedIpEnabledHasBeenSet () const
 
void SetCustomerOwnedIpEnabled (bool value)
 
DBInstanceWithCustomerOwnedIpEnabled (bool value)
 
const Aws::StringGetAwsBackupRecoveryPointArn () const
 
bool AwsBackupRecoveryPointArnHasBeenSet () const
 
void SetAwsBackupRecoveryPointArn (const Aws::String &value)
 
void SetAwsBackupRecoveryPointArn (Aws::String &&value)
 
void SetAwsBackupRecoveryPointArn (const char *value)
 
DBInstanceWithAwsBackupRecoveryPointArn (const Aws::String &value)
 
DBInstanceWithAwsBackupRecoveryPointArn (Aws::String &&value)
 
DBInstanceWithAwsBackupRecoveryPointArn (const char *value)
 

Detailed Description

Contains the details of an Amazon RDS DB instance.

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

See Also:

AWS API Reference

Definition at line 49 of file DBInstance.h.

Constructor & Destructor Documentation

◆ DBInstance() [1/2]

Aws::RDS::Model::DBInstance::DBInstance ( )

◆ DBInstance() [2/2]

Aws::RDS::Model::DBInstance::DBInstance ( const Aws::Utils::Xml::XmlNode xmlNode)

Member Function Documentation

◆ AddAssociatedRoles() [1/2]

DBInstance& Aws::RDS::Model::DBInstance::AddAssociatedRoles ( const DBInstanceRole value)
inline

The AWS Identity and Access Management (IAM) roles associated with the DB instance.

Definition at line 2680 of file DBInstance.h.

◆ AddAssociatedRoles() [2/2]

DBInstance& Aws::RDS::Model::DBInstance::AddAssociatedRoles ( DBInstanceRole &&  value)
inline

The AWS Identity and Access Management (IAM) roles associated with the DB instance.

Definition at line 2686 of file DBInstance.h.

◆ AddDBInstanceAutomatedBackupsReplications() [1/2]

DBInstance& Aws::RDS::Model::DBInstance::AddDBInstanceAutomatedBackupsReplications ( const DBInstanceAutomatedBackupsReplication value)
inline

The list of replicated automated backups associated with the DB instance.

Definition at line 2803 of file DBInstance.h.

◆ AddDBInstanceAutomatedBackupsReplications() [2/2]

DBInstance& Aws::RDS::Model::DBInstance::AddDBInstanceAutomatedBackupsReplications ( DBInstanceAutomatedBackupsReplication &&  value)
inline

The list of replicated automated backups associated with the DB instance.

Definition at line 2808 of file DBInstance.h.

◆ AddDBParameterGroups() [1/2]

DBInstance& Aws::RDS::Model::DBInstance::AddDBParameterGroups ( const DBParameterGroupStatus value)
inline

Provides the list of DB parameter groups applied to this DB instance.

Definition at line 706 of file DBInstance.h.

◆ AddDBParameterGroups() [2/2]

DBInstance& Aws::RDS::Model::DBInstance::AddDBParameterGroups ( DBParameterGroupStatus &&  value)
inline

Provides the list of DB parameter groups applied to this DB instance.

Definition at line 711 of file DBInstance.h.

◆ AddDBSecurityGroups() [1/2]

DBInstance& Aws::RDS::Model::DBInstance::AddDBSecurityGroups ( const DBSecurityGroupMembership value)
inline

A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

Definition at line 614 of file DBInstance.h.

◆ AddDBSecurityGroups() [2/2]

DBInstance& Aws::RDS::Model::DBInstance::AddDBSecurityGroups ( DBSecurityGroupMembership &&  value)
inline

A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

Definition at line 621 of file DBInstance.h.

◆ AddDomainMemberships() [1/2]

DBInstance& Aws::RDS::Model::DBInstance::AddDomainMemberships ( const DomainMembership value)
inline

The Active Directory Domain membership records associated with the DB instance.

Definition at line 2012 of file DBInstance.h.

◆ AddDomainMemberships() [2/2]

DBInstance& Aws::RDS::Model::DBInstance::AddDomainMemberships ( DomainMembership &&  value)
inline

The Active Directory Domain membership records associated with the DB instance.

Definition at line 2018 of file DBInstance.h.

◆ AddEnabledCloudwatchLogsExports() [1/3]

DBInstance& Aws::RDS::Model::DBInstance::AddEnabledCloudwatchLogsExports ( Aws::String &&  value)
inline

A list of log types that this DB instance is configured to export to CloudWatch Logs.

Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon RDS User Guide.

Definition at line 2542 of file DBInstance.h.

◆ AddEnabledCloudwatchLogsExports() [2/3]

DBInstance& Aws::RDS::Model::DBInstance::AddEnabledCloudwatchLogsExports ( const Aws::String value)
inline

A list of log types that this DB instance is configured to export to CloudWatch Logs.

Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon RDS User Guide.

Definition at line 2533 of file DBInstance.h.

◆ AddEnabledCloudwatchLogsExports() [3/3]

DBInstance& Aws::RDS::Model::DBInstance::AddEnabledCloudwatchLogsExports ( const char *  value)
inline

A list of log types that this DB instance is configured to export to CloudWatch Logs.

Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon RDS User Guide.

Definition at line 2551 of file DBInstance.h.

◆ AddOptionGroupMemberships() [1/2]

DBInstance& Aws::RDS::Model::DBInstance::AddOptionGroupMemberships ( const OptionGroupMembership value)
inline

Provides the list of option group memberships for this DB instance.

Definition at line 1367 of file DBInstance.h.

◆ AddOptionGroupMemberships() [2/2]

DBInstance& Aws::RDS::Model::DBInstance::AddOptionGroupMemberships ( OptionGroupMembership &&  value)
inline

Provides the list of option group memberships for this DB instance.

Definition at line 1372 of file DBInstance.h.

◆ AddProcessorFeatures() [1/2]

DBInstance& Aws::RDS::Model::DBInstance::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.

Definition at line 2594 of file DBInstance.h.

◆ AddProcessorFeatures() [2/2]

DBInstance& Aws::RDS::Model::DBInstance::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.

Definition at line 2600 of file DBInstance.h.

◆ AddReadReplicaDBClusterIdentifiers() [1/3]

DBInstance& Aws::RDS::Model::DBInstance::AddReadReplicaDBClusterIdentifiers ( Aws::String &&  value)
inline

Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output does not contain information about cross region Aurora read replicas.

Currently, each RDS DB instance can have only one Aurora read replica.

Definition at line 1198 of file DBInstance.h.

◆ AddReadReplicaDBClusterIdentifiers() [2/3]

DBInstance& Aws::RDS::Model::DBInstance::AddReadReplicaDBClusterIdentifiers ( const Aws::String value)
inline

Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output does not contain information about cross region Aurora read replicas.

Currently, each RDS DB instance can have only one Aurora read replica.

Definition at line 1188 of file DBInstance.h.

◆ AddReadReplicaDBClusterIdentifiers() [3/3]

DBInstance& Aws::RDS::Model::DBInstance::AddReadReplicaDBClusterIdentifiers ( const char *  value)
inline

Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output does not contain information about cross region Aurora read replicas.

Currently, each RDS DB instance can have only one Aurora read replica.

Definition at line 1208 of file DBInstance.h.

◆ AddReadReplicaDBInstanceIdentifiers() [1/3]

DBInstance& Aws::RDS::Model::DBInstance::AddReadReplicaDBInstanceIdentifiers ( Aws::String &&  value)
inline

Contains one or more identifiers of the read replicas associated with this DB instance.

Definition at line 1111 of file DBInstance.h.

◆ AddReadReplicaDBInstanceIdentifiers() [2/3]

DBInstance& Aws::RDS::Model::DBInstance::AddReadReplicaDBInstanceIdentifiers ( const Aws::String value)
inline

Contains one or more identifiers of the read replicas associated with this DB instance.

Definition at line 1105 of file DBInstance.h.

◆ AddReadReplicaDBInstanceIdentifiers() [3/3]

DBInstance& Aws::RDS::Model::DBInstance::AddReadReplicaDBInstanceIdentifiers ( const char *  value)
inline

Contains one or more identifiers of the read replicas associated with this DB instance.

Definition at line 1117 of file DBInstance.h.

◆ AddStatusInfos() [1/2]

DBInstance& Aws::RDS::Model::DBInstance::AddStatusInfos ( const DBInstanceStatusInfo value)
inline

The status of a read replica. If the instance isn't a read replica, this is blank.

Definition at line 1623 of file DBInstance.h.

◆ AddStatusInfos() [2/2]

DBInstance& Aws::RDS::Model::DBInstance::AddStatusInfos ( DBInstanceStatusInfo &&  value)
inline

The status of a read replica. If the instance isn't a read replica, this is blank.

Definition at line 1629 of file DBInstance.h.

◆ AddTagList() [1/2]

DBInstance& Aws::RDS::Model::DBInstance::AddTagList ( const Tag value)
inline

Definition at line 2764 of file DBInstance.h.

◆ AddTagList() [2/2]

DBInstance& Aws::RDS::Model::DBInstance::AddTagList ( Tag &&  value)
inline

Definition at line 2767 of file DBInstance.h.

◆ AddVpcSecurityGroups() [1/2]

DBInstance& Aws::RDS::Model::DBInstance::AddVpcSecurityGroups ( const VpcSecurityGroupMembership value)
inline

Provides a list of VPC security group elements that the DB instance belongs to.

Definition at line 664 of file DBInstance.h.

◆ AddVpcSecurityGroups() [2/2]

DBInstance& Aws::RDS::Model::DBInstance::AddVpcSecurityGroups ( VpcSecurityGroupMembership &&  value)
inline

Provides a list of VPC security group elements that the DB instance belongs to.

Definition at line 670 of file DBInstance.h.

◆ AllocatedStorageHasBeenSet()

bool Aws::RDS::Model::DBInstance::AllocatedStorageHasBeenSet ( ) const
inline

Specifies the allocated storage size specified in gibibytes.

Definition at line 441 of file DBInstance.h.

◆ AssociatedRolesHasBeenSet()

bool Aws::RDS::Model::DBInstance::AssociatedRolesHasBeenSet ( ) const
inline

The AWS Identity and Access Management (IAM) roles associated with the DB instance.

Definition at line 2650 of file DBInstance.h.

◆ AutoMinorVersionUpgradeHasBeenSet()

bool Aws::RDS::Model::DBInstance::AutoMinorVersionUpgradeHasBeenSet ( ) const
inline

A value that indicates that minor version patches are applied automatically.

Definition at line 1001 of file DBInstance.h.

◆ AvailabilityZoneHasBeenSet()

bool Aws::RDS::Model::DBInstance::AvailabilityZoneHasBeenSet ( ) const
inline

Specifies the name of the Availability Zone the DB instance is located in.

Definition at line 724 of file DBInstance.h.

◆ AwsBackupRecoveryPointArnHasBeenSet()

bool Aws::RDS::Model::DBInstance::AwsBackupRecoveryPointArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the recovery point in AWS Backup.

Definition at line 2880 of file DBInstance.h.

◆ BackupRetentionPeriodHasBeenSet()

bool Aws::RDS::Model::DBInstance::BackupRetentionPeriodHasBeenSet ( ) const
inline

Specifies the number of days for which automatic DB snapshots are retained.

Definition at line 552 of file DBInstance.h.

◆ CACertificateIdentifierHasBeenSet()

bool Aws::RDS::Model::DBInstance::CACertificateIdentifierHasBeenSet ( ) const
inline

The identifier of the CA certificate for this DB instance.

Definition at line 1939 of file DBInstance.h.

◆ CharacterSetNameHasBeenSet()

bool Aws::RDS::Model::DBInstance::CharacterSetNameHasBeenSet ( ) const
inline

If present, specifies the name of the character set that this instance is associated with.

Definition at line 1385 of file DBInstance.h.

◆ CopyTagsToSnapshotHasBeenSet()

bool Aws::RDS::Model::DBInstance::CopyTagsToSnapshotHasBeenSet ( ) const
inline

Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

Amazon Aurora

Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see DBCluster.

Definition at line 2037 of file DBInstance.h.

◆ CustomerOwnedIpEnabledHasBeenSet()

bool Aws::RDS::Model::DBInstance::CustomerOwnedIpEnabledHasBeenSet ( ) const
inline

Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.

A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.

For more information about RDS on Outposts, see Working with Amazon RDS on AWS Outposts in the Amazon RDS User Guide.

For more information about CoIPs, see Customer-owned IP addresses in the AWS Outposts User Guide.

Definition at line 2839 of file DBInstance.h.

◆ DBClusterIdentifierHasBeenSet()

bool Aws::RDS::Model::DBInstance::DBClusterIdentifierHasBeenSet ( ) const
inline

If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

Definition at line 1757 of file DBInstance.h.

◆ DBInstanceArnHasBeenSet()

bool Aws::RDS::Model::DBInstance::DBInstanceArnHasBeenSet ( ) const
inline

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

Definition at line 2230 of file DBInstance.h.

◆ DBInstanceAutomatedBackupsReplicationsHasBeenSet()

bool Aws::RDS::Model::DBInstance::DBInstanceAutomatedBackupsReplicationsHasBeenSet ( ) const
inline

The list of replicated automated backups associated with the DB instance.

Definition at line 2778 of file DBInstance.h.

◆ DBInstanceClassHasBeenSet()

bool Aws::RDS::Model::DBInstance::DBInstanceClassHasBeenSet ( ) const
inline

Contains the name of the compute and memory capacity class of the DB instance.

Definition at line 119 of file DBInstance.h.

◆ DBInstanceIdentifierHasBeenSet()

bool Aws::RDS::Model::DBInstance::DBInstanceIdentifierHasBeenSet ( ) const
inline

Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

Definition at line 70 of file DBInstance.h.

◆ DbInstancePortHasBeenSet()

bool Aws::RDS::Model::DBInstance::DbInstancePortHasBeenSet ( ) const
inline

Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

Definition at line 1732 of file DBInstance.h.

◆ DBInstanceStatusHasBeenSet()

bool Aws::RDS::Model::DBInstance::DBInstanceStatusHasBeenSet ( ) const
inline

Specifies the current state of this database.

For information about DB instance statuses, see DB Instance Status in the Amazon RDS User Guide.

Definition at line 213 of file DBInstance.h.

◆ DbiResourceIdHasBeenSet()

bool Aws::RDS::Model::DBInstance::DbiResourceIdHasBeenSet ( ) const
inline

The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS customer master key (CMK) for the DB instance is accessed.

Definition at line 1886 of file DBInstance.h.

◆ DBNameHasBeenSet()

bool Aws::RDS::Model::DBInstance::DBNameHasBeenSet ( ) const
inline

The meaning of this parameter differs according to the database engine you use.

MySQL, MariaDB, SQL Server, PostgreSQL

Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

Type: String

Oracle

Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

Definition at line 327 of file DBInstance.h.

◆ DBParameterGroupsHasBeenSet()

bool Aws::RDS::Model::DBInstance::DBParameterGroupsHasBeenSet ( ) const
inline

Provides the list of DB parameter groups applied to this DB instance.

Definition at line 681 of file DBInstance.h.

◆ DBSecurityGroupsHasBeenSet()

bool Aws::RDS::Model::DBInstance::DBSecurityGroupsHasBeenSet ( ) const
inline

A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

Definition at line 579 of file DBInstance.h.

◆ DBSubnetGroupHasBeenSet()

bool Aws::RDS::Model::DBInstance::DBSubnetGroupHasBeenSet ( ) const
inline

Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

Definition at line 773 of file DBInstance.h.

◆ DeletionProtectionHasBeenSet()

bool Aws::RDS::Model::DBInstance::DeletionProtectionHasBeenSet ( ) const
inline

Indicates if the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance.

Definition at line 2619 of file DBInstance.h.

◆ DomainMembershipsHasBeenSet()

bool Aws::RDS::Model::DBInstance::DomainMembershipsHasBeenSet ( ) const
inline

The Active Directory Domain membership records associated with the DB instance.

Definition at line 1982 of file DBInstance.h.

◆ EnabledCloudwatchLogsExportsHasBeenSet()

bool Aws::RDS::Model::DBInstance::EnabledCloudwatchLogsExportsHasBeenSet ( ) const
inline

A list of log types that this DB instance is configured to export to CloudWatch Logs.

Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon RDS User Guide.

Definition at line 2488 of file DBInstance.h.

◆ EndpointHasBeenSet()

bool Aws::RDS::Model::DBInstance::EndpointHasBeenSet ( ) const
inline

Specifies the connection endpoint.

Definition at line 410 of file DBInstance.h.

◆ EngineHasBeenSet()

bool Aws::RDS::Model::DBInstance::EngineHasBeenSet ( ) const
inline

The name of the database engine to be used for this DB instance.

Definition at line 166 of file DBInstance.h.

◆ EngineVersionHasBeenSet()

bool Aws::RDS::Model::DBInstance::EngineVersionHasBeenSet ( ) const
inline

Indicates the database engine version.

Definition at line 958 of file DBInstance.h.

◆ EnhancedMonitoringResourceArnHasBeenSet()

bool Aws::RDS::Model::DBInstance::EnhancedMonitoringResourceArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

Definition at line 2093 of file DBInstance.h.

◆ GetAllocatedStorage()

int Aws::RDS::Model::DBInstance::GetAllocatedStorage ( ) const
inline

Specifies the allocated storage size specified in gibibytes.

Definition at line 436 of file DBInstance.h.

◆ GetAssociatedRoles()

const Aws::Vector<DBInstanceRole>& Aws::RDS::Model::DBInstance::GetAssociatedRoles ( ) const
inline

The AWS Identity and Access Management (IAM) roles associated with the DB instance.

Definition at line 2644 of file DBInstance.h.

◆ GetAutoMinorVersionUpgrade()

bool Aws::RDS::Model::DBInstance::GetAutoMinorVersionUpgrade ( ) const
inline

A value that indicates that minor version patches are applied automatically.

Definition at line 995 of file DBInstance.h.

◆ GetAvailabilityZone()

const Aws::String& Aws::RDS::Model::DBInstance::GetAvailabilityZone ( ) const
inline

Specifies the name of the Availability Zone the DB instance is located in.

Definition at line 718 of file DBInstance.h.

◆ GetAwsBackupRecoveryPointArn()

const Aws::String& Aws::RDS::Model::DBInstance::GetAwsBackupRecoveryPointArn ( ) const
inline

The Amazon Resource Name (ARN) of the recovery point in AWS Backup.

Definition at line 2875 of file DBInstance.h.

◆ GetBackupRetentionPeriod()

int Aws::RDS::Model::DBInstance::GetBackupRetentionPeriod ( ) const
inline

Specifies the number of days for which automatic DB snapshots are retained.

Definition at line 546 of file DBInstance.h.

◆ GetCACertificateIdentifier()

const Aws::String& Aws::RDS::Model::DBInstance::GetCACertificateIdentifier ( ) const
inline

The identifier of the CA certificate for this DB instance.

Definition at line 1934 of file DBInstance.h.

◆ GetCharacterSetName()

const Aws::String& Aws::RDS::Model::DBInstance::GetCharacterSetName ( ) const
inline

If present, specifies the name of the character set that this instance is associated with.

Definition at line 1379 of file DBInstance.h.

◆ GetCopyTagsToSnapshot()

bool Aws::RDS::Model::DBInstance::GetCopyTagsToSnapshot ( ) const
inline

Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

Amazon Aurora

Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see DBCluster.

Definition at line 2028 of file DBInstance.h.

◆ GetCustomerOwnedIpEnabled()

bool Aws::RDS::Model::DBInstance::GetCustomerOwnedIpEnabled ( ) const
inline

Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.

A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.

For more information about RDS on Outposts, see Working with Amazon RDS on AWS Outposts in the Amazon RDS User Guide.

For more information about CoIPs, see Customer-owned IP addresses in the AWS Outposts User Guide.

Definition at line 2824 of file DBInstance.h.

◆ GetDBClusterIdentifier()

const Aws::String& Aws::RDS::Model::DBInstance::GetDBClusterIdentifier ( ) const
inline

If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

Definition at line 1751 of file DBInstance.h.

◆ GetDBInstanceArn()

const Aws::String& Aws::RDS::Model::DBInstance::GetDBInstanceArn ( ) const
inline

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

Definition at line 2225 of file DBInstance.h.

◆ GetDBInstanceAutomatedBackupsReplications()

const Aws::Vector<DBInstanceAutomatedBackupsReplication>& Aws::RDS::Model::DBInstance::GetDBInstanceAutomatedBackupsReplications ( ) const
inline

The list of replicated automated backups associated with the DB instance.

Definition at line 2773 of file DBInstance.h.

◆ GetDBInstanceClass()

const Aws::String& Aws::RDS::Model::DBInstance::GetDBInstanceClass ( ) const
inline

Contains the name of the compute and memory capacity class of the DB instance.

Definition at line 113 of file DBInstance.h.

◆ GetDBInstanceIdentifier()

const Aws::String& Aws::RDS::Model::DBInstance::GetDBInstanceIdentifier ( ) const
inline

Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

Definition at line 64 of file DBInstance.h.

◆ GetDbInstancePort()

int Aws::RDS::Model::DBInstance::GetDbInstancePort ( ) const
inline

Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

Definition at line 1726 of file DBInstance.h.

◆ GetDBInstanceStatus()

const Aws::String& Aws::RDS::Model::DBInstance::GetDBInstanceStatus ( ) const
inline

Specifies the current state of this database.

For information about DB instance statuses, see DB Instance Status in the Amazon RDS User Guide.

Definition at line 205 of file DBInstance.h.

◆ GetDbiResourceId()

const Aws::String& Aws::RDS::Model::DBInstance::GetDbiResourceId ( ) const
inline

The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS customer master key (CMK) for the DB instance is accessed.

Definition at line 1879 of file DBInstance.h.

◆ GetDBName()

const Aws::String& Aws::RDS::Model::DBInstance::GetDBName ( ) const
inline

The meaning of this parameter differs according to the database engine you use.

MySQL, MariaDB, SQL Server, PostgreSQL

Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

Type: String

Oracle

Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

Definition at line 315 of file DBInstance.h.

◆ GetDBParameterGroups()

const Aws::Vector<DBParameterGroupStatus>& Aws::RDS::Model::DBInstance::GetDBParameterGroups ( ) const
inline

Provides the list of DB parameter groups applied to this DB instance.

Definition at line 676 of file DBInstance.h.

◆ GetDBSecurityGroups()

const Aws::Vector<DBSecurityGroupMembership>& Aws::RDS::Model::DBInstance::GetDBSecurityGroups ( ) const
inline

A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

Definition at line 572 of file DBInstance.h.

◆ GetDBSubnetGroup()

const DBSubnetGroup& Aws::RDS::Model::DBInstance::GetDBSubnetGroup ( ) const
inline

Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

Definition at line 767 of file DBInstance.h.

◆ GetDeletionProtection()

bool Aws::RDS::Model::DBInstance::GetDeletionProtection ( ) const
inline

Indicates if the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance.

Definition at line 2610 of file DBInstance.h.

◆ GetDomainMemberships()

const Aws::Vector<DomainMembership>& Aws::RDS::Model::DBInstance::GetDomainMemberships ( ) const
inline

The Active Directory Domain membership records associated with the DB instance.

Definition at line 1976 of file DBInstance.h.

◆ GetEnabledCloudwatchLogsExports()

const Aws::Vector<Aws::String>& Aws::RDS::Model::DBInstance::GetEnabledCloudwatchLogsExports ( ) const
inline

A list of log types that this DB instance is configured to export to CloudWatch Logs.

Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon RDS User Guide.

Definition at line 2479 of file DBInstance.h.

◆ GetEndpoint()

const Endpoint& Aws::RDS::Model::DBInstance::GetEndpoint ( ) const
inline

Specifies the connection endpoint.

Definition at line 405 of file DBInstance.h.

◆ GetEngine()

const Aws::String& Aws::RDS::Model::DBInstance::GetEngine ( ) const
inline

The name of the database engine to be used for this DB instance.

Definition at line 161 of file DBInstance.h.

◆ GetEngineVersion()

const Aws::String& Aws::RDS::Model::DBInstance::GetEngineVersion ( ) const
inline

Indicates the database engine version.

Definition at line 953 of file DBInstance.h.

◆ GetEnhancedMonitoringResourceArn()

const Aws::String& Aws::RDS::Model::DBInstance::GetEnhancedMonitoringResourceArn ( ) const
inline

The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

Definition at line 2087 of file DBInstance.h.

◆ GetIAMDatabaseAuthenticationEnabled()

bool Aws::RDS::Model::DBInstance::GetIAMDatabaseAuthenticationEnabled ( ) const
inline

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

IAM database authentication can be enabled for the following database engines

  • For MySQL 5.6, minor version 5.6.34 or higher

  • For MySQL 5.7, minor version 5.7.16 or higher

  • Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.

Definition at line 2329 of file DBInstance.h.

◆ GetInstanceCreateTime()

const Aws::Utils::DateTime& Aws::RDS::Model::DBInstance::GetInstanceCreateTime ( ) const
inline

Provides the date and time the DB instance was created.

Definition at line 457 of file DBInstance.h.

◆ GetIops()

int Aws::RDS::Model::DBInstance::GetIops ( ) const
inline

Specifies the Provisioned IOPS (I/O operations per second) value.

Definition at line 1316 of file DBInstance.h.

◆ GetKmsKeyId()

const Aws::String& Aws::RDS::Model::DBInstance::GetKmsKeyId ( ) const
inline

If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB instance.

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 1822 of file DBInstance.h.

◆ GetLatestRestorableTime()

const Aws::Utils::DateTime& Aws::RDS::Model::DBInstance::GetLatestRestorableTime ( ) const
inline

Specifies the latest time to which a database can be restored with point-in-time restore.

Definition at line 896 of file DBInstance.h.

◆ GetLicenseModel()

const Aws::String& Aws::RDS::Model::DBInstance::GetLicenseModel ( ) const
inline

License model information for this DB instance.

Definition at line 1275 of file DBInstance.h.

◆ GetListenerEndpoint()

const Endpoint& Aws::RDS::Model::DBInstance::GetListenerEndpoint ( ) const
inline

Specifies the listener connection endpoint for SQL Server Always On.

Definition at line 2692 of file DBInstance.h.

◆ GetMasterUsername()

const Aws::String& Aws::RDS::Model::DBInstance::GetMasterUsername ( ) const
inline

Contains the master username for the DB instance.

Definition at line 267 of file DBInstance.h.

◆ GetMaxAllocatedStorage()

int Aws::RDS::Model::DBInstance::GetMaxAllocatedStorage ( ) const
inline

The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.

Definition at line 2724 of file DBInstance.h.

◆ GetMonitoringInterval()

int Aws::RDS::Model::DBInstance::GetMonitoringInterval ( ) const
inline

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

Definition at line 2062 of file DBInstance.h.

◆ GetMonitoringRoleArn()

const Aws::String& Aws::RDS::Model::DBInstance::GetMonitoringRoleArn ( ) const
inline

The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

Definition at line 2136 of file DBInstance.h.

◆ GetMultiAZ()

bool Aws::RDS::Model::DBInstance::GetMultiAZ ( ) const
inline

Specifies if the DB instance is a Multi-AZ deployment.

Definition at line 932 of file DBInstance.h.

◆ GetNcharCharacterSetName()

const Aws::String& Aws::RDS::Model::DBInstance::GetNcharCharacterSetName ( ) const
inline

The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.

Definition at line 1429 of file DBInstance.h.

◆ GetOptionGroupMemberships()

const Aws::Vector<OptionGroupMembership>& Aws::RDS::Model::DBInstance::GetOptionGroupMemberships ( ) const
inline

Provides the list of option group memberships for this DB instance.

Definition at line 1337 of file DBInstance.h.

◆ GetPendingModifiedValues()

const PendingModifiedValues& Aws::RDS::Model::DBInstance::GetPendingModifiedValues ( ) const
inline

A value that specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

Definition at line 854 of file DBInstance.h.

◆ GetPerformanceInsightsEnabled()

bool Aws::RDS::Model::DBInstance::GetPerformanceInsightsEnabled ( ) const
inline

True if Performance Insights is enabled for the DB instance, and otherwise false.

Definition at line 2369 of file DBInstance.h.

◆ GetPerformanceInsightsKMSKeyId()

const Aws::String& Aws::RDS::Model::DBInstance::GetPerformanceInsightsKMSKeyId ( ) const
inline

The AWS KMS key identifier for encryption of Performance Insights data.

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 2395 of file DBInstance.h.

◆ GetPerformanceInsightsRetentionPeriod()

int Aws::RDS::Model::DBInstance::GetPerformanceInsightsRetentionPeriod ( ) const
inline

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

Definition at line 2451 of file DBInstance.h.

◆ GetPreferredBackupWindow()

const Aws::String& Aws::RDS::Model::DBInstance::GetPreferredBackupWindow ( ) const
inline

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

Definition at line 490 of file DBInstance.h.

◆ GetPreferredMaintenanceWindow()

const Aws::String& Aws::RDS::Model::DBInstance::GetPreferredMaintenanceWindow ( ) const
inline

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Definition at line 804 of file DBInstance.h.

◆ GetProcessorFeatures()

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

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

Definition at line 2558 of file DBInstance.h.

◆ GetPromotionTier()

int Aws::RDS::Model::DBInstance::GetPromotionTier ( ) const
inline

A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

Definition at line 2189 of file DBInstance.h.

◆ GetPubliclyAccessible()

bool Aws::RDS::Model::DBInstance::GetPubliclyAccessible ( ) const
inline

Specifies the accessibility options for the DB instance.

When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

For more information, see CreateDBInstance.

Definition at line 1541 of file DBInstance.h.

◆ GetReadReplicaDBClusterIdentifiers()

const Aws::Vector<Aws::String>& Aws::RDS::Model::DBInstance::GetReadReplicaDBClusterIdentifiers ( ) const
inline

Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output does not contain information about cross region Aurora read replicas.

Currently, each RDS DB instance can have only one Aurora read replica.

Definition at line 1128 of file DBInstance.h.

◆ GetReadReplicaDBInstanceIdentifiers()

const Aws::Vector<Aws::String>& Aws::RDS::Model::DBInstance::GetReadReplicaDBInstanceIdentifiers ( ) const
inline

Contains one or more identifiers of the read replicas associated with this DB instance.

Definition at line 1069 of file DBInstance.h.

◆ GetReadReplicaSourceDBInstanceIdentifier()

const Aws::String& Aws::RDS::Model::DBInstance::GetReadReplicaSourceDBInstanceIdentifier ( ) const
inline

Contains the identifier of the source DB instance if this DB instance is a read replica.

Definition at line 1020 of file DBInstance.h.

◆ GetReplicaMode()

const ReplicaMode& Aws::RDS::Model::DBInstance::GetReplicaMode ( ) const
inline

The open mode of an Oracle read replica. The default is open-read-only. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.

This attribute is only supported in RDS for Oracle.

Definition at line 1219 of file DBInstance.h.

◆ GetSecondaryAvailabilityZone()

const Aws::String& Aws::RDS::Model::DBInstance::GetSecondaryAvailabilityZone ( ) const
inline

If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

Definition at line 1485 of file DBInstance.h.

◆ GetStatusInfos()

const Aws::Vector<DBInstanceStatusInfo>& Aws::RDS::Model::DBInstance::GetStatusInfos ( ) const
inline

The status of a read replica. If the instance isn't a read replica, this is blank.

Definition at line 1587 of file DBInstance.h.

◆ GetStorageEncrypted()

bool Aws::RDS::Model::DBInstance::GetStorageEncrypted ( ) const
inline

Specifies whether the DB instance is encrypted.

Definition at line 1799 of file DBInstance.h.

◆ GetStorageType()

const Aws::String& Aws::RDS::Model::DBInstance::GetStorageType ( ) const
inline

Specifies the storage type associated with DB instance.

Definition at line 1635 of file DBInstance.h.

◆ GetTagList()

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

Definition at line 2746 of file DBInstance.h.

◆ GetTdeCredentialArn()

const Aws::String& Aws::RDS::Model::DBInstance::GetTdeCredentialArn ( ) const
inline

The ARN from the key store with which the instance is associated for TDE encryption.

Definition at line 1677 of file DBInstance.h.

◆ GetTimezone()

const Aws::String& Aws::RDS::Model::DBInstance::GetTimezone ( ) const
inline

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

Definition at line 2268 of file DBInstance.h.

◆ GetVpcSecurityGroups()

const Aws::Vector<VpcSecurityGroupMembership>& Aws::RDS::Model::DBInstance::GetVpcSecurityGroups ( ) const
inline

Provides a list of VPC security group elements that the DB instance belongs to.

Definition at line 628 of file DBInstance.h.

◆ IAMDatabaseAuthenticationEnabledHasBeenSet()

bool Aws::RDS::Model::DBInstance::IAMDatabaseAuthenticationEnabledHasBeenSet ( ) const
inline

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

IAM database authentication can be enabled for the following database engines

  • For MySQL 5.6, minor version 5.6.34 or higher

  • For MySQL 5.7, minor version 5.7.16 or higher

  • Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.

Definition at line 2340 of file DBInstance.h.

◆ InstanceCreateTimeHasBeenSet()

bool Aws::RDS::Model::DBInstance::InstanceCreateTimeHasBeenSet ( ) const
inline

Provides the date and time the DB instance was created.

Definition at line 462 of file DBInstance.h.

◆ IopsHasBeenSet()

bool Aws::RDS::Model::DBInstance::IopsHasBeenSet ( ) const
inline

Specifies the Provisioned IOPS (I/O operations per second) value.

Definition at line 1321 of file DBInstance.h.

◆ KmsKeyIdHasBeenSet()

bool Aws::RDS::Model::DBInstance::KmsKeyIdHasBeenSet ( ) const
inline

If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB instance.

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 1829 of file DBInstance.h.

◆ LatestRestorableTimeHasBeenSet()

bool Aws::RDS::Model::DBInstance::LatestRestorableTimeHasBeenSet ( ) const
inline

Specifies the latest time to which a database can be restored with point-in-time restore.

Definition at line 902 of file DBInstance.h.

◆ LicenseModelHasBeenSet()

bool Aws::RDS::Model::DBInstance::LicenseModelHasBeenSet ( ) const
inline

License model information for this DB instance.

Definition at line 1280 of file DBInstance.h.

◆ ListenerEndpointHasBeenSet()

bool Aws::RDS::Model::DBInstance::ListenerEndpointHasBeenSet ( ) const
inline

Specifies the listener connection endpoint for SQL Server Always On.

Definition at line 2697 of file DBInstance.h.

◆ MasterUsernameHasBeenSet()

bool Aws::RDS::Model::DBInstance::MasterUsernameHasBeenSet ( ) const
inline

Contains the master username for the DB instance.

Definition at line 272 of file DBInstance.h.

◆ MaxAllocatedStorageHasBeenSet()

bool Aws::RDS::Model::DBInstance::MaxAllocatedStorageHasBeenSet ( ) const
inline

The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.

Definition at line 2730 of file DBInstance.h.

◆ MonitoringIntervalHasBeenSet()

bool Aws::RDS::Model::DBInstance::MonitoringIntervalHasBeenSet ( ) const
inline

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

Definition at line 2068 of file DBInstance.h.

◆ MonitoringRoleArnHasBeenSet()

bool Aws::RDS::Model::DBInstance::MonitoringRoleArnHasBeenSet ( ) const
inline

The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

Definition at line 2142 of file DBInstance.h.

◆ MultiAZHasBeenSet()

bool Aws::RDS::Model::DBInstance::MultiAZHasBeenSet ( ) const
inline

Specifies if the DB instance is a Multi-AZ deployment.

Definition at line 937 of file DBInstance.h.

◆ NcharCharacterSetNameHasBeenSet()

bool Aws::RDS::Model::DBInstance::NcharCharacterSetNameHasBeenSet ( ) const
inline

The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.

Definition at line 1436 of file DBInstance.h.

◆ operator=()

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

◆ OptionGroupMembershipsHasBeenSet()

bool Aws::RDS::Model::DBInstance::OptionGroupMembershipsHasBeenSet ( ) const
inline

Provides the list of option group memberships for this DB instance.

Definition at line 1342 of file DBInstance.h.

◆ OutputToStream() [1/2]

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

◆ OutputToStream() [2/2]

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

◆ PendingModifiedValuesHasBeenSet()

bool Aws::RDS::Model::DBInstance::PendingModifiedValuesHasBeenSet ( ) const
inline

A value that specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

Definition at line 861 of file DBInstance.h.

◆ PerformanceInsightsEnabledHasBeenSet()

bool Aws::RDS::Model::DBInstance::PerformanceInsightsEnabledHasBeenSet ( ) const
inline

True if Performance Insights is enabled for the DB instance, and otherwise false.

Definition at line 2375 of file DBInstance.h.

◆ PerformanceInsightsKMSKeyIdHasBeenSet()

bool Aws::RDS::Model::DBInstance::PerformanceInsightsKMSKeyIdHasBeenSet ( ) const
inline

The AWS KMS key identifier for encryption of Performance Insights data.

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 2402 of file DBInstance.h.

◆ PerformanceInsightsRetentionPeriodHasBeenSet()

bool Aws::RDS::Model::DBInstance::PerformanceInsightsRetentionPeriodHasBeenSet ( ) const
inline

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

Definition at line 2457 of file DBInstance.h.

◆ PreferredBackupWindowHasBeenSet()

bool Aws::RDS::Model::DBInstance::PreferredBackupWindowHasBeenSet ( ) const
inline

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

Definition at line 497 of file DBInstance.h.

◆ PreferredMaintenanceWindowHasBeenSet()

bool Aws::RDS::Model::DBInstance::PreferredMaintenanceWindowHasBeenSet ( ) const
inline

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Definition at line 810 of file DBInstance.h.

◆ ProcessorFeaturesHasBeenSet()

bool Aws::RDS::Model::DBInstance::ProcessorFeaturesHasBeenSet ( ) const
inline

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

Definition at line 2564 of file DBInstance.h.

◆ PromotionTierHasBeenSet()

bool Aws::RDS::Model::DBInstance::PromotionTierHasBeenSet ( ) const
inline

A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

Definition at line 2199 of file DBInstance.h.

◆ PubliclyAccessibleHasBeenSet()

bool Aws::RDS::Model::DBInstance::PubliclyAccessibleHasBeenSet ( ) const
inline

Specifies the accessibility options for the DB instance.

When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

For more information, see CreateDBInstance.

Definition at line 1554 of file DBInstance.h.

◆ ReadReplicaDBClusterIdentifiersHasBeenSet()

bool Aws::RDS::Model::DBInstance::ReadReplicaDBClusterIdentifiersHasBeenSet ( ) const
inline

Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output does not contain information about cross region Aurora read replicas.

Currently, each RDS DB instance can have only one Aurora read replica.

Definition at line 1138 of file DBInstance.h.

◆ ReadReplicaDBInstanceIdentifiersHasBeenSet()

bool Aws::RDS::Model::DBInstance::ReadReplicaDBInstanceIdentifiersHasBeenSet ( ) const
inline

Contains one or more identifiers of the read replicas associated with this DB instance.

Definition at line 1075 of file DBInstance.h.

◆ ReadReplicaSourceDBInstanceIdentifierHasBeenSet()

bool Aws::RDS::Model::DBInstance::ReadReplicaSourceDBInstanceIdentifierHasBeenSet ( ) const
inline

Contains the identifier of the source DB instance if this DB instance is a read replica.

Definition at line 1026 of file DBInstance.h.

◆ ReplicaModeHasBeenSet()

bool Aws::RDS::Model::DBInstance::ReplicaModeHasBeenSet ( ) const
inline

The open mode of an Oracle read replica. The default is open-read-only. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.

This attribute is only supported in RDS for Oracle.

Definition at line 1229 of file DBInstance.h.

◆ SecondaryAvailabilityZoneHasBeenSet()

bool Aws::RDS::Model::DBInstance::SecondaryAvailabilityZoneHasBeenSet ( ) const
inline

If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

Definition at line 1491 of file DBInstance.h.

◆ SetAllocatedStorage()

void Aws::RDS::Model::DBInstance::SetAllocatedStorage ( int  value)
inline

Specifies the allocated storage size specified in gibibytes.

Definition at line 446 of file DBInstance.h.

◆ SetAssociatedRoles() [1/2]

void Aws::RDS::Model::DBInstance::SetAssociatedRoles ( Aws::Vector< DBInstanceRole > &&  value)
inline

The AWS Identity and Access Management (IAM) roles associated with the DB instance.

Definition at line 2662 of file DBInstance.h.

◆ SetAssociatedRoles() [2/2]

void Aws::RDS::Model::DBInstance::SetAssociatedRoles ( const Aws::Vector< DBInstanceRole > &  value)
inline

The AWS Identity and Access Management (IAM) roles associated with the DB instance.

Definition at line 2656 of file DBInstance.h.

◆ SetAutoMinorVersionUpgrade()

void Aws::RDS::Model::DBInstance::SetAutoMinorVersionUpgrade ( bool  value)
inline

A value that indicates that minor version patches are applied automatically.

Definition at line 1007 of file DBInstance.h.

◆ SetAvailabilityZone() [1/3]

void Aws::RDS::Model::DBInstance::SetAvailabilityZone ( Aws::String &&  value)
inline

Specifies the name of the Availability Zone the DB instance is located in.

Definition at line 736 of file DBInstance.h.

◆ SetAvailabilityZone() [2/3]

void Aws::RDS::Model::DBInstance::SetAvailabilityZone ( const Aws::String value)
inline

Specifies the name of the Availability Zone the DB instance is located in.

Definition at line 730 of file DBInstance.h.

◆ SetAvailabilityZone() [3/3]

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

Specifies the name of the Availability Zone the DB instance is located in.

Definition at line 742 of file DBInstance.h.

◆ SetAwsBackupRecoveryPointArn() [1/3]

void Aws::RDS::Model::DBInstance::SetAwsBackupRecoveryPointArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the recovery point in AWS Backup.

Definition at line 2890 of file DBInstance.h.

◆ SetAwsBackupRecoveryPointArn() [2/3]

void Aws::RDS::Model::DBInstance::SetAwsBackupRecoveryPointArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the recovery point in AWS Backup.

Definition at line 2885 of file DBInstance.h.

◆ SetAwsBackupRecoveryPointArn() [3/3]

void Aws::RDS::Model::DBInstance::SetAwsBackupRecoveryPointArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the recovery point in AWS Backup.

Definition at line 2895 of file DBInstance.h.

◆ SetBackupRetentionPeriod()

void Aws::RDS::Model::DBInstance::SetBackupRetentionPeriod ( int  value)
inline

Specifies the number of days for which automatic DB snapshots are retained.

Definition at line 558 of file DBInstance.h.

◆ SetCACertificateIdentifier() [1/3]

void Aws::RDS::Model::DBInstance::SetCACertificateIdentifier ( Aws::String &&  value)
inline

The identifier of the CA certificate for this DB instance.

Definition at line 1949 of file DBInstance.h.

◆ SetCACertificateIdentifier() [2/3]

void Aws::RDS::Model::DBInstance::SetCACertificateIdentifier ( const Aws::String value)
inline

The identifier of the CA certificate for this DB instance.

Definition at line 1944 of file DBInstance.h.

◆ SetCACertificateIdentifier() [3/3]

void Aws::RDS::Model::DBInstance::SetCACertificateIdentifier ( const char *  value)
inline

The identifier of the CA certificate for this DB instance.

Definition at line 1954 of file DBInstance.h.

◆ SetCharacterSetName() [1/3]

void Aws::RDS::Model::DBInstance::SetCharacterSetName ( Aws::String &&  value)
inline

If present, specifies the name of the character set that this instance is associated with.

Definition at line 1397 of file DBInstance.h.

◆ SetCharacterSetName() [2/3]

void Aws::RDS::Model::DBInstance::SetCharacterSetName ( const Aws::String value)
inline

If present, specifies the name of the character set that this instance is associated with.

Definition at line 1391 of file DBInstance.h.

◆ SetCharacterSetName() [3/3]

void Aws::RDS::Model::DBInstance::SetCharacterSetName ( const char *  value)
inline

If present, specifies the name of the character set that this instance is associated with.

Definition at line 1403 of file DBInstance.h.

◆ SetCopyTagsToSnapshot()

void Aws::RDS::Model::DBInstance::SetCopyTagsToSnapshot ( bool  value)
inline

Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

Amazon Aurora

Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see DBCluster.

Definition at line 2046 of file DBInstance.h.

◆ SetCustomerOwnedIpEnabled()

void Aws::RDS::Model::DBInstance::SetCustomerOwnedIpEnabled ( bool  value)
inline

Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.

A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.

For more information about RDS on Outposts, see Working with Amazon RDS on AWS Outposts in the Amazon RDS User Guide.

For more information about CoIPs, see Customer-owned IP addresses in the AWS Outposts User Guide.

Definition at line 2854 of file DBInstance.h.

◆ SetDBClusterIdentifier() [1/3]

void Aws::RDS::Model::DBInstance::SetDBClusterIdentifier ( Aws::String &&  value)
inline

If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

Definition at line 1769 of file DBInstance.h.

◆ SetDBClusterIdentifier() [2/3]

void Aws::RDS::Model::DBInstance::SetDBClusterIdentifier ( const Aws::String value)
inline

If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

Definition at line 1763 of file DBInstance.h.

◆ SetDBClusterIdentifier() [3/3]

void Aws::RDS::Model::DBInstance::SetDBClusterIdentifier ( const char *  value)
inline

If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

Definition at line 1775 of file DBInstance.h.

◆ SetDBInstanceArn() [1/3]

void Aws::RDS::Model::DBInstance::SetDBInstanceArn ( Aws::String &&  value)
inline

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

Definition at line 2240 of file DBInstance.h.

◆ SetDBInstanceArn() [2/3]

void Aws::RDS::Model::DBInstance::SetDBInstanceArn ( const Aws::String value)
inline

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

Definition at line 2235 of file DBInstance.h.

◆ SetDBInstanceArn() [3/3]

void Aws::RDS::Model::DBInstance::SetDBInstanceArn ( const char *  value)
inline

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

Definition at line 2245 of file DBInstance.h.

◆ SetDBInstanceAutomatedBackupsReplications() [1/2]

void Aws::RDS::Model::DBInstance::SetDBInstanceAutomatedBackupsReplications ( Aws::Vector< DBInstanceAutomatedBackupsReplication > &&  value)
inline

The list of replicated automated backups associated with the DB instance.

Definition at line 2788 of file DBInstance.h.

◆ SetDBInstanceAutomatedBackupsReplications() [2/2]

void Aws::RDS::Model::DBInstance::SetDBInstanceAutomatedBackupsReplications ( const Aws::Vector< DBInstanceAutomatedBackupsReplication > &  value)
inline

The list of replicated automated backups associated with the DB instance.

Definition at line 2783 of file DBInstance.h.

◆ SetDBInstanceClass() [1/3]

void Aws::RDS::Model::DBInstance::SetDBInstanceClass ( Aws::String &&  value)
inline

Contains the name of the compute and memory capacity class of the DB instance.

Definition at line 131 of file DBInstance.h.

◆ SetDBInstanceClass() [2/3]

void Aws::RDS::Model::DBInstance::SetDBInstanceClass ( const Aws::String value)
inline

Contains the name of the compute and memory capacity class of the DB instance.

Definition at line 125 of file DBInstance.h.

◆ SetDBInstanceClass() [3/3]

void Aws::RDS::Model::DBInstance::SetDBInstanceClass ( const char *  value)
inline

Contains the name of the compute and memory capacity class of the DB instance.

Definition at line 137 of file DBInstance.h.

◆ SetDBInstanceIdentifier() [1/3]

void Aws::RDS::Model::DBInstance::SetDBInstanceIdentifier ( Aws::String &&  value)
inline

Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

Definition at line 82 of file DBInstance.h.

◆ SetDBInstanceIdentifier() [2/3]

void Aws::RDS::Model::DBInstance::SetDBInstanceIdentifier ( const Aws::String value)
inline

Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

Definition at line 76 of file DBInstance.h.

◆ SetDBInstanceIdentifier() [3/3]

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

Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

Definition at line 88 of file DBInstance.h.

◆ SetDbInstancePort()

void Aws::RDS::Model::DBInstance::SetDbInstancePort ( int  value)
inline

Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

Definition at line 1738 of file DBInstance.h.

◆ SetDBInstanceStatus() [1/3]

void Aws::RDS::Model::DBInstance::SetDBInstanceStatus ( Aws::String &&  value)
inline

Specifies the current state of this database.

For information about DB instance statuses, see DB Instance Status in the Amazon RDS User Guide.

Definition at line 229 of file DBInstance.h.

◆ SetDBInstanceStatus() [2/3]

void Aws::RDS::Model::DBInstance::SetDBInstanceStatus ( const Aws::String value)
inline

Specifies the current state of this database.

For information about DB instance statuses, see DB Instance Status in the Amazon RDS User Guide.

Definition at line 221 of file DBInstance.h.

◆ SetDBInstanceStatus() [3/3]

void Aws::RDS::Model::DBInstance::SetDBInstanceStatus ( const char *  value)
inline

Specifies the current state of this database.

For information about DB instance statuses, see DB Instance Status in the Amazon RDS User Guide.

Definition at line 237 of file DBInstance.h.

◆ SetDbiResourceId() [1/3]

void Aws::RDS::Model::DBInstance::SetDbiResourceId ( Aws::String &&  value)
inline

The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS customer master key (CMK) for the DB instance is accessed.

Definition at line 1900 of file DBInstance.h.

◆ SetDbiResourceId() [2/3]

void Aws::RDS::Model::DBInstance::SetDbiResourceId ( const Aws::String value)
inline

The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS customer master key (CMK) for the DB instance is accessed.

Definition at line 1893 of file DBInstance.h.

◆ SetDbiResourceId() [3/3]

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

The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS customer master key (CMK) for the DB instance is accessed.

Definition at line 1907 of file DBInstance.h.

◆ SetDBName() [1/3]

void Aws::RDS::Model::DBInstance::SetDBName ( Aws::String &&  value)
inline

The meaning of this parameter differs according to the database engine you use.

MySQL, MariaDB, SQL Server, PostgreSQL

Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

Type: String

Oracle

Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

Definition at line 351 of file DBInstance.h.

◆ SetDBName() [2/3]

void Aws::RDS::Model::DBInstance::SetDBName ( const Aws::String value)
inline

The meaning of this parameter differs according to the database engine you use.

MySQL, MariaDB, SQL Server, PostgreSQL

Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

Type: String

Oracle

Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

Definition at line 339 of file DBInstance.h.

◆ SetDBName() [3/3]

void Aws::RDS::Model::DBInstance::SetDBName ( const char *  value)
inline

The meaning of this parameter differs according to the database engine you use.

MySQL, MariaDB, SQL Server, PostgreSQL

Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

Type: String

Oracle

Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

Definition at line 363 of file DBInstance.h.

◆ SetDBParameterGroups() [1/2]

void Aws::RDS::Model::DBInstance::SetDBParameterGroups ( Aws::Vector< DBParameterGroupStatus > &&  value)
inline

Provides the list of DB parameter groups applied to this DB instance.

Definition at line 691 of file DBInstance.h.

◆ SetDBParameterGroups() [2/2]

void Aws::RDS::Model::DBInstance::SetDBParameterGroups ( const Aws::Vector< DBParameterGroupStatus > &  value)
inline

Provides the list of DB parameter groups applied to this DB instance.

Definition at line 686 of file DBInstance.h.

◆ SetDBSecurityGroups() [1/2]

void Aws::RDS::Model::DBInstance::SetDBSecurityGroups ( Aws::Vector< DBSecurityGroupMembership > &&  value)
inline

A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

Definition at line 593 of file DBInstance.h.

◆ SetDBSecurityGroups() [2/2]

void Aws::RDS::Model::DBInstance::SetDBSecurityGroups ( const Aws::Vector< DBSecurityGroupMembership > &  value)
inline

A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

Definition at line 586 of file DBInstance.h.

◆ SetDBSubnetGroup() [1/2]

void Aws::RDS::Model::DBInstance::SetDBSubnetGroup ( const DBSubnetGroup value)
inline

Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

Definition at line 779 of file DBInstance.h.

◆ SetDBSubnetGroup() [2/2]

void Aws::RDS::Model::DBInstance::SetDBSubnetGroup ( DBSubnetGroup &&  value)
inline

Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

Definition at line 785 of file DBInstance.h.

◆ SetDeletionProtection()

void Aws::RDS::Model::DBInstance::SetDeletionProtection ( bool  value)
inline

Indicates if the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance.

Definition at line 2628 of file DBInstance.h.

◆ SetDomainMemberships() [1/2]

void Aws::RDS::Model::DBInstance::SetDomainMemberships ( Aws::Vector< DomainMembership > &&  value)
inline

The Active Directory Domain membership records associated with the DB instance.

Definition at line 1994 of file DBInstance.h.

◆ SetDomainMemberships() [2/2]

void Aws::RDS::Model::DBInstance::SetDomainMemberships ( const Aws::Vector< DomainMembership > &  value)
inline

The Active Directory Domain membership records associated with the DB instance.

Definition at line 1988 of file DBInstance.h.

◆ SetEnabledCloudwatchLogsExports() [1/2]

void Aws::RDS::Model::DBInstance::SetEnabledCloudwatchLogsExports ( Aws::Vector< Aws::String > &&  value)
inline

A list of log types that this DB instance is configured to export to CloudWatch Logs.

Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon RDS User Guide.

Definition at line 2506 of file DBInstance.h.

◆ SetEnabledCloudwatchLogsExports() [2/2]

void Aws::RDS::Model::DBInstance::SetEnabledCloudwatchLogsExports ( const Aws::Vector< Aws::String > &  value)
inline

A list of log types that this DB instance is configured to export to CloudWatch Logs.

Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon RDS User Guide.

Definition at line 2497 of file DBInstance.h.

◆ SetEndpoint() [1/2]

void Aws::RDS::Model::DBInstance::SetEndpoint ( const Endpoint value)
inline

Specifies the connection endpoint.

Definition at line 415 of file DBInstance.h.

◆ SetEndpoint() [2/2]

void Aws::RDS::Model::DBInstance::SetEndpoint ( Endpoint &&  value)
inline

Specifies the connection endpoint.

Definition at line 420 of file DBInstance.h.

◆ SetEngine() [1/3]

void Aws::RDS::Model::DBInstance::SetEngine ( Aws::String &&  value)
inline

The name of the database engine to be used for this DB instance.

Definition at line 176 of file DBInstance.h.

◆ SetEngine() [2/3]

void Aws::RDS::Model::DBInstance::SetEngine ( const Aws::String value)
inline

The name of the database engine to be used for this DB instance.

Definition at line 171 of file DBInstance.h.

◆ SetEngine() [3/3]

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

The name of the database engine to be used for this DB instance.

Definition at line 181 of file DBInstance.h.

◆ SetEngineVersion() [1/3]

void Aws::RDS::Model::DBInstance::SetEngineVersion ( Aws::String &&  value)
inline

Indicates the database engine version.

Definition at line 968 of file DBInstance.h.

◆ SetEngineVersion() [2/3]

void Aws::RDS::Model::DBInstance::SetEngineVersion ( const Aws::String value)
inline

Indicates the database engine version.

Definition at line 963 of file DBInstance.h.

◆ SetEngineVersion() [3/3]

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

Indicates the database engine version.

Definition at line 973 of file DBInstance.h.

◆ SetEnhancedMonitoringResourceArn() [1/3]

void Aws::RDS::Model::DBInstance::SetEnhancedMonitoringResourceArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

Definition at line 2105 of file DBInstance.h.

◆ SetEnhancedMonitoringResourceArn() [2/3]

void Aws::RDS::Model::DBInstance::SetEnhancedMonitoringResourceArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

Definition at line 2099 of file DBInstance.h.

◆ SetEnhancedMonitoringResourceArn() [3/3]

void Aws::RDS::Model::DBInstance::SetEnhancedMonitoringResourceArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

Definition at line 2111 of file DBInstance.h.

◆ SetIAMDatabaseAuthenticationEnabled()

void Aws::RDS::Model::DBInstance::SetIAMDatabaseAuthenticationEnabled ( bool  value)
inline

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

IAM database authentication can be enabled for the following database engines

  • For MySQL 5.6, minor version 5.6.34 or higher

  • For MySQL 5.7, minor version 5.7.16 or higher

  • Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.

Definition at line 2351 of file DBInstance.h.

◆ SetInstanceCreateTime() [1/2]

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

Provides the date and time the DB instance was created.

Definition at line 472 of file DBInstance.h.

◆ SetInstanceCreateTime() [2/2]

void Aws::RDS::Model::DBInstance::SetInstanceCreateTime ( const Aws::Utils::DateTime value)
inline

Provides the date and time the DB instance was created.

Definition at line 467 of file DBInstance.h.

◆ SetIops()

void Aws::RDS::Model::DBInstance::SetIops ( int  value)
inline

Specifies the Provisioned IOPS (I/O operations per second) value.

Definition at line 1326 of file DBInstance.h.

◆ SetKmsKeyId() [1/3]

void Aws::RDS::Model::DBInstance::SetKmsKeyId ( Aws::String &&  value)
inline

If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB instance.

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 1843 of file DBInstance.h.

◆ SetKmsKeyId() [2/3]

void Aws::RDS::Model::DBInstance::SetKmsKeyId ( const Aws::String value)
inline

If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB instance.

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 1836 of file DBInstance.h.

◆ SetKmsKeyId() [3/3]

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

If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB instance.

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 1850 of file DBInstance.h.

◆ SetLatestRestorableTime() [1/2]

void Aws::RDS::Model::DBInstance::SetLatestRestorableTime ( Aws::Utils::DateTime &&  value)
inline

Specifies the latest time to which a database can be restored with point-in-time restore.

Definition at line 914 of file DBInstance.h.

◆ SetLatestRestorableTime() [2/2]

void Aws::RDS::Model::DBInstance::SetLatestRestorableTime ( const Aws::Utils::DateTime value)
inline

Specifies the latest time to which a database can be restored with point-in-time restore.

Definition at line 908 of file DBInstance.h.

◆ SetLicenseModel() [1/3]

void Aws::RDS::Model::DBInstance::SetLicenseModel ( Aws::String &&  value)
inline

License model information for this DB instance.

Definition at line 1290 of file DBInstance.h.

◆ SetLicenseModel() [2/3]

void Aws::RDS::Model::DBInstance::SetLicenseModel ( const Aws::String value)
inline

License model information for this DB instance.

Definition at line 1285 of file DBInstance.h.

◆ SetLicenseModel() [3/3]

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

License model information for this DB instance.

Definition at line 1295 of file DBInstance.h.

◆ SetListenerEndpoint() [1/2]

void Aws::RDS::Model::DBInstance::SetListenerEndpoint ( const Endpoint value)
inline

Specifies the listener connection endpoint for SQL Server Always On.

Definition at line 2702 of file DBInstance.h.

◆ SetListenerEndpoint() [2/2]

void Aws::RDS::Model::DBInstance::SetListenerEndpoint ( Endpoint &&  value)
inline

Specifies the listener connection endpoint for SQL Server Always On.

Definition at line 2707 of file DBInstance.h.

◆ SetMasterUsername() [1/3]

void Aws::RDS::Model::DBInstance::SetMasterUsername ( Aws::String &&  value)
inline

Contains the master username for the DB instance.

Definition at line 282 of file DBInstance.h.

◆ SetMasterUsername() [2/3]

void Aws::RDS::Model::DBInstance::SetMasterUsername ( const Aws::String value)
inline

Contains the master username for the DB instance.

Definition at line 277 of file DBInstance.h.

◆ SetMasterUsername() [3/3]

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

Contains the master username for the DB instance.

Definition at line 287 of file DBInstance.h.

◆ SetMaxAllocatedStorage()

void Aws::RDS::Model::DBInstance::SetMaxAllocatedStorage ( int  value)
inline

The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.

Definition at line 2736 of file DBInstance.h.

◆ SetMonitoringInterval()

void Aws::RDS::Model::DBInstance::SetMonitoringInterval ( int  value)
inline

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

Definition at line 2074 of file DBInstance.h.

◆ SetMonitoringRoleArn() [1/3]

void Aws::RDS::Model::DBInstance::SetMonitoringRoleArn ( Aws::String &&  value)
inline

The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

Definition at line 2154 of file DBInstance.h.

◆ SetMonitoringRoleArn() [2/3]

void Aws::RDS::Model::DBInstance::SetMonitoringRoleArn ( const Aws::String value)
inline

The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

Definition at line 2148 of file DBInstance.h.

◆ SetMonitoringRoleArn() [3/3]

void Aws::RDS::Model::DBInstance::SetMonitoringRoleArn ( const char *  value)
inline

The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

Definition at line 2160 of file DBInstance.h.

◆ SetMultiAZ()

void Aws::RDS::Model::DBInstance::SetMultiAZ ( bool  value)
inline

Specifies if the DB instance is a Multi-AZ deployment.

Definition at line 942 of file DBInstance.h.

◆ SetNcharCharacterSetName() [1/3]

void Aws::RDS::Model::DBInstance::SetNcharCharacterSetName ( Aws::String &&  value)
inline

The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.

Definition at line 1450 of file DBInstance.h.

◆ SetNcharCharacterSetName() [2/3]

void Aws::RDS::Model::DBInstance::SetNcharCharacterSetName ( const Aws::String value)
inline

The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.

Definition at line 1443 of file DBInstance.h.

◆ SetNcharCharacterSetName() [3/3]

void Aws::RDS::Model::DBInstance::SetNcharCharacterSetName ( const char *  value)
inline

The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.

Definition at line 1457 of file DBInstance.h.

◆ SetOptionGroupMemberships() [1/2]

void Aws::RDS::Model::DBInstance::SetOptionGroupMemberships ( Aws::Vector< OptionGroupMembership > &&  value)
inline

Provides the list of option group memberships for this DB instance.

Definition at line 1352 of file DBInstance.h.

◆ SetOptionGroupMemberships() [2/2]

void Aws::RDS::Model::DBInstance::SetOptionGroupMemberships ( const Aws::Vector< OptionGroupMembership > &  value)
inline

Provides the list of option group memberships for this DB instance.

Definition at line 1347 of file DBInstance.h.

◆ SetPendingModifiedValues() [1/2]

void Aws::RDS::Model::DBInstance::SetPendingModifiedValues ( const PendingModifiedValues value)
inline

A value that specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

Definition at line 868 of file DBInstance.h.

◆ SetPendingModifiedValues() [2/2]

void Aws::RDS::Model::DBInstance::SetPendingModifiedValues ( PendingModifiedValues &&  value)
inline

A value that specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

Definition at line 875 of file DBInstance.h.

◆ SetPerformanceInsightsEnabled()

void Aws::RDS::Model::DBInstance::SetPerformanceInsightsEnabled ( bool  value)
inline

True if Performance Insights is enabled for the DB instance, and otherwise false.

Definition at line 2381 of file DBInstance.h.

◆ SetPerformanceInsightsKMSKeyId() [1/3]

void Aws::RDS::Model::DBInstance::SetPerformanceInsightsKMSKeyId ( Aws::String &&  value)
inline

The AWS KMS key identifier for encryption of Performance Insights data.

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 2416 of file DBInstance.h.

◆ SetPerformanceInsightsKMSKeyId() [2/3]

void Aws::RDS::Model::DBInstance::SetPerformanceInsightsKMSKeyId ( const Aws::String value)
inline

The AWS KMS key identifier for encryption of Performance Insights data.

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 2409 of file DBInstance.h.

◆ SetPerformanceInsightsKMSKeyId() [3/3]

void Aws::RDS::Model::DBInstance::SetPerformanceInsightsKMSKeyId ( const char *  value)
inline

The AWS KMS key identifier for encryption of Performance Insights data.

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 2423 of file DBInstance.h.

◆ SetPerformanceInsightsRetentionPeriod()

void Aws::RDS::Model::DBInstance::SetPerformanceInsightsRetentionPeriod ( int  value)
inline

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

Definition at line 2463 of file DBInstance.h.

◆ SetPreferredBackupWindow() [1/3]

void Aws::RDS::Model::DBInstance::SetPreferredBackupWindow ( Aws::String &&  value)
inline

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

Definition at line 511 of file DBInstance.h.

◆ SetPreferredBackupWindow() [2/3]

void Aws::RDS::Model::DBInstance::SetPreferredBackupWindow ( const Aws::String value)
inline

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

Definition at line 504 of file DBInstance.h.

◆ SetPreferredBackupWindow() [3/3]

void Aws::RDS::Model::DBInstance::SetPreferredBackupWindow ( const char *  value)
inline

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

Definition at line 518 of file DBInstance.h.

◆ SetPreferredMaintenanceWindow() [1/3]

void Aws::RDS::Model::DBInstance::SetPreferredMaintenanceWindow ( Aws::String &&  value)
inline

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Definition at line 822 of file DBInstance.h.

◆ SetPreferredMaintenanceWindow() [2/3]

void Aws::RDS::Model::DBInstance::SetPreferredMaintenanceWindow ( const Aws::String value)
inline

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Definition at line 816 of file DBInstance.h.

◆ SetPreferredMaintenanceWindow() [3/3]

void Aws::RDS::Model::DBInstance::SetPreferredMaintenanceWindow ( const char *  value)
inline

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Definition at line 828 of file DBInstance.h.

◆ SetProcessorFeatures() [1/2]

void Aws::RDS::Model::DBInstance::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.

Definition at line 2576 of file DBInstance.h.

◆ SetProcessorFeatures() [2/2]

void Aws::RDS::Model::DBInstance::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.

Definition at line 2570 of file DBInstance.h.

◆ SetPromotionTier()

void Aws::RDS::Model::DBInstance::SetPromotionTier ( int  value)
inline

A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

Definition at line 2209 of file DBInstance.h.

◆ SetPubliclyAccessible()

void Aws::RDS::Model::DBInstance::SetPubliclyAccessible ( bool  value)
inline

Specifies the accessibility options for the DB instance.

When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

For more information, see CreateDBInstance.

Definition at line 1567 of file DBInstance.h.

◆ SetReadReplicaDBClusterIdentifiers() [1/2]

void Aws::RDS::Model::DBInstance::SetReadReplicaDBClusterIdentifiers ( Aws::Vector< Aws::String > &&  value)
inline

Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output does not contain information about cross region Aurora read replicas.

Currently, each RDS DB instance can have only one Aurora read replica.

Definition at line 1158 of file DBInstance.h.

◆ SetReadReplicaDBClusterIdentifiers() [2/2]

void Aws::RDS::Model::DBInstance::SetReadReplicaDBClusterIdentifiers ( const Aws::Vector< Aws::String > &  value)
inline

Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output does not contain information about cross region Aurora read replicas.

Currently, each RDS DB instance can have only one Aurora read replica.

Definition at line 1148 of file DBInstance.h.

◆ SetReadReplicaDBInstanceIdentifiers() [1/2]

void Aws::RDS::Model::DBInstance::SetReadReplicaDBInstanceIdentifiers ( Aws::Vector< Aws::String > &&  value)
inline

Contains one or more identifiers of the read replicas associated with this DB instance.

Definition at line 1087 of file DBInstance.h.

◆ SetReadReplicaDBInstanceIdentifiers() [2/2]

void Aws::RDS::Model::DBInstance::SetReadReplicaDBInstanceIdentifiers ( const Aws::Vector< Aws::String > &  value)
inline

Contains one or more identifiers of the read replicas associated with this DB instance.

Definition at line 1081 of file DBInstance.h.

◆ SetReadReplicaSourceDBInstanceIdentifier() [1/3]

void Aws::RDS::Model::DBInstance::SetReadReplicaSourceDBInstanceIdentifier ( Aws::String &&  value)
inline

Contains the identifier of the source DB instance if this DB instance is a read replica.

Definition at line 1038 of file DBInstance.h.

◆ SetReadReplicaSourceDBInstanceIdentifier() [2/3]

void Aws::RDS::Model::DBInstance::SetReadReplicaSourceDBInstanceIdentifier ( const Aws::String value)
inline

Contains the identifier of the source DB instance if this DB instance is a read replica.

Definition at line 1032 of file DBInstance.h.

◆ SetReadReplicaSourceDBInstanceIdentifier() [3/3]

void Aws::RDS::Model::DBInstance::SetReadReplicaSourceDBInstanceIdentifier ( const char *  value)
inline

Contains the identifier of the source DB instance if this DB instance is a read replica.

Definition at line 1044 of file DBInstance.h.

◆ SetReplicaMode() [1/2]

void Aws::RDS::Model::DBInstance::SetReplicaMode ( const ReplicaMode value)
inline

The open mode of an Oracle read replica. The default is open-read-only. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.

This attribute is only supported in RDS for Oracle.

Definition at line 1239 of file DBInstance.h.

◆ SetReplicaMode() [2/2]

void Aws::RDS::Model::DBInstance::SetReplicaMode ( ReplicaMode &&  value)
inline

The open mode of an Oracle read replica. The default is open-read-only. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.

This attribute is only supported in RDS for Oracle.

Definition at line 1249 of file DBInstance.h.

◆ SetSecondaryAvailabilityZone() [1/3]

void Aws::RDS::Model::DBInstance::SetSecondaryAvailabilityZone ( Aws::String &&  value)
inline

If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

Definition at line 1503 of file DBInstance.h.

◆ SetSecondaryAvailabilityZone() [2/3]

void Aws::RDS::Model::DBInstance::SetSecondaryAvailabilityZone ( const Aws::String value)
inline

If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

Definition at line 1497 of file DBInstance.h.

◆ SetSecondaryAvailabilityZone() [3/3]

void Aws::RDS::Model::DBInstance::SetSecondaryAvailabilityZone ( const char *  value)
inline

If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

Definition at line 1509 of file DBInstance.h.

◆ SetStatusInfos() [1/2]

void Aws::RDS::Model::DBInstance::SetStatusInfos ( Aws::Vector< DBInstanceStatusInfo > &&  value)
inline

The status of a read replica. If the instance isn't a read replica, this is blank.

Definition at line 1605 of file DBInstance.h.

◆ SetStatusInfos() [2/2]

void Aws::RDS::Model::DBInstance::SetStatusInfos ( const Aws::Vector< DBInstanceStatusInfo > &  value)
inline

The status of a read replica. If the instance isn't a read replica, this is blank.

Definition at line 1599 of file DBInstance.h.

◆ SetStorageEncrypted()

void Aws::RDS::Model::DBInstance::SetStorageEncrypted ( bool  value)
inline

Specifies whether the DB instance is encrypted.

Definition at line 1809 of file DBInstance.h.

◆ SetStorageType() [1/3]

void Aws::RDS::Model::DBInstance::SetStorageType ( Aws::String &&  value)
inline

Specifies the storage type associated with DB instance.

Definition at line 1650 of file DBInstance.h.

◆ SetStorageType() [2/3]

void Aws::RDS::Model::DBInstance::SetStorageType ( const Aws::String value)
inline

Specifies the storage type associated with DB instance.

Definition at line 1645 of file DBInstance.h.

◆ SetStorageType() [3/3]

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

Specifies the storage type associated with DB instance.

Definition at line 1655 of file DBInstance.h.

◆ SetTagList() [1/2]

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

Definition at line 2755 of file DBInstance.h.

◆ SetTagList() [2/2]

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

Definition at line 2752 of file DBInstance.h.

◆ SetTdeCredentialArn() [1/3]

void Aws::RDS::Model::DBInstance::SetTdeCredentialArn ( Aws::String &&  value)
inline

The ARN from the key store with which the instance is associated for TDE encryption.

Definition at line 1695 of file DBInstance.h.

◆ SetTdeCredentialArn() [2/3]

void Aws::RDS::Model::DBInstance::SetTdeCredentialArn ( const Aws::String value)
inline

The ARN from the key store with which the instance is associated for TDE encryption.

Definition at line 1689 of file DBInstance.h.

◆ SetTdeCredentialArn() [3/3]

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

The ARN from the key store with which the instance is associated for TDE encryption.

Definition at line 1701 of file DBInstance.h.

◆ SetTimezone() [1/3]

void Aws::RDS::Model::DBInstance::SetTimezone ( Aws::String &&  value)
inline

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

Definition at line 2289 of file DBInstance.h.

◆ SetTimezone() [2/3]

void Aws::RDS::Model::DBInstance::SetTimezone ( const Aws::String value)
inline

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

Definition at line 2282 of file DBInstance.h.

◆ SetTimezone() [3/3]

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

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

Definition at line 2296 of file DBInstance.h.

◆ SetVpcSecurityGroups() [1/2]

void Aws::RDS::Model::DBInstance::SetVpcSecurityGroups ( Aws::Vector< VpcSecurityGroupMembership > &&  value)
inline

Provides a list of VPC security group elements that the DB instance belongs to.

Definition at line 646 of file DBInstance.h.

◆ SetVpcSecurityGroups() [2/2]

void Aws::RDS::Model::DBInstance::SetVpcSecurityGroups ( const Aws::Vector< VpcSecurityGroupMembership > &  value)
inline

Provides a list of VPC security group elements that the DB instance belongs to.

Definition at line 640 of file DBInstance.h.

◆ StatusInfosHasBeenSet()

bool Aws::RDS::Model::DBInstance::StatusInfosHasBeenSet ( ) const
inline

The status of a read replica. If the instance isn't a read replica, this is blank.

Definition at line 1593 of file DBInstance.h.

◆ StorageEncryptedHasBeenSet()

bool Aws::RDS::Model::DBInstance::StorageEncryptedHasBeenSet ( ) const
inline

Specifies whether the DB instance is encrypted.

Definition at line 1804 of file DBInstance.h.

◆ StorageTypeHasBeenSet()

bool Aws::RDS::Model::DBInstance::StorageTypeHasBeenSet ( ) const
inline

Specifies the storage type associated with DB instance.

Definition at line 1640 of file DBInstance.h.

◆ TagListHasBeenSet()

bool Aws::RDS::Model::DBInstance::TagListHasBeenSet ( ) const
inline

Definition at line 2749 of file DBInstance.h.

◆ TdeCredentialArnHasBeenSet()

bool Aws::RDS::Model::DBInstance::TdeCredentialArnHasBeenSet ( ) const
inline

The ARN from the key store with which the instance is associated for TDE encryption.

Definition at line 1683 of file DBInstance.h.

◆ TimezoneHasBeenSet()

bool Aws::RDS::Model::DBInstance::TimezoneHasBeenSet ( ) const
inline

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

Definition at line 2275 of file DBInstance.h.

◆ VpcSecurityGroupsHasBeenSet()

bool Aws::RDS::Model::DBInstance::VpcSecurityGroupsHasBeenSet ( ) const
inline

Provides a list of VPC security group elements that the DB instance belongs to.

Definition at line 634 of file DBInstance.h.

◆ WithAllocatedStorage()

DBInstance& Aws::RDS::Model::DBInstance::WithAllocatedStorage ( int  value)
inline

Specifies the allocated storage size specified in gibibytes.

Definition at line 451 of file DBInstance.h.

◆ WithAssociatedRoles() [1/2]

DBInstance& Aws::RDS::Model::DBInstance::WithAssociatedRoles ( Aws::Vector< DBInstanceRole > &&  value)
inline

The AWS Identity and Access Management (IAM) roles associated with the DB instance.

Definition at line 2674 of file DBInstance.h.

◆ WithAssociatedRoles() [2/2]

DBInstance& Aws::RDS::Model::DBInstance::WithAssociatedRoles ( const Aws::Vector< DBInstanceRole > &  value)
inline

The AWS Identity and Access Management (IAM) roles associated with the DB instance.

Definition at line 2668 of file DBInstance.h.

◆ WithAutoMinorVersionUpgrade()

DBInstance& Aws::RDS::Model::DBInstance::WithAutoMinorVersionUpgrade ( bool  value)
inline

A value that indicates that minor version patches are applied automatically.

Definition at line 1013 of file DBInstance.h.

◆ WithAvailabilityZone() [1/3]

DBInstance& Aws::RDS::Model::DBInstance::WithAvailabilityZone ( Aws::String &&  value)
inline

Specifies the name of the Availability Zone the DB instance is located in.

Definition at line 754 of file DBInstance.h.

◆ WithAvailabilityZone() [2/3]

DBInstance& Aws::RDS::Model::DBInstance::WithAvailabilityZone ( const Aws::String value)
inline

Specifies the name of the Availability Zone the DB instance is located in.

Definition at line 748 of file DBInstance.h.

◆ WithAvailabilityZone() [3/3]

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

Specifies the name of the Availability Zone the DB instance is located in.

Definition at line 760 of file DBInstance.h.

◆ WithAwsBackupRecoveryPointArn() [1/3]

DBInstance& Aws::RDS::Model::DBInstance::WithAwsBackupRecoveryPointArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the recovery point in AWS Backup.

Definition at line 2905 of file DBInstance.h.

◆ WithAwsBackupRecoveryPointArn() [2/3]

DBInstance& Aws::RDS::Model::DBInstance::WithAwsBackupRecoveryPointArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the recovery point in AWS Backup.

Definition at line 2900 of file DBInstance.h.

◆ WithAwsBackupRecoveryPointArn() [3/3]

DBInstance& Aws::RDS::Model::DBInstance::WithAwsBackupRecoveryPointArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the recovery point in AWS Backup.

Definition at line 2910 of file DBInstance.h.

◆ WithBackupRetentionPeriod()

DBInstance& Aws::RDS::Model::DBInstance::WithBackupRetentionPeriod ( int  value)
inline

Specifies the number of days for which automatic DB snapshots are retained.

Definition at line 564 of file DBInstance.h.

◆ WithCACertificateIdentifier() [1/3]

DBInstance& Aws::RDS::Model::DBInstance::WithCACertificateIdentifier ( Aws::String &&  value)
inline

The identifier of the CA certificate for this DB instance.

Definition at line 1964 of file DBInstance.h.

◆ WithCACertificateIdentifier() [2/3]

DBInstance& Aws::RDS::Model::DBInstance::WithCACertificateIdentifier ( const Aws::String value)
inline

The identifier of the CA certificate for this DB instance.

Definition at line 1959 of file DBInstance.h.

◆ WithCACertificateIdentifier() [3/3]

DBInstance& Aws::RDS::Model::DBInstance::WithCACertificateIdentifier ( const char *  value)
inline

The identifier of the CA certificate for this DB instance.

Definition at line 1969 of file DBInstance.h.

◆ WithCharacterSetName() [1/3]

DBInstance& Aws::RDS::Model::DBInstance::WithCharacterSetName ( Aws::String &&  value)
inline

If present, specifies the name of the character set that this instance is associated with.

Definition at line 1415 of file DBInstance.h.

◆ WithCharacterSetName() [2/3]

DBInstance& Aws::RDS::Model::DBInstance::WithCharacterSetName ( const Aws::String value)
inline

If present, specifies the name of the character set that this instance is associated with.

Definition at line 1409 of file DBInstance.h.

◆ WithCharacterSetName() [3/3]

DBInstance& Aws::RDS::Model::DBInstance::WithCharacterSetName ( const char *  value)
inline

If present, specifies the name of the character set that this instance is associated with.

Definition at line 1421 of file DBInstance.h.

◆ WithCopyTagsToSnapshot()

DBInstance& Aws::RDS::Model::DBInstance::WithCopyTagsToSnapshot ( bool  value)
inline

Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

Amazon Aurora

Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see DBCluster.

Definition at line 2055 of file DBInstance.h.

◆ WithCustomerOwnedIpEnabled()

DBInstance& Aws::RDS::Model::DBInstance::WithCustomerOwnedIpEnabled ( bool  value)
inline

Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.

A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.

For more information about RDS on Outposts, see Working with Amazon RDS on AWS Outposts in the Amazon RDS User Guide.

For more information about CoIPs, see Customer-owned IP addresses in the AWS Outposts User Guide.

Definition at line 2869 of file DBInstance.h.

◆ WithDBClusterIdentifier() [1/3]

DBInstance& Aws::RDS::Model::DBInstance::WithDBClusterIdentifier ( Aws::String &&  value)
inline

If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

Definition at line 1787 of file DBInstance.h.

◆ WithDBClusterIdentifier() [2/3]

DBInstance& Aws::RDS::Model::DBInstance::WithDBClusterIdentifier ( const Aws::String value)
inline

If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

Definition at line 1781 of file DBInstance.h.

◆ WithDBClusterIdentifier() [3/3]

DBInstance& Aws::RDS::Model::DBInstance::WithDBClusterIdentifier ( const char *  value)
inline

If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

Definition at line 1793 of file DBInstance.h.

◆ WithDBInstanceArn() [1/3]

DBInstance& Aws::RDS::Model::DBInstance::WithDBInstanceArn ( Aws::String &&  value)
inline

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

Definition at line 2255 of file DBInstance.h.

◆ WithDBInstanceArn() [2/3]

DBInstance& Aws::RDS::Model::DBInstance::WithDBInstanceArn ( const Aws::String value)
inline

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

Definition at line 2250 of file DBInstance.h.

◆ WithDBInstanceArn() [3/3]

DBInstance& Aws::RDS::Model::DBInstance::WithDBInstanceArn ( const char *  value)
inline

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

Definition at line 2260 of file DBInstance.h.

◆ WithDBInstanceAutomatedBackupsReplications() [1/2]

DBInstance& Aws::RDS::Model::DBInstance::WithDBInstanceAutomatedBackupsReplications ( Aws::Vector< DBInstanceAutomatedBackupsReplication > &&  value)
inline

The list of replicated automated backups associated with the DB instance.

Definition at line 2798 of file DBInstance.h.

◆ WithDBInstanceAutomatedBackupsReplications() [2/2]

DBInstance& Aws::RDS::Model::DBInstance::WithDBInstanceAutomatedBackupsReplications ( const Aws::Vector< DBInstanceAutomatedBackupsReplication > &  value)
inline

The list of replicated automated backups associated with the DB instance.

Definition at line 2793 of file DBInstance.h.

◆ WithDBInstanceClass() [1/3]

DBInstance& Aws::RDS::Model::DBInstance::WithDBInstanceClass ( Aws::String &&  value)
inline

Contains the name of the compute and memory capacity class of the DB instance.

Definition at line 149 of file DBInstance.h.

◆ WithDBInstanceClass() [2/3]

DBInstance& Aws::RDS::Model::DBInstance::WithDBInstanceClass ( const Aws::String value)
inline

Contains the name of the compute and memory capacity class of the DB instance.

Definition at line 143 of file DBInstance.h.

◆ WithDBInstanceClass() [3/3]

DBInstance& Aws::RDS::Model::DBInstance::WithDBInstanceClass ( const char *  value)
inline

Contains the name of the compute and memory capacity class of the DB instance.

Definition at line 155 of file DBInstance.h.

◆ WithDBInstanceIdentifier() [1/3]

DBInstance& Aws::RDS::Model::DBInstance::WithDBInstanceIdentifier ( Aws::String &&  value)
inline

Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

Definition at line 100 of file DBInstance.h.

◆ WithDBInstanceIdentifier() [2/3]

DBInstance& Aws::RDS::Model::DBInstance::WithDBInstanceIdentifier ( const Aws::String value)
inline

Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

Definition at line 94 of file DBInstance.h.

◆ WithDBInstanceIdentifier() [3/3]

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

Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

Definition at line 106 of file DBInstance.h.

◆ WithDbInstancePort()

DBInstance& Aws::RDS::Model::DBInstance::WithDbInstancePort ( int  value)
inline

Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

Definition at line 1744 of file DBInstance.h.

◆ WithDBInstanceStatus() [1/3]

DBInstance& Aws::RDS::Model::DBInstance::WithDBInstanceStatus ( Aws::String &&  value)
inline

Specifies the current state of this database.

For information about DB instance statuses, see DB Instance Status in the Amazon RDS User Guide.

Definition at line 253 of file DBInstance.h.

◆ WithDBInstanceStatus() [2/3]

DBInstance& Aws::RDS::Model::DBInstance::WithDBInstanceStatus ( const Aws::String value)
inline

Specifies the current state of this database.

For information about DB instance statuses, see DB Instance Status in the Amazon RDS User Guide.

Definition at line 245 of file DBInstance.h.

◆ WithDBInstanceStatus() [3/3]

DBInstance& Aws::RDS::Model::DBInstance::WithDBInstanceStatus ( const char *  value)
inline

Specifies the current state of this database.

For information about DB instance statuses, see DB Instance Status in the Amazon RDS User Guide.

Definition at line 261 of file DBInstance.h.

◆ WithDbiResourceId() [1/3]

DBInstance& Aws::RDS::Model::DBInstance::WithDbiResourceId ( Aws::String &&  value)
inline

The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS customer master key (CMK) for the DB instance is accessed.

Definition at line 1921 of file DBInstance.h.

◆ WithDbiResourceId() [2/3]

DBInstance& Aws::RDS::Model::DBInstance::WithDbiResourceId ( const Aws::String value)
inline

The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS customer master key (CMK) for the DB instance is accessed.

Definition at line 1914 of file DBInstance.h.

◆ WithDbiResourceId() [3/3]

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

The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS customer master key (CMK) for the DB instance is accessed.

Definition at line 1928 of file DBInstance.h.

◆ WithDBName() [1/3]

DBInstance& Aws::RDS::Model::DBInstance::WithDBName ( Aws::String &&  value)
inline

The meaning of this parameter differs according to the database engine you use.

MySQL, MariaDB, SQL Server, PostgreSQL

Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

Type: String

Oracle

Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

Definition at line 387 of file DBInstance.h.

◆ WithDBName() [2/3]

DBInstance& Aws::RDS::Model::DBInstance::WithDBName ( const Aws::String value)
inline

The meaning of this parameter differs according to the database engine you use.

MySQL, MariaDB, SQL Server, PostgreSQL

Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

Type: String

Oracle

Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

Definition at line 375 of file DBInstance.h.

◆ WithDBName() [3/3]

DBInstance& Aws::RDS::Model::DBInstance::WithDBName ( const char *  value)
inline

The meaning of this parameter differs according to the database engine you use.

MySQL, MariaDB, SQL Server, PostgreSQL

Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

Type: String

Oracle

Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

Definition at line 399 of file DBInstance.h.

◆ WithDBParameterGroups() [1/2]

DBInstance& Aws::RDS::Model::DBInstance::WithDBParameterGroups ( Aws::Vector< DBParameterGroupStatus > &&  value)
inline

Provides the list of DB parameter groups applied to this DB instance.

Definition at line 701 of file DBInstance.h.

◆ WithDBParameterGroups() [2/2]

DBInstance& Aws::RDS::Model::DBInstance::WithDBParameterGroups ( const Aws::Vector< DBParameterGroupStatus > &  value)
inline

Provides the list of DB parameter groups applied to this DB instance.

Definition at line 696 of file DBInstance.h.

◆ WithDBSecurityGroups() [1/2]

DBInstance& Aws::RDS::Model::DBInstance::WithDBSecurityGroups ( Aws::Vector< DBSecurityGroupMembership > &&  value)
inline

A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

Definition at line 607 of file DBInstance.h.

◆ WithDBSecurityGroups() [2/2]

DBInstance& Aws::RDS::Model::DBInstance::WithDBSecurityGroups ( const Aws::Vector< DBSecurityGroupMembership > &  value)
inline

A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

Definition at line 600 of file DBInstance.h.

◆ WithDBSubnetGroup() [1/2]

DBInstance& Aws::RDS::Model::DBInstance::WithDBSubnetGroup ( const DBSubnetGroup value)
inline

Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

Definition at line 791 of file DBInstance.h.

◆ WithDBSubnetGroup() [2/2]

DBInstance& Aws::RDS::Model::DBInstance::WithDBSubnetGroup ( DBSubnetGroup &&  value)
inline

Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

Definition at line 797 of file DBInstance.h.

◆ WithDeletionProtection()

DBInstance& Aws::RDS::Model::DBInstance::WithDeletionProtection ( bool  value)
inline

Indicates if the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance.

Definition at line 2637 of file DBInstance.h.

◆ WithDomainMemberships() [1/2]

DBInstance& Aws::RDS::Model::DBInstance::WithDomainMemberships ( Aws::Vector< DomainMembership > &&  value)
inline

The Active Directory Domain membership records associated with the DB instance.

Definition at line 2006 of file DBInstance.h.

◆ WithDomainMemberships() [2/2]

DBInstance& Aws::RDS::Model::DBInstance::WithDomainMemberships ( const Aws::Vector< DomainMembership > &  value)
inline

The Active Directory Domain membership records associated with the DB instance.

Definition at line 2000 of file DBInstance.h.

◆ WithEnabledCloudwatchLogsExports() [1/2]

DBInstance& Aws::RDS::Model::DBInstance::WithEnabledCloudwatchLogsExports ( Aws::Vector< Aws::String > &&  value)
inline

A list of log types that this DB instance is configured to export to CloudWatch Logs.

Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon RDS User Guide.

Definition at line 2524 of file DBInstance.h.

◆ WithEnabledCloudwatchLogsExports() [2/2]

DBInstance& Aws::RDS::Model::DBInstance::WithEnabledCloudwatchLogsExports ( const Aws::Vector< Aws::String > &  value)
inline

A list of log types that this DB instance is configured to export to CloudWatch Logs.

Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon RDS User Guide.

Definition at line 2515 of file DBInstance.h.

◆ WithEndpoint() [1/2]

DBInstance& Aws::RDS::Model::DBInstance::WithEndpoint ( const Endpoint value)
inline

Specifies the connection endpoint.

Definition at line 425 of file DBInstance.h.

◆ WithEndpoint() [2/2]

DBInstance& Aws::RDS::Model::DBInstance::WithEndpoint ( Endpoint &&  value)
inline

Specifies the connection endpoint.

Definition at line 430 of file DBInstance.h.

◆ WithEngine() [1/3]

DBInstance& Aws::RDS::Model::DBInstance::WithEngine ( Aws::String &&  value)
inline

The name of the database engine to be used for this DB instance.

Definition at line 191 of file DBInstance.h.

◆ WithEngine() [2/3]

DBInstance& Aws::RDS::Model::DBInstance::WithEngine ( const Aws::String value)
inline

The name of the database engine to be used for this DB instance.

Definition at line 186 of file DBInstance.h.

◆ WithEngine() [3/3]

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

The name of the database engine to be used for this DB instance.

Definition at line 196 of file DBInstance.h.

◆ WithEngineVersion() [1/3]

DBInstance& Aws::RDS::Model::DBInstance::WithEngineVersion ( Aws::String &&  value)
inline

Indicates the database engine version.

Definition at line 983 of file DBInstance.h.

◆ WithEngineVersion() [2/3]

DBInstance& Aws::RDS::Model::DBInstance::WithEngineVersion ( const Aws::String value)
inline

Indicates the database engine version.

Definition at line 978 of file DBInstance.h.

◆ WithEngineVersion() [3/3]

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

Indicates the database engine version.

Definition at line 988 of file DBInstance.h.

◆ WithEnhancedMonitoringResourceArn() [1/3]

DBInstance& Aws::RDS::Model::DBInstance::WithEnhancedMonitoringResourceArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

Definition at line 2123 of file DBInstance.h.

◆ WithEnhancedMonitoringResourceArn() [2/3]

DBInstance& Aws::RDS::Model::DBInstance::WithEnhancedMonitoringResourceArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

Definition at line 2117 of file DBInstance.h.

◆ WithEnhancedMonitoringResourceArn() [3/3]

DBInstance& Aws::RDS::Model::DBInstance::WithEnhancedMonitoringResourceArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

Definition at line 2129 of file DBInstance.h.

◆ WithIAMDatabaseAuthenticationEnabled()

DBInstance& Aws::RDS::Model::DBInstance::WithIAMDatabaseAuthenticationEnabled ( bool  value)
inline

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

IAM database authentication can be enabled for the following database engines

  • For MySQL 5.6, minor version 5.6.34 or higher

  • For MySQL 5.7, minor version 5.7.16 or higher

  • Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.

Definition at line 2362 of file DBInstance.h.

◆ WithInstanceCreateTime() [1/2]

DBInstance& Aws::RDS::Model::DBInstance::WithInstanceCreateTime ( Aws::Utils::DateTime &&  value)
inline

Provides the date and time the DB instance was created.

Definition at line 482 of file DBInstance.h.

◆ WithInstanceCreateTime() [2/2]

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

Provides the date and time the DB instance was created.

Definition at line 477 of file DBInstance.h.

◆ WithIops()

DBInstance& Aws::RDS::Model::DBInstance::WithIops ( int  value)
inline

Specifies the Provisioned IOPS (I/O operations per second) value.

Definition at line 1331 of file DBInstance.h.

◆ WithKmsKeyId() [1/3]

DBInstance& Aws::RDS::Model::DBInstance::WithKmsKeyId ( Aws::String &&  value)
inline

If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB instance.

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 1864 of file DBInstance.h.

◆ WithKmsKeyId() [2/3]

DBInstance& Aws::RDS::Model::DBInstance::WithKmsKeyId ( const Aws::String value)
inline

If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB instance.

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 1857 of file DBInstance.h.

◆ WithKmsKeyId() [3/3]

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

If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB instance.

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 1871 of file DBInstance.h.

◆ WithLatestRestorableTime() [1/2]

DBInstance& Aws::RDS::Model::DBInstance::WithLatestRestorableTime ( Aws::Utils::DateTime &&  value)
inline

Specifies the latest time to which a database can be restored with point-in-time restore.

Definition at line 926 of file DBInstance.h.

◆ WithLatestRestorableTime() [2/2]

DBInstance& Aws::RDS::Model::DBInstance::WithLatestRestorableTime ( const Aws::Utils::DateTime value)
inline

Specifies the latest time to which a database can be restored with point-in-time restore.

Definition at line 920 of file DBInstance.h.

◆ WithLicenseModel() [1/3]

DBInstance& Aws::RDS::Model::DBInstance::WithLicenseModel ( Aws::String &&  value)
inline

License model information for this DB instance.

Definition at line 1305 of file DBInstance.h.

◆ WithLicenseModel() [2/3]

DBInstance& Aws::RDS::Model::DBInstance::WithLicenseModel ( const Aws::String value)
inline

License model information for this DB instance.

Definition at line 1300 of file DBInstance.h.

◆ WithLicenseModel() [3/3]

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

License model information for this DB instance.

Definition at line 1310 of file DBInstance.h.

◆ WithListenerEndpoint() [1/2]

DBInstance& Aws::RDS::Model::DBInstance::WithListenerEndpoint ( const Endpoint value)
inline

Specifies the listener connection endpoint for SQL Server Always On.

Definition at line 2712 of file DBInstance.h.

◆ WithListenerEndpoint() [2/2]

DBInstance& Aws::RDS::Model::DBInstance::WithListenerEndpoint ( Endpoint &&  value)
inline

Specifies the listener connection endpoint for SQL Server Always On.

Definition at line 2717 of file DBInstance.h.

◆ WithMasterUsername() [1/3]

DBInstance& Aws::RDS::Model::DBInstance::WithMasterUsername ( Aws::String &&  value)
inline

Contains the master username for the DB instance.

Definition at line 297 of file DBInstance.h.

◆ WithMasterUsername() [2/3]

DBInstance& Aws::RDS::Model::DBInstance::WithMasterUsername ( const Aws::String value)
inline

Contains the master username for the DB instance.

Definition at line 292 of file DBInstance.h.

◆ WithMasterUsername() [3/3]

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

Contains the master username for the DB instance.

Definition at line 302 of file DBInstance.h.

◆ WithMaxAllocatedStorage()

DBInstance& Aws::RDS::Model::DBInstance::WithMaxAllocatedStorage ( int  value)
inline

The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.

Definition at line 2742 of file DBInstance.h.

◆ WithMonitoringInterval()

DBInstance& Aws::RDS::Model::DBInstance::WithMonitoringInterval ( int  value)
inline

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

Definition at line 2080 of file DBInstance.h.

◆ WithMonitoringRoleArn() [1/3]

DBInstance& Aws::RDS::Model::DBInstance::WithMonitoringRoleArn ( Aws::String &&  value)
inline

The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

Definition at line 2172 of file DBInstance.h.

◆ WithMonitoringRoleArn() [2/3]

DBInstance& Aws::RDS::Model::DBInstance::WithMonitoringRoleArn ( const Aws::String value)
inline

The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

Definition at line 2166 of file DBInstance.h.

◆ WithMonitoringRoleArn() [3/3]

DBInstance& Aws::RDS::Model::DBInstance::WithMonitoringRoleArn ( const char *  value)
inline

The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

Definition at line 2178 of file DBInstance.h.

◆ WithMultiAZ()

DBInstance& Aws::RDS::Model::DBInstance::WithMultiAZ ( bool  value)
inline

Specifies if the DB instance is a Multi-AZ deployment.

Definition at line 947 of file DBInstance.h.

◆ WithNcharCharacterSetName() [1/3]

DBInstance& Aws::RDS::Model::DBInstance::WithNcharCharacterSetName ( Aws::String &&  value)
inline

The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.

Definition at line 1471 of file DBInstance.h.

◆ WithNcharCharacterSetName() [2/3]

DBInstance& Aws::RDS::Model::DBInstance::WithNcharCharacterSetName ( const Aws::String value)
inline

The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.

Definition at line 1464 of file DBInstance.h.

◆ WithNcharCharacterSetName() [3/3]

DBInstance& Aws::RDS::Model::DBInstance::WithNcharCharacterSetName ( const char *  value)
inline

The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.

Definition at line 1478 of file DBInstance.h.

◆ WithOptionGroupMemberships() [1/2]

DBInstance& Aws::RDS::Model::DBInstance::WithOptionGroupMemberships ( Aws::Vector< OptionGroupMembership > &&  value)
inline

Provides the list of option group memberships for this DB instance.

Definition at line 1362 of file DBInstance.h.

◆ WithOptionGroupMemberships() [2/2]

DBInstance& Aws::RDS::Model::DBInstance::WithOptionGroupMemberships ( const Aws::Vector< OptionGroupMembership > &  value)
inline

Provides the list of option group memberships for this DB instance.

Definition at line 1357 of file DBInstance.h.

◆ WithPendingModifiedValues() [1/2]

DBInstance& Aws::RDS::Model::DBInstance::WithPendingModifiedValues ( const PendingModifiedValues value)
inline

A value that specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

Definition at line 882 of file DBInstance.h.

◆ WithPendingModifiedValues() [2/2]

DBInstance& Aws::RDS::Model::DBInstance::WithPendingModifiedValues ( PendingModifiedValues &&  value)
inline

A value that specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

Definition at line 889 of file DBInstance.h.

◆ WithPerformanceInsightsEnabled()

DBInstance& Aws::RDS::Model::DBInstance::WithPerformanceInsightsEnabled ( bool  value)
inline

True if Performance Insights is enabled for the DB instance, and otherwise false.

Definition at line 2387 of file DBInstance.h.

◆ WithPerformanceInsightsKMSKeyId() [1/3]

DBInstance& Aws::RDS::Model::DBInstance::WithPerformanceInsightsKMSKeyId ( Aws::String &&  value)
inline

The AWS KMS key identifier for encryption of Performance Insights data.

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 2437 of file DBInstance.h.

◆ WithPerformanceInsightsKMSKeyId() [2/3]

DBInstance& Aws::RDS::Model::DBInstance::WithPerformanceInsightsKMSKeyId ( const Aws::String value)
inline

The AWS KMS key identifier for encryption of Performance Insights data.

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 2430 of file DBInstance.h.

◆ WithPerformanceInsightsKMSKeyId() [3/3]

DBInstance& Aws::RDS::Model::DBInstance::WithPerformanceInsightsKMSKeyId ( const char *  value)
inline

The AWS KMS key identifier for encryption of Performance Insights data.

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 2444 of file DBInstance.h.

◆ WithPerformanceInsightsRetentionPeriod()

DBInstance& Aws::RDS::Model::DBInstance::WithPerformanceInsightsRetentionPeriod ( int  value)
inline

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

Definition at line 2469 of file DBInstance.h.

◆ WithPreferredBackupWindow() [1/3]

DBInstance& Aws::RDS::Model::DBInstance::WithPreferredBackupWindow ( Aws::String &&  value)
inline

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

Definition at line 532 of file DBInstance.h.

◆ WithPreferredBackupWindow() [2/3]

DBInstance& Aws::RDS::Model::DBInstance::WithPreferredBackupWindow ( const Aws::String value)
inline

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

Definition at line 525 of file DBInstance.h.

◆ WithPreferredBackupWindow() [3/3]

DBInstance& Aws::RDS::Model::DBInstance::WithPreferredBackupWindow ( const char *  value)
inline

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

Definition at line 539 of file DBInstance.h.

◆ WithPreferredMaintenanceWindow() [1/3]

DBInstance& Aws::RDS::Model::DBInstance::WithPreferredMaintenanceWindow ( Aws::String &&  value)
inline

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Definition at line 840 of file DBInstance.h.

◆ WithPreferredMaintenanceWindow() [2/3]

DBInstance& Aws::RDS::Model::DBInstance::WithPreferredMaintenanceWindow ( const Aws::String value)
inline

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Definition at line 834 of file DBInstance.h.

◆ WithPreferredMaintenanceWindow() [3/3]

DBInstance& Aws::RDS::Model::DBInstance::WithPreferredMaintenanceWindow ( const char *  value)
inline

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Definition at line 846 of file DBInstance.h.

◆ WithProcessorFeatures() [1/2]

DBInstance& Aws::RDS::Model::DBInstance::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.

Definition at line 2588 of file DBInstance.h.

◆ WithProcessorFeatures() [2/2]

DBInstance& Aws::RDS::Model::DBInstance::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.

Definition at line 2582 of file DBInstance.h.

◆ WithPromotionTier()

DBInstance& Aws::RDS::Model::DBInstance::WithPromotionTier ( int  value)
inline

A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

Definition at line 2219 of file DBInstance.h.

◆ WithPubliclyAccessible()

DBInstance& Aws::RDS::Model::DBInstance::WithPubliclyAccessible ( bool  value)
inline

Specifies the accessibility options for the DB instance.

When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.

When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.

For more information, see CreateDBInstance.

Definition at line 1580 of file DBInstance.h.

◆ WithReadReplicaDBClusterIdentifiers() [1/2]

DBInstance& Aws::RDS::Model::DBInstance::WithReadReplicaDBClusterIdentifiers ( Aws::Vector< Aws::String > &&  value)
inline

Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output does not contain information about cross region Aurora read replicas.

Currently, each RDS DB instance can have only one Aurora read replica.

Definition at line 1178 of file DBInstance.h.

◆ WithReadReplicaDBClusterIdentifiers() [2/2]

DBInstance& Aws::RDS::Model::DBInstance::WithReadReplicaDBClusterIdentifiers ( const Aws::Vector< Aws::String > &  value)
inline

Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output does not contain information about cross region Aurora read replicas.

Currently, each RDS DB instance can have only one Aurora read replica.

Definition at line 1168 of file DBInstance.h.

◆ WithReadReplicaDBInstanceIdentifiers() [1/2]

DBInstance& Aws::RDS::Model::DBInstance::WithReadReplicaDBInstanceIdentifiers ( Aws::Vector< Aws::String > &&  value)
inline

Contains one or more identifiers of the read replicas associated with this DB instance.

Definition at line 1099 of file DBInstance.h.

◆ WithReadReplicaDBInstanceIdentifiers() [2/2]

DBInstance& Aws::RDS::Model::DBInstance::WithReadReplicaDBInstanceIdentifiers ( const Aws::Vector< Aws::String > &  value)
inline

Contains one or more identifiers of the read replicas associated with this DB instance.

Definition at line 1093 of file DBInstance.h.

◆ WithReadReplicaSourceDBInstanceIdentifier() [1/3]

DBInstance& Aws::RDS::Model::DBInstance::WithReadReplicaSourceDBInstanceIdentifier ( Aws::String &&  value)
inline

Contains the identifier of the source DB instance if this DB instance is a read replica.

Definition at line 1056 of file DBInstance.h.

◆ WithReadReplicaSourceDBInstanceIdentifier() [2/3]

DBInstance& Aws::RDS::Model::DBInstance::WithReadReplicaSourceDBInstanceIdentifier ( const Aws::String value)
inline

Contains the identifier of the source DB instance if this DB instance is a read replica.

Definition at line 1050 of file DBInstance.h.

◆ WithReadReplicaSourceDBInstanceIdentifier() [3/3]

DBInstance& Aws::RDS::Model::DBInstance::WithReadReplicaSourceDBInstanceIdentifier ( const char *  value)
inline

Contains the identifier of the source DB instance if this DB instance is a read replica.

Definition at line 1062 of file DBInstance.h.

◆ WithReplicaMode() [1/2]

DBInstance& Aws::RDS::Model::DBInstance::WithReplicaMode ( const ReplicaMode value)
inline

The open mode of an Oracle read replica. The default is open-read-only. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.

This attribute is only supported in RDS for Oracle.

Definition at line 1259 of file DBInstance.h.

◆ WithReplicaMode() [2/2]

DBInstance& Aws::RDS::Model::DBInstance::WithReplicaMode ( ReplicaMode &&  value)
inline

The open mode of an Oracle read replica. The default is open-read-only. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.

This attribute is only supported in RDS for Oracle.

Definition at line 1269 of file DBInstance.h.

◆ WithSecondaryAvailabilityZone() [1/3]

DBInstance& Aws::RDS::Model::DBInstance::WithSecondaryAvailabilityZone ( Aws::String &&  value)
inline

If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

Definition at line 1521 of file DBInstance.h.

◆ WithSecondaryAvailabilityZone() [2/3]

DBInstance& Aws::RDS::Model::DBInstance::WithSecondaryAvailabilityZone ( const Aws::String value)
inline

If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

Definition at line 1515 of file DBInstance.h.

◆ WithSecondaryAvailabilityZone() [3/3]

DBInstance& Aws::RDS::Model::DBInstance::WithSecondaryAvailabilityZone ( const char *  value)
inline

If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

Definition at line 1527 of file DBInstance.h.

◆ WithStatusInfos() [1/2]

DBInstance& Aws::RDS::Model::DBInstance::WithStatusInfos ( Aws::Vector< DBInstanceStatusInfo > &&  value)
inline

The status of a read replica. If the instance isn't a read replica, this is blank.

Definition at line 1617 of file DBInstance.h.

◆ WithStatusInfos() [2/2]

DBInstance& Aws::RDS::Model::DBInstance::WithStatusInfos ( const Aws::Vector< DBInstanceStatusInfo > &  value)
inline

The status of a read replica. If the instance isn't a read replica, this is blank.

Definition at line 1611 of file DBInstance.h.

◆ WithStorageEncrypted()

DBInstance& Aws::RDS::Model::DBInstance::WithStorageEncrypted ( bool  value)
inline

Specifies whether the DB instance is encrypted.

Definition at line 1814 of file DBInstance.h.

◆ WithStorageType() [1/3]

DBInstance& Aws::RDS::Model::DBInstance::WithStorageType ( Aws::String &&  value)
inline

Specifies the storage type associated with DB instance.

Definition at line 1665 of file DBInstance.h.

◆ WithStorageType() [2/3]

DBInstance& Aws::RDS::Model::DBInstance::WithStorageType ( const Aws::String value)
inline

Specifies the storage type associated with DB instance.

Definition at line 1660 of file DBInstance.h.

◆ WithStorageType() [3/3]

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

Specifies the storage type associated with DB instance.

Definition at line 1670 of file DBInstance.h.

◆ WithTagList() [1/2]

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

Definition at line 2761 of file DBInstance.h.

◆ WithTagList() [2/2]

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

Definition at line 2758 of file DBInstance.h.

◆ WithTdeCredentialArn() [1/3]

DBInstance& Aws::RDS::Model::DBInstance::WithTdeCredentialArn ( Aws::String &&  value)
inline

The ARN from the key store with which the instance is associated for TDE encryption.

Definition at line 1713 of file DBInstance.h.

◆ WithTdeCredentialArn() [2/3]

DBInstance& Aws::RDS::Model::DBInstance::WithTdeCredentialArn ( const Aws::String value)
inline

The ARN from the key store with which the instance is associated for TDE encryption.

Definition at line 1707 of file DBInstance.h.

◆ WithTdeCredentialArn() [3/3]

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

The ARN from the key store with which the instance is associated for TDE encryption.

Definition at line 1719 of file DBInstance.h.

◆ WithTimezone() [1/3]

DBInstance& Aws::RDS::Model::DBInstance::WithTimezone ( Aws::String &&  value)
inline

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

Definition at line 2310 of file DBInstance.h.

◆ WithTimezone() [2/3]

DBInstance& Aws::RDS::Model::DBInstance::WithTimezone ( const Aws::String value)
inline

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

Definition at line 2303 of file DBInstance.h.

◆ WithTimezone() [3/3]

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

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

Definition at line 2317 of file DBInstance.h.

◆ WithVpcSecurityGroups() [1/2]

DBInstance& Aws::RDS::Model::DBInstance::WithVpcSecurityGroups ( Aws::Vector< VpcSecurityGroupMembership > &&  value)
inline

Provides a list of VPC security group elements that the DB instance belongs to.

Definition at line 658 of file DBInstance.h.

◆ WithVpcSecurityGroups() [2/2]

DBInstance& Aws::RDS::Model::DBInstance::WithVpcSecurityGroups ( const Aws::Vector< VpcSecurityGroupMembership > &  value)
inline

Provides a list of VPC security group elements that the DB instance belongs to.

Definition at line 652 of file DBInstance.h.


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