#include <ModifyDBClusterRequest.h>

Inheritance diagram for Aws::RDS::Model::ModifyDBClusterRequest:

Public Member Functions
	ModifyDBClusterRequest ()

virtual const char *	GetServiceRequestName () const override

Aws::String	SerializePayload () const override

const Aws::String &	GetDBClusterIdentifier () const

bool	DBClusterIdentifierHasBeenSet () const

void	SetDBClusterIdentifier (const Aws::String &value)

void	SetDBClusterIdentifier (Aws::String &&value)

void	SetDBClusterIdentifier (const char *value)

ModifyDBClusterRequest &	WithDBClusterIdentifier (const Aws::String &value)

ModifyDBClusterRequest &	WithDBClusterIdentifier (Aws::String &&value)

ModifyDBClusterRequest &	WithDBClusterIdentifier (const char *value)

const Aws::String &	GetNewDBClusterIdentifier () const

bool	NewDBClusterIdentifierHasBeenSet () const

void	SetNewDBClusterIdentifier (const Aws::String &value)

void	SetNewDBClusterIdentifier (Aws::String &&value)

void	SetNewDBClusterIdentifier (const char *value)

ModifyDBClusterRequest &	WithNewDBClusterIdentifier (const Aws::String &value)

ModifyDBClusterRequest &	WithNewDBClusterIdentifier (Aws::String &&value)

ModifyDBClusterRequest &	WithNewDBClusterIdentifier (const char *value)

bool	GetApplyImmediately () const

bool	ApplyImmediatelyHasBeenSet () const

void	SetApplyImmediately (bool value)

ModifyDBClusterRequest &	WithApplyImmediately (bool value)

int	GetBackupRetentionPeriod () const

bool	BackupRetentionPeriodHasBeenSet () const

void	SetBackupRetentionPeriod (int value)

ModifyDBClusterRequest &	WithBackupRetentionPeriod (int value)

const Aws::String &	GetDBClusterParameterGroupName () const

bool	DBClusterParameterGroupNameHasBeenSet () const

void	SetDBClusterParameterGroupName (const Aws::String &value)

void	SetDBClusterParameterGroupName (Aws::String &&value)

void	SetDBClusterParameterGroupName (const char *value)

ModifyDBClusterRequest &	WithDBClusterParameterGroupName (const Aws::String &value)

ModifyDBClusterRequest &	WithDBClusterParameterGroupName (Aws::String &&value)

ModifyDBClusterRequest &	WithDBClusterParameterGroupName (const char *value)

const Aws::Vector< Aws::String > &	GetVpcSecurityGroupIds () const

bool	VpcSecurityGroupIdsHasBeenSet () const

void	SetVpcSecurityGroupIds (const Aws::Vector< Aws::String > &value)

void	SetVpcSecurityGroupIds (Aws::Vector< Aws::String > &&value)

ModifyDBClusterRequest &	WithVpcSecurityGroupIds (const Aws::Vector< Aws::String > &value)

ModifyDBClusterRequest &	WithVpcSecurityGroupIds (Aws::Vector< Aws::String > &&value)

ModifyDBClusterRequest &	AddVpcSecurityGroupIds (const Aws::String &value)

ModifyDBClusterRequest &	AddVpcSecurityGroupIds (Aws::String &&value)

ModifyDBClusterRequest &	AddVpcSecurityGroupIds (const char *value)

int	GetPort () const

bool	PortHasBeenSet () const

void	SetPort (int value)

ModifyDBClusterRequest &	WithPort (int value)

const Aws::String &	GetMasterUserPassword () const

bool	MasterUserPasswordHasBeenSet () const

void	SetMasterUserPassword (const Aws::String &value)

void	SetMasterUserPassword (Aws::String &&value)

void	SetMasterUserPassword (const char *value)

ModifyDBClusterRequest &	WithMasterUserPassword (const Aws::String &value)

ModifyDBClusterRequest &	WithMasterUserPassword (Aws::String &&value)

ModifyDBClusterRequest &	WithMasterUserPassword (const char *value)

const Aws::String &	GetOptionGroupName () const

bool	OptionGroupNameHasBeenSet () const

void	SetOptionGroupName (const Aws::String &value)

void	SetOptionGroupName (Aws::String &&value)

void	SetOptionGroupName (const char *value)

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

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

ModifyDBClusterRequest &	WithOptionGroupName (const char *value)

const Aws::String &	GetPreferredBackupWindow () const

bool	PreferredBackupWindowHasBeenSet () const

void	SetPreferredBackupWindow (const Aws::String &value)

void	SetPreferredBackupWindow (Aws::String &&value)

void	SetPreferredBackupWindow (const char *value)

ModifyDBClusterRequest &	WithPreferredBackupWindow (const Aws::String &value)

ModifyDBClusterRequest &	WithPreferredBackupWindow (Aws::String &&value)

ModifyDBClusterRequest &	WithPreferredBackupWindow (const char *value)

const Aws::String &	GetPreferredMaintenanceWindow () const

bool	PreferredMaintenanceWindowHasBeenSet () const

void	SetPreferredMaintenanceWindow (const Aws::String &value)

void	SetPreferredMaintenanceWindow (Aws::String &&value)

void	SetPreferredMaintenanceWindow (const char *value)

ModifyDBClusterRequest &	WithPreferredMaintenanceWindow (const Aws::String &value)

ModifyDBClusterRequest &	WithPreferredMaintenanceWindow (Aws::String &&value)

ModifyDBClusterRequest &	WithPreferredMaintenanceWindow (const char *value)

bool	GetEnableIAMDatabaseAuthentication () const

bool	EnableIAMDatabaseAuthenticationHasBeenSet () const

void	SetEnableIAMDatabaseAuthentication (bool value)

ModifyDBClusterRequest &	WithEnableIAMDatabaseAuthentication (bool value)

long long	GetBacktrackWindow () const

bool	BacktrackWindowHasBeenSet () const

void	SetBacktrackWindow (long long value)

ModifyDBClusterRequest &	WithBacktrackWindow (long long value)

const CloudwatchLogsExportConfiguration &	GetCloudwatchLogsExportConfiguration () const

bool	CloudwatchLogsExportConfigurationHasBeenSet () const

void	SetCloudwatchLogsExportConfiguration (const CloudwatchLogsExportConfiguration &value)

void	SetCloudwatchLogsExportConfiguration (CloudwatchLogsExportConfiguration &&value)

ModifyDBClusterRequest &	WithCloudwatchLogsExportConfiguration (const CloudwatchLogsExportConfiguration &value)

ModifyDBClusterRequest &	WithCloudwatchLogsExportConfiguration (CloudwatchLogsExportConfiguration &&value)

const Aws::String &	GetEngineVersion () const

bool	EngineVersionHasBeenSet () const

void	SetEngineVersion (const Aws::String &value)

void	SetEngineVersion (Aws::String &&value)

void	SetEngineVersion (const char *value)

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

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

ModifyDBClusterRequest &	WithEngineVersion (const char *value)

bool	GetAllowMajorVersionUpgrade () const

bool	AllowMajorVersionUpgradeHasBeenSet () const

void	SetAllowMajorVersionUpgrade (bool value)

ModifyDBClusterRequest &	WithAllowMajorVersionUpgrade (bool value)

const Aws::String &	GetDBInstanceParameterGroupName () const

bool	DBInstanceParameterGroupNameHasBeenSet () const

void	SetDBInstanceParameterGroupName (const Aws::String &value)

void	SetDBInstanceParameterGroupName (Aws::String &&value)

void	SetDBInstanceParameterGroupName (const char *value)

ModifyDBClusterRequest &	WithDBInstanceParameterGroupName (const Aws::String &value)

ModifyDBClusterRequest &	WithDBInstanceParameterGroupName (Aws::String &&value)

ModifyDBClusterRequest &	WithDBInstanceParameterGroupName (const char *value)

const Aws::String &	GetDomain () const

bool	DomainHasBeenSet () const

void	SetDomain (const Aws::String &value)

void	SetDomain (Aws::String &&value)

void	SetDomain (const char *value)

ModifyDBClusterRequest &	WithDomain (const Aws::String &value)

ModifyDBClusterRequest &	WithDomain (Aws::String &&value)

ModifyDBClusterRequest &	WithDomain (const char *value)

const Aws::String &	GetDomainIAMRoleName () const

bool	DomainIAMRoleNameHasBeenSet () const

void	SetDomainIAMRoleName (const Aws::String &value)

void	SetDomainIAMRoleName (Aws::String &&value)

void	SetDomainIAMRoleName (const char *value)

ModifyDBClusterRequest &	WithDomainIAMRoleName (const Aws::String &value)

ModifyDBClusterRequest &	WithDomainIAMRoleName (Aws::String &&value)

