/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include Represents the input to ModifyDBCluster.See Also:
AWS
* API Reference
The cluster identifier for the cluster that is being modified. This parameter * is not case sensitive.
Constraints:
Must match the
* identifier of an existing DBCluster.
The cluster identifier for the cluster that is being modified. This parameter * is not case sensitive.
Constraints:
Must match the
* identifier of an existing DBCluster.
The cluster identifier for the cluster that is being modified. This parameter * is not case sensitive.
Constraints:
Must match the
* identifier of an existing DBCluster.
The cluster identifier for the cluster that is being modified. This parameter * is not case sensitive.
Constraints:
Must match the
* identifier of an existing DBCluster.
The cluster identifier for the cluster that is being modified. This parameter * is not case sensitive.
Constraints:
Must match the
* identifier of an existing DBCluster.
The cluster identifier for the cluster that is being modified. This parameter * is not case sensitive.
Constraints:
Must match the
* identifier of an existing DBCluster.
The cluster identifier for the cluster that is being modified. This parameter * is not case sensitive.
Constraints:
Must match the
* identifier of an existing DBCluster.
The cluster identifier for the cluster that is being modified. This parameter * is not case sensitive.
Constraints:
Must match the
* identifier of an existing DBCluster.
The new cluster identifier for the cluster when renaming a 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.
Cannot end with a hyphen or * contain two consecutive hyphens.
Example:
* my-cluster2
The new cluster identifier for the cluster when renaming a 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.
Cannot end with a hyphen or * contain two consecutive hyphens.
Example:
* my-cluster2
The new cluster identifier for the cluster when renaming a 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.
Cannot end with a hyphen or * contain two consecutive hyphens.
Example:
* my-cluster2
The new cluster identifier for the cluster when renaming a 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.
Cannot end with a hyphen or * contain two consecutive hyphens.
Example:
* my-cluster2
The new cluster identifier for the cluster when renaming a 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.
Cannot end with a hyphen or * contain two consecutive hyphens.
Example:
* my-cluster2
The new cluster identifier for the cluster when renaming a 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.
Cannot end with a hyphen or * contain two consecutive hyphens.
Example:
* my-cluster2
The new cluster identifier for the cluster when renaming a 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.
Cannot end with a hyphen or * contain two consecutive hyphens.
Example:
* my-cluster2
The new cluster identifier for the cluster when renaming a 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.
Cannot end with a hyphen or * contain two consecutive hyphens.
Example:
* my-cluster2
A value that specifies whether the changes in this request and any pending
* changes are asynchronously applied as soon as possible, regardless of the
* PreferredMaintenanceWindow setting for the cluster. If this
* parameter is set to false, changes to the cluster are applied
* during the next maintenance window.
The ApplyImmediately
* parameter affects only the NewDBClusterIdentifier and
* MasterUserPassword values. If you set this parameter value to
* false, the changes to the NewDBClusterIdentifier and
* MasterUserPassword values are applied during the next maintenance
* window. All other changes are applied immediately, regardless of the value of
* the ApplyImmediately parameter.
Default: false
*
A value that specifies whether the changes in this request and any pending
* changes are asynchronously applied as soon as possible, regardless of the
* PreferredMaintenanceWindow setting for the cluster. If this
* parameter is set to false, changes to the cluster are applied
* during the next maintenance window.
The ApplyImmediately
* parameter affects only the NewDBClusterIdentifier and
* MasterUserPassword values. If you set this parameter value to
* false, the changes to the NewDBClusterIdentifier and
* MasterUserPassword values are applied during the next maintenance
* window. All other changes are applied immediately, regardless of the value of
* the ApplyImmediately parameter.
Default: false
*
A value that specifies whether the changes in this request and any pending
* changes are asynchronously applied as soon as possible, regardless of the
* PreferredMaintenanceWindow setting for the cluster. If this
* parameter is set to false, changes to the cluster are applied
* during the next maintenance window.
The ApplyImmediately
* parameter affects only the NewDBClusterIdentifier and
* MasterUserPassword values. If you set this parameter value to
* false, the changes to the NewDBClusterIdentifier and
* MasterUserPassword values are applied during the next maintenance
* window. All other changes are applied immediately, regardless of the value of
* the ApplyImmediately parameter.
Default: false
*
A value that specifies whether the changes in this request and any pending
* changes are asynchronously applied as soon as possible, regardless of the
* PreferredMaintenanceWindow setting for the cluster. If this
* parameter is set to false, changes to the cluster are applied
* during the next maintenance window.
The ApplyImmediately
* parameter affects only the NewDBClusterIdentifier and
* MasterUserPassword values. If you set this parameter value to
* false, the changes to the NewDBClusterIdentifier and
* MasterUserPassword values are applied during the next maintenance
* window. All other changes are applied immediately, regardless of the value of
* the ApplyImmediately parameter.
Default: false
*
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.
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.
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.
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.
The name of the cluster parameter group to use for the cluster.
*/ inline const Aws::String& GetDBClusterParameterGroupName() const{ return m_dBClusterParameterGroupName; } /** *The name of the cluster parameter group to use for the cluster.
*/ inline bool DBClusterParameterGroupNameHasBeenSet() const { return m_dBClusterParameterGroupNameHasBeenSet; } /** *The name of the cluster parameter group to use for the cluster.
*/ inline void SetDBClusterParameterGroupName(const Aws::String& value) { m_dBClusterParameterGroupNameHasBeenSet = true; m_dBClusterParameterGroupName = value; } /** *The name of the cluster parameter group to use for the cluster.
*/ inline void SetDBClusterParameterGroupName(Aws::String&& value) { m_dBClusterParameterGroupNameHasBeenSet = true; m_dBClusterParameterGroupName = std::move(value); } /** *The name of the cluster parameter group to use for the cluster.
*/ inline void SetDBClusterParameterGroupName(const char* value) { m_dBClusterParameterGroupNameHasBeenSet = true; m_dBClusterParameterGroupName.assign(value); } /** *The name of the cluster parameter group to use for the cluster.
*/ inline ModifyDBClusterRequest& WithDBClusterParameterGroupName(const Aws::String& value) { SetDBClusterParameterGroupName(value); return *this;} /** *The name of the cluster parameter group to use for the cluster.
*/ inline ModifyDBClusterRequest& WithDBClusterParameterGroupName(Aws::String&& value) { SetDBClusterParameterGroupName(std::move(value)); return *this;} /** *The name of the cluster parameter group to use for the cluster.
*/ inline ModifyDBClusterRequest& WithDBClusterParameterGroupName(const char* value) { SetDBClusterParameterGroupName(value); return *this;} /** *A list of virtual private cloud (VPC) security groups that the cluster will * belong to.
*/ inline const Aws::VectorA list of virtual private cloud (VPC) security groups that the cluster will * belong to.
*/ inline bool VpcSecurityGroupIdsHasBeenSet() const { return m_vpcSecurityGroupIdsHasBeenSet; } /** *A list of virtual private cloud (VPC) security groups that the cluster will * belong to.
*/ inline void SetVpcSecurityGroupIds(const Aws::VectorA list of virtual private cloud (VPC) security groups that the cluster will * belong to.
*/ inline void SetVpcSecurityGroupIds(Aws::VectorA list of virtual private cloud (VPC) security groups that the cluster will * belong to.
*/ inline ModifyDBClusterRequest& WithVpcSecurityGroupIds(const Aws::VectorA list of virtual private cloud (VPC) security groups that the cluster will * belong to.
*/ inline ModifyDBClusterRequest& WithVpcSecurityGroupIds(Aws::VectorA list of virtual private cloud (VPC) security groups that the cluster will * belong to.
*/ inline ModifyDBClusterRequest& AddVpcSecurityGroupIds(const Aws::String& value) { m_vpcSecurityGroupIdsHasBeenSet = true; m_vpcSecurityGroupIds.push_back(value); return *this; } /** *A list of virtual private cloud (VPC) security groups that the cluster will * belong to.
*/ inline ModifyDBClusterRequest& AddVpcSecurityGroupIds(Aws::String&& value) { m_vpcSecurityGroupIdsHasBeenSet = true; m_vpcSecurityGroupIds.push_back(std::move(value)); return *this; } /** *A list of virtual private cloud (VPC) security groups that the cluster will * belong to.
*/ inline ModifyDBClusterRequest& AddVpcSecurityGroupIds(const char* value) { m_vpcSecurityGroupIdsHasBeenSet = true; m_vpcSecurityGroupIds.push_back(value); return *this; } /** *The port number on which the cluster accepts connections.
Constraints:
* Must be a value from 1150 to 65535.
Default: * The same port as the original cluster.
*/ inline int GetPort() const{ return m_port; } /** *The port number on which the cluster accepts connections.
Constraints:
* Must be a value from 1150 to 65535.
Default: * The same port as the original cluster.
*/ inline bool PortHasBeenSet() const { return m_portHasBeenSet; } /** *The port number on which the cluster accepts connections.
Constraints:
* Must be a value from 1150 to 65535.
Default: * The same port as the original cluster.
*/ inline void SetPort(int value) { m_portHasBeenSet = true; m_port = value; } /** *The port number on which the cluster accepts connections.
Constraints:
* Must be a value from 1150 to 65535.
Default: * The same port as the original cluster.
*/ inline ModifyDBClusterRequest& WithPort(int value) { SetPort(value); return *this;} /** *The password for the master database user. This password can contain any * printable ASCII character except forward slash (/), double quote ("), or the * "at" symbol (@).
Constraints: Must contain from 8 to 100 characters.
*/ inline const Aws::String& GetMasterUserPassword() const{ return m_masterUserPassword; } /** *The password for the master database user. This password can contain any * printable ASCII character except forward slash (/), double quote ("), or the * "at" symbol (@).
Constraints: Must contain from 8 to 100 characters.
*/ inline bool MasterUserPasswordHasBeenSet() const { return m_masterUserPasswordHasBeenSet; } /** *The password for the master database user. This password can contain any * printable ASCII character except forward slash (/), double quote ("), or the * "at" symbol (@).
Constraints: Must contain from 8 to 100 characters.
*/ inline void SetMasterUserPassword(const Aws::String& value) { m_masterUserPasswordHasBeenSet = true; m_masterUserPassword = value; } /** *The password for the master database user. This password can contain any * printable ASCII character except forward slash (/), double quote ("), or the * "at" symbol (@).
Constraints: Must contain from 8 to 100 characters.
*/ inline void SetMasterUserPassword(Aws::String&& value) { m_masterUserPasswordHasBeenSet = true; m_masterUserPassword = std::move(value); } /** *The password for the master database user. This password can contain any * printable ASCII character except forward slash (/), double quote ("), or the * "at" symbol (@).
Constraints: Must contain from 8 to 100 characters.
*/ inline void SetMasterUserPassword(const char* value) { m_masterUserPasswordHasBeenSet = true; m_masterUserPassword.assign(value); } /** *The password for the master database user. This password can contain any * printable ASCII character except forward slash (/), double quote ("), or the * "at" symbol (@).
Constraints: Must contain from 8 to 100 characters.
*/ inline ModifyDBClusterRequest& WithMasterUserPassword(const Aws::String& value) { SetMasterUserPassword(value); return *this;} /** *The password for the master database user. This password can contain any * printable ASCII character except forward slash (/), double quote ("), or the * "at" symbol (@).
Constraints: Must contain from 8 to 100 characters.
*/ inline ModifyDBClusterRequest& WithMasterUserPassword(Aws::String&& value) { SetMasterUserPassword(std::move(value)); return *this;} /** *The password for the master database user. This password can contain any * printable ASCII character except forward slash (/), double quote ("), or the * "at" symbol (@).
Constraints: Must contain from 8 to 100 characters.
*/ inline ModifyDBClusterRequest& WithMasterUserPassword(const char* value) { SetMasterUserPassword(value); return *this;} /** *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.
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.
*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.
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.
*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.
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.
*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.
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.
*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.
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.
*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.
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.
*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.
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.
*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.
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.
*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.
Valid * days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute * window.
*/ inline const Aws::String& GetPreferredMaintenanceWindow() const{ return m_preferredMaintenanceWindow; } /** *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.
Valid * days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute * window.
*/ inline bool PreferredMaintenanceWindowHasBeenSet() const { return m_preferredMaintenanceWindowHasBeenSet; } /** *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.
Valid * days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute * window.
*/ inline void SetPreferredMaintenanceWindow(const Aws::String& value) { m_preferredMaintenanceWindowHasBeenSet = true; m_preferredMaintenanceWindow = value; } /** *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.
Valid * days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute * window.
*/ inline void SetPreferredMaintenanceWindow(Aws::String&& value) { m_preferredMaintenanceWindowHasBeenSet = true; m_preferredMaintenanceWindow = std::move(value); } /** *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.
Valid * days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute * window.
*/ inline void SetPreferredMaintenanceWindow(const char* value) { m_preferredMaintenanceWindowHasBeenSet = true; m_preferredMaintenanceWindow.assign(value); } /** *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.
Valid * days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute * window.
*/ inline ModifyDBClusterRequest& WithPreferredMaintenanceWindow(const Aws::String& value) { SetPreferredMaintenanceWindow(value); return *this;} /** *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.
Valid * days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute * window.
*/ inline ModifyDBClusterRequest& WithPreferredMaintenanceWindow(Aws::String&& value) { SetPreferredMaintenanceWindow(std::move(value)); return *this;} /** *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.
Valid * days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute * window.
*/ inline ModifyDBClusterRequest& WithPreferredMaintenanceWindow(const char* value) { SetPreferredMaintenanceWindow(value); return *this;} /** *The configuration setting for the log types to be enabled for export to
* Amazon CloudWatch Logs for a specific instance or cluster. The
* EnableLogTypes and DisableLogTypes arrays determine
* which logs are exported (or not exported) to CloudWatch Logs.
The configuration setting for the log types to be enabled for export to
* Amazon CloudWatch Logs for a specific instance or cluster. The
* EnableLogTypes and DisableLogTypes arrays determine
* which logs are exported (or not exported) to CloudWatch Logs.
The configuration setting for the log types to be enabled for export to
* Amazon CloudWatch Logs for a specific instance or cluster. The
* EnableLogTypes and DisableLogTypes arrays determine
* which logs are exported (or not exported) to CloudWatch Logs.
The configuration setting for the log types to be enabled for export to
* Amazon CloudWatch Logs for a specific instance or cluster. The
* EnableLogTypes and DisableLogTypes arrays determine
* which logs are exported (or not exported) to CloudWatch Logs.
The configuration setting for the log types to be enabled for export to
* Amazon CloudWatch Logs for a specific instance or cluster. The
* EnableLogTypes and DisableLogTypes arrays determine
* which logs are exported (or not exported) to CloudWatch Logs.
The configuration setting for the log types to be enabled for export to
* Amazon CloudWatch Logs for a specific instance or cluster. The
* EnableLogTypes and DisableLogTypes arrays determine
* which logs are exported (or not exported) to CloudWatch Logs.
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 the ApplyImmediately parameter is
* set to true.
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 the ApplyImmediately parameter is
* set to true.
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 the ApplyImmediately parameter is
* set to true.
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 the ApplyImmediately parameter is
* set to true.
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 the ApplyImmediately parameter is
* set to true.
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 the ApplyImmediately parameter is
* set to true.
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 the ApplyImmediately parameter is
* set to true.
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 the ApplyImmediately parameter is
* set to true.
Specifies whether this cluster can be deleted. If
* DeletionProtection is enabled, the cluster cannot be deleted unless
* it is modified and DeletionProtection is disabled.
* DeletionProtection protects clusters from being accidentally
* deleted.
Specifies whether this cluster can be deleted. If
* DeletionProtection is enabled, the cluster cannot be deleted unless
* it is modified and DeletionProtection is disabled.
* DeletionProtection protects clusters from being accidentally
* deleted.
Specifies whether this cluster can be deleted. If
* DeletionProtection is enabled, the cluster cannot be deleted unless
* it is modified and DeletionProtection is disabled.
* DeletionProtection protects clusters from being accidentally
* deleted.
Specifies whether this cluster can be deleted. If
* DeletionProtection is enabled, the cluster cannot be deleted unless
* it is modified and DeletionProtection is disabled.
* DeletionProtection protects clusters from being accidentally
* deleted.