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

#include <DBCluster.h>

Public Member Functions

 DBCluster ()
 
 DBCluster (const Aws::Utils::Xml::XmlNode &xmlNode)
 
DBClusteroperator= (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
 
int GetAllocatedStorage () const
 
bool AllocatedStorageHasBeenSet () const
 
void SetAllocatedStorage (int value)
 
DBClusterWithAllocatedStorage (int value)
 
const Aws::Vector< Aws::String > & GetAvailabilityZones () const
 
bool AvailabilityZonesHasBeenSet () const
 
void SetAvailabilityZones (const Aws::Vector< Aws::String > &value)
 
void SetAvailabilityZones (Aws::Vector< Aws::String > &&value)
 
DBClusterWithAvailabilityZones (const Aws::Vector< Aws::String > &value)
 
DBClusterWithAvailabilityZones (Aws::Vector< Aws::String > &&value)
 
DBClusterAddAvailabilityZones (const Aws::String &value)
 
DBClusterAddAvailabilityZones (Aws::String &&value)
 
DBClusterAddAvailabilityZones (const char *value)
 
int GetBackupRetentionPeriod () const
 
bool BackupRetentionPeriodHasBeenSet () const
 
void SetBackupRetentionPeriod (int value)
 
DBClusterWithBackupRetentionPeriod (int value)
 
const Aws::StringGetCharacterSetName () const
 
bool CharacterSetNameHasBeenSet () const
 
void SetCharacterSetName (const Aws::String &value)
 
void SetCharacterSetName (Aws::String &&value)
 
void SetCharacterSetName (const char *value)
 
DBClusterWithCharacterSetName (const Aws::String &value)
 
DBClusterWithCharacterSetName (Aws::String &&value)
 
DBClusterWithCharacterSetName (const char *value)
 
const Aws::StringGetDatabaseName () const
 
bool DatabaseNameHasBeenSet () const
 
void SetDatabaseName (const Aws::String &value)
 
void SetDatabaseName (Aws::String &&value)
 
void SetDatabaseName (const char *value)
 
DBClusterWithDatabaseName (const Aws::String &value)
 
DBClusterWithDatabaseName (Aws::String &&value)
 
DBClusterWithDatabaseName (const char *value)
 
const Aws::StringGetDBClusterIdentifier () const
 
bool DBClusterIdentifierHasBeenSet () const
 
void SetDBClusterIdentifier (const Aws::String &value)
 
void SetDBClusterIdentifier (Aws::String &&value)
 
void SetDBClusterIdentifier (const char *value)
 
DBClusterWithDBClusterIdentifier (const Aws::String &value)
 
DBClusterWithDBClusterIdentifier (Aws::String &&value)
 
DBClusterWithDBClusterIdentifier (const char *value)
 
const Aws::StringGetDBClusterParameterGroup () const
 
bool DBClusterParameterGroupHasBeenSet () const
 
void SetDBClusterParameterGroup (const Aws::String &value)
 
void SetDBClusterParameterGroup (Aws::String &&value)
 
void SetDBClusterParameterGroup (const char *value)
 
DBClusterWithDBClusterParameterGroup (const Aws::String &value)
 
DBClusterWithDBClusterParameterGroup (Aws::String &&value)
 
DBClusterWithDBClusterParameterGroup (const char *value)
 
const Aws::StringGetDBSubnetGroup () const
 
bool DBSubnetGroupHasBeenSet () const
 
void SetDBSubnetGroup (const Aws::String &value)
 
void SetDBSubnetGroup (Aws::String &&value)
 
void SetDBSubnetGroup (const char *value)
 
DBClusterWithDBSubnetGroup (const Aws::String &value)
 
DBClusterWithDBSubnetGroup (Aws::String &&value)
 
DBClusterWithDBSubnetGroup (const char *value)
 
const Aws::StringGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const Aws::String &value)
 
void SetStatus (Aws::String &&value)
 
void SetStatus (const char *value)
 
DBClusterWithStatus (const Aws::String &value)
 
DBClusterWithStatus (Aws::String &&value)
 
DBClusterWithStatus (const char *value)
 
const Aws::Utils::DateTimeGetAutomaticRestartTime () const
 
bool AutomaticRestartTimeHasBeenSet () const
 
void SetAutomaticRestartTime (const Aws::Utils::DateTime &value)
 
void SetAutomaticRestartTime (Aws::Utils::DateTime &&value)
 
DBClusterWithAutomaticRestartTime (const Aws::Utils::DateTime &value)
 
DBClusterWithAutomaticRestartTime (Aws::Utils::DateTime &&value)
 
const Aws::StringGetPercentProgress () const
 
bool PercentProgressHasBeenSet () const
 
void SetPercentProgress (const Aws::String &value)
 
void SetPercentProgress (Aws::String &&value)
 
void SetPercentProgress (const char *value)
 
DBClusterWithPercentProgress (const Aws::String &value)
 
DBClusterWithPercentProgress (Aws::String &&value)
 
DBClusterWithPercentProgress (const char *value)
 
const Aws::Utils::DateTimeGetEarliestRestorableTime () const
 
bool EarliestRestorableTimeHasBeenSet () const
 
void SetEarliestRestorableTime (const Aws::Utils::DateTime &value)
 
void SetEarliestRestorableTime (Aws::Utils::DateTime &&value)
 
DBClusterWithEarliestRestorableTime (const Aws::Utils::DateTime &value)
 
DBClusterWithEarliestRestorableTime (Aws::Utils::DateTime &&value)
 
const Aws::StringGetEndpoint () const
 
bool EndpointHasBeenSet () const
 
void SetEndpoint (const Aws::String &value)
 
void SetEndpoint (Aws::String &&value)
 
void SetEndpoint (const char *value)
 
DBClusterWithEndpoint (const Aws::String &value)
 
DBClusterWithEndpoint (Aws::String &&value)
 
DBClusterWithEndpoint (const char *value)
 
const Aws::StringGetReaderEndpoint () const
 
bool ReaderEndpointHasBeenSet () const
 
void SetReaderEndpoint (const Aws::String &value)
 
void SetReaderEndpoint (Aws::String &&value)
 
void SetReaderEndpoint (const char *value)
 
DBClusterWithReaderEndpoint (const Aws::String &value)
 
DBClusterWithReaderEndpoint (Aws::String &&value)
 
DBClusterWithReaderEndpoint (const char *value)
 
const Aws::Vector< Aws::String > & GetCustomEndpoints () const
 
bool CustomEndpointsHasBeenSet () const
 
void SetCustomEndpoints (const Aws::Vector< Aws::String > &value)
 
void SetCustomEndpoints (Aws::Vector< Aws::String > &&value)
 
DBClusterWithCustomEndpoints (const Aws::Vector< Aws::String > &value)
 
DBClusterWithCustomEndpoints (Aws::Vector< Aws::String > &&value)
 
DBClusterAddCustomEndpoints (const Aws::String &value)
 
DBClusterAddCustomEndpoints (Aws::String &&value)
 
DBClusterAddCustomEndpoints (const char *value)
 
bool GetMultiAZ () const
 
bool MultiAZHasBeenSet () const
 
void SetMultiAZ (bool value)
 
DBClusterWithMultiAZ (bool value)
 
const Aws::StringGetEngine () const
 
bool EngineHasBeenSet () const
 
void SetEngine (const Aws::String &value)
 
void SetEngine (Aws::String &&value)
 
void SetEngine (const char *value)
 
DBClusterWithEngine (const Aws::String &value)
 
DBClusterWithEngine (Aws::String &&value)
 
DBClusterWithEngine (const char *value)
 
const Aws::StringGetEngineVersion () const
 
bool EngineVersionHasBeenSet () const
 
void SetEngineVersion (const Aws::String &value)
 
void SetEngineVersion (Aws::String &&value)
 
void SetEngineVersion (const char *value)
 
DBClusterWithEngineVersion (const Aws::String &value)
 
DBClusterWithEngineVersion (Aws::String &&value)
 
DBClusterWithEngineVersion (const char *value)
 
const Aws::Utils::DateTimeGetLatestRestorableTime () const
 
bool LatestRestorableTimeHasBeenSet () const
 
void SetLatestRestorableTime (const Aws::Utils::DateTime &value)
 
void SetLatestRestorableTime (Aws::Utils::DateTime &&value)
 
DBClusterWithLatestRestorableTime (const Aws::Utils::DateTime &value)
 
DBClusterWithLatestRestorableTime (Aws::Utils::DateTime &&value)
 
int GetPort () const
 
bool PortHasBeenSet () const
 
void SetPort (int value)
 
DBClusterWithPort (int value)
 
const Aws::StringGetMasterUsername () const
 
bool MasterUsernameHasBeenSet () const
 
void SetMasterUsername (const Aws::String &value)
 
void SetMasterUsername (Aws::String &&value)
 
void SetMasterUsername (const char *value)
 
DBClusterWithMasterUsername (const Aws::String &value)
 
DBClusterWithMasterUsername (Aws::String &&value)
 
DBClusterWithMasterUsername (const char *value)
 
const Aws::Vector< DBClusterOptionGroupStatus > & GetDBClusterOptionGroupMemberships () const
 
bool DBClusterOptionGroupMembershipsHasBeenSet () const
 
void SetDBClusterOptionGroupMemberships (const Aws::Vector< DBClusterOptionGroupStatus > &value)
 
void SetDBClusterOptionGroupMemberships (Aws::Vector< DBClusterOptionGroupStatus > &&value)
 
DBClusterWithDBClusterOptionGroupMemberships (const Aws::Vector< DBClusterOptionGroupStatus > &value)
 
DBClusterWithDBClusterOptionGroupMemberships (Aws::Vector< DBClusterOptionGroupStatus > &&value)
 
DBClusterAddDBClusterOptionGroupMemberships (const DBClusterOptionGroupStatus &value)
 
DBClusterAddDBClusterOptionGroupMemberships (DBClusterOptionGroupStatus &&value)
 
const Aws::StringGetPreferredBackupWindow () const
 
bool PreferredBackupWindowHasBeenSet () const
 
void SetPreferredBackupWindow (const Aws::String &value)
 
void SetPreferredBackupWindow (Aws::String &&value)
 
void SetPreferredBackupWindow (const char *value)
 
DBClusterWithPreferredBackupWindow (const Aws::String &value)
 
DBClusterWithPreferredBackupWindow (Aws::String &&value)
 
DBClusterWithPreferredBackupWindow (const char *value)
 
const Aws::StringGetPreferredMaintenanceWindow () const
 
bool PreferredMaintenanceWindowHasBeenSet () const
 
void SetPreferredMaintenanceWindow (const Aws::String &value)
 
void SetPreferredMaintenanceWindow (Aws::String &&value)
 
void SetPreferredMaintenanceWindow (const char *value)
 
DBClusterWithPreferredMaintenanceWindow (const Aws::String &value)
 
DBClusterWithPreferredMaintenanceWindow (Aws::String &&value)
 
DBClusterWithPreferredMaintenanceWindow (const char *value)
 
const Aws::StringGetReplicationSourceIdentifier () const
 
bool ReplicationSourceIdentifierHasBeenSet () const
 
void SetReplicationSourceIdentifier (const Aws::String &value)
 
void SetReplicationSourceIdentifier (Aws::String &&value)
 
void SetReplicationSourceIdentifier (const char *value)
 
DBClusterWithReplicationSourceIdentifier (const Aws::String &value)
 
DBClusterWithReplicationSourceIdentifier (Aws::String &&value)
 
DBClusterWithReplicationSourceIdentifier (const char *value)
 
const Aws::Vector< Aws::String > & GetReadReplicaIdentifiers () const
 
bool ReadReplicaIdentifiersHasBeenSet () const
 
void SetReadReplicaIdentifiers (const Aws::Vector< Aws::String > &value)
 
void SetReadReplicaIdentifiers (Aws::Vector< Aws::String > &&value)
 
DBClusterWithReadReplicaIdentifiers (const Aws::Vector< Aws::String > &value)
 
DBClusterWithReadReplicaIdentifiers (Aws::Vector< Aws::String > &&value)
 
DBClusterAddReadReplicaIdentifiers (const Aws::String &value)
 
DBClusterAddReadReplicaIdentifiers (Aws::String &&value)
 
DBClusterAddReadReplicaIdentifiers (const char *value)
 
const Aws::Vector< DBClusterMember > & GetDBClusterMembers () const
 
bool DBClusterMembersHasBeenSet () const
 
void SetDBClusterMembers (const Aws::Vector< DBClusterMember > &value)
 
void SetDBClusterMembers (Aws::Vector< DBClusterMember > &&value)
 
DBClusterWithDBClusterMembers (const Aws::Vector< DBClusterMember > &value)
 
DBClusterWithDBClusterMembers (Aws::Vector< DBClusterMember > &&value)
 
DBClusterAddDBClusterMembers (const DBClusterMember &value)
 
DBClusterAddDBClusterMembers (DBClusterMember &&value)
 