ModifyDBClusterRequest &	WithDomainIAMRoleName (const char *value)

const ScalingConfiguration &	GetScalingConfiguration () const

bool	ScalingConfigurationHasBeenSet () const

void	SetScalingConfiguration (const ScalingConfiguration &value)

void	SetScalingConfiguration (ScalingConfiguration &&value)

ModifyDBClusterRequest &	WithScalingConfiguration (const ScalingConfiguration &value)

ModifyDBClusterRequest &	WithScalingConfiguration (ScalingConfiguration &&value)

bool	GetDeletionProtection () const

bool	DeletionProtectionHasBeenSet () const

void	SetDeletionProtection (bool value)

ModifyDBClusterRequest &	WithDeletionProtection (bool value)

bool	GetEnableHttpEndpoint () const

bool	EnableHttpEndpointHasBeenSet () const

void	SetEnableHttpEndpoint (bool value)

ModifyDBClusterRequest &	WithEnableHttpEndpoint (bool value)

bool	GetCopyTagsToSnapshot () const

bool	CopyTagsToSnapshotHasBeenSet () const

void	SetCopyTagsToSnapshot (bool value)

ModifyDBClusterRequest &	WithCopyTagsToSnapshot (bool value)

bool	GetEnableGlobalWriteForwarding () const

bool	EnableGlobalWriteForwardingHasBeenSet () const

void	SetEnableGlobalWriteForwarding (bool value)

ModifyDBClusterRequest &	WithEnableGlobalWriteForwarding (bool value)

Public Member Functions inherited from Aws::RDS::RDSRequest
virtual	~RDSRequest ()

void	AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const

Aws::Http::HeaderValueCollection	GetHeaders () const override

Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
	AmazonSerializableWebServiceRequest ()

virtual	~AmazonSerializableWebServiceRequest ()

std::shared_ptr< Aws::IOStream >	GetBody () const override

Public Member Functions inherited from Aws::AmazonWebServiceRequest
	AmazonWebServiceRequest ()

virtual	~AmazonWebServiceRequest ()=default

virtual void	AddQueryStringParameters (Aws::Http::URI &uri) const

virtual void	PutToPresignedUrl (Aws::Http::URI &uri) const

virtual bool	IsStreaming () const

virtual bool	IsEventStreamRequest () const

virtual bool	SignBody () const

virtual bool	IsChunked () const

virtual void	SetRequestSignedHandler (const RequestSignedHandler &handler)

virtual const RequestSignedHandler &	GetRequestSignedHandler () const

const Aws::IOStreamFactory &	GetResponseStreamFactory () const

void	SetResponseStreamFactory (const Aws::IOStreamFactory &factory)

virtual void	SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)

virtual void	SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)

virtual void	SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)

virtual void	SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)

virtual void	SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)

virtual void	SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)

virtual void	SetRequestRetryHandler (const RequestRetryHandler &handler)

virtual void	SetRequestRetryHandler (RequestRetryHandler &&handler)

virtual const Aws::Http::DataReceivedEventHandler &	GetDataReceivedEventHandler () const

virtual const Aws::Http::DataSentEventHandler &	GetDataSentEventHandler () const

virtual const Aws::Http::ContinueRequestHandler &	GetContinueRequestHandler () const

virtual const RequestRetryHandler &	GetRequestRetryHandler () const

virtual bool	ShouldComputeContentMd5 () const

Protected Member Functions
void	DumpBodyToUrl (Aws::Http::URI &uri) const override

Protected Member Functions inherited from Aws::RDS::RDSRequest
virtual Aws::Http::HeaderValueCollection	GetRequestSpecificHeaders () const

Detailed Description

Constructor & Destructor Documentation

◆ ModifyDBClusterRequest()

Aws::RDS::Model::ModifyDBClusterRequest::ModifyDBClusterRequest ( )

Member Function Documentation

◆ AddVpcSecurityGroupIds() [1/3]

ModifyDBClusterRequest& Aws::RDS::Model::ModifyDBClusterRequest::AddVpcSecurityGroupIds ( Aws::String && value )

inline

A list of VPC security groups that the DB cluster will belong to.

Definition at line 360 of file ModifyDBClusterRequest.h.

◆ AddVpcSecurityGroupIds() [2/3]

ModifyDBClusterRequest& Aws::RDS::Model::ModifyDBClusterRequest::AddVpcSecurityGroupIds ( const Aws::String & value )

inline

A list of VPC security groups that the DB cluster will belong to.

Definition at line 355 of file ModifyDBClusterRequest.h.

◆ AddVpcSecurityGroupIds() [3/3]

ModifyDBClusterRequest& Aws::RDS::Model::ModifyDBClusterRequest::AddVpcSecurityGroupIds ( const char * value )

inline

A list of VPC security groups that the DB cluster will belong to.

Definition at line 365 of file ModifyDBClusterRequest.h.

◆ AllowMajorVersionUpgradeHasBeenSet()

bool Aws::RDS::Model::ModifyDBClusterRequest::AllowMajorVersionUpgradeHasBeenSet ( ) const

inline

A value that indicates whether major version upgrades are allowed.

Constraints: You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.

Definition at line 1055 of file ModifyDBClusterRequest.h.

◆ ApplyImmediatelyHasBeenSet()

bool Aws::RDS::Model::ModifyDBClusterRequest::ApplyImmediatelyHasBeenSet ( ) const

inline

A value that indicates whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB cluster. If this parameter is disabled, changes to the DB cluster are applied during the next maintenance window.

The ApplyImmediately parameter only affects the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values. If the ApplyImmediately parameter is disabled, then changes to the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.

By default, this parameter is disabled.

Definition at line 215 of file ModifyDBClusterRequest.h.

◆ BacktrackWindowHasBeenSet()

bool Aws::RDS::Model::ModifyDBClusterRequest::BacktrackWindowHasBeenSet ( ) const

inline

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

Currently, Backtrack is only supported for Aurora MySQL DB clusters.

Default: 0

Constraints:

If specified, this value must be set to a number from 0 to 259,200 (72 hours).

Definition at line 838 of file ModifyDBClusterRequest.h.

◆ BackupRetentionPeriodHasBeenSet()

bool Aws::RDS::Model::ModifyDBClusterRequest::BackupRetentionPeriodHasBeenSet ( ) const

inline

The number of days for which automated backups are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

Must be a value from 1 to 35

Definition at line 264 of file ModifyDBClusterRequest.h.

◆ CloudwatchLogsExportConfigurationHasBeenSet()

bool Aws::RDS::Model::ModifyDBClusterRequest::CloudwatchLogsExportConfigurationHasBeenSet ( ) const

inline

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.

Definition at line 869 of file ModifyDBClusterRequest.h.

◆ CopyTagsToSnapshotHasBeenSet()

bool Aws::RDS::Model::ModifyDBClusterRequest::CopyTagsToSnapshotHasBeenSet ( ) const

inline

A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.

Definition at line 1438 of file ModifyDBClusterRequest.h.

◆ DBClusterIdentifierHasBeenSet()

bool Aws::RDS::Model::ModifyDBClusterRequest::DBClusterIdentifierHasBeenSet ( ) const

inline

The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.

Constraints: This identifier must match the identifier of an existing DB cluster.

Definition at line 57 of file ModifyDBClusterRequest.h.

◆ DBClusterParameterGroupNameHasBeenSet()

bool Aws::RDS::Model::ModifyDBClusterRequest::DBClusterParameterGroupNameHasBeenSet ( ) const

inline

The name of the DB cluster parameter group to use for the DB cluster.

Definition at line 289 of file ModifyDBClusterRequest.h.

◆ DBInstanceParameterGroupNameHasBeenSet()

bool Aws::RDS::Model::ModifyDBClusterRequest::DBInstanceParameterGroupNameHasBeenSet ( ) const

inline

The name of the DB parameter group to apply to all instances of the DB cluster.

When you apply a parameter group using the DBInstanceParameterGroupName parameter, the DB cluster isn't rebooted automatically. Also, parameter changes aren't applied during the next maintenance window but instead are applied immediately.

Default: The existing name setting

Constraints:

The DB parameter group must be in the same DB parameter group family as this DB cluster.
The DBInstanceParameterGroupName parameter is only valid in combination with the AllowMajorVersionUpgrade parameter.

Definition at line 1100 of file ModifyDBClusterRequest.h.

◆ DeletionProtectionHasBeenSet()

bool Aws::RDS::Model::ModifyDBClusterRequest::DeletionProtectionHasBeenSet ( ) const

inline

A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

Definition at line 1358 of file ModifyDBClusterRequest.h.

◆ DomainHasBeenSet()

bool Aws::RDS::Model::ModifyDBClusterRequest::DomainHasBeenSet ( ) const

inline

