AWS SDK for C++  1.8.76
AWS SDK for C++
Public Member Functions | List of all members
Aws::DocDB::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 EndpointGetEndpoint () const
 
bool EndpointHasBeenSet () const
 
void SetEndpoint (const Endpoint &value)
 
void SetEndpoint (Endpoint &&value)
 
DBInstanceWithEndpoint (const Endpoint &value)
 
DBInstanceWithEndpoint (Endpoint &&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< 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::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)
 
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)
 
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::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)
 
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::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)
 

Detailed Description

Detailed information about an instance.

See Also:

AWS API Reference

Definition at line 38 of file DBInstance.h.

Constructor & Destructor Documentation

◆ DBInstance() [1/2]

Aws::DocDB::Model::DBInstance::DBInstance ( )

◆ DBInstance() [2/2]

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

Member Function Documentation

◆ AddEnabledCloudwatchLogsExports() [1/3]

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

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

Definition at line 1096 of file DBInstance.h.

◆ AddEnabledCloudwatchLogsExports() [2/3]

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

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

Definition at line 1102 of file DBInstance.h.

◆ AddEnabledCloudwatchLogsExports() [3/3]

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

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

Definition at line 1108 of file DBInstance.h.

◆ AddStatusInfos() [1/2]

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

The status of a read replica. If the instance is not a read replica, this is blank.

Definition at line 760 of file DBInstance.h.

◆ AddStatusInfos() [2/2]

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

The status of a read replica. If the instance is not a read replica, this is blank.

Definition at line 766 of file DBInstance.h.

◆ AddVpcSecurityGroups() [1/2]

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

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

Definition at line 409 of file DBInstance.h.

◆ AddVpcSecurityGroups() [2/2]

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

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

Definition at line 415 of file DBInstance.h.

◆ AutoMinorVersionUpgradeHasBeenSet()

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

Indicates that minor version patches are applied automatically.

Definition at line 682 of file DBInstance.h.

◆ AvailabilityZoneHasBeenSet()

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

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

Definition at line 428 of file DBInstance.h.

◆ BackupRetentionPeriodHasBeenSet()

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

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

Definition at line 356 of file DBInstance.h.

◆ CACertificateIdentifierHasBeenSet()

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

The identifier of the CA certificate for this DB instance.

Definition at line 953 of file DBInstance.h.

◆ DBClusterIdentifierHasBeenSet()

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

Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.

Definition at line 779 of file DBInstance.h.

◆ DBInstanceArnHasBeenSet()

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

The Amazon Resource Name (ARN) for the instance.

Definition at line 1023 of file DBInstance.h.

◆ DBInstanceClassHasBeenSet()

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

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

Definition at line 108 of file DBInstance.h.

◆ DBInstanceIdentifierHasBeenSet()

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

Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.

Definition at line 59 of file DBInstance.h.

◆ DBInstanceStatusHasBeenSet()

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

Specifies the current state of this database.

Definition at line 196 of file DBInstance.h.

◆ DbiResourceIdHasBeenSet()

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

The AWS Region-unique, immutable identifier for the instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the instance is accessed.

Definition at line 900 of file DBInstance.h.

◆ DBSubnetGroupHasBeenSet()

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

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

Definition at line 477 of file DBInstance.h.

◆ EnabledCloudwatchLogsExportsHasBeenSet()

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

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

Definition at line 1066 of file DBInstance.h.

◆ EndpointHasBeenSet()

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

Specifies the connection endpoint.

Definition at line 237 of file DBInstance.h.

◆ EngineHasBeenSet()

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

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

Definition at line 155 of file DBInstance.h.

◆ EngineVersionHasBeenSet()

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

Indicates the database engine version.

Definition at line 641 of file DBInstance.h.

◆ GetAutoMinorVersionUpgrade()

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

Indicates that minor version patches are applied automatically.

Definition at line 677 of file DBInstance.h.

◆ GetAvailabilityZone()

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

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

Definition at line 422 of file DBInstance.h.

◆ GetBackupRetentionPeriod()

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

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

Definition at line 351 of file DBInstance.h.