const Aws::Vector< VpcSecurityGroupMembership > & GetVpcSecurityGroups () const
 
bool VpcSecurityGroupsHasBeenSet () const
 
void SetVpcSecurityGroups (const Aws::Vector< VpcSecurityGroupMembership > &value)
 
void SetVpcSecurityGroups (Aws::Vector< VpcSecurityGroupMembership > &&value)
 
DBClusterWithVpcSecurityGroups (const Aws::Vector< VpcSecurityGroupMembership > &value)
 
DBClusterWithVpcSecurityGroups (Aws::Vector< VpcSecurityGroupMembership > &&value)
 
DBClusterAddVpcSecurityGroups (const VpcSecurityGroupMembership &value)
 
DBClusterAddVpcSecurityGroups (VpcSecurityGroupMembership &&value)
 
const Aws::StringGetHostedZoneId () const
 
bool HostedZoneIdHasBeenSet () const
 
void SetHostedZoneId (const Aws::String &value)
 
void SetHostedZoneId (Aws::String &&value)
 
void SetHostedZoneId (const char *value)
 
DBClusterWithHostedZoneId (const Aws::String &value)
 
DBClusterWithHostedZoneId (Aws::String &&value)
 
DBClusterWithHostedZoneId (const char *value)
 
bool GetStorageEncrypted () const
 
bool StorageEncryptedHasBeenSet () const
 
void SetStorageEncrypted (bool value)
 
DBClusterWithStorageEncrypted (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)
 
DBClusterWithKmsKeyId (const Aws::String &value)
 
DBClusterWithKmsKeyId (Aws::String &&value)
 
DBClusterWithKmsKeyId (const char *value)
 
const Aws::StringGetDbClusterResourceId () const
 
bool DbClusterResourceIdHasBeenSet () const
 
void SetDbClusterResourceId (const Aws::String &value)
 
void SetDbClusterResourceId (Aws::String &&value)
 
void SetDbClusterResourceId (const char *value)
 
DBClusterWithDbClusterResourceId (const Aws::String &value)
 
DBClusterWithDbClusterResourceId (Aws::String &&value)
 
DBClusterWithDbClusterResourceId (const char *value)
 
const Aws::StringGetDBClusterArn () const
 
bool DBClusterArnHasBeenSet () const
 
void SetDBClusterArn (const Aws::String &value)
 
void SetDBClusterArn (Aws::String &&value)
 
void SetDBClusterArn (const char *value)
 
DBClusterWithDBClusterArn (const Aws::String &value)
 
DBClusterWithDBClusterArn (Aws::String &&value)
 
DBClusterWithDBClusterArn (const char *value)
 
const Aws::Vector< DBClusterRole > & GetAssociatedRoles () const
 
bool AssociatedRolesHasBeenSet () const
 
void SetAssociatedRoles (const Aws::Vector< DBClusterRole > &value)
 
void SetAssociatedRoles (Aws::Vector< DBClusterRole > &&value)
 
DBClusterWithAssociatedRoles (const Aws::Vector< DBClusterRole > &value)
 
DBClusterWithAssociatedRoles (Aws::Vector< DBClusterRole > &&value)
 
DBClusterAddAssociatedRoles (const DBClusterRole &value)
 
DBClusterAddAssociatedRoles (DBClusterRole &&value)
 
bool GetIAMDatabaseAuthenticationEnabled () const
 
bool IAMDatabaseAuthenticationEnabledHasBeenSet () const
 
void SetIAMDatabaseAuthenticationEnabled (bool value)
 
DBClusterWithIAMDatabaseAuthenticationEnabled (bool value)
 
const Aws::StringGetCloneGroupId () const
 
bool CloneGroupIdHasBeenSet () const
 
void SetCloneGroupId (const Aws::String &value)
 
void SetCloneGroupId (Aws::String &&value)
 
void SetCloneGroupId (const char *value)
 
DBClusterWithCloneGroupId (const Aws::String &value)
 
DBClusterWithCloneGroupId (Aws::String &&value)
 
DBClusterWithCloneGroupId (const char *value)
 
const Aws::Utils::DateTimeGetClusterCreateTime () const
 
bool ClusterCreateTimeHasBeenSet () const
 
void SetClusterCreateTime (const Aws::Utils::DateTime &value)
 
void SetClusterCreateTime (Aws::Utils::DateTime &&value)
 
DBClusterWithClusterCreateTime (const Aws::Utils::DateTime &value)
 