The Active Directory directory ID to move the DB cluster to. Specify none to remove the cluster from its current domain. The domain must be created prior to this operation.

For more information, see Kerberos Authentication in the Amazon Aurora User Guide.

Definition at line 1203 of file ModifyDBClusterRequest.h.

◆ DomainIAMRoleNameHasBeenSet()

bool Aws::RDS::Model::ModifyDBClusterRequest::DomainIAMRoleNameHasBeenSet ( ) const

inline

Specify the name of the IAM role to be used when making API calls to the Directory Service.

Definition at line 1270 of file ModifyDBClusterRequest.h.

◆ DumpBodyToUrl()

void Aws::RDS::Model::ModifyDBClusterRequest::DumpBodyToUrl ( Aws::Http::URI & uri ) const

overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ EnableGlobalWriteForwardingHasBeenSet()

bool Aws::RDS::Model::ModifyDBClusterRequest::EnableGlobalWriteForwardingHasBeenSet ( ) const

inline

A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an Aurora global database (GlobalCluster). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.

You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by the FailoverGlobalCluster API operation, but it does nothing until then.

Definition at line 1479 of file ModifyDBClusterRequest.h.

◆ EnableHttpEndpointHasBeenSet()

bool Aws::RDS::Model::ModifyDBClusterRequest::EnableHttpEndpointHasBeenSet ( ) const

inline

A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.

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 1399 of file ModifyDBClusterRequest.h.

◆ EnableIAMDatabaseAuthenticationHasBeenSet()

bool Aws::RDS::Model::ModifyDBClusterRequest::EnableIAMDatabaseAuthenticationHasBeenSet ( ) const

inline

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

For more information, see IAM Database Authentication in the Amazon Aurora User Guide.

Definition at line 801 of file ModifyDBClusterRequest.h.

◆ EngineVersionHasBeenSet()

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

inline

The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless ApplyImmediately is enabled.

To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

aws rds describe-db-engine-versions –engine aurora –query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:

aws rds describe-db-engine-versions –engine aurora-mysql –query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for aurora-postgresql, use the following command:

aws rds describe-db-engine-versions –engine aurora-postgresql –query "DBEngineVersions[].EngineVersion"

Definition at line 930 of file ModifyDBClusterRequest.h.

◆ GetAllowMajorVersionUpgrade()

bool Aws::RDS::Model::ModifyDBClusterRequest::GetAllowMajorVersionUpgrade ( ) const

inline

A value that indicates whether major version upgrades are allowed.

Constraints: You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.

Definition at line 1047 of file ModifyDBClusterRequest.h.

◆ GetApplyImmediately()

bool Aws::RDS::Model::ModifyDBClusterRequest::GetApplyImmediately ( ) const

inline

A value that indicates whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB cluster. If this parameter is disabled, changes to the DB cluster are applied during the next maintenance window.

The ApplyImmediately parameter only affects the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values. If the ApplyImmediately parameter is disabled, then changes to the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.

By default, this parameter is disabled.

Definition at line 198 of file ModifyDBClusterRequest.h.

◆ GetBacktrackWindow()

long long Aws::RDS::Model::ModifyDBClusterRequest::GetBacktrackWindow ( ) const

inline

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

Currently, Backtrack is only supported for Aurora MySQL DB clusters.

Default: 0

Constraints:

If specified, this value must be set to a number from 0 to 259,200 (72 hours).

Definition at line 829 of file ModifyDBClusterRequest.h.

◆ GetBackupRetentionPeriod()

int Aws::RDS::Model::ModifyDBClusterRequest::GetBackupRetentionPeriod ( ) const

inline

The number of days for which automated backups are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

Must be a value from 1 to 35

Definition at line 257 of file ModifyDBClusterRequest.h.

◆ GetCloudwatchLogsExportConfiguration()

const CloudwatchLogsExportConfiguration& Aws::RDS::Model::ModifyDBClusterRequest::GetCloudwatchLogsExportConfiguration ( ) const

inline

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.

Definition at line 863 of file ModifyDBClusterRequest.h.

◆ GetCopyTagsToSnapshot()

bool Aws::RDS::Model::ModifyDBClusterRequest::GetCopyTagsToSnapshot ( ) const

inline

A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.

Definition at line 1432 of file ModifyDBClusterRequest.h.

◆ GetDBClusterIdentifier()

const Aws::String& Aws::RDS::Model::ModifyDBClusterRequest::GetDBClusterIdentifier ( ) const

inline

The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.

Constraints: This identifier must match the identifier of an existing DB cluster.

Definition at line 50 of file ModifyDBClusterRequest.h.

◆ GetDBClusterParameterGroupName()

const Aws::String& Aws::RDS::Model::ModifyDBClusterRequest::GetDBClusterParameterGroupName ( ) const

inline

The name of the DB cluster parameter group to use for the DB cluster.

Definition at line 284 of file ModifyDBClusterRequest.h.

◆ GetDBInstanceParameterGroupName()

const Aws::String& Aws::RDS::Model::ModifyDBClusterRequest::GetDBInstanceParameterGroupName ( ) const

inline

The name of the DB parameter group to apply to all instances of the DB cluster.

When you apply a parameter group using the DBInstanceParameterGroupName parameter, the DB cluster isn't rebooted automatically. Also, parameter changes aren't applied during the next maintenance window but instead are applied immediately.

Default: The existing name setting

Constraints:

The DB parameter group must be in the same DB parameter group family as this DB cluster.
The DBInstanceParameterGroupName parameter is only valid in combination with the AllowMajorVersionUpgrade parameter.

Definition at line 1086 of file ModifyDBClusterRequest.h.

◆ GetDeletionProtection()

bool Aws::RDS::Model::ModifyDBClusterRequest::GetDeletionProtection ( ) const

inline

A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

Definition at line 1351 of file ModifyDBClusterRequest.h.

◆ GetDomain()

const Aws::String& Aws::RDS::Model::ModifyDBClusterRequest::GetDomain ( ) const

inline

The Active Directory directory ID to move the DB cluster to. Specify none to remove the cluster from its current domain. The domain must be created prior to this operation.

For more information, see Kerberos Authentication in the Amazon Aurora User Guide.

Definition at line 1194 of file ModifyDBClusterRequest.h.

◆ GetDomainIAMRoleName()

const Aws::String& Aws::RDS::Model::ModifyDBClusterRequest::GetDomainIAMRoleName ( ) const

inline

Specify the name of the IAM role to be used when making API calls to the Directory Service.

Definition at line 1264 of file ModifyDBClusterRequest.h.

◆ GetEnableGlobalWriteForwarding()

bool Aws::RDS::Model::ModifyDBClusterRequest::GetEnableGlobalWriteForwarding ( ) const

inline

A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an Aurora global database (GlobalCluster). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.

You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by the FailoverGlobalCluster API operation, but it does nothing until then.

Definition at line 1465 of file ModifyDBClusterRequest.h.

◆ GetEnableHttpEndpoint()

bool Aws::RDS::Model::ModifyDBClusterRequest::GetEnableHttpEndpoint ( ) const

inline

A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.

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 1386 of file ModifyDBClusterRequest.h.

◆ GetEnableIAMDatabaseAuthentication()

bool Aws::RDS::Model::ModifyDBClusterRequest::GetEnableIAMDatabaseAuthentication ( ) const

inline

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

For more information, see IAM Database Authentication in the Amazon Aurora User Guide.

Definition at line 792 of file ModifyDBClusterRequest.h.

◆ GetEngineVersion()

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

inline

The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless ApplyImmediately is enabled.

To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

aws rds describe-db-engine-versions –engine aurora –query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:

aws rds describe-db-engine-versions –engine aurora-mysql –query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for aurora-postgresql, use the following command:

aws rds describe-db-engine-versions –engine aurora-postgresql –query "DBEngineVersions[].EngineVersion"

Definition at line 912 of file ModifyDBClusterRequest.h.

◆ GetMasterUserPassword()

const Aws::String& Aws::RDS::Model::ModifyDBClusterRequest::GetMasterUserPassword ( ) const

inline