◆ GetCACertificateIdentifier()

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

The identifier of the CA certificate for this DB instance.

Definition at line 948 of file DBInstance.h.

◆ GetDBClusterIdentifier()

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

Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.

Definition at line 773 of file DBInstance.h.

◆ GetDBInstanceArn()

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

The Amazon Resource Name (ARN) for the instance.

Definition at line 1018 of file DBInstance.h.

◆ GetDBInstanceClass()

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

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

Definition at line 102 of file DBInstance.h.

◆ GetDBInstanceIdentifier()

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

Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.

Definition at line 53 of file DBInstance.h.

◆ GetDBInstanceStatus()

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

Specifies the current state of this database.

Definition at line 191 of file DBInstance.h.

◆ GetDbiResourceId()

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

The AWS Region-unique, immutable identifier for the instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the instance is accessed.

Definition at line 893 of file DBInstance.h.

◆ GetDBSubnetGroup()

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

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

Definition at line 471 of file DBInstance.h.

◆ GetEnabledCloudwatchLogsExports()

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

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

Definition at line 1060 of file DBInstance.h.

◆ GetEndpoint()

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

Specifies the connection endpoint.

Definition at line 232 of file DBInstance.h.

◆ GetEngine()

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

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

Definition at line 150 of file DBInstance.h.

◆ GetEngineVersion()

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

Indicates the database engine version.

Definition at line 636 of file DBInstance.h.

◆ GetInstanceCreateTime()

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

Provides the date and time that the instance was created.

Definition at line 263 of file DBInstance.h.

◆ GetKmsKeyId()

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

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

Definition at line 843 of file DBInstance.h.

◆ GetLatestRestorableTime()

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

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

Definition at line 600 of file DBInstance.h.

◆ GetPendingModifiedValues()

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

Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.

Definition at line 558 of file DBInstance.h.

◆ GetPreferredBackupWindow()

const Aws::String& Aws::DocDB::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 296 of file DBInstance.h.

◆ GetPreferredMaintenanceWindow()

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

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

Definition at line 508 of file DBInstance.h.

◆ GetPromotionTier()

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

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

Definition at line 991 of file DBInstance.h.

◆ GetPubliclyAccessible()

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

Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false.

Definition at line 699 of file DBInstance.h.

◆ GetStatusInfos()

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

The status of a read replica. If the instance is not a read replica, this is blank.

Definition at line 724 of file DBInstance.h.

◆ GetStorageEncrypted()

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

Specifies whether or not the instance is encrypted.

Definition at line 821 of file DBInstance.h.

◆ GetVpcSecurityGroups()

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

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

Definition at line 373 of file DBInstance.h.

◆ InstanceCreateTimeHasBeenSet()

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

Provides the date and time that the instance was created.

Definition at line 268 of file DBInstance.h.

◆ KmsKeyIdHasBeenSet()

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

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

Definition at line 849 of file DBInstance.h.

◆ LatestRestorableTimeHasBeenSet()

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

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

Definition at line 606 of file DBInstance.h.

◆ operator=()

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

◆ OutputToStream() [1/2]

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

◆ OutputToStream() [2/2]

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

◆ PendingModifiedValuesHasBeenSet()

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

Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.

Definition at line 565 of file DBInstance.h.

◆ PreferredBackupWindowHasBeenSet()

bool Aws::DocDB::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 303 of file DBInstance.h.

◆ PreferredMaintenanceWindowHasBeenSet()

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

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

Definition at line 514 of file DBInstance.h.

◆ PromotionTierHasBeenSet()

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

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

Definition at line 998 of file DBInstance.h.

◆ PubliclyAccessibleHasBeenSet()

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

Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false.

Definition at line 705 of file DBInstance.h.

◆ SetAutoMinorVersionUpgrade()

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

Indicates that minor version patches are applied automatically.

Definition at line 687 of file DBInstance.h.

◆ SetAvailabilityZone() [1/3]

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

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

Definition at line 434 of file DBInstance.h.

◆ SetAvailabilityZone() [2/3]

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

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

Definition at line 440 of file DBInstance.h.