DBClusterWithClusterCreateTime (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetEarliestBacktrackTime () const
 
bool EarliestBacktrackTimeHasBeenSet () const
 
void SetEarliestBacktrackTime (const Aws::Utils::DateTime &value)
 
void SetEarliestBacktrackTime (Aws::Utils::DateTime &&value)
 
DBClusterWithEarliestBacktrackTime (const Aws::Utils::DateTime &value)
 
DBClusterWithEarliestBacktrackTime (Aws::Utils::DateTime &&value)
 
long long GetBacktrackWindow () const
 
bool BacktrackWindowHasBeenSet () const
 
void SetBacktrackWindow (long long value)
 
DBClusterWithBacktrackWindow (long long value)
 
long long GetBacktrackConsumedChangeRecords () const
 
bool BacktrackConsumedChangeRecordsHasBeenSet () const
 
void SetBacktrackConsumedChangeRecords (long long value)
 
DBClusterWithBacktrackConsumedChangeRecords (long long 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)
 
DBClusterWithEnabledCloudwatchLogsExports (const Aws::Vector< Aws::String > &value)
 
DBClusterWithEnabledCloudwatchLogsExports (Aws::Vector< Aws::String > &&value)
 
DBClusterAddEnabledCloudwatchLogsExports (const Aws::String &value)
 
DBClusterAddEnabledCloudwatchLogsExports (Aws::String &&value)
 
DBClusterAddEnabledCloudwatchLogsExports (const char *value)
 
int GetCapacity () const
 
bool CapacityHasBeenSet () const
 
void SetCapacity (int value)
 
DBClusterWithCapacity (int value)
 
const Aws::StringGetEngineMode () const
 
bool EngineModeHasBeenSet () const
 
void SetEngineMode (const Aws::String &value)
 
void SetEngineMode (Aws::String &&value)
 
void SetEngineMode (const char *value)
 
DBClusterWithEngineMode (const Aws::String &value)
 
DBClusterWithEngineMode (Aws::String &&value)
 
DBClusterWithEngineMode (const char *value)
 
const ScalingConfigurationInfoGetScalingConfigurationInfo () const
 
bool ScalingConfigurationInfoHasBeenSet () const
 
void SetScalingConfigurationInfo (const ScalingConfigurationInfo &value)
 
void SetScalingConfigurationInfo (ScalingConfigurationInfo &&value)
 
DBClusterWithScalingConfigurationInfo (const ScalingConfigurationInfo &value)
 
DBClusterWithScalingConfigurationInfo (ScalingConfigurationInfo &&value)
 
bool GetDeletionProtection () const
 
bool DeletionProtectionHasBeenSet () const
 
void SetDeletionProtection (bool value)
 
DBClusterWithDeletionProtection (bool value)
 
bool GetHttpEndpointEnabled () const
 
bool HttpEndpointEnabledHasBeenSet () const
 
void SetHttpEndpointEnabled (bool value)
 
DBClusterWithHttpEndpointEnabled (bool value)
 
const ActivityStreamModeGetActivityStreamMode () const
 
bool ActivityStreamModeHasBeenSet () const
 
void SetActivityStreamMode (const ActivityStreamMode &value)
 
void SetActivityStreamMode (ActivityStreamMode &&value)
 
DBClusterWithActivityStreamMode (const ActivityStreamMode &value)
 
DBClusterWithActivityStreamMode (ActivityStreamMode &&value)
 
const ActivityStreamStatusGetActivityStreamStatus () const
 
bool ActivityStreamStatusHasBeenSet () const
 
void SetActivityStreamStatus (const ActivityStreamStatus &value)
 
void SetActivityStreamStatus (ActivityStreamStatus &&value)
 
DBClusterWithActivityStreamStatus (const ActivityStreamStatus &value)
 
DBClusterWithActivityStreamStatus (ActivityStreamStatus &&value)
 
const Aws::StringGetActivityStreamKmsKeyId () const
 
bool ActivityStreamKmsKeyIdHasBeenSet () const
 
void SetActivityStreamKmsKeyId (const Aws::String &value)
 
void SetActivityStreamKmsKeyId (Aws::String &&value)
 
void SetActivityStreamKmsKeyId (const char *value)
 
DBClusterWithActivityStreamKmsKeyId (const Aws::String &value)
 
DBClusterWithActivityStreamKmsKeyId (Aws::String &&value)
 
DBClusterWithActivityStreamKmsKeyId (const char *value)
 
const Aws::StringGetActivityStreamKinesisStreamName () const
 
bool ActivityStreamKinesisStreamNameHasBeenSet () const
 
void SetActivityStreamKinesisStreamName (const Aws::String &value)
 
void SetActivityStreamKinesisStreamName (Aws::String &&value)
 
void SetActivityStreamKinesisStreamName (const char *value)
 
DBClusterWithActivityStreamKinesisStreamName (const Aws::String &value)
 
DBClusterWithActivityStreamKinesisStreamName (Aws::String &&value)
 
DBClusterWithActivityStreamKinesisStreamName (const char *value)
 
bool GetCopyTagsToSnapshot () const
 
bool CopyTagsToSnapshotHasBeenSet () const
 
void SetCopyTagsToSnapshot (bool value)
 
DBClusterWithCopyTagsToSnapshot (bool value)
 
bool GetCrossAccountClone () const
 
bool CrossAccountCloneHasBeenSet () const
 
void SetCrossAccountClone (bool value)
 
DBClusterWithCrossAccountClone (bool value)
 
const Aws::Vector< DomainMembership > & GetDomainMemberships () const
 
bool DomainMembershipsHasBeenSet () const
 
void SetDomainMemberships (const Aws::Vector< DomainMembership > &value)
 
void SetDomainMemberships (Aws::Vector< DomainMembership > &&value)
 
DBClusterWithDomainMemberships (const Aws::Vector< DomainMembership > &value)
 
DBClusterWithDomainMemberships (Aws::Vector< DomainMembership > &&value)
 
DBClusterAddDomainMemberships (const DomainMembership &value)
 
DBClusterAddDomainMemberships (DomainMembership &&value)
 
const Aws::Vector< Tag > & GetTagList () const
 
bool TagListHasBeenSet () const
 
void SetTagList (const Aws::Vector< Tag > &value)
 
void SetTagList (Aws::Vector< Tag > &&value)
 
DBClusterWithTagList (const Aws::Vector< Tag > &value)
 
DBClusterWithTagList (Aws::Vector< Tag > &&value)
 
DBClusterAddTagList (const Tag &value)
 
DBClusterAddTagList (Tag &&value)
 
const WriteForwardingStatusGetGlobalWriteForwardingStatus () const
 
bool GlobalWriteForwardingStatusHasBeenSet () const
 
void SetGlobalWriteForwardingStatus (const WriteForwardingStatus &value)
 
void SetGlobalWriteForwardingStatus (WriteForwardingStatus &&value)
 
DBClusterWithGlobalWriteForwardingStatus (const WriteForwardingStatus &value)
 
DBClusterWithGlobalWriteForwardingStatus (WriteForwardingStatus &&value)
 
bool GetGlobalWriteForwardingRequested () const
 
bool GlobalWriteForwardingRequestedHasBeenSet () const
 
void SetGlobalWriteForwardingRequested (bool value)
 
DBClusterWithGlobalWriteForwardingRequested (bool value)
 
const ClusterPendingModifiedValuesGetPendingModifiedValues () const
 
bool PendingModifiedValuesHasBeenSet () const
 
void SetPendingModifiedValues (const ClusterPendingModifiedValues &value)
 
void SetPendingModifiedValues (ClusterPendingModifiedValues &&value)
 
DBClusterWithPendingModifiedValues (const ClusterPendingModifiedValues &value)
 
DBClusterWithPendingModifiedValues (ClusterPendingModifiedValues &&value)
 

Detailed Description

Contains the details of an Amazon Aurora DB cluster.

This data type is used as a response element in the DescribeDBClusters, StopDBCluster, and StartDBCluster actions.

See Also:

AWS API Reference

Definition at line 47 of file DBCluster.h.

Constructor & Destructor Documentation

◆ DBCluster() [1/2]

Aws::RDS::Model::DBCluster::DBCluster ( )

◆ DBCluster() [2/2]

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

Member Function Documentation

◆ ActivityStreamKinesisStreamNameHasBeenSet()

bool Aws::RDS::Model::DBCluster::ActivityStreamKinesisStreamNameHasBeenSet ( ) const
inline

The name of the Amazon Kinesis data stream used for the database activity stream.

Definition at line 2221 of file DBCluster.h.

◆ ActivityStreamKmsKeyIdHasBeenSet()

bool Aws::RDS::Model::DBCluster::ActivityStreamKmsKeyIdHasBeenSet ( ) const
inline

The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.

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

Definition at line 2160 of file DBCluster.h.

◆ ActivityStreamModeHasBeenSet()

bool Aws::RDS::Model::DBCluster::ActivityStreamModeHasBeenSet ( ) const
inline

The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.

Definition at line 2084 of file DBCluster.h.

◆ ActivityStreamStatusHasBeenSet()

bool Aws::RDS::Model::DBCluster::ActivityStreamStatusHasBeenSet ( ) const
inline

The status of the database activity stream.

Definition at line 2123 of file DBCluster.h.

◆ AddAssociatedRoles() [1/2]

DBCluster& Aws::RDS::Model::DBCluster::AddAssociatedRoles ( const DBClusterRole value)
inline

Provides a list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.

Definition at line 1592 of file DBCluster.h.

◆ AddAssociatedRoles() [2/2]

DBCluster& Aws::RDS::Model::DBCluster::AddAssociatedRoles ( DBClusterRole &&  value)
inline

Provides a list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.

Definition at line 1600 of file DBCluster.h.

◆ AddAvailabilityZones() [1/3]

DBCluster& Aws::RDS::Model::DBCluster::AddAvailabilityZones ( Aws::String &&  value)
inline

Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.

Definition at line 137 of file DBCluster.h.

◆ AddAvailabilityZones() [2/3]

DBCluster& Aws::RDS::Model::DBCluster::AddAvailabilityZones ( const Aws::String value)
inline

Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.

Definition at line 131 of file DBCluster.h.

◆ AddAvailabilityZones() [3/3]

DBCluster& Aws::RDS::Model::DBCluster::AddAvailabilityZones ( const char *  value)
inline

Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.

Definition at line 143 of file DBCluster.h.

◆ AddCustomEndpoints() [1/3]

DBCluster& Aws::RDS::Model::DBCluster::AddCustomEndpoints ( Aws::String &&  value)
inline

Identifies all custom endpoints associated with the cluster.

Definition at line 758 of file DBCluster.h.

◆ AddCustomEndpoints() [2/3]

DBCluster& Aws::RDS::Model::DBCluster::AddCustomEndpoints ( const Aws::String value)
inline

Identifies all custom endpoints associated with the cluster.

Definition at line 753 of file DBCluster.h.

◆ AddCustomEndpoints() [3/3]

DBCluster& Aws::RDS::Model::DBCluster::AddCustomEndpoints ( const char *  value)
inline

Identifies all custom endpoints associated with the cluster.

Definition at line 763 of file DBCluster.h.

◆ AddDBClusterMembers() [1/2]

DBCluster& Aws::RDS::Model::DBCluster::AddDBClusterMembers ( const DBClusterMember value)
inline

Provides the list of instances that make up the DB cluster.

Definition at line 1256 of file DBCluster.h.

◆ AddDBClusterMembers() [2/2]

DBCluster& Aws::RDS::Model::DBCluster::AddDBClusterMembers ( DBClusterMember &&  value)
inline

Provides the list of instances that make up the DB cluster.

Definition at line 1261 of file DBCluster.h.

◆ AddDBClusterOptionGroupMemberships() [1/2]

DBCluster& Aws::RDS::Model::DBCluster::AddDBClusterOptionGroupMemberships ( const DBClusterOptionGroupStatus value)
inline

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

Definition at line 1005 of file DBCluster.h.

◆ AddDBClusterOptionGroupMemberships() [2/2]

DBCluster& Aws::RDS::Model::DBCluster::AddDBClusterOptionGroupMemberships ( DBClusterOptionGroupStatus &&  value)
inline

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

Definition at line 1010 of file DBCluster.h.

◆ AddDomainMemberships() [1/2]

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

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

Definition at line 2350 of file DBCluster.h.

◆ AddDomainMemberships() [2/2]

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

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

Definition at line 2356 of file DBCluster.h.

◆ AddEnabledCloudwatchLogsExports() [1/3]

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

A list of log types that this DB cluster 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 Aurora User Guide.

Definition at line 1857 of file DBCluster.h.

◆ AddEnabledCloudwatchLogsExports() [2/3]

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

A list of log types that this DB cluster 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 Aurora User Guide.

Definition at line 1848 of file DBCluster.h.

◆ AddEnabledCloudwatchLogsExports() [3/3]

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

A list of log types that this DB cluster 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 Aurora User Guide.

Definition at line 1866 of file DBCluster.h.

◆ AddReadReplicaIdentifiers() [1/3]

DBCluster& Aws::RDS::Model::DBCluster::AddReadReplicaIdentifiers ( Aws::String &&  value)
inline

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

Definition at line 1214 of file DBCluster.h.

◆ AddReadReplicaIdentifiers() [2/3]

DBCluster& Aws::RDS::Model::DBCluster::AddReadReplicaIdentifiers ( const Aws::String value)
inline

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

Definition at line 1208 of file DBCluster.h.

◆ AddReadReplicaIdentifiers() [3/3]

DBCluster& Aws::RDS::Model::DBCluster::AddReadReplicaIdentifiers ( const char *  value)
inline

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

Definition at line 1220 of file DBCluster.h.

◆ AddTagList() [1/2]

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

Definition at line 2378 of file DBCluster.h.

◆ AddTagList() [2/2]

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

Definition at line 2381 of file DBCluster.h.

◆ AddVpcSecurityGroups() [1/2]

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

Provides a list of VPC security groups that the DB cluster belongs to.

Definition at line 1297 of file DBCluster.h.

◆ AddVpcSecurityGroups() [2/2]

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

Provides a list of VPC security groups that the DB cluster belongs to.

Definition at line 1302 of file DBCluster.h.

◆ AllocatedStorageHasBeenSet()

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

For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.

Definition at line 72 of file DBCluster.h.

◆ AssociatedRolesHasBeenSet()

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

Provides a list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.

Definition at line 1552 of file DBCluster.h.

◆ AutomaticRestartTimeHasBeenSet()

bool Aws::RDS::Model::DBCluster::AutomaticRestartTimeHasBeenSet ( ) const
inline

The time when a stopped DB cluster is restarted automatically.

Definition at line 465 of file DBCluster.h.

◆ AvailabilityZonesHasBeenSet()

bool Aws::RDS::Model::DBCluster::AvailabilityZonesHasBeenSet ( ) const
inline

Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.

Definition at line 101 of file DBCluster.h.

◆ BacktrackConsumedChangeRecordsHasBeenSet()

bool Aws::RDS::Model::DBCluster::BacktrackConsumedChangeRecordsHasBeenSet ( ) const
inline

The number of change records stored for Backtrack.

Definition at line 1774 of file DBCluster.h.

◆ BacktrackWindowHasBeenSet()

bool Aws::RDS::Model::DBCluster::BacktrackWindowHasBeenSet ( ) const
inline

The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.

Definition at line 1749 of file DBCluster.h.

◆ BackupRetentionPeriodHasBeenSet()

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

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

Definition at line 156 of file DBCluster.h.

◆ CapacityHasBeenSet()

bool Aws::RDS::Model::DBCluster::CapacityHasBeenSet ( ) const
inline

The current capacity of an Aurora Serverless DB cluster. The capacity is 0 (zero) when the cluster is paused.

For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

Definition at line 1885 of file DBCluster.h.

◆ CharacterSetNameHasBeenSet()

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

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

Definition at line 181 of file DBCluster.h.

◆ CloneGroupIdHasBeenSet()

bool Aws::RDS::Model::DBCluster::CloneGroupIdHasBeenSet ( ) const
inline

Identifies the clone group to which the DB cluster is associated.

Definition at line 1636 of file DBCluster.h.

◆ ClusterCreateTimeHasBeenSet()

bool Aws::RDS::Model::DBCluster::ClusterCreateTimeHasBeenSet ( ) const
inline

Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

Definition at line 1679 of file DBCluster.h.

◆ CopyTagsToSnapshotHasBeenSet()

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

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

Definition at line 2270 of file DBCluster.h.

◆ CrossAccountCloneHasBeenSet()

bool Aws::RDS::Model::DBCluster::CrossAccountCloneHasBeenSet ( ) const
inline

Specifies whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.

Definition at line 2295 of file DBCluster.h.

◆ CustomEndpointsHasBeenSet()

bool Aws::RDS::Model::DBCluster::CustomEndpointsHasBeenSet ( ) const
inline

Identifies all custom endpoints associated with the cluster.

Definition at line 728 of file DBCluster.h.

◆ DatabaseNameHasBeenSet()

bool Aws::RDS::Model::DBCluster::DatabaseNameHasBeenSet ( ) const
inline

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

Definition at line 232 of file DBCluster.h.

◆ DBClusterArnHasBeenSet()

bool Aws::RDS::Model::DBCluster::DBClusterArnHasBeenSet ( ) const
inline

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

Definition at line 1505 of file DBCluster.h.

◆ DBClusterIdentifierHasBeenSet()

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

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

Definition at line 287 of file DBCluster.h.

◆ DBClusterMembersHasBeenSet()

bool Aws::RDS::Model::DBCluster::DBClusterMembersHasBeenSet ( ) const
inline

Provides the list of instances that make up the DB cluster.

Definition at line 1231 of file DBCluster.h.

◆ DBClusterOptionGroupMembershipsHasBeenSet()

bool Aws::RDS::Model::DBCluster::DBClusterOptionGroupMembershipsHasBeenSet ( ) const
inline

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

Definition at line 980 of file DBCluster.h.

◆ DBClusterParameterGroupHasBeenSet()

bool Aws::RDS::Model::DBCluster::DBClusterParameterGroupHasBeenSet ( ) const
inline

Specifies the name of the DB cluster parameter group for the DB cluster.

Definition at line 334 of file DBCluster.h.

◆ DbClusterResourceIdHasBeenSet()

bool Aws::RDS::Model::DBCluster::DbClusterResourceIdHasBeenSet ( ) const
inline

The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS CMK for the DB cluster is accessed.

Definition at line 1452 of file DBCluster.h.

◆ DBSubnetGroupHasBeenSet()

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

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

Definition at line 377 of file DBCluster.h.

◆ DeletionProtectionHasBeenSet()

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

Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

Definition at line 2008 of file DBCluster.h.

◆ DomainMembershipsHasBeenSet()

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

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

Definition at line 2320 of file DBCluster.h.

◆ EarliestBacktrackTimeHasBeenSet()

bool Aws::RDS::Model::DBCluster::EarliestBacktrackTimeHasBeenSet ( ) const
inline

The earliest time to which a DB cluster can be backtracked.

Definition at line 1714 of file DBCluster.h.

◆ EarliestRestorableTimeHasBeenSet()

bool Aws::RDS::Model::DBCluster::EarliestRestorableTimeHasBeenSet ( ) const
inline

The earliest time to which a database can be restored with point-in-time restore.

Definition at line 539 of file DBCluster.h.

◆ EnabledCloudwatchLogsExportsHasBeenSet()

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

A list of log types that this DB cluster 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 Aurora User Guide.

Definition at line 1803 of file DBCluster.h.

◆ EndpointHasBeenSet()

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

Specifies the connection endpoint for the primary instance of the DB cluster.

Definition at line 576 of file DBCluster.h.

◆ EngineHasBeenSet()

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

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

Definition at line 799 of file DBCluster.h.

◆ EngineModeHasBeenSet()

bool Aws::RDS::Model::DBCluster::EngineModeHasBeenSet ( ) const
inline

The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.

For more information, see CreateDBCluster.

Definition at line 1922 of file DBCluster.h.

◆ EngineVersionHasBeenSet()

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

Indicates the database engine version.

Definition at line 840 of file DBCluster.h.

◆ GetActivityStreamKinesisStreamName()

const Aws::String& Aws::RDS::Model::DBCluster::GetActivityStreamKinesisStreamName ( ) const
inline

The name of the Amazon Kinesis data stream used for the database activity stream.

Definition at line 2215 of file DBCluster.h.

◆ GetActivityStreamKmsKeyId()

const Aws::String& Aws::RDS::Model::DBCluster::GetActivityStreamKmsKeyId ( ) const
inline

The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.

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

Definition at line 2152 of file DBCluster.h.

◆ GetActivityStreamMode()

const ActivityStreamMode& Aws::RDS::Model::DBCluster::GetActivityStreamMode ( ) const
inline

The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.

Definition at line 2077 of file DBCluster.h.

◆ GetActivityStreamStatus()

const ActivityStreamStatus& Aws::RDS::Model::DBCluster::GetActivityStreamStatus ( ) const
inline

The status of the database activity stream.

Definition at line 2118 of file DBCluster.h.

◆ GetAllocatedStorage()

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

For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.

Definition at line 64 of file DBCluster.h.

◆ GetAssociatedRoles()

const Aws::Vector<DBClusterRole>& Aws::RDS::Model::DBCluster::GetAssociatedRoles ( ) const
inline

Provides a list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.

Definition at line 1544 of file DBCluster.h.

◆ GetAutomaticRestartTime()

const Aws::Utils::DateTime& Aws::RDS::Model::DBCluster::GetAutomaticRestartTime ( ) const
inline

The time when a stopped DB cluster is restarted automatically.

Definition at line 460 of file DBCluster.h.

◆ GetAvailabilityZones()

const Aws::Vector<Aws::String>& Aws::RDS::Model::DBCluster::GetAvailabilityZones ( ) const
inline

Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.

Definition at line 95 of file DBCluster.h.

◆ GetBacktrackConsumedChangeRecords()

long long Aws::RDS::Model::DBCluster::GetBacktrackConsumedChangeRecords ( ) const
inline

The number of change records stored for Backtrack.

Definition at line 1769 of file DBCluster.h.

◆ GetBacktrackWindow()

long long Aws::RDS::Model::DBCluster::GetBacktrackWindow ( ) const
inline

The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.

Definition at line 1742 of file DBCluster.h.

◆ GetBackupRetentionPeriod()

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

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

Definition at line 150 of file DBCluster.h.

◆ GetCapacity()

int Aws::RDS::Model::DBCluster::GetCapacity ( ) const
inline

The current capacity of an Aurora Serverless DB cluster. The capacity is 0 (zero) when the cluster is paused.

For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

Definition at line 1876 of file DBCluster.h.

◆ GetCharacterSetName()

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

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

Definition at line 175 of file DBCluster.h.

◆ GetCloneGroupId()

const Aws::String& Aws::RDS::Model::DBCluster::GetCloneGroupId ( ) const
inline

Identifies the clone group to which the DB cluster is associated.

Definition at line 1631 of file DBCluster.h.

◆ GetClusterCreateTime()

const Aws::Utils::DateTime& Aws::RDS::Model::DBCluster::GetClusterCreateTime ( ) const
inline

Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

Definition at line 1673 of file DBCluster.h.

◆ GetCopyTagsToSnapshot()

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

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

Definition at line 2264 of file DBCluster.h.

◆ GetCrossAccountClone()

bool Aws::RDS::Model::DBCluster::GetCrossAccountClone ( ) const
inline

Specifies whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.

Definition at line 2289 of file DBCluster.h.

◆ GetCustomEndpoints()

const Aws::Vector<Aws::String>& Aws::RDS::Model::DBCluster::GetCustomEndpoints ( ) const
inline

Identifies all custom endpoints associated with the cluster.

Definition at line 723 of file DBCluster.h.

◆ GetDatabaseName()

const Aws::String& Aws::RDS::Model::DBCluster::GetDatabaseName ( ) const
inline

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

Definition at line 225 of file DBCluster.h.

◆ GetDBClusterArn()

const Aws::String& Aws::RDS::Model::DBCluster::GetDBClusterArn ( ) const
inline

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

Definition at line 1500 of file DBCluster.h.

◆ GetDBClusterIdentifier()

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

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

Definition at line 281 of file DBCluster.h.

◆ GetDBClusterMembers()

const Aws::Vector<DBClusterMember>& Aws::RDS::Model::DBCluster::GetDBClusterMembers ( ) const
inline

Provides the list of instances that make up the DB cluster.

Definition at line 1226 of file DBCluster.h.

◆ GetDBClusterOptionGroupMemberships()

const Aws::Vector<DBClusterOptionGroupStatus>& Aws::RDS::Model::DBCluster::GetDBClusterOptionGroupMemberships ( ) const
inline

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

Definition at line 975 of file DBCluster.h.

◆ GetDBClusterParameterGroup()

const Aws::String& Aws::RDS::Model::DBCluster::GetDBClusterParameterGroup ( ) const
inline

Specifies the name of the DB cluster parameter group for the DB cluster.

Definition at line 329 of file DBCluster.h.

◆ GetDbClusterResourceId()

const Aws::String& Aws::RDS::Model::DBCluster::GetDbClusterResourceId ( ) const
inline

The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS CMK for the DB cluster is accessed.

Definition at line 1445 of file DBCluster.h.

◆ GetDBSubnetGroup()

const Aws::String& Aws::RDS::Model::DBCluster::GetDBSubnetGroup ( ) const
inline

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

Definition at line 371 of file DBCluster.h.

◆ GetDeletionProtection()

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

Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

Definition at line 2002 of file DBCluster.h.

◆ GetDomainMemberships()

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

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

Definition at line 2314 of file DBCluster.h.

◆ GetEarliestBacktrackTime()

const Aws::Utils::DateTime& Aws::RDS::Model::DBCluster::GetEarliestBacktrackTime ( ) const
inline

The earliest time to which a DB cluster can be backtracked.

Definition at line 1709 of file DBCluster.h.

◆ GetEarliestRestorableTime()

const Aws::Utils::DateTime& Aws::RDS::Model::DBCluster::GetEarliestRestorableTime ( ) const
inline

The earliest time to which a database can be restored with point-in-time restore.

Definition at line 533 of file DBCluster.h.

◆ GetEnabledCloudwatchLogsExports()

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

A list of log types that this DB cluster 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 Aurora User Guide.

Definition at line 1794 of file DBCluster.h.

◆ GetEndpoint()

const Aws::String& Aws::RDS::Model::DBCluster::GetEndpoint ( ) const
inline

Specifies the connection endpoint for the primary instance of the DB cluster.

Definition at line 570 of file DBCluster.h.

◆ GetEngine()

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

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

Definition at line 794 of file DBCluster.h.

◆ GetEngineMode()

const Aws::String& Aws::RDS::Model::DBCluster::GetEngineMode ( ) const
inline

The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.

For more information, see CreateDBCluster.

Definition at line 1913 of file DBCluster.h.

◆ GetEngineVersion()

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

Indicates the database engine version.

Definition at line 835 of file DBCluster.h.

◆ GetGlobalWriteForwardingRequested()

bool Aws::RDS::Model::DBCluster::GetGlobalWriteForwardingRequested ( ) const
inline

Specifies whether you have requested to enable write forwarding for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.

Definition at line 2428 of file DBCluster.h.

◆ GetGlobalWriteForwardingStatus()

const WriteForwardingStatus& Aws::RDS::Model::DBCluster::GetGlobalWriteForwardingStatus ( ) const
inline

Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.

Definition at line 2388 of file DBCluster.h.

◆ GetHostedZoneId()

const Aws::String& Aws::RDS::Model::DBCluster::GetHostedZoneId ( ) const
inline

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

Definition at line 1309 of file DBCluster.h.

◆ GetHttpEndpointEnabled()

bool Aws::RDS::Model::DBCluster::GetHttpEndpointEnabled ( ) const
inline

A value that indicates whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.

When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.

For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.

Definition at line 2033 of file DBCluster.h.

◆ GetIAMDatabaseAuthenticationEnabled()

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

A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

Definition at line 1607 of file DBCluster.h.

◆ GetKmsKeyId()

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

If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.

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

Definition at line 1381 of file DBCluster.h.

◆ GetLatestRestorableTime()

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

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

Definition at line 877 of file DBCluster.h.

◆ GetMasterUsername()

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

Contains the master username for the DB cluster.

Definition at line 934 of file DBCluster.h.

◆ GetMultiAZ()

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

Specifies whether the DB cluster has instances in multiple Availability Zones.

Definition at line 770 of file DBCluster.h.

◆ GetPendingModifiedValues()

const ClusterPendingModifiedValues& Aws::RDS::Model::DBCluster::GetPendingModifiedValues ( ) const
inline

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

Definition at line 2463 of file DBCluster.h.

◆ GetPercentProgress()

const Aws::String& Aws::RDS::Model::DBCluster::GetPercentProgress ( ) const
inline

Specifies the progress of the operation as a percentage.

Definition at line 491 of file DBCluster.h.

◆ GetPort()

int Aws::RDS::Model::DBCluster::GetPort ( ) const
inline

Specifies the port that the database engine is listening on.

Definition at line 913 of file DBCluster.h.

◆ GetPreferredBackupWindow()

const Aws::String& Aws::RDS::Model::DBCluster::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 1018 of file DBCluster.h.

◆ GetPreferredMaintenanceWindow()

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

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

Definition at line 1074 of file DBCluster.h.

◆ GetReaderEndpoint()

const Aws::String& Aws::RDS::Model::DBCluster::GetReaderEndpoint ( ) const
inline

The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.

If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.

Definition at line 626 of file DBCluster.h.

◆ GetReadReplicaIdentifiers()

const Aws::Vector<Aws::String>& Aws::RDS::Model::DBCluster::GetReadReplicaIdentifiers ( ) const
inline

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

Definition at line 1172 of file DBCluster.h.

◆ GetReplicationSourceIdentifier()

const Aws::String& Aws::RDS::Model::DBCluster::GetReplicationSourceIdentifier ( ) const
inline

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

Definition at line 1123 of file DBCluster.h.

◆ GetScalingConfigurationInfo()

const ScalingConfigurationInfo& Aws::RDS::Model::DBCluster::GetScalingConfigurationInfo ( ) const
inline

Definition at line 1980 of file DBCluster.h.

◆ GetStatus()

const Aws::String& Aws::RDS::Model::DBCluster::GetStatus ( ) const
inline

Specifies the current state of this DB cluster.

Definition at line 419 of file DBCluster.h.

◆ GetStorageEncrypted()

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

Specifies whether the DB cluster is encrypted.

Definition at line 1357 of file DBCluster.h.

◆ GetTagList()

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

Definition at line 2360 of file DBCluster.h.

◆ GetVpcSecurityGroups()

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

Provides a list of VPC security groups that the DB cluster belongs to.

Definition at line 1267 of file DBCluster.h.

◆ GlobalWriteForwardingRequestedHasBeenSet()

bool Aws::RDS::Model::DBCluster::GlobalWriteForwardingRequestedHasBeenSet ( ) const
inline

Specifies whether you have requested to enable write forwarding for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.

Definition at line 2437 of file DBCluster.h.

◆ GlobalWriteForwardingStatusHasBeenSet()

bool Aws::RDS::Model::DBCluster::GlobalWriteForwardingStatusHasBeenSet ( ) const
inline

Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.

Definition at line 2394 of file DBCluster.h.

◆ HostedZoneIdHasBeenSet()

bool Aws::RDS::Model::DBCluster::HostedZoneIdHasBeenSet ( ) const
inline

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

Definition at line 1315 of file DBCluster.h.

◆ HttpEndpointEnabledHasBeenSet()

bool Aws::RDS::Model::DBCluster::HttpEndpointEnabledHasBeenSet ( ) const
inline

A value that indicates whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.

When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.

For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.

Definition at line 2045 of file DBCluster.h.

◆ IAMDatabaseAuthenticationEnabledHasBeenSet()

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

A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

Definition at line 1613 of file DBCluster.h.

◆ KmsKeyIdHasBeenSet()

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

If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.

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

Definition at line 1389 of file DBCluster.h.

◆ LatestRestorableTimeHasBeenSet()

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

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

Definition at line 883 of file DBCluster.h.

◆ MasterUsernameHasBeenSet()

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

Contains the master username for the DB cluster.

Definition at line 939 of file DBCluster.h.

◆ MultiAZHasBeenSet()

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

Specifies whether the DB cluster has instances in multiple Availability Zones.

Definition at line 776 of file DBCluster.h.

◆ operator=()

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

◆ OutputToStream() [1/2]

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

◆ OutputToStream() [2/2]

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

◆ PendingModifiedValuesHasBeenSet()

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

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

Definition at line 2470 of file DBCluster.h.

◆ PercentProgressHasBeenSet()

bool Aws::RDS::Model::DBCluster::PercentProgressHasBeenSet ( ) const
inline

Specifies the progress of the operation as a percentage.

Definition at line 496 of file DBCluster.h.

◆ PortHasBeenSet()

bool Aws::RDS::Model::DBCluster::PortHasBeenSet ( ) const
inline

Specifies the port that the database engine is listening on.

Definition at line 918 of file DBCluster.h.

◆ PreferredBackupWindowHasBeenSet()

bool Aws::RDS::Model::DBCluster::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 1025 of file DBCluster.h.

◆ PreferredMaintenanceWindowHasBeenSet()

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

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

Definition at line 1080 of file DBCluster.h.

◆ ReaderEndpointHasBeenSet()

bool Aws::RDS::Model::DBCluster::ReaderEndpointHasBeenSet ( ) const
inline

The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.

If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.

Definition at line 639 of file DBCluster.h.

◆ ReadReplicaIdentifiersHasBeenSet()

bool Aws::RDS::Model::DBCluster::ReadReplicaIdentifiersHasBeenSet ( ) const
inline

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

Definition at line 1178 of file DBCluster.h.

◆ ReplicationSourceIdentifierHasBeenSet()

bool Aws::RDS::Model::DBCluster::ReplicationSourceIdentifierHasBeenSet ( ) const
inline

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

Definition at line 1129 of file DBCluster.h.

◆ ScalingConfigurationInfoHasBeenSet()

bool Aws::RDS::Model::DBCluster::ScalingConfigurationInfoHasBeenSet ( ) const
inline

Definition at line 1983 of file DBCluster.h.

◆ SetActivityStreamKinesisStreamName() [1/3]

void Aws::RDS::Model::DBCluster::SetActivityStreamKinesisStreamName ( Aws::String &&  value)
inline

The name of the Amazon Kinesis data stream used for the database activity stream.

Definition at line 2233 of file DBCluster.h.

◆ SetActivityStreamKinesisStreamName() [2/3]

void Aws::RDS::Model::DBCluster::SetActivityStreamKinesisStreamName ( const Aws::String value)
inline

The name of the Amazon Kinesis data stream used for the database activity stream.

Definition at line 2227 of file DBCluster.h.

◆ SetActivityStreamKinesisStreamName() [3/3]

void Aws::RDS::Model::DBCluster::SetActivityStreamKinesisStreamName ( const char *  value)
inline

The name of the Amazon Kinesis data stream used for the database activity stream.

Definition at line 2239 of file DBCluster.h.

◆ SetActivityStreamKmsKeyId() [1/3]

void Aws::RDS::Model::DBCluster::SetActivityStreamKmsKeyId ( Aws::String &&  value)
inline

The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.

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

Definition at line 2176 of file DBCluster.h.

◆ SetActivityStreamKmsKeyId() [2/3]

void Aws::RDS::Model::DBCluster::SetActivityStreamKmsKeyId ( const Aws::String value)
inline

The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.

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

Definition at line 2168 of file DBCluster.h.

◆ SetActivityStreamKmsKeyId() [3/3]

void Aws::RDS::Model::DBCluster::SetActivityStreamKmsKeyId ( const char *  value)
inline

The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.

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

Definition at line 2184 of file DBCluster.h.

◆ SetActivityStreamMode() [1/2]

void Aws::RDS::Model::DBCluster::SetActivityStreamMode ( ActivityStreamMode &&  value)
inline

The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.

Definition at line 2098 of file DBCluster.h.

◆ SetActivityStreamMode() [2/2]

void Aws::RDS::Model::DBCluster::SetActivityStreamMode ( const ActivityStreamMode value)
inline

The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.

Definition at line 2091 of file DBCluster.h.

◆ SetActivityStreamStatus() [1/2]

void Aws::RDS::Model::DBCluster::SetActivityStreamStatus ( ActivityStreamStatus &&  value)
inline

The status of the database activity stream.

Definition at line 2133 of file DBCluster.h.

◆ SetActivityStreamStatus() [2/2]

void Aws::RDS::Model::DBCluster::SetActivityStreamStatus ( const ActivityStreamStatus value)
inline

The status of the database activity stream.

Definition at line 2128 of file DBCluster.h.

◆ SetAllocatedStorage()

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

For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.

Definition at line 80 of file DBCluster.h.

◆ SetAssociatedRoles() [1/2]

void Aws::RDS::Model::DBCluster::SetAssociatedRoles ( Aws::Vector< DBClusterRole > &&  value)
inline

Provides a list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.

Definition at line 1568 of file DBCluster.h.

◆ SetAssociatedRoles() [2/2]

void Aws::RDS::Model::DBCluster::SetAssociatedRoles ( const Aws::Vector< DBClusterRole > &  value)
inline

Provides a list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.

Definition at line 1560 of file DBCluster.h.

◆ SetAutomaticRestartTime() [1/2]

void Aws::RDS::Model::DBCluster::SetAutomaticRestartTime ( Aws::Utils::DateTime &&  value)
inline

The time when a stopped DB cluster is restarted automatically.

Definition at line 475 of file DBCluster.h.

◆ SetAutomaticRestartTime() [2/2]

void Aws::RDS::Model::DBCluster::SetAutomaticRestartTime ( const Aws::Utils::DateTime value)
inline

The time when a stopped DB cluster is restarted automatically.

Definition at line 470 of file DBCluster.h.

◆ SetAvailabilityZones() [1/2]

void Aws::RDS::Model::DBCluster::SetAvailabilityZones ( Aws::Vector< Aws::String > &&  value)
inline

Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.

Definition at line 113 of file DBCluster.h.

◆ SetAvailabilityZones() [2/2]

void Aws::RDS::Model::DBCluster::SetAvailabilityZones ( const Aws::Vector< Aws::String > &  value)
inline

Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.

Definition at line 107 of file DBCluster.h.

◆ SetBacktrackConsumedChangeRecords()

void Aws::RDS::Model::DBCluster::SetBacktrackConsumedChangeRecords ( long long  value)
inline

The number of change records stored for Backtrack.

Definition at line 1779 of file DBCluster.h.

◆ SetBacktrackWindow()

void Aws::RDS::Model::DBCluster::SetBacktrackWindow ( long long  value)
inline

The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.

Definition at line 1756 of file DBCluster.h.

◆ SetBackupRetentionPeriod()

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

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

Definition at line 162 of file DBCluster.h.

◆ SetCapacity()

void Aws::RDS::Model::DBCluster::SetCapacity ( int  value)
inline

The current capacity of an Aurora Serverless DB cluster. The capacity is 0 (zero) when the cluster is paused.

For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

Definition at line 1894 of file DBCluster.h.

◆ SetCharacterSetName() [1/3]

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

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

Definition at line 193 of file DBCluster.h.

◆ SetCharacterSetName() [2/3]

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

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

Definition at line 187 of file DBCluster.h.

◆ SetCharacterSetName() [3/3]

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

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

Definition at line 199 of file DBCluster.h.

◆ SetCloneGroupId() [1/3]

void Aws::RDS::Model::DBCluster::SetCloneGroupId ( Aws::String &&  value)
inline

Identifies the clone group to which the DB cluster is associated.

Definition at line 1646 of file DBCluster.h.

◆ SetCloneGroupId() [2/3]

void Aws::RDS::Model::DBCluster::SetCloneGroupId ( const Aws::String value)
inline

Identifies the clone group to which the DB cluster is associated.

Definition at line 1641 of file DBCluster.h.

◆ SetCloneGroupId() [3/3]

void Aws::RDS::Model::DBCluster::SetCloneGroupId ( const char *  value)
inline

Identifies the clone group to which the DB cluster is associated.

Definition at line 1651 of file DBCluster.h.

◆ SetClusterCreateTime() [1/2]

void Aws::RDS::Model::DBCluster::SetClusterCreateTime ( Aws::Utils::DateTime &&  value)
inline

Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

Definition at line 1691 of file DBCluster.h.

◆ SetClusterCreateTime() [2/2]

void Aws::RDS::Model::DBCluster::SetClusterCreateTime ( const Aws::Utils::DateTime value)
inline

Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

Definition at line 1685 of file DBCluster.h.

◆ SetCopyTagsToSnapshot()

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

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

Definition at line 2276 of file DBCluster.h.

◆ SetCrossAccountClone()

void Aws::RDS::Model::DBCluster::SetCrossAccountClone ( bool  value)
inline

Specifies whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.

Definition at line 2301 of file DBCluster.h.

◆ SetCustomEndpoints() [1/2]

void Aws::RDS::Model::DBCluster::SetCustomEndpoints ( Aws::Vector< Aws::String > &&  value)
inline

Identifies all custom endpoints associated with the cluster.

Definition at line 738 of file DBCluster.h.

◆ SetCustomEndpoints() [2/2]

void Aws::RDS::Model::DBCluster::SetCustomEndpoints ( const Aws::Vector< Aws::String > &  value)
inline

Identifies all custom endpoints associated with the cluster.

Definition at line 733 of file DBCluster.h.

◆ SetDatabaseName() [1/3]

void Aws::RDS::Model::DBCluster::SetDatabaseName ( Aws::String &&  value)
inline

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

Definition at line 246 of file DBCluster.h.

◆ SetDatabaseName() [2/3]

void Aws::RDS::Model::DBCluster::SetDatabaseName ( const Aws::String value)
inline

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

Definition at line 239 of file DBCluster.h.

◆ SetDatabaseName() [3/3]

void Aws::RDS::Model::DBCluster::SetDatabaseName ( const char *  value)
inline

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

Definition at line 253 of file DBCluster.h.

◆ SetDBClusterArn() [1/3]

void Aws::RDS::Model::DBCluster::SetDBClusterArn ( Aws::String &&  value)
inline

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

Definition at line 1515 of file DBCluster.h.

◆ SetDBClusterArn() [2/3]

void Aws::RDS::Model::DBCluster::SetDBClusterArn ( const Aws::String value)
inline

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

Definition at line 1510 of file DBCluster.h.

◆ SetDBClusterArn() [3/3]

void Aws::RDS::Model::DBCluster::SetDBClusterArn ( const char *  value)
inline

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

Definition at line 1520 of file DBCluster.h.

◆ SetDBClusterIdentifier() [1/3]

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

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

Definition at line 299 of file DBCluster.h.

◆ SetDBClusterIdentifier() [2/3]

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

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

Definition at line 293 of file DBCluster.h.

◆ SetDBClusterIdentifier() [3/3]

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

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

Definition at line 305 of file DBCluster.h.

◆ SetDBClusterMembers() [1/2]

void Aws::RDS::Model::DBCluster::SetDBClusterMembers ( Aws::Vector< DBClusterMember > &&  value)
inline

Provides the list of instances that make up the DB cluster.

Definition at line 1241 of file DBCluster.h.

◆ SetDBClusterMembers() [2/2]

void Aws::RDS::Model::DBCluster::SetDBClusterMembers ( const Aws::Vector< DBClusterMember > &  value)
inline

Provides the list of instances that make up the DB cluster.

Definition at line 1236 of file DBCluster.h.

◆ SetDBClusterOptionGroupMemberships() [1/2]

void Aws::RDS::Model::DBCluster::SetDBClusterOptionGroupMemberships ( Aws::Vector< DBClusterOptionGroupStatus > &&  value)
inline

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

Definition at line 990 of file DBCluster.h.

◆ SetDBClusterOptionGroupMemberships() [2/2]

void Aws::RDS::Model::DBCluster::SetDBClusterOptionGroupMemberships ( const Aws::Vector< DBClusterOptionGroupStatus > &  value)
inline

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

Definition at line 985 of file DBCluster.h.

◆ SetDBClusterParameterGroup() [1/3]

void Aws::RDS::Model::DBCluster::SetDBClusterParameterGroup ( Aws::String &&  value)
inline

Specifies the name of the DB cluster parameter group for the DB cluster.

Definition at line 344 of file DBCluster.h.

◆ SetDBClusterParameterGroup() [2/3]

void Aws::RDS::Model::DBCluster::SetDBClusterParameterGroup ( const Aws::String value)
inline

Specifies the name of the DB cluster parameter group for the DB cluster.

Definition at line 339 of file DBCluster.h.

◆ SetDBClusterParameterGroup() [3/3]

void Aws::RDS::Model::DBCluster::SetDBClusterParameterGroup ( const char *  value)
inline

Specifies the name of the DB cluster parameter group for the DB cluster.

Definition at line 349 of file DBCluster.h.

◆ SetDbClusterResourceId() [1/3]

void Aws::RDS::Model::DBCluster::SetDbClusterResourceId ( Aws::String &&  value)
inline

The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS CMK for the DB cluster is accessed.

Definition at line 1466 of file DBCluster.h.

◆ SetDbClusterResourceId() [2/3]

void Aws::RDS::Model::DBCluster::SetDbClusterResourceId ( const Aws::String value)
inline

The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS CMK for the DB cluster is accessed.

Definition at line 1459 of file DBCluster.h.

◆ SetDbClusterResourceId() [3/3]

void Aws::RDS::Model::DBCluster::SetDbClusterResourceId ( const char *  value)
inline

The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS CMK for the DB cluster is accessed.

Definition at line 1473 of file DBCluster.h.

◆ SetDBSubnetGroup() [1/3]

void Aws::RDS::Model::DBCluster::SetDBSubnetGroup ( Aws::String &&  value)
inline

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

Definition at line 389 of file DBCluster.h.

◆ SetDBSubnetGroup() [2/3]

void Aws::RDS::Model::DBCluster::SetDBSubnetGroup ( const Aws::String value)
inline

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

Definition at line 383 of file DBCluster.h.

◆ SetDBSubnetGroup() [3/3]

void Aws::RDS::Model::DBCluster::SetDBSubnetGroup ( const char *  value)
inline

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

Definition at line 395 of file DBCluster.h.

◆ SetDeletionProtection()

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

Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

Definition at line 2014 of file DBCluster.h.

◆ SetDomainMemberships() [1/2]

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

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

Definition at line 2332 of file DBCluster.h.

◆ SetDomainMemberships() [2/2]

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

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

Definition at line 2326 of file DBCluster.h.

◆ SetEarliestBacktrackTime() [1/2]

void Aws::RDS::Model::DBCluster::SetEarliestBacktrackTime ( Aws::Utils::DateTime &&  value)
inline

The earliest time to which a DB cluster can be backtracked.

Definition at line 1724 of file DBCluster.h.

◆ SetEarliestBacktrackTime() [2/2]

void Aws::RDS::Model::DBCluster::SetEarliestBacktrackTime ( const Aws::Utils::DateTime value)
inline

The earliest time to which a DB cluster can be backtracked.

Definition at line 1719 of file DBCluster.h.

◆ SetEarliestRestorableTime() [1/2]

void Aws::RDS::Model::DBCluster::SetEarliestRestorableTime ( Aws::Utils::DateTime &&  value)
inline

The earliest time to which a database can be restored with point-in-time restore.

Definition at line 551 of file DBCluster.h.

◆ SetEarliestRestorableTime() [2/2]

void Aws::RDS::Model::DBCluster::SetEarliestRestorableTime ( const Aws::Utils::DateTime value)
inline

The earliest time to which a database can be restored with point-in-time restore.

Definition at line 545 of file DBCluster.h.

◆ SetEnabledCloudwatchLogsExports() [1/2]

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

A list of log types that this DB cluster 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 Aurora User Guide.

Definition at line 1821 of file DBCluster.h.

◆ SetEnabledCloudwatchLogsExports() [2/2]

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

A list of log types that this DB cluster 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 Aurora User Guide.

Definition at line 1812 of file DBCluster.h.

◆ SetEndpoint() [1/3]

void Aws::RDS::Model::DBCluster::SetEndpoint ( Aws::String &&  value)
inline

Specifies the connection endpoint for the primary instance of the DB cluster.

Definition at line 588 of file DBCluster.h.

◆ SetEndpoint() [2/3]

void Aws::RDS::Model::DBCluster::SetEndpoint ( const Aws::String value)
inline

Specifies the connection endpoint for the primary instance of the DB cluster.

Definition at line 582 of file DBCluster.h.

◆ SetEndpoint() [3/3]

void Aws::RDS::Model::DBCluster::SetEndpoint ( const char *  value)
inline

Specifies the connection endpoint for the primary instance of the DB cluster.

Definition at line 594 of file DBCluster.h.

◆ SetEngine() [1/3]

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

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

Definition at line 809 of file DBCluster.h.

◆ SetEngine() [2/3]

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

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

Definition at line 804 of file DBCluster.h.

◆ SetEngine() [3/3]

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

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

Definition at line 814 of file DBCluster.h.

◆ SetEngineMode() [1/3]

void Aws::RDS::Model::DBCluster::SetEngineMode ( Aws::String &&  value)
inline

The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.

For more information, see CreateDBCluster.

Definition at line 1940 of file DBCluster.h.

◆ SetEngineMode() [2/3]

void Aws::RDS::Model::DBCluster::SetEngineMode ( const Aws::String value)
inline

The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.

For more information, see CreateDBCluster.

Definition at line 1931 of file DBCluster.h.

◆ SetEngineMode() [3/3]

void Aws::RDS::Model::DBCluster::SetEngineMode ( const char *  value)
inline

The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.

For more information, see CreateDBCluster.

Definition at line 1949 of file DBCluster.h.

◆ SetEngineVersion() [1/3]

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

Indicates the database engine version.

Definition at line 850 of file DBCluster.h.

◆ SetEngineVersion() [2/3]

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

Indicates the database engine version.

Definition at line 845 of file DBCluster.h.

◆ SetEngineVersion() [3/3]

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

Indicates the database engine version.

Definition at line 855 of file DBCluster.h.

◆ SetGlobalWriteForwardingRequested()

void Aws::RDS::Model::DBCluster::SetGlobalWriteForwardingRequested ( bool  value)
inline

Specifies whether you have requested to enable write forwarding for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.

Definition at line 2446 of file DBCluster.h.

◆ SetGlobalWriteForwardingStatus() [1/2]

void Aws::RDS::Model::DBCluster::SetGlobalWriteForwardingStatus ( const WriteForwardingStatus value)
inline

Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.

Definition at line 2400 of file DBCluster.h.

◆ SetGlobalWriteForwardingStatus() [2/2]

void Aws::RDS::Model::DBCluster::SetGlobalWriteForwardingStatus ( WriteForwardingStatus &&  value)
inline

Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.

Definition at line 2406 of file DBCluster.h.

◆ SetHostedZoneId() [1/3]

void Aws::RDS::Model::DBCluster::SetHostedZoneId ( Aws::String &&  value)
inline

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

Definition at line 1327 of file DBCluster.h.

◆ SetHostedZoneId() [2/3]

void Aws::RDS::Model::DBCluster::SetHostedZoneId ( const Aws::String value)
inline

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

Definition at line 1321 of file DBCluster.h.

◆ SetHostedZoneId() [3/3]

void Aws::RDS::Model::DBCluster::SetHostedZoneId ( const char *  value)
inline

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

Definition at line 1333 of file DBCluster.h.

◆ SetHttpEndpointEnabled()

void Aws::RDS::Model::DBCluster::SetHttpEndpointEnabled ( bool  value)
inline

A value that indicates whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.

When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.

For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.

Definition at line 2057 of file DBCluster.h.

◆ SetIAMDatabaseAuthenticationEnabled()

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

A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

Definition at line 1619 of file DBCluster.h.

◆ SetKmsKeyId() [1/3]

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

If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.

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

Definition at line 1405 of file DBCluster.h.

◆ SetKmsKeyId() [2/3]

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

If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.

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

Definition at line 1397 of file DBCluster.h.

◆ SetKmsKeyId() [3/3]

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

If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.

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

Definition at line 1413 of file DBCluster.h.

◆ SetLatestRestorableTime() [1/2]

void Aws::RDS::Model::DBCluster::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 895 of file DBCluster.h.

◆ SetLatestRestorableTime() [2/2]

void Aws::RDS::Model::DBCluster::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 889 of file DBCluster.h.

◆ SetMasterUsername() [1/3]

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

Contains the master username for the DB cluster.

Definition at line 949 of file DBCluster.h.

◆ SetMasterUsername() [2/3]

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

Contains the master username for the DB cluster.

Definition at line 944 of file DBCluster.h.

◆ SetMasterUsername() [3/3]

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

Contains the master username for the DB cluster.

Definition at line 954 of file DBCluster.h.

◆ SetMultiAZ()

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

Specifies whether the DB cluster has instances in multiple Availability Zones.

Definition at line 782 of file DBCluster.h.

◆ SetPendingModifiedValues() [1/2]

void Aws::RDS::Model::DBCluster::SetPendingModifiedValues ( ClusterPendingModifiedValues &&  value)
inline

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

Definition at line 2484 of file DBCluster.h.

◆ SetPendingModifiedValues() [2/2]

void Aws::RDS::Model::DBCluster::SetPendingModifiedValues ( const ClusterPendingModifiedValues value)
inline

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

Definition at line 2477 of file DBCluster.h.

◆ SetPercentProgress() [1/3]

void Aws::RDS::Model::DBCluster::SetPercentProgress ( Aws::String &&  value)
inline

Specifies the progress of the operation as a percentage.

Definition at line 506 of file DBCluster.h.

◆ SetPercentProgress() [2/3]

void Aws::RDS::Model::DBCluster::SetPercentProgress ( const Aws::String value)
inline

Specifies the progress of the operation as a percentage.

Definition at line 501 of file DBCluster.h.

◆ SetPercentProgress() [3/3]

void Aws::RDS::Model::DBCluster::SetPercentProgress ( const char *  value)
inline

Specifies the progress of the operation as a percentage.

Definition at line 511 of file DBCluster.h.

◆ SetPort()

void Aws::RDS::Model::DBCluster::SetPort ( int  value)
inline

Specifies the port that the database engine is listening on.

Definition at line 923 of file DBCluster.h.

◆ SetPreferredBackupWindow() [1/3]

void Aws::RDS::Model::DBCluster::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 1039 of file DBCluster.h.

◆ SetPreferredBackupWindow() [2/3]

void Aws::RDS::Model::DBCluster::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 1032 of file DBCluster.h.

◆ SetPreferredBackupWindow() [3/3]

void Aws::RDS::Model::DBCluster::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 1046 of file DBCluster.h.

◆ SetPreferredMaintenanceWindow() [1/3]

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

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

Definition at line 1092 of file DBCluster.h.

◆ SetPreferredMaintenanceWindow() [2/3]

void Aws::RDS::Model::DBCluster::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 1086 of file DBCluster.h.

◆ SetPreferredMaintenanceWindow() [3/3]

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

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

Definition at line 1098 of file DBCluster.h.

◆ SetReaderEndpoint() [1/3]

void Aws::RDS::Model::DBCluster::SetReaderEndpoint ( Aws::String &&  value)
inline

The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.

If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.

Definition at line 665 of file DBCluster.h.

◆ SetReaderEndpoint() [2/3]

void Aws::RDS::Model::DBCluster::SetReaderEndpoint ( const Aws::String value)
inline

The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.

If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.

Definition at line 652 of file DBCluster.h.

◆ SetReaderEndpoint() [3/3]

void Aws::RDS::Model::DBCluster::SetReaderEndpoint ( const char *  value)
inline

The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.

If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.

Definition at line 678 of file DBCluster.h.

◆ SetReadReplicaIdentifiers() [1/2]

void Aws::RDS::Model::DBCluster::SetReadReplicaIdentifiers ( Aws::Vector< Aws::String > &&  value)
inline

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

Definition at line 1190 of file DBCluster.h.

◆ SetReadReplicaIdentifiers() [2/2]

void Aws::RDS::Model::DBCluster::SetReadReplicaIdentifiers ( const Aws::Vector< Aws::String > &  value)
inline

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

Definition at line 1184 of file DBCluster.h.

◆ SetReplicationSourceIdentifier() [1/3]

void Aws::RDS::Model::DBCluster::SetReplicationSourceIdentifier ( Aws::String &&  value)
inline

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

Definition at line 1141 of file DBCluster.h.

◆ SetReplicationSourceIdentifier() [2/3]

void Aws::RDS::Model::DBCluster::SetReplicationSourceIdentifier ( const Aws::String value)
inline

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

Definition at line 1135 of file DBCluster.h.

◆ SetReplicationSourceIdentifier() [3/3]

void Aws::RDS::Model::DBCluster::SetReplicationSourceIdentifier ( const char *  value)
inline

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

Definition at line 1147 of file DBCluster.h.

◆ SetScalingConfigurationInfo() [1/2]

void Aws::RDS::Model::DBCluster::SetScalingConfigurationInfo ( const ScalingConfigurationInfo value)
inline

Definition at line 1986 of file DBCluster.h.

◆ SetScalingConfigurationInfo() [2/2]

void Aws::RDS::Model::DBCluster::SetScalingConfigurationInfo ( ScalingConfigurationInfo &&  value)
inline

Definition at line 1989 of file DBCluster.h.

◆ SetStatus() [1/3]

void Aws::RDS::Model::DBCluster::SetStatus ( Aws::String &&  value)
inline

Specifies the current state of this DB cluster.

Definition at line 434 of file DBCluster.h.

◆ SetStatus() [2/3]

void Aws::RDS::Model::DBCluster::SetStatus ( const Aws::String value)
inline

Specifies the current state of this DB cluster.

Definition at line 429 of file DBCluster.h.

◆ SetStatus() [3/3]

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

Specifies the current state of this DB cluster.

Definition at line 439 of file DBCluster.h.

◆ SetStorageEncrypted()

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

Specifies whether the DB cluster is encrypted.

Definition at line 1367 of file DBCluster.h.

◆ SetTagList() [1/2]

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

Definition at line 2369 of file DBCluster.h.

◆ SetTagList() [2/2]

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

Definition at line 2366 of file DBCluster.h.

◆ SetVpcSecurityGroups() [1/2]

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

Provides a list of VPC security groups that the DB cluster belongs to.

Definition at line 1282 of file DBCluster.h.

◆ SetVpcSecurityGroups() [2/2]

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

Provides a list of VPC security groups that the DB cluster belongs to.

Definition at line 1277 of file DBCluster.h.

◆ StatusHasBeenSet()

bool Aws::RDS::Model::DBCluster::StatusHasBeenSet ( ) const
inline

Specifies the current state of this DB cluster.

Definition at line 424 of file DBCluster.h.

◆ StorageEncryptedHasBeenSet()

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

Specifies whether the DB cluster is encrypted.

Definition at line 1362 of file DBCluster.h.

◆ TagListHasBeenSet()

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

Definition at line 2363 of file DBCluster.h.

◆ VpcSecurityGroupsHasBeenSet()

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

Provides a list of VPC security groups that the DB cluster belongs to.

Definition at line 1272 of file DBCluster.h.

◆ WithActivityStreamKinesisStreamName() [1/3]

DBCluster& Aws::RDS::Model::DBCluster::WithActivityStreamKinesisStreamName ( Aws::String &&  value)
inline

The name of the Amazon Kinesis data stream used for the database activity stream.

Definition at line 2251 of file DBCluster.h.

◆ WithActivityStreamKinesisStreamName() [2/3]

DBCluster& Aws::RDS::Model::DBCluster::WithActivityStreamKinesisStreamName ( const Aws::String value)
inline

The name of the Amazon Kinesis data stream used for the database activity stream.

Definition at line 2245 of file DBCluster.h.

◆ WithActivityStreamKinesisStreamName() [3/3]

DBCluster& Aws::RDS::Model::DBCluster::WithActivityStreamKinesisStreamName ( const char *  value)
inline

The name of the Amazon Kinesis data stream used for the database activity stream.

Definition at line 2257 of file DBCluster.h.

◆ WithActivityStreamKmsKeyId() [1/3]

DBCluster& Aws::RDS::Model::DBCluster::WithActivityStreamKmsKeyId ( Aws::String &&  value)
inline

The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.

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

Definition at line 2200 of file DBCluster.h.

◆ WithActivityStreamKmsKeyId() [2/3]

DBCluster& Aws::RDS::Model::DBCluster::WithActivityStreamKmsKeyId ( const Aws::String value)
inline

The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.

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

Definition at line 2192 of file DBCluster.h.

◆ WithActivityStreamKmsKeyId() [3/3]

DBCluster& Aws::RDS::Model::DBCluster::WithActivityStreamKmsKeyId ( const char *  value)
inline

The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.

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

Definition at line 2208 of file DBCluster.h.

◆ WithActivityStreamMode() [1/2]

DBCluster& Aws::RDS::Model::DBCluster::WithActivityStreamMode ( ActivityStreamMode &&  value)
inline

The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.

Definition at line 2112 of file DBCluster.h.

◆ WithActivityStreamMode() [2/2]

DBCluster& Aws::RDS::Model::DBCluster::WithActivityStreamMode ( const ActivityStreamMode value)
inline

The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.

Definition at line 2105 of file DBCluster.h.

◆ WithActivityStreamStatus() [1/2]

DBCluster& Aws::RDS::Model::DBCluster::WithActivityStreamStatus ( ActivityStreamStatus &&  value)
inline

The status of the database activity stream.

Definition at line 2143 of file DBCluster.h.

◆ WithActivityStreamStatus() [2/2]

DBCluster& Aws::RDS::Model::DBCluster::WithActivityStreamStatus ( const ActivityStreamStatus value)
inline

The status of the database activity stream.

Definition at line 2138 of file DBCluster.h.

◆ WithAllocatedStorage()

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

For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.

Definition at line 88 of file DBCluster.h.

◆ WithAssociatedRoles() [1/2]

DBCluster& Aws::RDS::Model::DBCluster::WithAssociatedRoles ( Aws::Vector< DBClusterRole > &&  value)
inline

Provides a list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.

Definition at line 1584 of file DBCluster.h.

◆ WithAssociatedRoles() [2/2]

DBCluster& Aws::RDS::Model::DBCluster::WithAssociatedRoles ( const Aws::Vector< DBClusterRole > &  value)
inline

Provides a list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.

Definition at line 1576 of file DBCluster.h.

◆ WithAutomaticRestartTime() [1/2]

DBCluster& Aws::RDS::Model::DBCluster::WithAutomaticRestartTime ( Aws::Utils::DateTime &&  value)
inline

The time when a stopped DB cluster is restarted automatically.

Definition at line 485 of file DBCluster.h.

◆ WithAutomaticRestartTime() [2/2]

DBCluster& Aws::RDS::Model::DBCluster::WithAutomaticRestartTime ( const Aws::Utils::DateTime value)
inline

The time when a stopped DB cluster is restarted automatically.

Definition at line 480 of file DBCluster.h.

◆ WithAvailabilityZones() [1/2]

DBCluster& Aws::RDS::Model::DBCluster::WithAvailabilityZones ( Aws::Vector< Aws::String > &&  value)
inline

Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.

Definition at line 125 of file DBCluster.h.

◆ WithAvailabilityZones() [2/2]

DBCluster& Aws::RDS::Model::DBCluster::WithAvailabilityZones ( const Aws::Vector< Aws::String > &  value)
inline

Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.

Definition at line 119 of file DBCluster.h.

◆ WithBacktrackConsumedChangeRecords()

DBCluster& Aws::RDS::Model::DBCluster::WithBacktrackConsumedChangeRecords ( long long  value)
inline

The number of change records stored for Backtrack.

Definition at line 1784 of file DBCluster.h.

◆ WithBacktrackWindow()

DBCluster& Aws::RDS::Model::DBCluster::WithBacktrackWindow ( long long  value)
inline

The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.

Definition at line 1763 of file DBCluster.h.

◆ WithBackupRetentionPeriod()

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

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

Definition at line 168 of file DBCluster.h.

◆ WithCapacity()

DBCluster& Aws::RDS::Model::DBCluster::WithCapacity ( int  value)
inline

The current capacity of an Aurora Serverless DB cluster. The capacity is 0 (zero) when the cluster is paused.

For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

Definition at line 1903 of file DBCluster.h.

◆ WithCharacterSetName() [1/3]

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

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

Definition at line 211 of file DBCluster.h.

◆ WithCharacterSetName() [2/3]

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

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

Definition at line 205 of file DBCluster.h.

◆ WithCharacterSetName() [3/3]

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

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

Definition at line 217 of file DBCluster.h.

◆ WithCloneGroupId() [1/3]

DBCluster& Aws::RDS::Model::DBCluster::WithCloneGroupId ( Aws::String &&  value)
inline

Identifies the clone group to which the DB cluster is associated.

Definition at line 1661 of file DBCluster.h.

◆ WithCloneGroupId() [2/3]

DBCluster& Aws::RDS::Model::DBCluster::WithCloneGroupId ( const Aws::String value)
inline

Identifies the clone group to which the DB cluster is associated.

Definition at line 1656 of file DBCluster.h.

◆ WithCloneGroupId() [3/3]

DBCluster& Aws::RDS::Model::DBCluster::WithCloneGroupId ( const char *  value)
inline

Identifies the clone group to which the DB cluster is associated.

Definition at line 1666 of file DBCluster.h.

◆ WithClusterCreateTime() [1/2]

DBCluster& Aws::RDS::Model::DBCluster::WithClusterCreateTime ( Aws::Utils::DateTime &&  value)
inline

Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

Definition at line 1703 of file DBCluster.h.

◆ WithClusterCreateTime() [2/2]

DBCluster& Aws::RDS::Model::DBCluster::WithClusterCreateTime ( const Aws::Utils::DateTime value)
inline

Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

Definition at line 1697 of file DBCluster.h.

◆ WithCopyTagsToSnapshot()

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

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

Definition at line 2282 of file DBCluster.h.

◆ WithCrossAccountClone()

DBCluster& Aws::RDS::Model::DBCluster::WithCrossAccountClone ( bool  value)
inline

Specifies whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.

Definition at line 2307 of file DBCluster.h.

◆ WithCustomEndpoints() [1/2]

DBCluster& Aws::RDS::Model::DBCluster::WithCustomEndpoints ( Aws::Vector< Aws::String > &&  value)
inline

Identifies all custom endpoints associated with the cluster.

Definition at line 748 of file DBCluster.h.

◆ WithCustomEndpoints() [2/2]

DBCluster& Aws::RDS::Model::DBCluster::WithCustomEndpoints ( const Aws::Vector< Aws::String > &  value)
inline

Identifies all custom endpoints associated with the cluster.

Definition at line 743 of file DBCluster.h.

◆ WithDatabaseName() [1/3]

DBCluster& Aws::RDS::Model::DBCluster::WithDatabaseName ( Aws::String &&  value)
inline

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

Definition at line 267 of file DBCluster.h.

◆ WithDatabaseName() [2/3]

DBCluster& Aws::RDS::Model::DBCluster::WithDatabaseName ( const Aws::String value)
inline

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

Definition at line 260 of file DBCluster.h.

◆ WithDatabaseName() [3/3]

DBCluster& Aws::RDS::Model::DBCluster::WithDatabaseName ( const char *  value)
inline

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

Definition at line 274 of file DBCluster.h.

◆ WithDBClusterArn() [1/3]

DBCluster& Aws::RDS::Model::DBCluster::WithDBClusterArn ( Aws::String &&  value)
inline

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

Definition at line 1530 of file DBCluster.h.

◆ WithDBClusterArn() [2/3]

DBCluster& Aws::RDS::Model::DBCluster::WithDBClusterArn ( const Aws::String value)
inline

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

Definition at line 1525 of file DBCluster.h.

◆ WithDBClusterArn() [3/3]

DBCluster& Aws::RDS::Model::DBCluster::WithDBClusterArn ( const char *  value)
inline

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

Definition at line 1535 of file DBCluster.h.

◆ WithDBClusterIdentifier() [1/3]

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

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

Definition at line 317 of file DBCluster.h.

◆ WithDBClusterIdentifier() [2/3]

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

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

Definition at line 311 of file DBCluster.h.

◆ WithDBClusterIdentifier() [3/3]

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

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

Definition at line 323 of file DBCluster.h.

◆ WithDBClusterMembers() [1/2]

DBCluster& Aws::RDS::Model::DBCluster::WithDBClusterMembers ( Aws::Vector< DBClusterMember > &&  value)
inline

Provides the list of instances that make up the DB cluster.

Definition at line 1251 of file DBCluster.h.

◆ WithDBClusterMembers() [2/2]

DBCluster& Aws::RDS::Model::DBCluster::WithDBClusterMembers ( const Aws::Vector< DBClusterMember > &  value)
inline

Provides the list of instances that make up the DB cluster.

Definition at line 1246 of file DBCluster.h.

◆ WithDBClusterOptionGroupMemberships() [1/2]

DBCluster& Aws::RDS::Model::DBCluster::WithDBClusterOptionGroupMemberships ( Aws::Vector< DBClusterOptionGroupStatus > &&  value)
inline

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

Definition at line 1000 of file DBCluster.h.

◆ WithDBClusterOptionGroupMemberships() [2/2]

DBCluster& Aws::RDS::Model::DBCluster::WithDBClusterOptionGroupMemberships ( const Aws::Vector< DBClusterOptionGroupStatus > &  value)
inline

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

Definition at line 995 of file DBCluster.h.

◆ WithDBClusterParameterGroup() [1/3]

DBCluster& Aws::RDS::Model::DBCluster::WithDBClusterParameterGroup ( Aws::String &&  value)
inline

Specifies the name of the DB cluster parameter group for the DB cluster.

Definition at line 359 of file DBCluster.h.

◆ WithDBClusterParameterGroup() [2/3]

DBCluster& Aws::RDS::Model::DBCluster::WithDBClusterParameterGroup ( const Aws::String value)
inline

Specifies the name of the DB cluster parameter group for the DB cluster.

Definition at line 354 of file DBCluster.h.

◆ WithDBClusterParameterGroup() [3/3]

DBCluster& Aws::RDS::Model::DBCluster::WithDBClusterParameterGroup ( const char *  value)
inline

Specifies the name of the DB cluster parameter group for the DB cluster.

Definition at line 364 of file DBCluster.h.

◆ WithDbClusterResourceId() [1/3]

DBCluster& Aws::RDS::Model::DBCluster::WithDbClusterResourceId ( Aws::String &&  value)
inline

The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS CMK for the DB cluster is accessed.

Definition at line 1487 of file DBCluster.h.

◆ WithDbClusterResourceId() [2/3]

DBCluster& Aws::RDS::Model::DBCluster::WithDbClusterResourceId ( const Aws::String value)
inline

The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS CMK for the DB cluster is accessed.

Definition at line 1480 of file DBCluster.h.

◆ WithDbClusterResourceId() [3/3]

DBCluster& Aws::RDS::Model::DBCluster::WithDbClusterResourceId ( const char *  value)
inline

The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS CMK for the DB cluster is accessed.

Definition at line 1494 of file DBCluster.h.

◆ WithDBSubnetGroup() [1/3]

DBCluster& Aws::RDS::Model::DBCluster::WithDBSubnetGroup ( Aws::String &&  value)
inline

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

Definition at line 407 of file DBCluster.h.

◆ WithDBSubnetGroup() [2/3]

DBCluster& Aws::RDS::Model::DBCluster::WithDBSubnetGroup ( const Aws::String value)
inline

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

Definition at line 401 of file DBCluster.h.

◆ WithDBSubnetGroup() [3/3]

DBCluster& Aws::RDS::Model::DBCluster::WithDBSubnetGroup ( const char *  value)
inline

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

Definition at line 413 of file DBCluster.h.

◆ WithDeletionProtection()

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

Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

Definition at line 2020 of file DBCluster.h.

◆ WithDomainMemberships() [1/2]

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

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

Definition at line 2344 of file DBCluster.h.

◆ WithDomainMemberships() [2/2]

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

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

Definition at line 2338 of file DBCluster.h.

◆ WithEarliestBacktrackTime() [1/2]

DBCluster& Aws::RDS::Model::DBCluster::WithEarliestBacktrackTime ( Aws::Utils::DateTime &&  value)
inline

The earliest time to which a DB cluster can be backtracked.

Definition at line 1734 of file DBCluster.h.

◆ WithEarliestBacktrackTime() [2/2]

DBCluster& Aws::RDS::Model::DBCluster::WithEarliestBacktrackTime ( const Aws::Utils::DateTime value)
inline

The earliest time to which a DB cluster can be backtracked.

Definition at line 1729 of file DBCluster.h.

◆ WithEarliestRestorableTime() [1/2]

DBCluster& Aws::RDS::Model::DBCluster::WithEarliestRestorableTime ( Aws::Utils::DateTime &&  value)
inline

The earliest time to which a database can be restored with point-in-time restore.

Definition at line 563 of file DBCluster.h.

◆ WithEarliestRestorableTime() [2/2]

DBCluster& Aws::RDS::Model::DBCluster::WithEarliestRestorableTime ( const Aws::Utils::DateTime value)
inline

The earliest time to which a database can be restored with point-in-time restore.

Definition at line 557 of file DBCluster.h.

◆ WithEnabledCloudwatchLogsExports() [1/2]

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

A list of log types that this DB cluster 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 Aurora User Guide.

Definition at line 1839 of file DBCluster.h.

◆ WithEnabledCloudwatchLogsExports() [2/2]

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

A list of log types that this DB cluster 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 Aurora User Guide.

Definition at line 1830 of file DBCluster.h.

◆ WithEndpoint() [1/3]

DBCluster& Aws::RDS::Model::DBCluster::WithEndpoint ( Aws::String &&  value)
inline

Specifies the connection endpoint for the primary instance of the DB cluster.

Definition at line 606 of file DBCluster.h.

◆ WithEndpoint() [2/3]

DBCluster& Aws::RDS::Model::DBCluster::WithEndpoint ( const Aws::String value)
inline

Specifies the connection endpoint for the primary instance of the DB cluster.

Definition at line 600 of file DBCluster.h.

◆ WithEndpoint() [3/3]

DBCluster& Aws::RDS::Model::DBCluster::WithEndpoint ( const char *  value)
inline

Specifies the connection endpoint for the primary instance of the DB cluster.

Definition at line 612 of file DBCluster.h.

◆ WithEngine() [1/3]

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

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

Definition at line 824 of file DBCluster.h.

◆ WithEngine() [2/3]

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

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

Definition at line 819 of file DBCluster.h.

◆ WithEngine() [3/3]

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

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

Definition at line 829 of file DBCluster.h.

◆ WithEngineMode() [1/3]

DBCluster& Aws::RDS::Model::DBCluster::WithEngineMode ( Aws::String &&  value)
inline

The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.

For more information, see CreateDBCluster.

Definition at line 1967 of file DBCluster.h.

◆ WithEngineMode() [2/3]

DBCluster& Aws::RDS::Model::DBCluster::WithEngineMode ( const Aws::String value)
inline

The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.

For more information, see CreateDBCluster.

Definition at line 1958 of file DBCluster.h.

◆ WithEngineMode() [3/3]

DBCluster& Aws::RDS::Model::DBCluster::WithEngineMode ( const char *  value)
inline

The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.

For more information, see CreateDBCluster.

Definition at line 1976 of file DBCluster.h.

◆ WithEngineVersion() [1/3]

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

Indicates the database engine version.

Definition at line 865 of file DBCluster.h.

◆ WithEngineVersion() [2/3]

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

Indicates the database engine version.

Definition at line 860 of file DBCluster.h.

◆ WithEngineVersion() [3/3]

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

Indicates the database engine version.

Definition at line 870 of file DBCluster.h.

◆ WithGlobalWriteForwardingRequested()

DBCluster& Aws::RDS::Model::DBCluster::WithGlobalWriteForwardingRequested ( bool  value)
inline

Specifies whether you have requested to enable write forwarding for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.

Definition at line 2455 of file DBCluster.h.

◆ WithGlobalWriteForwardingStatus() [1/2]

DBCluster& Aws::RDS::Model::DBCluster::WithGlobalWriteForwardingStatus ( const WriteForwardingStatus value)
inline

Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.

Definition at line 2412 of file DBCluster.h.

◆ WithGlobalWriteForwardingStatus() [2/2]

DBCluster& Aws::RDS::Model::DBCluster::WithGlobalWriteForwardingStatus ( WriteForwardingStatus &&  value)
inline

Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.

Definition at line 2418 of file DBCluster.h.

◆ WithHostedZoneId() [1/3]

DBCluster& Aws::RDS::Model::DBCluster::WithHostedZoneId ( Aws::String &&  value)
inline

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

Definition at line 1345 of file DBCluster.h.

◆ WithHostedZoneId() [2/3]

DBCluster& Aws::RDS::Model::DBCluster::WithHostedZoneId ( const Aws::String value)
inline

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

Definition at line 1339 of file DBCluster.h.

◆ WithHostedZoneId() [3/3]

DBCluster& Aws::RDS::Model::DBCluster::WithHostedZoneId ( const char *  value)
inline

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

Definition at line 1351 of file DBCluster.h.

◆ WithHttpEndpointEnabled()

DBCluster& Aws::RDS::Model::DBCluster::WithHttpEndpointEnabled ( bool  value)
inline

A value that indicates whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.

When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.

For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.

Definition at line 2069 of file DBCluster.h.

◆ WithIAMDatabaseAuthenticationEnabled()

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

A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

Definition at line 1625 of file DBCluster.h.

◆ WithKmsKeyId() [1/3]

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

If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.

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

Definition at line 1429 of file DBCluster.h.

◆ WithKmsKeyId() [2/3]

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

If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.

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

Definition at line 1421 of file DBCluster.h.

◆ WithKmsKeyId() [3/3]

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

If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.

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

Definition at line 1437 of file DBCluster.h.

◆ WithLatestRestorableTime() [1/2]

DBCluster& Aws::RDS::Model::DBCluster::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 907 of file DBCluster.h.

◆ WithLatestRestorableTime() [2/2]

DBCluster& Aws::RDS::Model::DBCluster::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 901 of file DBCluster.h.

◆ WithMasterUsername() [1/3]

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

Contains the master username for the DB cluster.

Definition at line 964 of file DBCluster.h.

◆ WithMasterUsername() [2/3]

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

Contains the master username for the DB cluster.

Definition at line 959 of file DBCluster.h.

◆ WithMasterUsername() [3/3]

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

Contains the master username for the DB cluster.

Definition at line 969 of file DBCluster.h.

◆ WithMultiAZ()

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

Specifies whether the DB cluster has instances in multiple Availability Zones.

Definition at line 788 of file DBCluster.h.

◆ WithPendingModifiedValues() [1/2]

DBCluster& Aws::RDS::Model::DBCluster::WithPendingModifiedValues ( ClusterPendingModifiedValues &&  value)
inline

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

Definition at line 2498 of file DBCluster.h.

◆ WithPendingModifiedValues() [2/2]

DBCluster& Aws::RDS::Model::DBCluster::WithPendingModifiedValues ( const ClusterPendingModifiedValues value)
inline

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

Definition at line 2491 of file DBCluster.h.

◆ WithPercentProgress() [1/3]

DBCluster& Aws::RDS::Model::DBCluster::WithPercentProgress ( Aws::String &&  value)
inline

Specifies the progress of the operation as a percentage.

Definition at line 521 of file DBCluster.h.

◆ WithPercentProgress() [2/3]

DBCluster& Aws::RDS::Model::DBCluster::WithPercentProgress ( const Aws::String value)
inline

Specifies the progress of the operation as a percentage.

Definition at line 516 of file DBCluster.h.

◆ WithPercentProgress() [3/3]

DBCluster& Aws::RDS::Model::DBCluster::WithPercentProgress ( const char *  value)
inline

Specifies the progress of the operation as a percentage.

Definition at line 526 of file DBCluster.h.

◆ WithPort()

DBCluster& Aws::RDS::Model::DBCluster::WithPort ( int  value)
inline

Specifies the port that the database engine is listening on.

Definition at line 928 of file DBCluster.h.

◆ WithPreferredBackupWindow() [1/3]

DBCluster& Aws::RDS::Model::DBCluster::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 1060 of file DBCluster.h.

◆ WithPreferredBackupWindow() [2/3]

DBCluster& Aws::RDS::Model::DBCluster::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 1053 of file DBCluster.h.

◆ WithPreferredBackupWindow() [3/3]

DBCluster& Aws::RDS::Model::DBCluster::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 1067 of file DBCluster.h.

◆ WithPreferredMaintenanceWindow() [1/3]

DBCluster& Aws::RDS::Model::DBCluster::WithPreferredMaintenanceWindow ( Aws::String &&  value)
inline

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

Definition at line 1110 of file DBCluster.h.

◆ WithPreferredMaintenanceWindow() [2/3]

DBCluster& Aws::RDS::Model::DBCluster::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 1104 of file DBCluster.h.

◆ WithPreferredMaintenanceWindow() [3/3]

DBCluster& Aws::RDS::Model::DBCluster::WithPreferredMaintenanceWindow ( const char *  value)
inline

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

Definition at line 1116 of file DBCluster.h.

◆ WithReaderEndpoint() [1/3]

DBCluster& Aws::RDS::Model::DBCluster::WithReaderEndpoint ( Aws::String &&  value)
inline

The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.

If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.

Definition at line 704 of file DBCluster.h.

◆ WithReaderEndpoint() [2/3]

DBCluster& Aws::RDS::Model::DBCluster::WithReaderEndpoint ( const Aws::String value)
inline

The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.

If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.

Definition at line 691 of file DBCluster.h.

◆ WithReaderEndpoint() [3/3]

DBCluster& Aws::RDS::Model::DBCluster::WithReaderEndpoint ( const char *  value)
inline

The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.

If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.

Definition at line 717 of file DBCluster.h.

◆ WithReadReplicaIdentifiers() [1/2]

DBCluster& Aws::RDS::Model::DBCluster::WithReadReplicaIdentifiers ( Aws::Vector< Aws::String > &&  value)
inline

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

Definition at line 1202 of file DBCluster.h.

◆ WithReadReplicaIdentifiers() [2/2]

DBCluster& Aws::RDS::Model::DBCluster::WithReadReplicaIdentifiers ( const Aws::Vector< Aws::String > &  value)
inline

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

Definition at line 1196 of file DBCluster.h.

◆ WithReplicationSourceIdentifier() [1/3]

DBCluster& Aws::RDS::Model::DBCluster::WithReplicationSourceIdentifier ( Aws::String &&  value)
inline

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

Definition at line 1159 of file DBCluster.h.

◆ WithReplicationSourceIdentifier() [2/3]

DBCluster& Aws::RDS::Model::DBCluster::WithReplicationSourceIdentifier ( const Aws::String value)
inline

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

Definition at line 1153 of file DBCluster.h.

◆ WithReplicationSourceIdentifier() [3/3]

DBCluster& Aws::RDS::Model::DBCluster::WithReplicationSourceIdentifier ( const char *  value)
inline

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

Definition at line 1165 of file DBCluster.h.

◆ WithScalingConfigurationInfo() [1/2]

DBCluster& Aws::RDS::Model::DBCluster::WithScalingConfigurationInfo ( const ScalingConfigurationInfo value)
inline

Definition at line 1992 of file DBCluster.h.

◆ WithScalingConfigurationInfo() [2/2]

DBCluster& Aws::RDS::Model::DBCluster::WithScalingConfigurationInfo ( ScalingConfigurationInfo &&  value)
inline

Definition at line 1995 of file DBCluster.h.

◆ WithStatus() [1/3]

DBCluster& Aws::RDS::Model::DBCluster::WithStatus ( Aws::String &&  value)
inline

Specifies the current state of this DB cluster.

Definition at line 449 of file DBCluster.h.

◆ WithStatus() [2/3]

DBCluster& Aws::RDS::Model::DBCluster::WithStatus ( const Aws::String value)
inline

Specifies the current state of this DB cluster.

Definition at line 444 of file DBCluster.h.

◆ WithStatus() [3/3]

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

Specifies the current state of this DB cluster.

Definition at line 454 of file DBCluster.h.

◆ WithStorageEncrypted()

DBCluster& Aws::RDS::Model::DBCluster::WithStorageEncrypted ( bool  value)
inline

Specifies whether the DB cluster is encrypted.

Definition at line 1372 of file DBCluster.h.

◆ WithTagList() [1/2]

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

Definition at line 2375 of file DBCluster.h.

◆ WithTagList() [2/2]

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

Definition at line 2372 of file DBCluster.h.

◆ WithVpcSecurityGroups() [1/2]

DBCluster& Aws::RDS::Model::DBCluster::WithVpcSecurityGroups ( Aws::Vector< VpcSecurityGroupMembership > &&  value)
inline

Provides a list of VPC security groups that the DB cluster belongs to.

Definition at line 1292 of file DBCluster.h.

◆ WithVpcSecurityGroups() [2/2]

DBCluster& Aws::RDS::Model::DBCluster::WithVpcSecurityGroups ( const Aws::Vector< VpcSecurityGroupMembership > &  value)
inline

Provides a list of VPC security groups that the DB cluster belongs to.

Definition at line 1287 of file DBCluster.h.


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