The new password for the master database user. This password can contain any printable ASCII character except "/", """, or "".

Constraints: Must contain from 8 to 41 characters.

Definition at line 402 of file ModifyDBClusterRequest.h.

◆ GetNewDBClusterIdentifier()

const Aws::String& Aws::RDS::Model::ModifyDBClusterRequest::GetNewDBClusterIdentifier ( ) const

inline

The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.

Constraints:

Must contain from 1 to 63 letters, numbers, or hyphens
The first character must be a letter
Can't end with a hyphen or contain two consecutive hyphens

Example: my-cluster2

Definition at line 110 of file ModifyDBClusterRequest.h.

◆ GetOptionGroupName()

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

inline

A value that indicates that the DB cluster should be associated with the specified option group. Changing this parameter doesn't result in an outage except in the following case, and the change is applied during the next maintenance window unless the ApplyImmediately is enabled for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.

Definition at line 465 of file ModifyDBClusterRequest.h.

◆ GetPort()

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

inline

The port number on which the DB cluster accepts connections.

Constraints: Value must be 1150-65535

Default: The same port as the original DB cluster.

Definition at line 373 of file ModifyDBClusterRequest.h.

◆ GetPreferredBackupWindow()

const Aws::String& Aws::RDS::Model::ModifyDBClusterRequest::GetPreferredBackupWindow ( ) const

inline

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

Constraints:

Must be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.

Definition at line 572 of file ModifyDBClusterRequest.h.

◆ GetPreferredMaintenanceWindow()

const Aws::String& Aws::RDS::Model::ModifyDBClusterRequest::GetPreferredMaintenanceWindow ( ) const

inline

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

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

Definition at line 691 of file ModifyDBClusterRequest.h.

◆ GetScalingConfiguration()

const ScalingConfiguration& Aws::RDS::Model::ModifyDBClusterRequest::GetScalingConfiguration ( ) const

inline

The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.

Definition at line 1313 of file ModifyDBClusterRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::RDS::Model::ModifyDBClusterRequest::GetServiceRequestName ( ) const

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file ModifyDBClusterRequest.h.

◆ GetVpcSecurityGroupIds()

const Aws::Vector<Aws::String>& Aws::RDS::Model::ModifyDBClusterRequest::GetVpcSecurityGroupIds ( ) const

inline

A list of VPC security groups that the DB cluster will belong to.

Definition at line 325 of file ModifyDBClusterRequest.h.

◆ MasterUserPasswordHasBeenSet()

bool Aws::RDS::Model::ModifyDBClusterRequest::MasterUserPasswordHasBeenSet ( ) const

inline

The new password for the master database user. This password can contain any printable ASCII character except "/", """, or "".

Constraints: Must contain from 8 to 41 characters.

Definition at line 409 of file ModifyDBClusterRequest.h.

◆ NewDBClusterIdentifierHasBeenSet()

bool Aws::RDS::Model::ModifyDBClusterRequest::NewDBClusterIdentifierHasBeenSet ( ) const

inline

The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.

Constraints:

Must contain from 1 to 63 letters, numbers, or hyphens
The first character must be a letter
Can't end with a hyphen or contain two consecutive hyphens

Example: my-cluster2

Definition at line 120 of file ModifyDBClusterRequest.h.

◆ OptionGroupNameHasBeenSet()

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

inline

A value that indicates that the DB cluster should be associated with the specified option group. Changing this parameter doesn't result in an outage except in the following case, and the change is applied during the next maintenance window unless the ApplyImmediately is enabled for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.

Definition at line 478 of file ModifyDBClusterRequest.h.

◆ PortHasBeenSet()

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

inline

The port number on which the DB cluster accepts connections.

Constraints: Value must be 1150-65535

Default: The same port as the original DB cluster.

Definition at line 380 of file ModifyDBClusterRequest.h.

◆ PreferredBackupWindowHasBeenSet()

bool Aws::RDS::Model::ModifyDBClusterRequest::PreferredBackupWindowHasBeenSet ( ) const

inline

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

Constraints:

Must be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.

Definition at line 587 of file ModifyDBClusterRequest.h.

◆ PreferredMaintenanceWindowHasBeenSet()

bool Aws::RDS::Model::ModifyDBClusterRequest::PreferredMaintenanceWindowHasBeenSet ( ) const

inline

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

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

Definition at line 704 of file ModifyDBClusterRequest.h.

◆ ScalingConfigurationHasBeenSet()

bool Aws::RDS::Model::ModifyDBClusterRequest::ScalingConfigurationHasBeenSet ( ) const

inline

The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.

Definition at line 1319 of file ModifyDBClusterRequest.h.

◆ SerializePayload()

Aws::String Aws::RDS::Model::ModifyDBClusterRequest::SerializePayload ( ) const

overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAllowMajorVersionUpgrade()

void Aws::RDS::Model::ModifyDBClusterRequest::SetAllowMajorVersionUpgrade ( bool value )

inline

A value that indicates whether major version upgrades are allowed.

Constraints: You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.

Definition at line 1063 of file ModifyDBClusterRequest.h.

◆ SetApplyImmediately()

void Aws::RDS::Model::ModifyDBClusterRequest::SetApplyImmediately ( bool value )

inline

A value that indicates whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB cluster. If this parameter is disabled, changes to the DB cluster are applied during the next maintenance window.

The ApplyImmediately parameter only affects the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values. If the ApplyImmediately parameter is disabled, then changes to the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.

By default, this parameter is disabled.

Definition at line 232 of file ModifyDBClusterRequest.h.

◆ SetBacktrackWindow()

void Aws::RDS::Model::ModifyDBClusterRequest::SetBacktrackWindow ( long long value )

inline

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

Currently, Backtrack is only supported for Aurora MySQL DB clusters.

Default: 0

Constraints:

If specified, this value must be set to a number from 0 to 259,200 (72 hours).

Definition at line 847 of file ModifyDBClusterRequest.h.

◆ SetBackupRetentionPeriod()

void Aws::RDS::Model::ModifyDBClusterRequest::SetBackupRetentionPeriod ( int value )

inline

The number of days for which automated backups are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

Must be a value from 1 to 35

Definition at line 271 of file ModifyDBClusterRequest.h.

◆ SetCloudwatchLogsExportConfiguration() [1/2]

void Aws::RDS::Model::ModifyDBClusterRequest::SetCloudwatchLogsExportConfiguration ( CloudwatchLogsExportConfiguration && value )

inline

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.

Definition at line 881 of file ModifyDBClusterRequest.h.

◆ SetCloudwatchLogsExportConfiguration() [2/2]

void Aws::RDS::Model::ModifyDBClusterRequest::SetCloudwatchLogsExportConfiguration ( const CloudwatchLogsExportConfiguration & value )

inline

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.

Definition at line 875 of file ModifyDBClusterRequest.h.

◆ SetCopyTagsToSnapshot()

void Aws::RDS::Model::ModifyDBClusterRequest::SetCopyTagsToSnapshot ( bool value )

inline

A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.

Definition at line 1444 of file ModifyDBClusterRequest.h.

◆ SetDBClusterIdentifier() [1/3]

void Aws::RDS::Model::ModifyDBClusterRequest::SetDBClusterIdentifier ( Aws::String && value )

inline

The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.

Constraints: This identifier must match the identifier of an existing DB cluster.

Definition at line 71 of file ModifyDBClusterRequest.h.

◆ SetDBClusterIdentifier() [2/3]

void Aws::RDS::Model::ModifyDBClusterRequest::SetDBClusterIdentifier ( const Aws::String & value )

inline

The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.

Constraints: This identifier must match the identifier of an existing DB cluster.

Definition at line 64 of file ModifyDBClusterRequest.h.

◆ SetDBClusterIdentifier() [3/3]

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

inline

The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.

Constraints: This identifier must match the identifier of an existing DB cluster.

Definition at line 78 of file ModifyDBClusterRequest.h.

◆ SetDBClusterParameterGroupName() [1/3]

void Aws::RDS::Model::ModifyDBClusterRequest::SetDBClusterParameterGroupName ( Aws::String && value )

inline

The name of the DB cluster parameter group to use for the DB cluster.

Definition at line 299 of file ModifyDBClusterRequest.h.

◆ SetDBClusterParameterGroupName() [2/3]

void Aws::RDS::Model::ModifyDBClusterRequest::SetDBClusterParameterGroupName ( const Aws::String & value )

inline

The name of the DB cluster parameter group to use for the DB cluster.

Definition at line 294 of file ModifyDBClusterRequest.h.

◆ SetDBClusterParameterGroupName() [3/3]

void Aws::RDS::Model::ModifyDBClusterRequest::SetDBClusterParameterGroupName ( const char * value )

inline

The name of the DB cluster parameter group to use for the DB cluster.

Definition at line 304 of file ModifyDBClusterRequest.h.

◆ SetDBInstanceParameterGroupName() [1/3]

void Aws::RDS::Model::ModifyDBClusterRequest::SetDBInstanceParameterGroupName ( Aws::String && value )

inline

The name of the DB parameter group to apply to all instances of the DB cluster.

When you apply a parameter group using the DBInstanceParameterGroupName parameter, the DB cluster isn't rebooted automatically. Also, parameter changes aren't applied during the next maintenance window but instead are applied immediately.

Default: The existing name setting

Constraints:

The DB parameter group must be in the same DB parameter group family as this DB cluster.
The DBInstanceParameterGroupName parameter is only valid in combination with the AllowMajorVersionUpgrade parameter.

Definition at line 1128 of file ModifyDBClusterRequest.h.