◆ SetAvailabilityZone() [3/3]

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

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

Definition at line 446 of file DBInstance.h.

◆ SetBackupRetentionPeriod()

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

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

Definition at line 361 of file DBInstance.h.

◆ SetCACertificateIdentifier() [1/3]

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

The identifier of the CA certificate for this DB instance.

Definition at line 958 of file DBInstance.h.

◆ SetCACertificateIdentifier() [2/3]

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

The identifier of the CA certificate for this DB instance.

Definition at line 963 of file DBInstance.h.

◆ SetCACertificateIdentifier() [3/3]

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

The identifier of the CA certificate for this DB instance.

Definition at line 968 of file DBInstance.h.

◆ SetDBClusterIdentifier() [1/3]

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

Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.

Definition at line 785 of file DBInstance.h.

◆ SetDBClusterIdentifier() [2/3]

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

Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.

Definition at line 791 of file DBInstance.h.

◆ SetDBClusterIdentifier() [3/3]

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

Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.

Definition at line 797 of file DBInstance.h.

◆ SetDBInstanceArn() [1/3]

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

The Amazon Resource Name (ARN) for the instance.

Definition at line 1028 of file DBInstance.h.

◆ SetDBInstanceArn() [2/3]

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

The Amazon Resource Name (ARN) for the instance.

Definition at line 1033 of file DBInstance.h.

◆ SetDBInstanceArn() [3/3]

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

The Amazon Resource Name (ARN) for the instance.

Definition at line 1038 of file DBInstance.h.

◆ SetDBInstanceClass() [1/3]

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

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

Definition at line 114 of file DBInstance.h.

◆ SetDBInstanceClass() [2/3]

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

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

Definition at line 120 of file DBInstance.h.

◆ SetDBInstanceClass() [3/3]

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

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

Definition at line 126 of file DBInstance.h.

◆ SetDBInstanceIdentifier() [1/3]

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

Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.

Definition at line 65 of file DBInstance.h.

◆ SetDBInstanceIdentifier() [2/3]

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

Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.

Definition at line 71 of file DBInstance.h.

◆ SetDBInstanceIdentifier() [3/3]

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

Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.

Definition at line 77 of file DBInstance.h.

◆ SetDBInstanceStatus() [1/3]

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

Specifies the current state of this database.

Definition at line 201 of file DBInstance.h.

◆ SetDBInstanceStatus() [2/3]

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

Specifies the current state of this database.

Definition at line 206 of file DBInstance.h.

◆ SetDBInstanceStatus() [3/3]

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

Specifies the current state of this database.

Definition at line 211 of file DBInstance.h.

◆ SetDbiResourceId() [1/3]

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

The AWS Region-unique, immutable identifier for the instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the instance is accessed.

Definition at line 907 of file DBInstance.h.

◆ SetDbiResourceId() [2/3]

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

The AWS Region-unique, immutable identifier for the instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the instance is accessed.

Definition at line 914 of file DBInstance.h.

◆ SetDbiResourceId() [3/3]

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

The AWS Region-unique, immutable identifier for the instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the instance is accessed.

Definition at line 921 of file DBInstance.h.

◆ SetDBSubnetGroup() [1/2]

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

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

Definition at line 483 of file DBInstance.h.

◆ SetDBSubnetGroup() [2/2]

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

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

Definition at line 489 of file DBInstance.h.

◆ SetEnabledCloudwatchLogsExports() [1/2]

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

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

Definition at line 1072 of file DBInstance.h.

◆ SetEnabledCloudwatchLogsExports() [2/2]

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

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

Definition at line 1078 of file DBInstance.h.

◆ SetEndpoint() [1/2]

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

Specifies the connection endpoint.

Definition at line 242 of file DBInstance.h.

◆ SetEndpoint() [2/2]

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

Specifies the connection endpoint.

Definition at line 247 of file DBInstance.h.

◆ SetEngine() [1/3]

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

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

Definition at line 160 of file DBInstance.h.

◆ SetEngine() [2/3]

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

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

Definition at line 165 of file DBInstance.h.