◆ SetDBInstanceParameterGroupName() [2/3]

void Aws::RDS::Model::ModifyDBClusterRequest::SetDBInstanceParameterGroupName ( const Aws::String & value )

inline

The name of the DB parameter group to apply to all instances of the DB cluster.

When you apply a parameter group using the DBInstanceParameterGroupName parameter, the DB cluster isn't rebooted automatically. Also, parameter changes aren't applied during the next maintenance window but instead are applied immediately.

Default: The existing name setting

Constraints:

The DB parameter group must be in the same DB parameter group family as this DB cluster.
The DBInstanceParameterGroupName parameter is only valid in combination with the AllowMajorVersionUpgrade parameter.

Definition at line 1114 of file ModifyDBClusterRequest.h.

◆ SetDBInstanceParameterGroupName() [3/3]

void Aws::RDS::Model::ModifyDBClusterRequest::SetDBInstanceParameterGroupName ( const char * value )

inline

The name of the DB parameter group to apply to all instances of the DB cluster.

When you apply a parameter group using the DBInstanceParameterGroupName parameter, the DB cluster isn't rebooted automatically. Also, parameter changes aren't applied during the next maintenance window but instead are applied immediately.

Default: The existing name setting

Constraints:

The DB parameter group must be in the same DB parameter group family as this DB cluster.
The DBInstanceParameterGroupName parameter is only valid in combination with the AllowMajorVersionUpgrade parameter.

Definition at line 1142 of file ModifyDBClusterRequest.h.

◆ SetDeletionProtection()

void Aws::RDS::Model::ModifyDBClusterRequest::SetDeletionProtection ( bool value )

inline

A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

Definition at line 1365 of file ModifyDBClusterRequest.h.

◆ SetDomain() [1/3]

void Aws::RDS::Model::ModifyDBClusterRequest::SetDomain ( Aws::String && value )

inline

The Active Directory directory ID to move the DB cluster to. Specify none to remove the cluster from its current domain. The domain must be created prior to this operation.

For more information, see Kerberos Authentication in the Amazon Aurora User Guide.

Definition at line 1221 of file ModifyDBClusterRequest.h.

◆ SetDomain() [2/3]

void Aws::RDS::Model::ModifyDBClusterRequest::SetDomain ( const Aws::String & value )

inline

The Active Directory directory ID to move the DB cluster to. Specify none to remove the cluster from its current domain. The domain must be created prior to this operation.

For more information, see Kerberos Authentication in the Amazon Aurora User Guide.

Definition at line 1212 of file ModifyDBClusterRequest.h.

◆ SetDomain() [3/3]

void Aws::RDS::Model::ModifyDBClusterRequest::SetDomain ( const char * value )

inline

The Active Directory directory ID to move the DB cluster to. Specify none to remove the cluster from its current domain. The domain must be created prior to this operation.

For more information, see Kerberos Authentication in the Amazon Aurora User Guide.

Definition at line 1230 of file ModifyDBClusterRequest.h.

◆ SetDomainIAMRoleName() [1/3]

void Aws::RDS::Model::ModifyDBClusterRequest::SetDomainIAMRoleName ( Aws::String && value )

inline

Specify the name of the IAM role to be used when making API calls to the Directory Service.

Definition at line 1282 of file ModifyDBClusterRequest.h.

◆ SetDomainIAMRoleName() [2/3]

void Aws::RDS::Model::ModifyDBClusterRequest::SetDomainIAMRoleName ( const Aws::String & value )

inline

Specify the name of the IAM role to be used when making API calls to the Directory Service.

Definition at line 1276 of file ModifyDBClusterRequest.h.

◆ SetDomainIAMRoleName() [3/3]

void Aws::RDS::Model::ModifyDBClusterRequest::SetDomainIAMRoleName ( const char * value )

inline

Specify the name of the IAM role to be used when making API calls to the Directory Service.

Definition at line 1288 of file ModifyDBClusterRequest.h.

◆ SetEnableGlobalWriteForwarding()

void Aws::RDS::Model::ModifyDBClusterRequest::SetEnableGlobalWriteForwarding ( bool value )

inline

A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an Aurora global database (GlobalCluster). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.

You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by the FailoverGlobalCluster API operation, but it does nothing until then.

Definition at line 1493 of file ModifyDBClusterRequest.h.

◆ SetEnableHttpEndpoint()

void Aws::RDS::Model::ModifyDBClusterRequest::SetEnableHttpEndpoint ( bool value )

inline

A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.

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 1412 of file ModifyDBClusterRequest.h.

◆ SetEnableIAMDatabaseAuthentication()

void Aws::RDS::Model::ModifyDBClusterRequest::SetEnableIAMDatabaseAuthentication ( bool value )

inline

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

For more information, see IAM Database Authentication in the Amazon Aurora User Guide.

Definition at line 810 of file ModifyDBClusterRequest.h.

◆ SetEngineVersion() [1/3]

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

inline

The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless ApplyImmediately is enabled.

To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

aws rds describe-db-engine-versions –engine aurora –query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:

aws rds describe-db-engine-versions –engine aurora-mysql –query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for aurora-postgresql, use the following command:

aws rds describe-db-engine-versions –engine aurora-postgresql –query "DBEngineVersions[].EngineVersion"

Definition at line 966 of file ModifyDBClusterRequest.h.

◆ SetEngineVersion() [2/3]

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

inline

The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless ApplyImmediately is enabled.

To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

aws rds describe-db-engine-versions –engine aurora –query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:

aws rds describe-db-engine-versions –engine aurora-mysql –query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for aurora-postgresql, use the following command:

aws rds describe-db-engine-versions –engine aurora-postgresql –query "DBEngineVersions[].EngineVersion"

Definition at line 948 of file ModifyDBClusterRequest.h.

◆ SetEngineVersion() [3/3]

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

inline

The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless ApplyImmediately is enabled.

To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

aws rds describe-db-engine-versions –engine aurora –query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:

aws rds describe-db-engine-versions –engine aurora-mysql –query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for aurora-postgresql, use the following command:

aws rds describe-db-engine-versions –engine aurora-postgresql –query "DBEngineVersions[].EngineVersion"

Definition at line 984 of file ModifyDBClusterRequest.h.

◆ SetMasterUserPassword() [1/3]

void Aws::RDS::Model::ModifyDBClusterRequest::SetMasterUserPassword ( Aws::String && value )

inline

The new password for the master database user. This password can contain any printable ASCII character except "/", """, or "".

Constraints: Must contain from 8 to 41 characters.

Definition at line 423 of file ModifyDBClusterRequest.h.

◆ SetMasterUserPassword() [2/3]

void Aws::RDS::Model::ModifyDBClusterRequest::SetMasterUserPassword ( const Aws::String & value )

inline

The new password for the master database user. This password can contain any printable ASCII character except "/", """, or "".

Constraints: Must contain from 8 to 41 characters.

Definition at line 416 of file ModifyDBClusterRequest.h.

◆ SetMasterUserPassword() [3/3]

void Aws::RDS::Model::ModifyDBClusterRequest::SetMasterUserPassword ( const char * value )

inline

The new password for the master database user. This password can contain any printable ASCII character except "/", """, or "".

Constraints: Must contain from 8 to 41 characters.

Definition at line 430 of file ModifyDBClusterRequest.h.

◆ SetNewDBClusterIdentifier() [1/3]

void Aws::RDS::Model::ModifyDBClusterRequest::SetNewDBClusterIdentifier ( Aws::String && value )

inline

The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.

Constraints:

Must contain from 1 to 63 letters, numbers, or hyphens
The first character must be a letter
Can't end with a hyphen or contain two consecutive hyphens

Example: my-cluster2

Definition at line 140 of file ModifyDBClusterRequest.h.

◆ SetNewDBClusterIdentifier() [2/3]

void Aws::RDS::Model::ModifyDBClusterRequest::SetNewDBClusterIdentifier ( const Aws::String & value )

inline

The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.

Constraints:

Must contain from 1 to 63 letters, numbers, or hyphens
The first character must be a letter
Can't end with a hyphen or contain two consecutive hyphens

Example: my-cluster2

Definition at line 130 of file ModifyDBClusterRequest.h.

◆ SetNewDBClusterIdentifier() [3/3]

void Aws::RDS::Model::ModifyDBClusterRequest::SetNewDBClusterIdentifier ( const char * value )

inline

The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.

Constraints:

Must contain from 1 to 63 letters, numbers, or hyphens
The first character must be a letter
Can't end with a hyphen or contain two consecutive hyphens

Example: my-cluster2

Definition at line 150 of file ModifyDBClusterRequest.h.

◆ SetOptionGroupName() [1/3]

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

inline

A value that indicates that the DB cluster should be associated with the specified option group. Changing this parameter doesn't result in an outage except in the following case, and the change is applied during the next maintenance window unless the ApplyImmediately is enabled for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.

Definition at line 504 of file ModifyDBClusterRequest.h.

◆ SetOptionGroupName() [2/3]

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

inline

A value that indicates that the DB cluster should be associated with the specified option group. Changing this parameter doesn't result in an outage except in the following case, and the change is applied during the next maintenance window unless the ApplyImmediately is enabled for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.

Definition at line 491 of file ModifyDBClusterRequest.h.

◆ SetOptionGroupName() [3/3]

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

inline

A value that indicates that the DB cluster should be associated with the specified option group. Changing this parameter doesn't result in an outage except in the following case, and the change is applied during the next maintenance window unless the ApplyImmediately is enabled for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.

Definition at line 517 of file ModifyDBClusterRequest.h.

◆ SetPort()

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

inline

The port number on which the DB cluster accepts connections.

Constraints: Value must be 1150-65535

Default: The same port as the original DB cluster.

Definition at line 387 of file ModifyDBClusterRequest.h.

◆ SetPreferredBackupWindow() [1/3]

void Aws::RDS::Model::ModifyDBClusterRequest::SetPreferredBackupWindow ( Aws::String && value )

inline

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

Constraints:

Must be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.

Definition at line 617 of file ModifyDBClusterRequest.h.

◆ SetPreferredBackupWindow() [2/3]

void Aws::RDS::Model::ModifyDBClusterRequest::SetPreferredBackupWindow ( const Aws::String & value )

inline

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

Constraints:

Must be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.

Definition at line 602 of file ModifyDBClusterRequest.h.

◆ SetPreferredBackupWindow() [3/3]

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

inline

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

Constraints:

Must be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.

Definition at line 632 of file ModifyDBClusterRequest.h.

◆ SetPreferredMaintenanceWindow() [1/3]

void Aws::RDS::Model::ModifyDBClusterRequest::SetPreferredMaintenanceWindow ( Aws::String && value )

inline

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

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

Definition at line 730 of file ModifyDBClusterRequest.h.

◆ SetPreferredMaintenanceWindow() [2/3]

void Aws::RDS::Model::ModifyDBClusterRequest::SetPreferredMaintenanceWindow ( const Aws::String & value )

inline

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

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

Definition at line 717 of file ModifyDBClusterRequest.h.

◆ SetPreferredMaintenanceWindow() [3/3]

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

inline

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

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

Definition at line 743 of file ModifyDBClusterRequest.h.

◆ SetScalingConfiguration() [1/2]

void Aws::RDS::Model::ModifyDBClusterRequest::SetScalingConfiguration ( const ScalingConfiguration & value )

inline

The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.

Definition at line 1325 of file ModifyDBClusterRequest.h.

◆ SetScalingConfiguration() [2/2]

void Aws::RDS::Model::ModifyDBClusterRequest::SetScalingConfiguration ( ScalingConfiguration && value )

inline

The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.

Definition at line 1331 of file ModifyDBClusterRequest.h.

◆ SetVpcSecurityGroupIds() [1/2]

void Aws::RDS::Model::ModifyDBClusterRequest::SetVpcSecurityGroupIds ( Aws::Vector< Aws::String > && value )

inline

A list of VPC security groups that the DB cluster will belong to.

Definition at line 340 of file ModifyDBClusterRequest.h.

◆ SetVpcSecurityGroupIds() [2/2]

void Aws::RDS::Model::ModifyDBClusterRequest::SetVpcSecurityGroupIds ( const Aws::Vector< Aws::String > & value )

inline

A list of VPC security groups that the DB cluster will belong to.

Definition at line 335 of file ModifyDBClusterRequest.h.

◆ VpcSecurityGroupIdsHasBeenSet()

bool Aws::RDS::Model::ModifyDBClusterRequest::VpcSecurityGroupIdsHasBeenSet ( ) const

inline

A list of VPC security groups that the DB cluster will belong to.

Definition at line 330 of file ModifyDBClusterRequest.h.

◆ WithAllowMajorVersionUpgrade()

ModifyDBClusterRequest& Aws::RDS::Model::ModifyDBClusterRequest::WithAllowMajorVersionUpgrade ( bool value )

inline

A value that indicates whether major version upgrades are allowed.

Constraints: You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.

Definition at line 1071 of file ModifyDBClusterRequest.h.

◆ WithApplyImmediately()

ModifyDBClusterRequest& Aws::RDS::Model::ModifyDBClusterRequest::WithApplyImmediately ( bool value )

inline

A value that indicates whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB cluster. If this parameter is disabled, changes to the DB cluster are applied during the next maintenance window.

The ApplyImmediately parameter only affects the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values. If the ApplyImmediately parameter is disabled, then changes to the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.

By default, this parameter is disabled.

Definition at line 249 of file ModifyDBClusterRequest.h.

◆ WithBacktrackWindow()

ModifyDBClusterRequest& Aws::RDS::Model::ModifyDBClusterRequest::WithBacktrackWindow ( long long value )

inline

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

Currently, Backtrack is only supported for Aurora MySQL DB clusters.

Default: 0

Constraints:

If specified, this value must be set to a number from 0 to 259,200 (72 hours).

Definition at line 856 of file ModifyDBClusterRequest.h.

◆ WithBackupRetentionPeriod()

ModifyDBClusterRequest& Aws::RDS::Model::ModifyDBClusterRequest::WithBackupRetentionPeriod ( int value )

inline

The number of days for which automated backups are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

Must be a value from 1 to 35

Definition at line 278 of file ModifyDBClusterRequest.h.

◆ WithCloudwatchLogsExportConfiguration() [1/2]

ModifyDBClusterRequest& Aws::RDS::Model::ModifyDBClusterRequest::WithCloudwatchLogsExportConfiguration ( CloudwatchLogsExportConfiguration && value )

inline

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.

Definition at line 893 of file ModifyDBClusterRequest.h.

◆ WithCloudwatchLogsExportConfiguration() [2/2]

ModifyDBClusterRequest& Aws::RDS::Model::ModifyDBClusterRequest::WithCloudwatchLogsExportConfiguration ( const CloudwatchLogsExportConfiguration & value )

inline

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.

Definition at line 887 of file ModifyDBClusterRequest.h.

◆ WithCopyTagsToSnapshot()

ModifyDBClusterRequest& Aws::RDS::Model::ModifyDBClusterRequest::WithCopyTagsToSnapshot ( bool value )

inline

A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.

Definition at line 1450 of file ModifyDBClusterRequest.h.

◆ WithDBClusterIdentifier() [1/3]

ModifyDBClusterRequest& Aws::RDS::Model::ModifyDBClusterRequest::WithDBClusterIdentifier ( Aws::String && value )

inline

The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.

Constraints: This identifier must match the identifier of an existing DB cluster.

Definition at line 92 of file ModifyDBClusterRequest.h.

◆ WithDBClusterIdentifier() [2/3]

ModifyDBClusterRequest& Aws::RDS::Model::ModifyDBClusterRequest::WithDBClusterIdentifier ( const Aws::String & value )

inline

The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.

Constraints: This identifier must match the identifier of an existing DB cluster.

Definition at line 85 of file ModifyDBClusterRequest.h.

◆ WithDBClusterIdentifier() [3/3]

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

inline

The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.

Constraints: This identifier must match the identifier of an existing DB cluster.

Definition at line 99 of file ModifyDBClusterRequest.h.

◆ WithDBClusterParameterGroupName() [1/3]

ModifyDBClusterRequest& Aws::RDS::Model::ModifyDBClusterRequest::WithDBClusterParameterGroupName ( Aws::String && value )

inline

The name of the DB cluster parameter group to use for the DB cluster.

Definition at line 314 of file ModifyDBClusterRequest.h.

◆ WithDBClusterParameterGroupName() [2/3]

ModifyDBClusterRequest& Aws::RDS::Model::ModifyDBClusterRequest::WithDBClusterParameterGroupName ( const Aws::String & value )

inline

The name of the DB cluster parameter group to use for the DB cluster.

Definition at line 309 of file ModifyDBClusterRequest.h.

◆ WithDBClusterParameterGroupName() [3/3]

ModifyDBClusterRequest& Aws::RDS::Model::ModifyDBClusterRequest::WithDBClusterParameterGroupName ( const char * value )

inline

The name of the DB cluster parameter group to use for the DB cluster.

Definition at line 319 of file ModifyDBClusterRequest.h.

◆ WithDBInstanceParameterGroupName() [1/3]

ModifyDBClusterRequest& Aws::RDS::Model::ModifyDBClusterRequest::WithDBInstanceParameterGroupName ( Aws::String && value )

inline

The name of the DB parameter group to apply to all instances of the DB cluster.

When you apply a parameter group using the DBInstanceParameterGroupName parameter, the DB cluster isn't rebooted automatically. Also, parameter changes aren't applied during the next maintenance window but instead are applied immediately.

Default: The existing name setting

Constraints:

The DB parameter group must be in the same DB parameter group family as this DB cluster.
The DBInstanceParameterGroupName parameter is only valid in combination with the AllowMajorVersionUpgrade parameter.

Definition at line 1170 of file ModifyDBClusterRequest.h.

◆ WithDBInstanceParameterGroupName() [2/3]

ModifyDBClusterRequest& Aws::RDS::Model::ModifyDBClusterRequest::WithDBInstanceParameterGroupName ( const Aws::String & value )

inline

The name of the DB parameter group to apply to all instances of the DB cluster.

When you apply a parameter group using the DBInstanceParameterGroupName parameter, the DB cluster isn't rebooted automatically. Also, parameter changes aren't applied during the next maintenance window but instead are applied immediately.

Default: The existing name setting

Constraints:

The DB parameter group must be in the same DB parameter group family as this DB cluster.
The DBInstanceParameterGroupName parameter is only valid in combination with the AllowMajorVersionUpgrade parameter.

Definition at line 1156 of file ModifyDBClusterRequest.h.

◆ WithDBInstanceParameterGroupName() [3/3]

ModifyDBClusterRequest& Aws::RDS::Model::ModifyDBClusterRequest::WithDBInstanceParameterGroupName ( const char * value )

inline

The name of the DB parameter group to apply to all instances of the DB cluster.

When you apply a parameter group using the DBInstanceParameterGroupName parameter, the DB cluster isn't rebooted automatically. Also, parameter changes aren't applied during the next maintenance window but instead are applied immediately.

Default: The existing name setting

Constraints:

The DB parameter group must be in the same DB parameter group family as this DB cluster.
The DBInstanceParameterGroupName parameter is only valid in combination with the AllowMajorVersionUpgrade parameter.

Definition at line 1184 of file ModifyDBClusterRequest.h.

◆ WithDeletionProtection()

ModifyDBClusterRequest& Aws::RDS::Model::ModifyDBClusterRequest::WithDeletionProtection ( bool value )

inline

A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

Definition at line 1372 of file ModifyDBClusterRequest.h.

◆ WithDomain() [1/3]

ModifyDBClusterRequest& Aws::RDS::Model::ModifyDBClusterRequest::WithDomain ( Aws::String && value )

inline

The Active Directory directory ID to move the DB cluster to. Specify none to remove the cluster from its current domain. The domain must be created prior to this operation.

For more information, see Kerberos Authentication in the Amazon Aurora User Guide.

Definition at line 1248 of file ModifyDBClusterRequest.h.

◆ WithDomain() [2/3]

ModifyDBClusterRequest& Aws::RDS::Model::ModifyDBClusterRequest::WithDomain ( const Aws::String & value )

inline

The Active Directory directory ID to move the DB cluster to. Specify none to remove the cluster from its current domain. The domain must be created prior to this operation.

For more information, see Kerberos Authentication in the Amazon Aurora User Guide.

Definition at line 1239 of file ModifyDBClusterRequest.h.

◆ WithDomain() [3/3]

ModifyDBClusterRequest& Aws::RDS::Model::ModifyDBClusterRequest::WithDomain ( const char * value )

inline

The Active Directory directory ID to move the DB cluster to. Specify none to remove the cluster from its current domain. The domain must be created prior to this operation.

For more information, see Kerberos Authentication in the Amazon Aurora User Guide.

Definition at line 1257 of file ModifyDBClusterRequest.h.

◆ WithDomainIAMRoleName() [1/3]

ModifyDBClusterRequest& Aws::RDS::Model::ModifyDBClusterRequest::WithDomainIAMRoleName ( Aws::String && value )

inline

Specify the name of the IAM role to be used when making API calls to the Directory Service.

Definition at line 1300 of file ModifyDBClusterRequest.h.

◆ WithDomainIAMRoleName() [2/3]

ModifyDBClusterRequest& Aws::RDS::Model::ModifyDBClusterRequest::WithDomainIAMRoleName ( const Aws::String & value )

inline

Specify the name of the IAM role to be used when making API calls to the Directory Service.

Definition at line 1294 of file ModifyDBClusterRequest.h.

◆ WithDomainIAMRoleName() [3/3]

ModifyDBClusterRequest& Aws::RDS::Model::ModifyDBClusterRequest::WithDomainIAMRoleName ( const char * value )

inline

Specify the name of the IAM role to be used when making API calls to the Directory Service.

Definition at line 1306 of file ModifyDBClusterRequest.h.

◆ WithEnableGlobalWriteForwarding()

ModifyDBClusterRequest& Aws::RDS::Model::ModifyDBClusterRequest::WithEnableGlobalWriteForwarding ( bool value )

inline

A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an Aurora global database (GlobalCluster). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.

You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by the FailoverGlobalCluster API operation, but it does nothing until then.

Definition at line 1507 of file ModifyDBClusterRequest.h.

◆ WithEnableHttpEndpoint()

ModifyDBClusterRequest& Aws::RDS::Model::ModifyDBClusterRequest::WithEnableHttpEndpoint ( bool value )

inline

A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.

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 1425 of file ModifyDBClusterRequest.h.

◆ WithEnableIAMDatabaseAuthentication()

ModifyDBClusterRequest& Aws::RDS::Model::ModifyDBClusterRequest::WithEnableIAMDatabaseAuthentication ( bool value )

inline

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

For more information, see IAM Database Authentication in the Amazon Aurora User Guide.

Definition at line 819 of file ModifyDBClusterRequest.h.

◆ WithEngineVersion() [1/3]

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

inline

The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless ApplyImmediately is enabled.

To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

aws rds describe-db-engine-versions –engine aurora –query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:

aws rds describe-db-engine-versions –engine aurora-mysql –query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for aurora-postgresql, use the following command:

aws rds describe-db-engine-versions –engine aurora-postgresql –query "DBEngineVersions[].EngineVersion"

Definition at line 1020 of file ModifyDBClusterRequest.h.

◆ WithEngineVersion() [2/3]

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

inline

The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless ApplyImmediately is enabled.

To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

aws rds describe-db-engine-versions –engine aurora –query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:

aws rds describe-db-engine-versions –engine aurora-mysql –query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for aurora-postgresql, use the following command:

aws rds describe-db-engine-versions –engine aurora-postgresql –query "DBEngineVersions[].EngineVersion"

Definition at line 1002 of file ModifyDBClusterRequest.h.

◆ WithEngineVersion() [3/3]

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

inline

The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless ApplyImmediately is enabled.

To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

aws rds describe-db-engine-versions –engine aurora –query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:

aws rds describe-db-engine-versions –engine aurora-mysql –query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for aurora-postgresql, use the following command:

aws rds describe-db-engine-versions –engine aurora-postgresql –query "DBEngineVersions[].EngineVersion"

Definition at line 1038 of file ModifyDBClusterRequest.h.

◆ WithMasterUserPassword() [1/3]

ModifyDBClusterRequest& Aws::RDS::Model::ModifyDBClusterRequest::WithMasterUserPassword ( Aws::String && value )

inline

The new password for the master database user. This password can contain any printable ASCII character except "/", """, or "".