◆ SetEngine() [3/3]

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

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

Definition at line 170 of file DBInstance.h.

◆ SetEngineVersion() [1/3]

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

Indicates the database engine version.

Definition at line 646 of file DBInstance.h.

◆ SetEngineVersion() [2/3]

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

Indicates the database engine version.

Definition at line 651 of file DBInstance.h.

◆ SetEngineVersion() [3/3]

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

Indicates the database engine version.

Definition at line 656 of file DBInstance.h.

◆ SetInstanceCreateTime() [1/2]

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

Provides the date and time that the instance was created.

Definition at line 273 of file DBInstance.h.

◆ SetInstanceCreateTime() [2/2]

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

Provides the date and time that the instance was created.

Definition at line 278 of file DBInstance.h.

◆ SetKmsKeyId() [1/3]

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

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

Definition at line 855 of file DBInstance.h.

◆ SetKmsKeyId() [2/3]

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

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

Definition at line 861 of file DBInstance.h.

◆ SetKmsKeyId() [3/3]

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

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

Definition at line 867 of file DBInstance.h.

◆ SetLatestRestorableTime() [1/2]

void Aws::DocDB::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 612 of file DBInstance.h.

◆ SetLatestRestorableTime() [2/2]

void Aws::DocDB::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 618 of file DBInstance.h.

◆ SetPendingModifiedValues() [1/2]

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

Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.

Definition at line 572 of file DBInstance.h.

◆ SetPendingModifiedValues() [2/2]

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

Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.

Definition at line 579 of file DBInstance.h.

◆ SetPreferredBackupWindow() [1/3]

void Aws::DocDB::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 310 of file DBInstance.h.

◆ SetPreferredBackupWindow() [2/3]

void Aws::DocDB::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 317 of file DBInstance.h.

◆ SetPreferredBackupWindow() [3/3]

void Aws::DocDB::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 324 of file DBInstance.h.

◆ SetPreferredMaintenanceWindow() [1/3]

void Aws::DocDB::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 520 of file DBInstance.h.

◆ SetPreferredMaintenanceWindow() [2/3]

void Aws::DocDB::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 526 of file DBInstance.h.

◆ SetPreferredMaintenanceWindow() [3/3]

void Aws::DocDB::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 532 of file DBInstance.h.

◆ SetPromotionTier()

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

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

Definition at line 1005 of file DBInstance.h.

◆ SetPubliclyAccessible()

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

Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false.

Definition at line 711 of file DBInstance.h.

◆ SetStatusInfos() [1/2]

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

The status of a read replica. If the instance is not a read replica, this is blank.

Definition at line 736 of file DBInstance.h.

◆ SetStatusInfos() [2/2]

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

The status of a read replica. If the instance is not a read replica, this is blank.

Definition at line 742 of file DBInstance.h.

◆ SetStorageEncrypted()

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

Specifies whether or not the instance is encrypted.

Definition at line 831 of file DBInstance.h.

◆ SetVpcSecurityGroups() [1/2]

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

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

Definition at line 385 of file DBInstance.h.

◆ SetVpcSecurityGroups() [2/2]

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

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

Definition at line 391 of file DBInstance.h.

◆ StatusInfosHasBeenSet()

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

The status of a read replica. If the instance is not a read replica, this is blank.

Definition at line 730 of file DBInstance.h.

◆ StorageEncryptedHasBeenSet()

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

Specifies whether or not the instance is encrypted.

Definition at line 826 of file DBInstance.h.

◆ VpcSecurityGroupsHasBeenSet()

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

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

Definition at line 379 of file DBInstance.h.

◆ WithAutoMinorVersionUpgrade()

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

Indicates that minor version patches are applied automatically.

Definition at line 692 of file DBInstance.h.

◆ WithAvailabilityZone() [1/3]

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

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

Definition at line 452 of file DBInstance.h.

◆ WithAvailabilityZone() [2/3]

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

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

Definition at line 458 of file DBInstance.h.

◆ WithAvailabilityZone() [3/3]

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

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

Definition at line 464 of file DBInstance.h.