Constraints: Must contain from 8 to 41 characters.

Definition at line 444 of file ModifyDBClusterRequest.h.

◆ WithMasterUserPassword() [2/3]

ModifyDBClusterRequest& Aws::RDS::Model::ModifyDBClusterRequest::WithMasterUserPassword ( const Aws::String & value )

inline

The new password for the master database user. This password can contain any printable ASCII character except "/", """, or "".

Constraints: Must contain from 8 to 41 characters.

Definition at line 437 of file ModifyDBClusterRequest.h.

◆ WithMasterUserPassword() [3/3]

ModifyDBClusterRequest& Aws::RDS::Model::ModifyDBClusterRequest::WithMasterUserPassword ( const char * value )

inline

The new password for the master database user. This password can contain any printable ASCII character except "/", """, or "".

Constraints: Must contain from 8 to 41 characters.

Definition at line 451 of file ModifyDBClusterRequest.h.

◆ WithNewDBClusterIdentifier() [1/3]

ModifyDBClusterRequest& Aws::RDS::Model::ModifyDBClusterRequest::WithNewDBClusterIdentifier ( Aws::String && value )

inline

The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.

Constraints:

Must contain from 1 to 63 letters, numbers, or hyphens
The first character must be a letter
Can't end with a hyphen or contain two consecutive hyphens

Example: my-cluster2

Definition at line 170 of file ModifyDBClusterRequest.h.

◆ WithNewDBClusterIdentifier() [2/3]