◆ WithBackupRetentionPeriod()

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

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

Definition at line 366 of file DBInstance.h.

◆ WithCACertificateIdentifier() [1/3]

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

The identifier of the CA certificate for this DB instance.

Definition at line 973 of file DBInstance.h.

◆ WithCACertificateIdentifier() [2/3]

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

The identifier of the CA certificate for this DB instance.

Definition at line 978 of file DBInstance.h.

◆ WithCACertificateIdentifier() [3/3]

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

The identifier of the CA certificate for this DB instance.

Definition at line 983 of file DBInstance.h.

◆ WithDBClusterIdentifier() [1/3]

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

Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.

Definition at line 803 of file DBInstance.h.

◆ WithDBClusterIdentifier() [2/3]

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

Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.

Definition at line 809 of file DBInstance.h.

◆ WithDBClusterIdentifier() [3/3]

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

Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.

Definition at line 815 of file DBInstance.h.

◆ WithDBInstanceArn() [1/3]

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

The Amazon Resource Name (ARN) for the instance.

Definition at line 1043 of file DBInstance.h.

◆ WithDBInstanceArn() [2/3]

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

The Amazon Resource Name (ARN) for the instance.

Definition at line 1048 of file DBInstance.h.

◆ WithDBInstanceArn() [3/3]

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

The Amazon Resource Name (ARN) for the instance.

Definition at line 1053 of file DBInstance.h.

◆ WithDBInstanceClass() [1/3]

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

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

Definition at line 132 of file DBInstance.h.

◆ WithDBInstanceClass() [2/3]

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

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

Definition at line 138 of file DBInstance.h.

◆ WithDBInstanceClass() [3/3]

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

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

Definition at line 144 of file DBInstance.h.

◆ WithDBInstanceIdentifier() [1/3]

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

Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.

Definition at line 83 of file DBInstance.h.

◆ WithDBInstanceIdentifier() [2/3]

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

Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.

Definition at line 89 of file DBInstance.h.

◆ WithDBInstanceIdentifier() [3/3]

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

Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.

Definition at line 95 of file DBInstance.h.

◆ WithDBInstanceStatus() [1/3]

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

Specifies the current state of this database.

Definition at line 216 of file DBInstance.h.

◆ WithDBInstanceStatus() [2/3]

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

Specifies the current state of this database.

Definition at line 221 of file DBInstance.h.

◆ WithDBInstanceStatus() [3/3]

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

Specifies the current state of this database.

Definition at line 226 of file DBInstance.h.

◆ WithDbiResourceId() [1/3]

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

The AWS Region-unique, immutable identifier for the instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the instance is accessed.

Definition at line 928 of file DBInstance.h.

◆ WithDbiResourceId() [2/3]

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

The AWS Region-unique, immutable identifier for the instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the instance is accessed.

Definition at line 935 of file DBInstance.h.

◆ WithDbiResourceId() [3/3]

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

The AWS Region-unique, immutable identifier for the instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the instance is accessed.

Definition at line 942 of file DBInstance.h.

◆ WithDBSubnetGroup() [1/2]

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

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

Definition at line 495 of file DBInstance.h.

◆ WithDBSubnetGroup() [2/2]

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

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

Definition at line 501 of file DBInstance.h.

◆ WithEnabledCloudwatchLogsExports() [1/2]

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

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

Definition at line 1084 of file DBInstance.h.

◆ WithEnabledCloudwatchLogsExports() [2/2]

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

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

Definition at line 1090 of file DBInstance.h.

◆ WithEndpoint() [1/2]

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

Specifies the connection endpoint.

Definition at line 252 of file DBInstance.h.

◆ WithEndpoint() [2/2]

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

Specifies the connection endpoint.

Definition at line 257 of file DBInstance.h.

◆ WithEngine() [1/3]

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

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

Definition at line 175 of file DBInstance.h.

◆ WithEngine() [2/3]

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

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

Definition at line 180 of file DBInstance.h.

◆ WithEngine() [3/3]

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

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

Definition at line 185 of file DBInstance.h.

◆ WithEngineVersion() [1/3]

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