ModifyDBClusterRequest& Aws::RDS::Model::ModifyDBClusterRequest::WithNewDBClusterIdentifier ( const Aws::String & value )

inline

The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.

Constraints:

Must contain from 1 to 63 letters, numbers, or hyphens
The first character must be a letter
Can't end with a hyphen or contain two consecutive hyphens

Example: my-cluster2

Definition at line 160 of file ModifyDBClusterRequest.h.

◆ WithNewDBClusterIdentifier() [3/3]

ModifyDBClusterRequest& Aws::RDS::Model::ModifyDBClusterRequest::WithNewDBClusterIdentifier ( const char * value )

inline

The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.

Constraints:

Must contain from 1 to 63 letters, numbers, or hyphens
The first character must be a letter
Can't end with a hyphen or contain two consecutive hyphens

Example: my-cluster2

Definition at line 180 of file ModifyDBClusterRequest.h.

◆ WithOptionGroupName() [1/3]

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

inline

A value that indicates that the DB cluster should be associated with the specified option group. Changing this parameter doesn't result in an outage except in the following case, and the change is applied during the next maintenance window unless the ApplyImmediately is enabled for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.

Definition at line 543 of file ModifyDBClusterRequest.h.

◆ WithOptionGroupName() [2/3]

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

inline

A value that indicates that the DB cluster should be associated with the specified option group. Changing this parameter doesn't result in an outage except in the following case, and the change is applied during the next maintenance window unless the ApplyImmediately is enabled for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.

Definition at line 530 of file ModifyDBClusterRequest.h.

◆ WithOptionGroupName() [3/3]

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

inline

A value that indicates that the DB cluster should be associated with the specified option group. Changing this parameter doesn't result in an outage except in the following case, and the change is applied during the next maintenance window unless the ApplyImmediately is enabled for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.

Definition at line 556 of file ModifyDBClusterRequest.h.

◆ WithPort()

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

inline

The port number on which the DB cluster accepts connections.

Constraints: Value must be 1150-65535

Default: The same port as the original DB cluster.

Definition at line 394 of file ModifyDBClusterRequest.h.

◆ WithPreferredBackupWindow() [1/3]

ModifyDBClusterRequest& Aws::RDS::Model::ModifyDBClusterRequest::WithPreferredBackupWindow ( Aws::String && value )

inline

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

Constraints:

Must be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.

Definition at line 662 of file ModifyDBClusterRequest.h.

◆ WithPreferredBackupWindow() [2/3]

ModifyDBClusterRequest& Aws::RDS::Model::ModifyDBClusterRequest::WithPreferredBackupWindow ( const Aws::String & value )

inline

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

Constraints:

Must be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.

Definition at line 647 of file ModifyDBClusterRequest.h.

◆ WithPreferredBackupWindow() [3/3]

ModifyDBClusterRequest& Aws::RDS::Model::ModifyDBClusterRequest::WithPreferredBackupWindow ( const char * value )

inline

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

Constraints:

Must be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.

Definition at line 677 of file ModifyDBClusterRequest.h.

◆ WithPreferredMaintenanceWindow() [1/3]

ModifyDBClusterRequest& Aws::RDS::Model::ModifyDBClusterRequest::WithPreferredMaintenanceWindow ( Aws::String && value )

inline

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

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

Definition at line 769 of file ModifyDBClusterRequest.h.

◆ WithPreferredMaintenanceWindow() [2/3]

ModifyDBClusterRequest& Aws::RDS::Model::ModifyDBClusterRequest::WithPreferredMaintenanceWindow ( const Aws::String & value )

inline

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

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

Definition at line 756 of file ModifyDBClusterRequest.h.

◆ WithPreferredMaintenanceWindow() [3/3]

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

inline

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

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

Definition at line 782 of file ModifyDBClusterRequest.h.

◆ WithScalingConfiguration() [1/2]

ModifyDBClusterRequest& Aws::RDS::Model::ModifyDBClusterRequest::WithScalingConfiguration ( const ScalingConfiguration & value )

inline

The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.

Definition at line 1337 of file ModifyDBClusterRequest.h.

◆ WithScalingConfiguration() [2/2]

ModifyDBClusterRequest& Aws::RDS::Model::ModifyDBClusterRequest::WithScalingConfiguration ( ScalingConfiguration && value )

inline

The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.

Definition at line 1343 of file ModifyDBClusterRequest.h.

◆ WithVpcSecurityGroupIds() [1/2]

ModifyDBClusterRequest& Aws::RDS::Model::ModifyDBClusterRequest::WithVpcSecurityGroupIds ( Aws::Vector< Aws::String > && value )

inline

A list of VPC security groups that the DB cluster will belong to.

Definition at line 350 of file ModifyDBClusterRequest.h.

◆ WithVpcSecurityGroupIds() [2/2]

ModifyDBClusterRequest& Aws::RDS::Model::ModifyDBClusterRequest::WithVpcSecurityGroupIds ( const Aws::Vector< Aws::String > & value )

inline

A list of VPC security groups that the DB cluster will belong to.

Definition at line 345 of file ModifyDBClusterRequest.h.

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

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

Public Member Functions

Protected Member Functions

Detailed Description

See Also:

Constructor & Destructor Documentation

◆ ModifyDBClusterRequest()

Member Function Documentation

◆ AddVpcSecurityGroupIds() [1/3]

◆ AddVpcSecurityGroupIds() [2/3]

◆ AddVpcSecurityGroupIds() [3/3]

◆ AllowMajorVersionUpgradeHasBeenSet()

◆ ApplyImmediatelyHasBeenSet()

◆ BacktrackWindowHasBeenSet()

◆ BackupRetentionPeriodHasBeenSet()

◆ CloudwatchLogsExportConfigurationHasBeenSet()

◆ CopyTagsToSnapshotHasBeenSet()

◆ DBClusterIdentifierHasBeenSet()

◆ DBClusterParameterGroupNameHasBeenSet()

◆ DBInstanceParameterGroupNameHasBeenSet()

◆ DeletionProtectionHasBeenSet()

◆ DomainHasBeenSet()

◆ DomainIAMRoleNameHasBeenSet()

◆ DumpBodyToUrl()

◆ EnableGlobalWriteForwardingHasBeenSet()

◆ EnableHttpEndpointHasBeenSet()

◆ EnableIAMDatabaseAuthenticationHasBeenSet()

◆ EngineVersionHasBeenSet()

◆ GetAllowMajorVersionUpgrade()

◆ GetApplyImmediately()

◆ GetBacktrackWindow()

◆ GetBackupRetentionPeriod()

◆ GetCloudwatchLogsExportConfiguration()

◆ GetCopyTagsToSnapshot()

◆ GetDBClusterIdentifier()

◆ GetDBClusterParameterGroupName()

◆ GetDBInstanceParameterGroupName()

◆ GetDeletionProtection()

◆ GetDomain()

◆ GetDomainIAMRoleName()

◆ GetEnableGlobalWriteForwarding()

◆ GetEnableHttpEndpoint()

◆ GetEnableIAMDatabaseAuthentication()

◆ GetEngineVersion()

◆ GetMasterUserPassword()

◆ GetNewDBClusterIdentifier()

◆ GetOptionGroupName()

◆ GetPort()

◆ GetPreferredBackupWindow()

◆ GetPreferredMaintenanceWindow()

◆ GetScalingConfiguration()

◆ GetServiceRequestName()

◆ GetVpcSecurityGroupIds()

◆ MasterUserPasswordHasBeenSet()

◆ NewDBClusterIdentifierHasBeenSet()

◆ OptionGroupNameHasBeenSet()

◆ PortHasBeenSet()

◆ PreferredBackupWindowHasBeenSet()

◆ PreferredMaintenanceWindowHasBeenSet()

◆ ScalingConfigurationHasBeenSet()

◆ SerializePayload()

◆ SetAllowMajorVersionUpgrade()

◆ SetApplyImmediately()

◆ SetBacktrackWindow()

◆ SetBackupRetentionPeriod()

◆ SetCloudwatchLogsExportConfiguration() [1/2]

◆ SetCloudwatchLogsExportConfiguration() [2/2]

◆ SetCopyTagsToSnapshot()

◆ SetDBClusterIdentifier() [1/3]

◆ SetDBClusterIdentifier() [2/3]

◆ SetDBClusterIdentifier() [3/3]

◆ SetDBClusterParameterGroupName() [1/3]

◆ SetDBClusterParameterGroupName() [2/3]

◆ SetDBClusterParameterGroupName() [3/3]

◆ SetDBInstanceParameterGroupName() [1/3]

◆ SetDBInstanceParameterGroupName() [2/3]

◆ SetDBInstanceParameterGroupName() [3/3]

◆ SetDeletionProtection()

◆ SetDomain() [1/3]

◆ SetDomain() [2/3]

◆ SetDomain() [3/3]