Indicates the database engine version.

Definition at line 661 of file DBInstance.h.

◆ WithEngineVersion() [2/3]

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

Indicates the database engine version.

Definition at line 666 of file DBInstance.h.

◆ WithEngineVersion() [3/3]

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

Indicates the database engine version.

Definition at line 671 of file DBInstance.h.

◆ WithInstanceCreateTime() [1/2]

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

Provides the date and time that the instance was created.

Definition at line 283 of file DBInstance.h.

◆ WithInstanceCreateTime() [2/2]

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

Provides the date and time that the instance was created.

Definition at line 288 of file DBInstance.h.

◆ WithKmsKeyId() [1/3]

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

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

Definition at line 873 of file DBInstance.h.

◆ WithKmsKeyId() [2/3]

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

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

Definition at line 879 of file DBInstance.h.

◆ WithKmsKeyId() [3/3]

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

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

Definition at line 885 of file DBInstance.h.

◆ WithLatestRestorableTime() [1/2]

DBInstance& Aws::DocDB::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 624 of file DBInstance.h.

◆ WithLatestRestorableTime() [2/2]

DBInstance& Aws::DocDB::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 630 of file DBInstance.h.

◆ WithPendingModifiedValues() [1/2]

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

Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.

Definition at line 586 of file DBInstance.h.

◆ WithPendingModifiedValues() [2/2]

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

Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.

Definition at line 593 of file DBInstance.h.

◆ WithPreferredBackupWindow() [1/3]

DBInstance& Aws::DocDB::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 331 of file DBInstance.h.

◆ WithPreferredBackupWindow() [2/3]

DBInstance& Aws::DocDB::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 338 of file DBInstance.h.

◆ WithPreferredBackupWindow() [3/3]

DBInstance& Aws::DocDB::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 345 of file DBInstance.h.

◆ WithPreferredMaintenanceWindow() [1/3]

DBInstance& Aws::DocDB::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 538 of file DBInstance.h.

◆ WithPreferredMaintenanceWindow() [2/3]

DBInstance& Aws::DocDB::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 544 of file DBInstance.h.

◆ WithPreferredMaintenanceWindow() [3/3]

DBInstance& Aws::DocDB::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 550 of file DBInstance.h.

◆ WithPromotionTier()

DBInstance& Aws::DocDB::Model::DBInstance::WithPromotionTier ( int  value)
inline

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

Definition at line 1012 of file DBInstance.h.

◆ WithPubliclyAccessible()

DBInstance& Aws::DocDB::Model::DBInstance::WithPubliclyAccessible ( bool  value)
inline

Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false.

Definition at line 717 of file DBInstance.h.

◆ WithStatusInfos() [1/2]

DBInstance& Aws::DocDB::Model::DBInstance::WithStatusInfos ( const Aws::Vector< DBInstanceStatusInfo > &  value)
inline

The status of a read replica. If the instance is not a read replica, this is blank.

Definition at line 748 of file DBInstance.h.

◆ WithStatusInfos() [2/2]

DBInstance& Aws::DocDB::Model::DBInstance::WithStatusInfos ( Aws::Vector< DBInstanceStatusInfo > &&  value)
inline

The status of a read replica. If the instance is not a read replica, this is blank.

Definition at line 754 of file DBInstance.h.

◆ WithStorageEncrypted()

DBInstance& Aws::DocDB::Model::DBInstance::WithStorageEncrypted ( bool  value)
inline

Specifies whether or not the instance is encrypted.

Definition at line 836 of file DBInstance.h.

◆ WithVpcSecurityGroups() [1/2]

DBInstance& Aws::DocDB::Model::DBInstance::WithVpcSecurityGroups ( const Aws::Vector< VpcSecurityGroupMembership > &  value)
inline

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

Definition at line 397 of file DBInstance.h.

◆ WithVpcSecurityGroups() [2/2]

DBInstance& Aws::DocDB::Model::DBInstance::WithVpcSecurityGroups ( Aws::Vector< VpcSecurityGroupMembership > &&  value)
inline

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

Definition at line 403 of file DBInstance.h.


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