/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include See Also:
AWS
* API Reference
The DB cluster identifier for the cluster being modified. This parameter * isn't case-sensitive.
Valid for Cluster Type: Aurora DB clusters and * Multi-AZ DB clusters
Constraints:
Must match the * identifier of an existing DB cluster.
The DB cluster identifier for the cluster being modified. This parameter * isn't case-sensitive.
Valid for Cluster Type: Aurora DB clusters and * Multi-AZ DB clusters
Constraints:
Must match the * identifier of an existing DB cluster.
The DB cluster identifier for the cluster being modified. This parameter * isn't case-sensitive.
Valid for Cluster Type: Aurora DB clusters and * Multi-AZ DB clusters
Constraints:
Must match the * identifier of an existing DB cluster.
The DB cluster identifier for the cluster being modified. This parameter * isn't case-sensitive.
Valid for Cluster Type: Aurora DB clusters and * Multi-AZ DB clusters
Constraints:
Must match the * identifier of an existing DB cluster.
The DB cluster identifier for the cluster being modified. This parameter * isn't case-sensitive.
Valid for Cluster Type: Aurora DB clusters and * Multi-AZ DB clusters
Constraints:
Must match the * identifier of an existing DB cluster.
The DB cluster identifier for the cluster being modified. This parameter * isn't case-sensitive.
Valid for Cluster Type: Aurora DB clusters and * Multi-AZ DB clusters
Constraints:
Must match the * identifier of an existing DB cluster.
The DB cluster identifier for the cluster being modified. This parameter * isn't case-sensitive.
Valid for Cluster Type: Aurora DB clusters and * Multi-AZ DB clusters
Constraints:
Must match the * identifier of an existing DB cluster.
The DB cluster identifier for the cluster being modified. This parameter * isn't case-sensitive.
Valid for Cluster Type: Aurora DB clusters and * Multi-AZ DB clusters
Constraints:
Must match the * identifier of an existing DB cluster.
The new DB cluster identifier for the DB cluster when renaming a DB cluster. * This value is stored as a lowercase string.
Valid for Cluster Type: * Aurora DB clusters and Multi-AZ DB clusters
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
The new DB cluster identifier for the DB cluster when renaming a DB cluster. * This value is stored as a lowercase string.
Valid for Cluster Type: * Aurora DB clusters and Multi-AZ DB clusters
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
The new DB cluster identifier for the DB cluster when renaming a DB cluster. * This value is stored as a lowercase string.
Valid for Cluster Type: * Aurora DB clusters and Multi-AZ DB clusters
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
The new DB cluster identifier for the DB cluster when renaming a DB cluster. * This value is stored as a lowercase string.
Valid for Cluster Type: * Aurora DB clusters and Multi-AZ DB clusters
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
The new DB cluster identifier for the DB cluster when renaming a DB cluster. * This value is stored as a lowercase string.
Valid for Cluster Type: * Aurora DB clusters and Multi-AZ DB clusters
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
The new DB cluster identifier for the DB cluster when renaming a DB cluster. * This value is stored as a lowercase string.
Valid for Cluster Type: * Aurora DB clusters and Multi-AZ DB clusters
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
The new DB cluster identifier for the DB cluster when renaming a DB cluster. * This value is stored as a lowercase string.
Valid for Cluster Type: * Aurora DB clusters and Multi-AZ DB clusters
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
The new DB cluster identifier for the DB cluster when renaming a DB cluster. * This value is stored as a lowercase string.
Valid for Cluster Type: * Aurora DB clusters and Multi-AZ DB clusters
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
Specifies 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.
Most modifications can be applied immediately or * during the next scheduled maintenance window. Some modifications, such as * turning on deletion protection and changing the master password, are applied * immediately—regardless of when you choose to apply them.
By default, this * parameter is disabled.
Valid for Cluster Type: Aurora DB clusters and * Multi-AZ DB clusters
*/ inline bool GetApplyImmediately() const{ return m_applyImmediately; } /** *Specifies 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.
Most modifications can be applied immediately or * during the next scheduled maintenance window. Some modifications, such as * turning on deletion protection and changing the master password, are applied * immediately—regardless of when you choose to apply them.
By default, this * parameter is disabled.
Valid for Cluster Type: Aurora DB clusters and * Multi-AZ DB clusters
*/ inline bool ApplyImmediatelyHasBeenSet() const { return m_applyImmediatelyHasBeenSet; } /** *Specifies 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.
Most modifications can be applied immediately or * during the next scheduled maintenance window. Some modifications, such as * turning on deletion protection and changing the master password, are applied * immediately—regardless of when you choose to apply them.
By default, this * parameter is disabled.
Valid for Cluster Type: Aurora DB clusters and * Multi-AZ DB clusters
*/ inline void SetApplyImmediately(bool value) { m_applyImmediatelyHasBeenSet = true; m_applyImmediately = value; } /** *Specifies 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.
Most modifications can be applied immediately or * during the next scheduled maintenance window. Some modifications, such as * turning on deletion protection and changing the master password, are applied * immediately—regardless of when you choose to apply them.
By default, this * parameter is disabled.
Valid for Cluster Type: Aurora DB clusters and * Multi-AZ DB clusters
*/ inline ModifyDBClusterRequest& WithApplyImmediately(bool value) { SetApplyImmediately(value); return *this;} /** *The number of days for which automated backups are retained. Specify a
* minimum value of 1
.
Valid for Cluster Type: Aurora DB * clusters and Multi-AZ DB clusters
Default: 1
Constraints:
Must be a value from 1 to 35.
The number of days for which automated backups are retained. Specify a
* minimum value of 1
.
Valid for Cluster Type: Aurora DB * clusters and Multi-AZ DB clusters
Default: 1
Constraints:
Must be a value from 1 to 35.
The number of days for which automated backups are retained. Specify a
* minimum value of 1
.
Valid for Cluster Type: Aurora DB * clusters and Multi-AZ DB clusters
Default: 1
Constraints:
Must be a value from 1 to 35.
The number of days for which automated backups are retained. Specify a
* minimum value of 1
.
Valid for Cluster Type: Aurora DB * clusters and Multi-AZ DB clusters
Default: 1
Constraints:
Must be a value from 1 to 35.
The name of the DB cluster parameter group to use for the DB cluster.
*Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
*/ inline const Aws::String& GetDBClusterParameterGroupName() const{ return m_dBClusterParameterGroupName; } /** *The name of the DB cluster parameter group to use for the DB cluster.
*Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
*/ inline bool DBClusterParameterGroupNameHasBeenSet() const { return m_dBClusterParameterGroupNameHasBeenSet; } /** *The name of the DB cluster parameter group to use for the DB cluster.
*Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
*/ inline void SetDBClusterParameterGroupName(const Aws::String& value) { m_dBClusterParameterGroupNameHasBeenSet = true; m_dBClusterParameterGroupName = value; } /** *The name of the DB cluster parameter group to use for the DB cluster.
*Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
*/ inline void SetDBClusterParameterGroupName(Aws::String&& value) { m_dBClusterParameterGroupNameHasBeenSet = true; m_dBClusterParameterGroupName = std::move(value); } /** *The name of the DB cluster parameter group to use for the DB cluster.
*Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
*/ inline void SetDBClusterParameterGroupName(const char* value) { m_dBClusterParameterGroupNameHasBeenSet = true; m_dBClusterParameterGroupName.assign(value); } /** *The name of the DB cluster parameter group to use for the DB cluster.
*Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
*/ inline ModifyDBClusterRequest& WithDBClusterParameterGroupName(const Aws::String& value) { SetDBClusterParameterGroupName(value); return *this;} /** *The name of the DB cluster parameter group to use for the DB cluster.
*Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
*/ inline ModifyDBClusterRequest& WithDBClusterParameterGroupName(Aws::String&& value) { SetDBClusterParameterGroupName(std::move(value)); return *this;} /** *The name of the DB cluster parameter group to use for the DB cluster.
*Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
*/ inline ModifyDBClusterRequest& WithDBClusterParameterGroupName(const char* value) { SetDBClusterParameterGroupName(value); return *this;} /** *A list of EC2 VPC security groups to associate with this DB cluster.
*Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
*/ inline const Aws::VectorA list of EC2 VPC security groups to associate with this DB cluster.
*Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
*/ inline bool VpcSecurityGroupIdsHasBeenSet() const { return m_vpcSecurityGroupIdsHasBeenSet; } /** *A list of EC2 VPC security groups to associate with this DB cluster.
*Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
*/ inline void SetVpcSecurityGroupIds(const Aws::VectorA list of EC2 VPC security groups to associate with this DB cluster.
*Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
*/ inline void SetVpcSecurityGroupIds(Aws::VectorA list of EC2 VPC security groups to associate with this DB cluster.
*Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
*/ inline ModifyDBClusterRequest& WithVpcSecurityGroupIds(const Aws::VectorA list of EC2 VPC security groups to associate with this DB cluster.
*Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
*/ inline ModifyDBClusterRequest& WithVpcSecurityGroupIds(Aws::VectorA list of EC2 VPC security groups to associate with this DB cluster.
*Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
*/ inline ModifyDBClusterRequest& AddVpcSecurityGroupIds(const Aws::String& value) { m_vpcSecurityGroupIdsHasBeenSet = true; m_vpcSecurityGroupIds.push_back(value); return *this; } /** *A list of EC2 VPC security groups to associate with this DB cluster.
*Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
*/ inline ModifyDBClusterRequest& AddVpcSecurityGroupIds(Aws::String&& value) { m_vpcSecurityGroupIdsHasBeenSet = true; m_vpcSecurityGroupIds.push_back(std::move(value)); return *this; } /** *A list of EC2 VPC security groups to associate with this DB cluster.
*Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
*/ inline ModifyDBClusterRequest& AddVpcSecurityGroupIds(const char* value) { m_vpcSecurityGroupIdsHasBeenSet = true; m_vpcSecurityGroupIds.push_back(value); return *this; } /** *The port number on which the DB cluster accepts connections.
Valid for * Cluster Type: Aurora DB clusters only
Valid Values:
* 1150-65535
Default: The same port as the original DB * cluster.
*/ inline int GetPort() const{ return m_port; } /** *The port number on which the DB cluster accepts connections.
Valid for * Cluster Type: Aurora DB clusters only
Valid Values:
* 1150-65535
Default: The same port as the original DB * cluster.
*/ inline bool PortHasBeenSet() const { return m_portHasBeenSet; } /** *The port number on which the DB cluster accepts connections.
Valid for * Cluster Type: Aurora DB clusters only
Valid Values:
* 1150-65535
Default: The same port as the original DB * cluster.
*/ inline void SetPort(int value) { m_portHasBeenSet = true; m_port = value; } /** *The port number on which the DB cluster accepts connections.
Valid for * Cluster Type: Aurora DB clusters only
Valid Values:
* 1150-65535
Default: The same port as the original DB * cluster.
*/ inline ModifyDBClusterRequest& WithPort(int value) { SetPort(value); return *this;} /** *The new password for the master database user.
Valid for Cluster Type: * Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must contain from 8 to 41 characters.
Can contain any * printable ASCII character except "/", """, or "@".
Can't be
* specified if ManageMasterUserPassword
is turned on.
The new password for the master database user.
Valid for Cluster Type: * Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must contain from 8 to 41 characters.
Can contain any * printable ASCII character except "/", """, or "@".
Can't be
* specified if ManageMasterUserPassword
is turned on.
The new password for the master database user.
Valid for Cluster Type: * Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must contain from 8 to 41 characters.
Can contain any * printable ASCII character except "/", """, or "@".
Can't be
* specified if ManageMasterUserPassword
is turned on.
The new password for the master database user.
Valid for Cluster Type: * Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must contain from 8 to 41 characters.
Can contain any * printable ASCII character except "/", """, or "@".
Can't be
* specified if ManageMasterUserPassword
is turned on.
The new password for the master database user.
Valid for Cluster Type: * Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must contain from 8 to 41 characters.
Can contain any * printable ASCII character except "/", """, or "@".
Can't be
* specified if ManageMasterUserPassword
is turned on.
The new password for the master database user.
Valid for Cluster Type: * Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must contain from 8 to 41 characters.
Can contain any * printable ASCII character except "/", """, or "@".
Can't be
* specified if ManageMasterUserPassword
is turned on.
The new password for the master database user.
Valid for Cluster Type: * Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must contain from 8 to 41 characters.
Can contain any * printable ASCII character except "/", """, or "@".
Can't be
* specified if ManageMasterUserPassword
is turned on.
The new password for the master database user.
Valid for Cluster Type: * Aurora DB clusters and Multi-AZ DB clusters
Constraints:
Must contain from 8 to 41 characters.
Can contain any * printable ASCII character except "/", """, or "@".
Can't be
* specified if ManageMasterUserPassword
is turned on.
The option group to associate the DB cluster with.
DB clusters are * associated with a default option group that can't be modified.
*/ inline const Aws::String& GetOptionGroupName() const{ return m_optionGroupName; } /** *The option group to associate the DB cluster with.
DB clusters are * associated with a default option group that can't be modified.
*/ inline bool OptionGroupNameHasBeenSet() const { return m_optionGroupNameHasBeenSet; } /** *The option group to associate the DB cluster with.
DB clusters are * associated with a default option group that can't be modified.
*/ inline void SetOptionGroupName(const Aws::String& value) { m_optionGroupNameHasBeenSet = true; m_optionGroupName = value; } /** *The option group to associate the DB cluster with.
DB clusters are * associated with a default option group that can't be modified.
*/ inline void SetOptionGroupName(Aws::String&& value) { m_optionGroupNameHasBeenSet = true; m_optionGroupName = std::move(value); } /** *The option group to associate the DB cluster with.
DB clusters are * associated with a default option group that can't be modified.
*/ inline void SetOptionGroupName(const char* value) { m_optionGroupNameHasBeenSet = true; m_optionGroupName.assign(value); } /** *The option group to associate the DB cluster with.
DB clusters are * associated with a default option group that can't be modified.
*/ inline ModifyDBClusterRequest& WithOptionGroupName(const Aws::String& value) { SetOptionGroupName(value); return *this;} /** *The option group to associate the DB cluster with.
DB clusters are * associated with a default option group that can't be modified.
*/ inline ModifyDBClusterRequest& WithOptionGroupName(Aws::String&& value) { SetOptionGroupName(std::move(value)); return *this;} /** *The option group to associate the DB cluster with.
DB clusters are * associated with a default option group that can't be modified.
*/ inline ModifyDBClusterRequest& WithOptionGroupName(const char* value) { SetOptionGroupName(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 Amazon Web Services Region. To view the time blocks available, see * * Backup window in the Amazon Aurora User Guide.
Valid for * Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
*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 Amazon Web Services Region. To view the time blocks available, see * * Backup window in the Amazon Aurora User Guide.
Valid for * Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
*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 Amazon Web Services Region. To view the time blocks available, see * * Backup window in the Amazon Aurora User Guide.
Valid for * Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
*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 Amazon Web Services Region. To view the time blocks available, see * * Backup window in the Amazon Aurora User Guide.
Valid for * Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
*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 Amazon Web Services Region. To view the time blocks available, see * * Backup window in the Amazon Aurora User Guide.
Valid for * Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
*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 Amazon Web Services Region. To view the time blocks available, see * * Backup window in the Amazon Aurora User Guide.
Valid for * Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
*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 Amazon Web Services Region. To view the time blocks available, see * * Backup window in the Amazon Aurora User Guide.
Valid for * Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
*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 Amazon Web Services Region. To view the time blocks available, see * * Backup window in the Amazon Aurora User Guide.
Valid for * Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
*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).
Valid for Cluster Type: Aurora DB clusters and * Multi-AZ DB clusters
The default is a 30-minute window selected at random * from an 8-hour block of time for each Amazon Web Services 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.
Constraints:
Must be in the
* format ddd:hh24:mi-ddd:hh24:mi
.
Days must be one
* of Mon | Tue | Wed | Thu | Fri | Sat | Sun
.
Must * be in Universal Coordinated Time (UTC).
Must be at least 30 * minutes.
The weekly time range during which system maintenance can occur, in Universal * Coordinated Time (UTC).
Valid for Cluster Type: Aurora DB clusters and * Multi-AZ DB clusters
The default is a 30-minute window selected at random * from an 8-hour block of time for each Amazon Web Services 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.
Constraints:
Must be in the
* format ddd:hh24:mi-ddd:hh24:mi
.
Days must be one
* of Mon | Tue | Wed | Thu | Fri | Sat | Sun
.
Must * be in Universal Coordinated Time (UTC).
Must be at least 30 * minutes.
The weekly time range during which system maintenance can occur, in Universal * Coordinated Time (UTC).
Valid for Cluster Type: Aurora DB clusters and * Multi-AZ DB clusters
The default is a 30-minute window selected at random * from an 8-hour block of time for each Amazon Web Services 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.
Constraints:
Must be in the
* format ddd:hh24:mi-ddd:hh24:mi
.
Days must be one
* of Mon | Tue | Wed | Thu | Fri | Sat | Sun
.
Must * be in Universal Coordinated Time (UTC).
Must be at least 30 * minutes.
The weekly time range during which system maintenance can occur, in Universal * Coordinated Time (UTC).
Valid for Cluster Type: Aurora DB clusters and * Multi-AZ DB clusters
The default is a 30-minute window selected at random * from an 8-hour block of time for each Amazon Web Services 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.
Constraints:
Must be in the
* format ddd:hh24:mi-ddd:hh24:mi
.
Days must be one
* of Mon | Tue | Wed | Thu | Fri | Sat | Sun
.
Must * be in Universal Coordinated Time (UTC).
Must be at least 30 * minutes.
The weekly time range during which system maintenance can occur, in Universal * Coordinated Time (UTC).
Valid for Cluster Type: Aurora DB clusters and * Multi-AZ DB clusters
The default is a 30-minute window selected at random * from an 8-hour block of time for each Amazon Web Services 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.
Constraints:
Must be in the
* format ddd:hh24:mi-ddd:hh24:mi
.
Days must be one
* of Mon | Tue | Wed | Thu | Fri | Sat | Sun
.
Must * be in Universal Coordinated Time (UTC).
Must be at least 30 * minutes.
The weekly time range during which system maintenance can occur, in Universal * Coordinated Time (UTC).
Valid for Cluster Type: Aurora DB clusters and * Multi-AZ DB clusters
The default is a 30-minute window selected at random * from an 8-hour block of time for each Amazon Web Services 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.
Constraints:
Must be in the
* format ddd:hh24:mi-ddd:hh24:mi
.
Days must be one
* of Mon | Tue | Wed | Thu | Fri | Sat | Sun
.
Must * be in Universal Coordinated Time (UTC).
Must be at least 30 * minutes.
The weekly time range during which system maintenance can occur, in Universal * Coordinated Time (UTC).
Valid for Cluster Type: Aurora DB clusters and * Multi-AZ DB clusters
The default is a 30-minute window selected at random * from an 8-hour block of time for each Amazon Web Services 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.
Constraints:
Must be in the
* format ddd:hh24:mi-ddd:hh24:mi
.
Days must be one
* of Mon | Tue | Wed | Thu | Fri | Sat | Sun
.
Must * be in Universal Coordinated Time (UTC).
Must be at least 30 * minutes.
The weekly time range during which system maintenance can occur, in Universal * Coordinated Time (UTC).
Valid for Cluster Type: Aurora DB clusters and * Multi-AZ DB clusters
The default is a 30-minute window selected at random * from an 8-hour block of time for each Amazon Web Services 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.
Constraints:
Must be in the
* format ddd:hh24:mi-ddd:hh24:mi
.
Days must be one
* of Mon | Tue | Wed | Thu | Fri | Sat | Sun
.
Must * be in Universal Coordinated Time (UTC).
Must be at least 30 * minutes.
Specifies whether to enable mapping of Amazon Web Services Identity and * Access Management (IAM) accounts to database accounts. By default, mapping isn't * enabled.
For more information, see * IAM Database Authentication in the Amazon Aurora User Guide.
*Valid for Cluster Type: Aurora DB clusters only
*/ inline bool GetEnableIAMDatabaseAuthentication() const{ return m_enableIAMDatabaseAuthentication; } /** *Specifies whether to enable mapping of Amazon Web Services Identity and * Access Management (IAM) accounts to database accounts. By default, mapping isn't * enabled.
For more information, see * IAM Database Authentication in the Amazon Aurora User Guide.
*Valid for Cluster Type: Aurora DB clusters only
*/ inline bool EnableIAMDatabaseAuthenticationHasBeenSet() const { return m_enableIAMDatabaseAuthenticationHasBeenSet; } /** *Specifies whether to enable mapping of Amazon Web Services Identity and * Access Management (IAM) accounts to database accounts. By default, mapping isn't * enabled.
For more information, see * IAM Database Authentication in the Amazon Aurora User Guide.
*Valid for Cluster Type: Aurora DB clusters only
*/ inline void SetEnableIAMDatabaseAuthentication(bool value) { m_enableIAMDatabaseAuthenticationHasBeenSet = true; m_enableIAMDatabaseAuthentication = value; } /** *Specifies whether to enable mapping of Amazon Web Services Identity and * Access Management (IAM) accounts to database accounts. By default, mapping isn't * enabled.
For more information, see * IAM Database Authentication in the Amazon Aurora User Guide.
*Valid for Cluster Type: Aurora DB clusters only
*/ inline ModifyDBClusterRequest& WithEnableIAMDatabaseAuthentication(bool value) { SetEnableIAMDatabaseAuthentication(value); return *this;} /** *The target backtrack window, in seconds. To disable backtracking, set this
* value to 0
.
Valid for Cluster Type: Aurora MySQL DB clusters * only
Default: 0
Constraints:
If * specified, this value must be set to a number from 0 to 259,200 (72 hours).
*The target backtrack window, in seconds. To disable backtracking, set this
* value to 0
.
Valid for Cluster Type: Aurora MySQL DB clusters * only
Default: 0
Constraints:
If * specified, this value must be set to a number from 0 to 259,200 (72 hours).
*The target backtrack window, in seconds. To disable backtracking, set this
* value to 0
.
Valid for Cluster Type: Aurora MySQL DB clusters * only
Default: 0
Constraints:
If * specified, this value must be set to a number from 0 to 259,200 (72 hours).
*The target backtrack window, in seconds. To disable backtracking, set this
* value to 0
.
Valid for Cluster Type: Aurora MySQL DB clusters * only
Default: 0
Constraints:
If * specified, this value must be set to a number from 0 to 259,200 (72 hours).
*The configuration setting for the log types to be enabled for export to * CloudWatch Logs for a specific DB cluster.
Valid for Cluster Type: Aurora * DB clusters and Multi-AZ DB clusters
The following values are valid for * each DB engine:
Aurora MySQL - audit | error | general |
* slowquery
Aurora PostgreSQL - postgresql
*
RDS for MySQL - error | general | slowquery
RDS for PostgreSQL - postgresql | upgrade
For more information about exporting CloudWatch Logs for Amazon RDS, * see * Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User * Guide.
For more information about exporting CloudWatch Logs for * Amazon Aurora, see Publishing * Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User * Guide.
*/ inline const CloudwatchLogsExportConfiguration& GetCloudwatchLogsExportConfiguration() const{ return m_cloudwatchLogsExportConfiguration; } /** *The configuration setting for the log types to be enabled for export to * CloudWatch Logs for a specific DB cluster.
Valid for Cluster Type: Aurora * DB clusters and Multi-AZ DB clusters
The following values are valid for * each DB engine:
Aurora MySQL - audit | error | general |
* slowquery
Aurora PostgreSQL - postgresql
*
RDS for MySQL - error | general | slowquery
RDS for PostgreSQL - postgresql | upgrade
For more information about exporting CloudWatch Logs for Amazon RDS, * see * Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User * Guide.
For more information about exporting CloudWatch Logs for * Amazon Aurora, see Publishing * Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User * Guide.
*/ inline bool CloudwatchLogsExportConfigurationHasBeenSet() const { return m_cloudwatchLogsExportConfigurationHasBeenSet; } /** *The configuration setting for the log types to be enabled for export to * CloudWatch Logs for a specific DB cluster.
Valid for Cluster Type: Aurora * DB clusters and Multi-AZ DB clusters
The following values are valid for * each DB engine:
Aurora MySQL - audit | error | general |
* slowquery
Aurora PostgreSQL - postgresql
*
RDS for MySQL - error | general | slowquery
RDS for PostgreSQL - postgresql | upgrade
For more information about exporting CloudWatch Logs for Amazon RDS, * see * Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User * Guide.
For more information about exporting CloudWatch Logs for * Amazon Aurora, see Publishing * Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User * Guide.
*/ inline void SetCloudwatchLogsExportConfiguration(const CloudwatchLogsExportConfiguration& value) { m_cloudwatchLogsExportConfigurationHasBeenSet = true; m_cloudwatchLogsExportConfiguration = value; } /** *The configuration setting for the log types to be enabled for export to * CloudWatch Logs for a specific DB cluster.
Valid for Cluster Type: Aurora * DB clusters and Multi-AZ DB clusters
The following values are valid for * each DB engine:
Aurora MySQL - audit | error | general |
* slowquery
Aurora PostgreSQL - postgresql
*
RDS for MySQL - error | general | slowquery
RDS for PostgreSQL - postgresql | upgrade
For more information about exporting CloudWatch Logs for Amazon RDS, * see * Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User * Guide.
For more information about exporting CloudWatch Logs for * Amazon Aurora, see Publishing * Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User * Guide.
*/ inline void SetCloudwatchLogsExportConfiguration(CloudwatchLogsExportConfiguration&& value) { m_cloudwatchLogsExportConfigurationHasBeenSet = true; m_cloudwatchLogsExportConfiguration = std::move(value); } /** *The configuration setting for the log types to be enabled for export to * CloudWatch Logs for a specific DB cluster.
Valid for Cluster Type: Aurora * DB clusters and Multi-AZ DB clusters
The following values are valid for * each DB engine:
Aurora MySQL - audit | error | general |
* slowquery
Aurora PostgreSQL - postgresql
*
RDS for MySQL - error | general | slowquery
RDS for PostgreSQL - postgresql | upgrade
For more information about exporting CloudWatch Logs for Amazon RDS, * see * Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User * Guide.
For more information about exporting CloudWatch Logs for * Amazon Aurora, see Publishing * Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User * Guide.
*/ inline ModifyDBClusterRequest& WithCloudwatchLogsExportConfiguration(const CloudwatchLogsExportConfiguration& value) { SetCloudwatchLogsExportConfiguration(value); return *this;} /** *The configuration setting for the log types to be enabled for export to * CloudWatch Logs for a specific DB cluster.
Valid for Cluster Type: Aurora * DB clusters and Multi-AZ DB clusters
The following values are valid for * each DB engine:
Aurora MySQL - audit | error | general |
* slowquery
Aurora PostgreSQL - postgresql
*
RDS for MySQL - error | general | slowquery
RDS for PostgreSQL - postgresql | upgrade
For more information about exporting CloudWatch Logs for Amazon RDS, * see * Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User * Guide.
For more information about exporting CloudWatch Logs for * Amazon Aurora, see Publishing * Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User * Guide.
*/ inline ModifyDBClusterRequest& WithCloudwatchLogsExportConfiguration(CloudwatchLogsExportConfiguration&& value) { SetCloudwatchLogsExportConfiguration(std::move(value)); return *this;} /** *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.
If the cluster that you're modifying has one or more read replicas, all * replicas must be running an engine version that's the same or later than the * version you specify.
To list all of the available engine versions for * Aurora MySQL, 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"
To list all of the available * engine versions for RDS for MySQL, use the following command:
aws
* rds describe-db-engine-versions --engine mysql --query
* "DBEngineVersions[].EngineVersion"
To list all of the available * engine versions for RDS for PostgreSQL, use the following command:
* aws rds describe-db-engine-versions --engine postgres --query
* "DBEngineVersions[].EngineVersion"
Valid for Cluster Type: Aurora * DB clusters and Multi-AZ DB clusters
*/ inline const Aws::String& GetEngineVersion() const{ return m_engineVersion; } /** *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.
If the cluster that you're modifying has one or more read replicas, all * replicas must be running an engine version that's the same or later than the * version you specify.
To list all of the available engine versions for * Aurora MySQL, 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"
To list all of the available * engine versions for RDS for MySQL, use the following command:
aws
* rds describe-db-engine-versions --engine mysql --query
* "DBEngineVersions[].EngineVersion"
To list all of the available * engine versions for RDS for PostgreSQL, use the following command:
* aws rds describe-db-engine-versions --engine postgres --query
* "DBEngineVersions[].EngineVersion"
Valid for Cluster Type: Aurora * DB clusters and Multi-AZ DB clusters
*/ inline bool EngineVersionHasBeenSet() const { return m_engineVersionHasBeenSet; } /** *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.
If the cluster that you're modifying has one or more read replicas, all * replicas must be running an engine version that's the same or later than the * version you specify.
To list all of the available engine versions for * Aurora MySQL, 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"
To list all of the available * engine versions for RDS for MySQL, use the following command:
aws
* rds describe-db-engine-versions --engine mysql --query
* "DBEngineVersions[].EngineVersion"
To list all of the available * engine versions for RDS for PostgreSQL, use the following command:
* aws rds describe-db-engine-versions --engine postgres --query
* "DBEngineVersions[].EngineVersion"
Valid for Cluster Type: Aurora * DB clusters and Multi-AZ DB clusters
*/ inline void SetEngineVersion(const Aws::String& value) { m_engineVersionHasBeenSet = true; m_engineVersion = value; } /** *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.
If the cluster that you're modifying has one or more read replicas, all * replicas must be running an engine version that's the same or later than the * version you specify.
To list all of the available engine versions for * Aurora MySQL, 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"
To list all of the available * engine versions for RDS for MySQL, use the following command:
aws
* rds describe-db-engine-versions --engine mysql --query
* "DBEngineVersions[].EngineVersion"
To list all of the available * engine versions for RDS for PostgreSQL, use the following command:
* aws rds describe-db-engine-versions --engine postgres --query
* "DBEngineVersions[].EngineVersion"
Valid for Cluster Type: Aurora * DB clusters and Multi-AZ DB clusters
*/ inline void SetEngineVersion(Aws::String&& value) { m_engineVersionHasBeenSet = true; m_engineVersion = std::move(value); } /** *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.
If the cluster that you're modifying has one or more read replicas, all * replicas must be running an engine version that's the same or later than the * version you specify.
To list all of the available engine versions for * Aurora MySQL, 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"
To list all of the available * engine versions for RDS for MySQL, use the following command:
aws
* rds describe-db-engine-versions --engine mysql --query
* "DBEngineVersions[].EngineVersion"
To list all of the available * engine versions for RDS for PostgreSQL, use the following command:
* aws rds describe-db-engine-versions --engine postgres --query
* "DBEngineVersions[].EngineVersion"
Valid for Cluster Type: Aurora * DB clusters and Multi-AZ DB clusters
*/ inline void SetEngineVersion(const char* value) { m_engineVersionHasBeenSet = true; m_engineVersion.assign(value); } /** *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.
If the cluster that you're modifying has one or more read replicas, all * replicas must be running an engine version that's the same or later than the * version you specify.
To list all of the available engine versions for * Aurora MySQL, 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"
To list all of the available * engine versions for RDS for MySQL, use the following command:
aws
* rds describe-db-engine-versions --engine mysql --query
* "DBEngineVersions[].EngineVersion"
To list all of the available * engine versions for RDS for PostgreSQL, use the following command:
* aws rds describe-db-engine-versions --engine postgres --query
* "DBEngineVersions[].EngineVersion"
Valid for Cluster Type: Aurora * DB clusters and Multi-AZ DB clusters
*/ inline ModifyDBClusterRequest& WithEngineVersion(const Aws::String& value) { SetEngineVersion(value); return *this;} /** *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.
If the cluster that you're modifying has one or more read replicas, all * replicas must be running an engine version that's the same or later than the * version you specify.
To list all of the available engine versions for * Aurora MySQL, 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"
To list all of the available * engine versions for RDS for MySQL, use the following command:
aws
* rds describe-db-engine-versions --engine mysql --query
* "DBEngineVersions[].EngineVersion"
To list all of the available * engine versions for RDS for PostgreSQL, use the following command:
* aws rds describe-db-engine-versions --engine postgres --query
* "DBEngineVersions[].EngineVersion"
Valid for Cluster Type: Aurora * DB clusters and Multi-AZ DB clusters
*/ inline ModifyDBClusterRequest& WithEngineVersion(Aws::String&& value) { SetEngineVersion(std::move(value)); return *this;} /** *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.
If the cluster that you're modifying has one or more read replicas, all * replicas must be running an engine version that's the same or later than the * version you specify.
To list all of the available engine versions for * Aurora MySQL, 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"
To list all of the available * engine versions for RDS for MySQL, use the following command:
aws
* rds describe-db-engine-versions --engine mysql --query
* "DBEngineVersions[].EngineVersion"
To list all of the available * engine versions for RDS for PostgreSQL, use the following command:
* aws rds describe-db-engine-versions --engine postgres --query
* "DBEngineVersions[].EngineVersion"
Valid for Cluster Type: Aurora * DB clusters and Multi-AZ DB clusters
*/ inline ModifyDBClusterRequest& WithEngineVersion(const char* value) { SetEngineVersion(value); return *this;} /** *Specifies whether major version upgrades are allowed.
Valid for * Cluster Type: Aurora DB clusters only
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.
Specifies whether major version upgrades are allowed.
Valid for * Cluster Type: Aurora DB clusters only
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.
Specifies whether major version upgrades are allowed.
Valid for * Cluster Type: Aurora DB clusters only
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.
Specifies whether major version upgrades are allowed.
Valid for * Cluster Type: Aurora DB clusters only
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.
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 are applied immediately rather
* than during the next maintenance window.
Valid for Cluster Type: * Aurora DB clusters only
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 valid in combination with
* the AllowMajorVersionUpgrade
parameter for a major version upgrade
* only.
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 are applied immediately rather
* than during the next maintenance window.
Valid for Cluster Type: * Aurora DB clusters only
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 valid in combination with
* the AllowMajorVersionUpgrade
parameter for a major version upgrade
* only.
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 are applied immediately rather
* than during the next maintenance window.
Valid for Cluster Type: * Aurora DB clusters only
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 valid in combination with
* the AllowMajorVersionUpgrade
parameter for a major version upgrade
* only.
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 are applied immediately rather
* than during the next maintenance window.
Valid for Cluster Type: * Aurora DB clusters only
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 valid in combination with
* the AllowMajorVersionUpgrade
parameter for a major version upgrade
* only.
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 are applied immediately rather
* than during the next maintenance window.
Valid for Cluster Type: * Aurora DB clusters only
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 valid in combination with
* the AllowMajorVersionUpgrade
parameter for a major version upgrade
* only.
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 are applied immediately rather
* than during the next maintenance window.
Valid for Cluster Type: * Aurora DB clusters only
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 valid in combination with
* the AllowMajorVersionUpgrade
parameter for a major version upgrade
* only.
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 are applied immediately rather
* than during the next maintenance window.
Valid for Cluster Type: * Aurora DB clusters only
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 valid in combination with
* the AllowMajorVersionUpgrade
parameter for a major version upgrade
* only.
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 are applied immediately rather
* than during the next maintenance window.
Valid for Cluster Type: * Aurora DB clusters only
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 valid in combination with
* the AllowMajorVersionUpgrade
parameter for a major version upgrade
* only.
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.
Valid for * Cluster Type: Aurora DB clusters only
*/ inline const Aws::String& GetDomain() const{ return m_domain; } /** *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.
Valid for * Cluster Type: Aurora DB clusters only
*/ inline bool DomainHasBeenSet() const { return m_domainHasBeenSet; } /** *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.
Valid for * Cluster Type: Aurora DB clusters only
*/ inline void SetDomain(const Aws::String& value) { m_domainHasBeenSet = true; m_domain = value; } /** *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.
Valid for * Cluster Type: Aurora DB clusters only
*/ inline void SetDomain(Aws::String&& value) { m_domainHasBeenSet = true; m_domain = std::move(value); } /** *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.
Valid for * Cluster Type: Aurora DB clusters only
*/ inline void SetDomain(const char* value) { m_domainHasBeenSet = true; m_domain.assign(value); } /** *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.
Valid for * Cluster Type: Aurora DB clusters only
*/ inline ModifyDBClusterRequest& WithDomain(const Aws::String& value) { SetDomain(value); return *this;} /** *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.
Valid for * Cluster Type: Aurora DB clusters only
*/ inline ModifyDBClusterRequest& WithDomain(Aws::String&& value) { SetDomain(std::move(value)); return *this;} /** *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.
Valid for * Cluster Type: Aurora DB clusters only
*/ inline ModifyDBClusterRequest& WithDomain(const char* value) { SetDomain(value); return *this;} /** *The name of the IAM role to use when making API calls to the Directory * Service.
Valid for Cluster Type: Aurora DB clusters only
*/ inline const Aws::String& GetDomainIAMRoleName() const{ return m_domainIAMRoleName; } /** *The name of the IAM role to use when making API calls to the Directory * Service.
Valid for Cluster Type: Aurora DB clusters only
*/ inline bool DomainIAMRoleNameHasBeenSet() const { return m_domainIAMRoleNameHasBeenSet; } /** *The name of the IAM role to use when making API calls to the Directory * Service.
Valid for Cluster Type: Aurora DB clusters only
*/ inline void SetDomainIAMRoleName(const Aws::String& value) { m_domainIAMRoleNameHasBeenSet = true; m_domainIAMRoleName = value; } /** *The name of the IAM role to use when making API calls to the Directory * Service.
Valid for Cluster Type: Aurora DB clusters only
*/ inline void SetDomainIAMRoleName(Aws::String&& value) { m_domainIAMRoleNameHasBeenSet = true; m_domainIAMRoleName = std::move(value); } /** *The name of the IAM role to use when making API calls to the Directory * Service.
Valid for Cluster Type: Aurora DB clusters only
*/ inline void SetDomainIAMRoleName(const char* value) { m_domainIAMRoleNameHasBeenSet = true; m_domainIAMRoleName.assign(value); } /** *The name of the IAM role to use when making API calls to the Directory * Service.
Valid for Cluster Type: Aurora DB clusters only
*/ inline ModifyDBClusterRequest& WithDomainIAMRoleName(const Aws::String& value) { SetDomainIAMRoleName(value); return *this;} /** *The name of the IAM role to use when making API calls to the Directory * Service.
Valid for Cluster Type: Aurora DB clusters only
*/ inline ModifyDBClusterRequest& WithDomainIAMRoleName(Aws::String&& value) { SetDomainIAMRoleName(std::move(value)); return *this;} /** *The name of the IAM role to use when making API calls to the Directory * Service.
Valid for Cluster Type: Aurora DB clusters only
*/ inline ModifyDBClusterRequest& WithDomainIAMRoleName(const char* value) { SetDomainIAMRoleName(value); return *this;} /** *The scaling properties of the DB cluster. You can only modify scaling
* properties for DB clusters in serverless
DB engine mode.
Valid for Cluster Type: Aurora DB clusters only
*/ inline const ScalingConfiguration& GetScalingConfiguration() const{ return m_scalingConfiguration; } /** *The scaling properties of the DB cluster. You can only modify scaling
* properties for DB clusters in serverless
DB engine mode.
Valid for Cluster Type: Aurora DB clusters only
*/ inline bool ScalingConfigurationHasBeenSet() const { return m_scalingConfigurationHasBeenSet; } /** *The scaling properties of the DB cluster. You can only modify scaling
* properties for DB clusters in serverless
DB engine mode.
Valid for Cluster Type: Aurora DB clusters only
*/ inline void SetScalingConfiguration(const ScalingConfiguration& value) { m_scalingConfigurationHasBeenSet = true; m_scalingConfiguration = value; } /** *The scaling properties of the DB cluster. You can only modify scaling
* properties for DB clusters in serverless
DB engine mode.
Valid for Cluster Type: Aurora DB clusters only
*/ inline void SetScalingConfiguration(ScalingConfiguration&& value) { m_scalingConfigurationHasBeenSet = true; m_scalingConfiguration = std::move(value); } /** *The scaling properties of the DB cluster. You can only modify scaling
* properties for DB clusters in serverless
DB engine mode.
Valid for Cluster Type: Aurora DB clusters only
*/ inline ModifyDBClusterRequest& WithScalingConfiguration(const ScalingConfiguration& value) { SetScalingConfiguration(value); return *this;} /** *The scaling properties of the DB cluster. You can only modify scaling
* properties for DB clusters in serverless
DB engine mode.
Valid for Cluster Type: Aurora DB clusters only
*/ inline ModifyDBClusterRequest& WithScalingConfiguration(ScalingConfiguration&& value) { SetScalingConfiguration(std::move(value)); return *this;} /** *Specifies whether the DB cluster has deletion protection enabled. The * database can't be deleted when deletion protection is enabled. By default, * deletion protection isn't enabled.
Valid for Cluster Type: Aurora DB * clusters and Multi-AZ DB clusters
*/ inline bool GetDeletionProtection() const{ return m_deletionProtection; } /** *Specifies whether the DB cluster has deletion protection enabled. The * database can't be deleted when deletion protection is enabled. By default, * deletion protection isn't enabled.
Valid for Cluster Type: Aurora DB * clusters and Multi-AZ DB clusters
*/ inline bool DeletionProtectionHasBeenSet() const { return m_deletionProtectionHasBeenSet; } /** *Specifies whether the DB cluster has deletion protection enabled. The * database can't be deleted when deletion protection is enabled. By default, * deletion protection isn't enabled.
Valid for Cluster Type: Aurora DB * clusters and Multi-AZ DB clusters
*/ inline void SetDeletionProtection(bool value) { m_deletionProtectionHasBeenSet = true; m_deletionProtection = value; } /** *Specifies whether the DB cluster has deletion protection enabled. The * database can't be deleted when deletion protection is enabled. By default, * deletion protection isn't enabled.
Valid for Cluster Type: Aurora DB * clusters and Multi-AZ DB clusters
*/ inline ModifyDBClusterRequest& WithDeletionProtection(bool value) { SetDeletionProtection(value); return *this;} /** *Specifies whether to enable the HTTP endpoint for an Aurora Serverless v1 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 v1 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 v1 in the Amazon Aurora User * Guide.
Valid for Cluster Type: Aurora DB clusters only
*/ inline bool GetEnableHttpEndpoint() const{ return m_enableHttpEndpoint; } /** *Specifies whether to enable the HTTP endpoint for an Aurora Serverless v1 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 v1 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 v1 in the Amazon Aurora User * Guide.
Valid for Cluster Type: Aurora DB clusters only
*/ inline bool EnableHttpEndpointHasBeenSet() const { return m_enableHttpEndpointHasBeenSet; } /** *Specifies whether to enable the HTTP endpoint for an Aurora Serverless v1 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 v1 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 v1 in the Amazon Aurora User * Guide.
Valid for Cluster Type: Aurora DB clusters only
*/ inline void SetEnableHttpEndpoint(bool value) { m_enableHttpEndpointHasBeenSet = true; m_enableHttpEndpoint = value; } /** *Specifies whether to enable the HTTP endpoint for an Aurora Serverless v1 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 v1 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 v1 in the Amazon Aurora User * Guide.
Valid for Cluster Type: Aurora DB clusters only
*/ inline ModifyDBClusterRequest& WithEnableHttpEndpoint(bool value) { SetEnableHttpEndpoint(value); return *this;} /** *Specifies whether to copy all tags from the DB cluster to snapshots of the DB * cluster. The default is not to copy them.
Valid for Cluster Type: Aurora * DB clusters and Multi-AZ DB clusters
*/ inline bool GetCopyTagsToSnapshot() const{ return m_copyTagsToSnapshot; } /** *Specifies whether to copy all tags from the DB cluster to snapshots of the DB * cluster. The default is not to copy them.
Valid for Cluster Type: Aurora * DB clusters and Multi-AZ DB clusters
*/ inline bool CopyTagsToSnapshotHasBeenSet() const { return m_copyTagsToSnapshotHasBeenSet; } /** *Specifies whether to copy all tags from the DB cluster to snapshots of the DB * cluster. The default is not to copy them.
Valid for Cluster Type: Aurora * DB clusters and Multi-AZ DB clusters
*/ inline void SetCopyTagsToSnapshot(bool value) { m_copyTagsToSnapshotHasBeenSet = true; m_copyTagsToSnapshot = value; } /** *Specifies whether to copy all tags from the DB cluster to snapshots of the DB * cluster. The default is not to copy them.
Valid for Cluster Type: Aurora * DB clusters and Multi-AZ DB clusters
*/ inline ModifyDBClusterRequest& WithCopyTagsToSnapshot(bool value) { SetCopyTagsToSnapshot(value); return *this;} /** *Specifies whether to enable this DB cluster to forward write operations to * the primary cluster of a global cluster (Aurora global database). 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 a global cluster API operation, but it does nothing * until then.
Valid for Cluster Type: Aurora DB clusters only
*/ inline bool GetEnableGlobalWriteForwarding() const{ return m_enableGlobalWriteForwarding; } /** *Specifies whether to enable this DB cluster to forward write operations to * the primary cluster of a global cluster (Aurora global database). 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 a global cluster API operation, but it does nothing * until then.
Valid for Cluster Type: Aurora DB clusters only
*/ inline bool EnableGlobalWriteForwardingHasBeenSet() const { return m_enableGlobalWriteForwardingHasBeenSet; } /** *Specifies whether to enable this DB cluster to forward write operations to * the primary cluster of a global cluster (Aurora global database). 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 a global cluster API operation, but it does nothing * until then.
Valid for Cluster Type: Aurora DB clusters only
*/ inline void SetEnableGlobalWriteForwarding(bool value) { m_enableGlobalWriteForwardingHasBeenSet = true; m_enableGlobalWriteForwarding = value; } /** *Specifies whether to enable this DB cluster to forward write operations to * the primary cluster of a global cluster (Aurora global database). 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 a global cluster API operation, but it does nothing * until then.
Valid for Cluster Type: Aurora DB clusters only
*/ inline ModifyDBClusterRequest& WithEnableGlobalWriteForwarding(bool value) { SetEnableGlobalWriteForwarding(value); return *this;} /** *The compute and memory capacity of each DB instance in the Multi-AZ DB
* cluster, for example db.m6gd.xlarge
. Not all DB instance classes
* are available in all Amazon Web Services Regions, or for all database
* engines.
For the full list of DB instance classes and availability for * your engine, see * DB Instance Class in the Amazon RDS User Guide.
Valid for * Cluster Type: Multi-AZ DB clusters only
*/ inline const Aws::String& GetDBClusterInstanceClass() const{ return m_dBClusterInstanceClass; } /** *The compute and memory capacity of each DB instance in the Multi-AZ DB
* cluster, for example db.m6gd.xlarge
. Not all DB instance classes
* are available in all Amazon Web Services Regions, or for all database
* engines.
For the full list of DB instance classes and availability for * your engine, see * DB Instance Class in the Amazon RDS User Guide.
Valid for * Cluster Type: Multi-AZ DB clusters only
*/ inline bool DBClusterInstanceClassHasBeenSet() const { return m_dBClusterInstanceClassHasBeenSet; } /** *The compute and memory capacity of each DB instance in the Multi-AZ DB
* cluster, for example db.m6gd.xlarge
. Not all DB instance classes
* are available in all Amazon Web Services Regions, or for all database
* engines.
For the full list of DB instance classes and availability for * your engine, see * DB Instance Class in the Amazon RDS User Guide.
Valid for * Cluster Type: Multi-AZ DB clusters only
*/ inline void SetDBClusterInstanceClass(const Aws::String& value) { m_dBClusterInstanceClassHasBeenSet = true; m_dBClusterInstanceClass = value; } /** *The compute and memory capacity of each DB instance in the Multi-AZ DB
* cluster, for example db.m6gd.xlarge
. Not all DB instance classes
* are available in all Amazon Web Services Regions, or for all database
* engines.
For the full list of DB instance classes and availability for * your engine, see * DB Instance Class in the Amazon RDS User Guide.
Valid for * Cluster Type: Multi-AZ DB clusters only
*/ inline void SetDBClusterInstanceClass(Aws::String&& value) { m_dBClusterInstanceClassHasBeenSet = true; m_dBClusterInstanceClass = std::move(value); } /** *The compute and memory capacity of each DB instance in the Multi-AZ DB
* cluster, for example db.m6gd.xlarge
. Not all DB instance classes
* are available in all Amazon Web Services Regions, or for all database
* engines.
For the full list of DB instance classes and availability for * your engine, see * DB Instance Class in the Amazon RDS User Guide.
Valid for * Cluster Type: Multi-AZ DB clusters only
*/ inline void SetDBClusterInstanceClass(const char* value) { m_dBClusterInstanceClassHasBeenSet = true; m_dBClusterInstanceClass.assign(value); } /** *The compute and memory capacity of each DB instance in the Multi-AZ DB
* cluster, for example db.m6gd.xlarge
. Not all DB instance classes
* are available in all Amazon Web Services Regions, or for all database
* engines.
For the full list of DB instance classes and availability for * your engine, see * DB Instance Class in the Amazon RDS User Guide.
Valid for * Cluster Type: Multi-AZ DB clusters only
*/ inline ModifyDBClusterRequest& WithDBClusterInstanceClass(const Aws::String& value) { SetDBClusterInstanceClass(value); return *this;} /** *The compute and memory capacity of each DB instance in the Multi-AZ DB
* cluster, for example db.m6gd.xlarge
. Not all DB instance classes
* are available in all Amazon Web Services Regions, or for all database
* engines.
For the full list of DB instance classes and availability for * your engine, see * DB Instance Class in the Amazon RDS User Guide.
Valid for * Cluster Type: Multi-AZ DB clusters only
*/ inline ModifyDBClusterRequest& WithDBClusterInstanceClass(Aws::String&& value) { SetDBClusterInstanceClass(std::move(value)); return *this;} /** *The compute and memory capacity of each DB instance in the Multi-AZ DB
* cluster, for example db.m6gd.xlarge
. Not all DB instance classes
* are available in all Amazon Web Services Regions, or for all database
* engines.
For the full list of DB instance classes and availability for * your engine, see * DB Instance Class in the Amazon RDS User Guide.
Valid for * Cluster Type: Multi-AZ DB clusters only
*/ inline ModifyDBClusterRequest& WithDBClusterInstanceClass(const char* value) { SetDBClusterInstanceClass(value); return *this;} /** *The amount of storage in gibibytes (GiB) to allocate to each DB instance in * the Multi-AZ DB cluster.
Valid for Cluster Type: Multi-AZ DB clusters * only
*/ inline int GetAllocatedStorage() const{ return m_allocatedStorage; } /** *The amount of storage in gibibytes (GiB) to allocate to each DB instance in * the Multi-AZ DB cluster.
Valid for Cluster Type: Multi-AZ DB clusters * only
*/ inline bool AllocatedStorageHasBeenSet() const { return m_allocatedStorageHasBeenSet; } /** *The amount of storage in gibibytes (GiB) to allocate to each DB instance in * the Multi-AZ DB cluster.
Valid for Cluster Type: Multi-AZ DB clusters * only
*/ inline void SetAllocatedStorage(int value) { m_allocatedStorageHasBeenSet = true; m_allocatedStorage = value; } /** *The amount of storage in gibibytes (GiB) to allocate to each DB instance in * the Multi-AZ DB cluster.
Valid for Cluster Type: Multi-AZ DB clusters * only
*/ inline ModifyDBClusterRequest& WithAllocatedStorage(int value) { SetAllocatedStorage(value); return *this;} /** *The storage type to associate with the DB cluster.
For information on * storage types for Aurora DB clusters, see Storage * configurations for Amazon Aurora DB clusters. For information on storage * types for Multi-AZ DB clusters, see Settings * for creating Multi-AZ DB clusters.
When specified for a Multi-AZ DB
* cluster, a value for the Iops
parameter is required.
Valid * for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid * Values:
Aurora DB clusters - aurora | aurora-iopt1
*
Multi-AZ DB clusters - io1
Default:
Aurora DB clusters - aurora
Multi-AZ DB clusters - io1
The storage type to associate with the DB cluster.
For information on * storage types for Aurora DB clusters, see Storage * configurations for Amazon Aurora DB clusters. For information on storage * types for Multi-AZ DB clusters, see Settings * for creating Multi-AZ DB clusters.
When specified for a Multi-AZ DB
* cluster, a value for the Iops
parameter is required.
Valid * for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid * Values:
Aurora DB clusters - aurora | aurora-iopt1
*
Multi-AZ DB clusters - io1
Default:
Aurora DB clusters - aurora
Multi-AZ DB clusters - io1
The storage type to associate with the DB cluster.
For information on * storage types for Aurora DB clusters, see Storage * configurations for Amazon Aurora DB clusters. For information on storage * types for Multi-AZ DB clusters, see Settings * for creating Multi-AZ DB clusters.
When specified for a Multi-AZ DB
* cluster, a value for the Iops
parameter is required.
Valid * for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid * Values:
Aurora DB clusters - aurora | aurora-iopt1
*
Multi-AZ DB clusters - io1
Default:
Aurora DB clusters - aurora
Multi-AZ DB clusters - io1
The storage type to associate with the DB cluster.
For information on * storage types for Aurora DB clusters, see Storage * configurations for Amazon Aurora DB clusters. For information on storage * types for Multi-AZ DB clusters, see Settings * for creating Multi-AZ DB clusters.
When specified for a Multi-AZ DB
* cluster, a value for the Iops
parameter is required.
Valid * for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid * Values:
Aurora DB clusters - aurora | aurora-iopt1
*
Multi-AZ DB clusters - io1
Default:
Aurora DB clusters - aurora
Multi-AZ DB clusters - io1
The storage type to associate with the DB cluster.
For information on * storage types for Aurora DB clusters, see Storage * configurations for Amazon Aurora DB clusters. For information on storage * types for Multi-AZ DB clusters, see Settings * for creating Multi-AZ DB clusters.
When specified for a Multi-AZ DB
* cluster, a value for the Iops
parameter is required.
Valid * for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid * Values:
Aurora DB clusters - aurora | aurora-iopt1
*
Multi-AZ DB clusters - io1
Default:
Aurora DB clusters - aurora
Multi-AZ DB clusters - io1
The storage type to associate with the DB cluster.
For information on * storage types for Aurora DB clusters, see Storage * configurations for Amazon Aurora DB clusters. For information on storage * types for Multi-AZ DB clusters, see Settings * for creating Multi-AZ DB clusters.
When specified for a Multi-AZ DB
* cluster, a value for the Iops
parameter is required.
Valid * for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid * Values:
Aurora DB clusters - aurora | aurora-iopt1
*
Multi-AZ DB clusters - io1
Default:
Aurora DB clusters - aurora
Multi-AZ DB clusters - io1
The storage type to associate with the DB cluster.
For information on * storage types for Aurora DB clusters, see Storage * configurations for Amazon Aurora DB clusters. For information on storage * types for Multi-AZ DB clusters, see Settings * for creating Multi-AZ DB clusters.
When specified for a Multi-AZ DB
* cluster, a value for the Iops
parameter is required.
Valid * for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid * Values:
Aurora DB clusters - aurora | aurora-iopt1
*
Multi-AZ DB clusters - io1
Default:
Aurora DB clusters - aurora
Multi-AZ DB clusters - io1
The storage type to associate with the DB cluster.
For information on * storage types for Aurora DB clusters, see Storage * configurations for Amazon Aurora DB clusters. For information on storage * types for Multi-AZ DB clusters, see Settings * for creating Multi-AZ DB clusters.
When specified for a Multi-AZ DB
* cluster, a value for the Iops
parameter is required.
Valid * for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid * Values:
Aurora DB clusters - aurora | aurora-iopt1
*
Multi-AZ DB clusters - io1
Default:
Aurora DB clusters - aurora
Multi-AZ DB clusters - io1
The amount of Provisioned IOPS (input/output operations per second) to be * initially allocated for each DB instance in the Multi-AZ DB cluster.
For * information about valid IOPS values, see Amazon * RDS Provisioned IOPS storage in the Amazon RDS User Guide.
*Valid for Cluster Type: Multi-AZ DB clusters only
Constraints:
*Must be a multiple between .5 and 50 of the storage amount for the * DB cluster.
The amount of Provisioned IOPS (input/output operations per second) to be * initially allocated for each DB instance in the Multi-AZ DB cluster.
For * information about valid IOPS values, see Amazon * RDS Provisioned IOPS storage in the Amazon RDS User Guide.
*Valid for Cluster Type: Multi-AZ DB clusters only
Constraints:
*Must be a multiple between .5 and 50 of the storage amount for the * DB cluster.
The amount of Provisioned IOPS (input/output operations per second) to be * initially allocated for each DB instance in the Multi-AZ DB cluster.
For * information about valid IOPS values, see Amazon * RDS Provisioned IOPS storage in the Amazon RDS User Guide.
*Valid for Cluster Type: Multi-AZ DB clusters only
Constraints:
*Must be a multiple between .5 and 50 of the storage amount for the * DB cluster.
The amount of Provisioned IOPS (input/output operations per second) to be * initially allocated for each DB instance in the Multi-AZ DB cluster.
For * information about valid IOPS values, see Amazon * RDS Provisioned IOPS storage in the Amazon RDS User Guide.
*Valid for Cluster Type: Multi-AZ DB clusters only
Constraints:
*Must be a multiple between .5 and 50 of the storage amount for the * DB cluster.
Specifies whether minor engine upgrades are applied automatically to the DB * cluster during the maintenance window. By default, minor engine upgrades are * applied automatically.
Valid for Cluster Type: Multi-AZ DB clusters * only
*/ inline bool GetAutoMinorVersionUpgrade() const{ return m_autoMinorVersionUpgrade; } /** *Specifies whether minor engine upgrades are applied automatically to the DB * cluster during the maintenance window. By default, minor engine upgrades are * applied automatically.
Valid for Cluster Type: Multi-AZ DB clusters * only
*/ inline bool AutoMinorVersionUpgradeHasBeenSet() const { return m_autoMinorVersionUpgradeHasBeenSet; } /** *Specifies whether minor engine upgrades are applied automatically to the DB * cluster during the maintenance window. By default, minor engine upgrades are * applied automatically.
Valid for Cluster Type: Multi-AZ DB clusters * only
*/ inline void SetAutoMinorVersionUpgrade(bool value) { m_autoMinorVersionUpgradeHasBeenSet = true; m_autoMinorVersionUpgrade = value; } /** *Specifies whether minor engine upgrades are applied automatically to the DB * cluster during the maintenance window. By default, minor engine upgrades are * applied automatically.
Valid for Cluster Type: Multi-AZ DB clusters * only
*/ inline ModifyDBClusterRequest& WithAutoMinorVersionUpgrade(bool value) { SetAutoMinorVersionUpgrade(value); return *this;} /** *The interval, in seconds, between points when Enhanced Monitoring metrics are
* collected for the DB cluster. To turn off collecting Enhanced Monitoring
* metrics, specify 0
.
If MonitoringRoleArn
is
* specified, also set MonitoringInterval
to a value other than
* 0
.
Valid for Cluster Type: Multi-AZ DB clusters only
*Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60
Default:
* 0
The interval, in seconds, between points when Enhanced Monitoring metrics are
* collected for the DB cluster. To turn off collecting Enhanced Monitoring
* metrics, specify 0
.
If MonitoringRoleArn
is
* specified, also set MonitoringInterval
to a value other than
* 0
.
Valid for Cluster Type: Multi-AZ DB clusters only
*Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60
Default:
* 0
The interval, in seconds, between points when Enhanced Monitoring metrics are
* collected for the DB cluster. To turn off collecting Enhanced Monitoring
* metrics, specify 0
.
If MonitoringRoleArn
is
* specified, also set MonitoringInterval
to a value other than
* 0
.
Valid for Cluster Type: Multi-AZ DB clusters only
*Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60
Default:
* 0
The interval, in seconds, between points when Enhanced Monitoring metrics are
* collected for the DB cluster. To turn off collecting Enhanced Monitoring
* metrics, specify 0
.
If MonitoringRoleArn
is
* specified, also set MonitoringInterval
to a value other than
* 0
.
Valid for Cluster Type: Multi-AZ DB clusters only
*Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60
Default:
* 0
The Amazon Resource Name (ARN) for the IAM role that permits RDS to send
* Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is
* arn:aws:iam:123456789012:role/emaccess
. For information on creating
* a monitoring role, see To
* create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS
* User Guide.
If MonitoringInterval
is set to a value
* other than 0
, supply a MonitoringRoleArn
value.
Valid for Cluster Type: Multi-AZ DB clusters only
*/ inline const Aws::String& GetMonitoringRoleArn() const{ return m_monitoringRoleArn; } /** *The Amazon Resource Name (ARN) for the IAM role that permits RDS to send
* Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is
* arn:aws:iam:123456789012:role/emaccess
. For information on creating
* a monitoring role, see To
* create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS
* User Guide.
If MonitoringInterval
is set to a value
* other than 0
, supply a MonitoringRoleArn
value.
Valid for Cluster Type: Multi-AZ DB clusters only
*/ inline bool MonitoringRoleArnHasBeenSet() const { return m_monitoringRoleArnHasBeenSet; } /** *The Amazon Resource Name (ARN) for the IAM role that permits RDS to send
* Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is
* arn:aws:iam:123456789012:role/emaccess
. For information on creating
* a monitoring role, see To
* create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS
* User Guide.
If MonitoringInterval
is set to a value
* other than 0
, supply a MonitoringRoleArn
value.
Valid for Cluster Type: Multi-AZ DB clusters only
*/ inline void SetMonitoringRoleArn(const Aws::String& value) { m_monitoringRoleArnHasBeenSet = true; m_monitoringRoleArn = value; } /** *The Amazon Resource Name (ARN) for the IAM role that permits RDS to send
* Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is
* arn:aws:iam:123456789012:role/emaccess
. For information on creating
* a monitoring role, see To
* create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS
* User Guide.
If MonitoringInterval
is set to a value
* other than 0
, supply a MonitoringRoleArn
value.
Valid for Cluster Type: Multi-AZ DB clusters only
*/ inline void SetMonitoringRoleArn(Aws::String&& value) { m_monitoringRoleArnHasBeenSet = true; m_monitoringRoleArn = std::move(value); } /** *The Amazon Resource Name (ARN) for the IAM role that permits RDS to send
* Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is
* arn:aws:iam:123456789012:role/emaccess
. For information on creating
* a monitoring role, see To
* create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS
* User Guide.
If MonitoringInterval
is set to a value
* other than 0
, supply a MonitoringRoleArn
value.
Valid for Cluster Type: Multi-AZ DB clusters only
*/ inline void SetMonitoringRoleArn(const char* value) { m_monitoringRoleArnHasBeenSet = true; m_monitoringRoleArn.assign(value); } /** *The Amazon Resource Name (ARN) for the IAM role that permits RDS to send
* Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is
* arn:aws:iam:123456789012:role/emaccess
. For information on creating
* a monitoring role, see To
* create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS
* User Guide.
If MonitoringInterval
is set to a value
* other than 0
, supply a MonitoringRoleArn
value.
Valid for Cluster Type: Multi-AZ DB clusters only
*/ inline ModifyDBClusterRequest& WithMonitoringRoleArn(const Aws::String& value) { SetMonitoringRoleArn(value); return *this;} /** *The Amazon Resource Name (ARN) for the IAM role that permits RDS to send
* Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is
* arn:aws:iam:123456789012:role/emaccess
. For information on creating
* a monitoring role, see To
* create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS
* User Guide.
If MonitoringInterval
is set to a value
* other than 0
, supply a MonitoringRoleArn
value.
Valid for Cluster Type: Multi-AZ DB clusters only
*/ inline ModifyDBClusterRequest& WithMonitoringRoleArn(Aws::String&& value) { SetMonitoringRoleArn(std::move(value)); return *this;} /** *The Amazon Resource Name (ARN) for the IAM role that permits RDS to send
* Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is
* arn:aws:iam:123456789012:role/emaccess
. For information on creating
* a monitoring role, see To
* create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS
* User Guide.
If MonitoringInterval
is set to a value
* other than 0
, supply a MonitoringRoleArn
value.
Valid for Cluster Type: Multi-AZ DB clusters only
*/ inline ModifyDBClusterRequest& WithMonitoringRoleArn(const char* value) { SetMonitoringRoleArn(value); return *this;} /** *Specifies whether to turn on Performance Insights for the DB cluster.
*For more information, see * Using Amazon Performance Insights in the Amazon RDS User Guide.
*Valid for Cluster Type: Multi-AZ DB clusters only
*/ inline bool GetEnablePerformanceInsights() const{ return m_enablePerformanceInsights; } /** *Specifies whether to turn on Performance Insights for the DB cluster.
*For more information, see * Using Amazon Performance Insights in the Amazon RDS User Guide.
*Valid for Cluster Type: Multi-AZ DB clusters only
*/ inline bool EnablePerformanceInsightsHasBeenSet() const { return m_enablePerformanceInsightsHasBeenSet; } /** *Specifies whether to turn on Performance Insights for the DB cluster.
*For more information, see * Using Amazon Performance Insights in the Amazon RDS User Guide.
*Valid for Cluster Type: Multi-AZ DB clusters only
*/ inline void SetEnablePerformanceInsights(bool value) { m_enablePerformanceInsightsHasBeenSet = true; m_enablePerformanceInsights = value; } /** *Specifies whether to turn on Performance Insights for the DB cluster.
*For more information, see * Using Amazon Performance Insights in the Amazon RDS User Guide.
*Valid for Cluster Type: Multi-AZ DB clusters only
*/ inline ModifyDBClusterRequest& WithEnablePerformanceInsights(bool value) { SetEnablePerformanceInsights(value); return *this;} /** *The Amazon Web Services KMS key identifier for encryption of Performance * Insights data.
The Amazon Web Services KMS key identifier is the key ARN, * key ID, alias ARN, or alias name for the KMS key.
If you don't specify a
* value for PerformanceInsightsKMSKeyId
, then Amazon RDS uses your
* default KMS key. There is a default KMS key for your Amazon Web Services
* account. Your Amazon Web Services account has a different default KMS key for
* each Amazon Web Services Region.
Valid for Cluster Type: Multi-AZ DB * clusters only
*/ inline const Aws::String& GetPerformanceInsightsKMSKeyId() const{ return m_performanceInsightsKMSKeyId; } /** *The Amazon Web Services KMS key identifier for encryption of Performance * Insights data.
The Amazon Web Services KMS key identifier is the key ARN, * key ID, alias ARN, or alias name for the KMS key.
If you don't specify a
* value for PerformanceInsightsKMSKeyId
, then Amazon RDS uses your
* default KMS key. There is a default KMS key for your Amazon Web Services
* account. Your Amazon Web Services account has a different default KMS key for
* each Amazon Web Services Region.
Valid for Cluster Type: Multi-AZ DB * clusters only
*/ inline bool PerformanceInsightsKMSKeyIdHasBeenSet() const { return m_performanceInsightsKMSKeyIdHasBeenSet; } /** *The Amazon Web Services KMS key identifier for encryption of Performance * Insights data.
The Amazon Web Services KMS key identifier is the key ARN, * key ID, alias ARN, or alias name for the KMS key.
If you don't specify a
* value for PerformanceInsightsKMSKeyId
, then Amazon RDS uses your
* default KMS key. There is a default KMS key for your Amazon Web Services
* account. Your Amazon Web Services account has a different default KMS key for
* each Amazon Web Services Region.
Valid for Cluster Type: Multi-AZ DB * clusters only
*/ inline void SetPerformanceInsightsKMSKeyId(const Aws::String& value) { m_performanceInsightsKMSKeyIdHasBeenSet = true; m_performanceInsightsKMSKeyId = value; } /** *The Amazon Web Services KMS key identifier for encryption of Performance * Insights data.
The Amazon Web Services KMS key identifier is the key ARN, * key ID, alias ARN, or alias name for the KMS key.
If you don't specify a
* value for PerformanceInsightsKMSKeyId
, then Amazon RDS uses your
* default KMS key. There is a default KMS key for your Amazon Web Services
* account. Your Amazon Web Services account has a different default KMS key for
* each Amazon Web Services Region.
Valid for Cluster Type: Multi-AZ DB * clusters only
*/ inline void SetPerformanceInsightsKMSKeyId(Aws::String&& value) { m_performanceInsightsKMSKeyIdHasBeenSet = true; m_performanceInsightsKMSKeyId = std::move(value); } /** *The Amazon Web Services KMS key identifier for encryption of Performance * Insights data.
The Amazon Web Services KMS key identifier is the key ARN, * key ID, alias ARN, or alias name for the KMS key.
If you don't specify a
* value for PerformanceInsightsKMSKeyId
, then Amazon RDS uses your
* default KMS key. There is a default KMS key for your Amazon Web Services
* account. Your Amazon Web Services account has a different default KMS key for
* each Amazon Web Services Region.
Valid for Cluster Type: Multi-AZ DB * clusters only
*/ inline void SetPerformanceInsightsKMSKeyId(const char* value) { m_performanceInsightsKMSKeyIdHasBeenSet = true; m_performanceInsightsKMSKeyId.assign(value); } /** *The Amazon Web Services KMS key identifier for encryption of Performance * Insights data.
The Amazon Web Services KMS key identifier is the key ARN, * key ID, alias ARN, or alias name for the KMS key.
If you don't specify a
* value for PerformanceInsightsKMSKeyId
, then Amazon RDS uses your
* default KMS key. There is a default KMS key for your Amazon Web Services
* account. Your Amazon Web Services account has a different default KMS key for
* each Amazon Web Services Region.
Valid for Cluster Type: Multi-AZ DB * clusters only
*/ inline ModifyDBClusterRequest& WithPerformanceInsightsKMSKeyId(const Aws::String& value) { SetPerformanceInsightsKMSKeyId(value); return *this;} /** *The Amazon Web Services KMS key identifier for encryption of Performance * Insights data.
The Amazon Web Services KMS key identifier is the key ARN, * key ID, alias ARN, or alias name for the KMS key.
If you don't specify a
* value for PerformanceInsightsKMSKeyId
, then Amazon RDS uses your
* default KMS key. There is a default KMS key for your Amazon Web Services
* account. Your Amazon Web Services account has a different default KMS key for
* each Amazon Web Services Region.
Valid for Cluster Type: Multi-AZ DB * clusters only
*/ inline ModifyDBClusterRequest& WithPerformanceInsightsKMSKeyId(Aws::String&& value) { SetPerformanceInsightsKMSKeyId(std::move(value)); return *this;} /** *The Amazon Web Services KMS key identifier for encryption of Performance * Insights data.
The Amazon Web Services KMS key identifier is the key ARN, * key ID, alias ARN, or alias name for the KMS key.
If you don't specify a
* value for PerformanceInsightsKMSKeyId
, then Amazon RDS uses your
* default KMS key. There is a default KMS key for your Amazon Web Services
* account. Your Amazon Web Services account has a different default KMS key for
* each Amazon Web Services Region.
Valid for Cluster Type: Multi-AZ DB * clusters only
*/ inline ModifyDBClusterRequest& WithPerformanceInsightsKMSKeyId(const char* value) { SetPerformanceInsightsKMSKeyId(value); return *this;} /** *The number of days to retain Performance Insights data.
Valid for * Cluster Type: Multi-AZ DB clusters only
Valid Values:
* 7
month * 31, where month is a
* number of months from 1-23. Examples: 93
(3 months * 31),
* 341
(11 months * 31), 589
(19 months * 31)
731
Default: 7
days
If you specify a retention period that isn't valid, such as 94
,
* Amazon RDS issues an error.
The number of days to retain Performance Insights data.
Valid for * Cluster Type: Multi-AZ DB clusters only
Valid Values:
* 7
month * 31, where month is a
* number of months from 1-23. Examples: 93
(3 months * 31),
* 341
(11 months * 31), 589
(19 months * 31)
731
Default: 7
days
If you specify a retention period that isn't valid, such as 94
,
* Amazon RDS issues an error.
The number of days to retain Performance Insights data.
Valid for * Cluster Type: Multi-AZ DB clusters only
Valid Values:
* 7
month * 31, where month is a
* number of months from 1-23. Examples: 93
(3 months * 31),
* 341
(11 months * 31), 589
(19 months * 31)
731
Default: 7
days
If you specify a retention period that isn't valid, such as 94
,
* Amazon RDS issues an error.
The number of days to retain Performance Insights data.
Valid for * Cluster Type: Multi-AZ DB clusters only
Valid Values:
* 7
month * 31, where month is a
* number of months from 1-23. Examples: 93
(3 months * 31),
* 341
(11 months * 31), 589
(19 months * 31)
731
Default: 7
days
If you specify a retention period that isn't valid, such as 94
,
* Amazon RDS issues an error.
The network type of the DB cluster.
The network type is determined by
* the DBSubnetGroup
specified for the DB cluster. A
* DBSubnetGroup
can support only the IPv4 protocol or the IPv4 and
* the IPv6 protocols (DUAL
).
For more information, see * Working with a DB instance in a VPC in the Amazon Aurora User Guide. *
Valid for Cluster Type: Aurora DB clusters only
Valid Values:
* IPV4 | DUAL
The network type of the DB cluster.
The network type is determined by
* the DBSubnetGroup
specified for the DB cluster. A
* DBSubnetGroup
can support only the IPv4 protocol or the IPv4 and
* the IPv6 protocols (DUAL
).
For more information, see * Working with a DB instance in a VPC in the Amazon Aurora User Guide. *
Valid for Cluster Type: Aurora DB clusters only
Valid Values:
* IPV4 | DUAL
The network type of the DB cluster.
The network type is determined by
* the DBSubnetGroup
specified for the DB cluster. A
* DBSubnetGroup
can support only the IPv4 protocol or the IPv4 and
* the IPv6 protocols (DUAL
).
For more information, see * Working with a DB instance in a VPC in the Amazon Aurora User Guide. *
Valid for Cluster Type: Aurora DB clusters only
Valid Values:
* IPV4 | DUAL
The network type of the DB cluster.
The network type is determined by
* the DBSubnetGroup
specified for the DB cluster. A
* DBSubnetGroup
can support only the IPv4 protocol or the IPv4 and
* the IPv6 protocols (DUAL
).
For more information, see * Working with a DB instance in a VPC in the Amazon Aurora User Guide. *
Valid for Cluster Type: Aurora DB clusters only
Valid Values:
* IPV4 | DUAL
The network type of the DB cluster.
The network type is determined by
* the DBSubnetGroup
specified for the DB cluster. A
* DBSubnetGroup
can support only the IPv4 protocol or the IPv4 and
* the IPv6 protocols (DUAL
).
For more information, see * Working with a DB instance in a VPC in the Amazon Aurora User Guide. *
Valid for Cluster Type: Aurora DB clusters only
Valid Values:
* IPV4 | DUAL
The network type of the DB cluster.
The network type is determined by
* the DBSubnetGroup
specified for the DB cluster. A
* DBSubnetGroup
can support only the IPv4 protocol or the IPv4 and
* the IPv6 protocols (DUAL
).
For more information, see * Working with a DB instance in a VPC in the Amazon Aurora User Guide. *
Valid for Cluster Type: Aurora DB clusters only
Valid Values:
* IPV4 | DUAL
The network type of the DB cluster.
The network type is determined by
* the DBSubnetGroup
specified for the DB cluster. A
* DBSubnetGroup
can support only the IPv4 protocol or the IPv4 and
* the IPv6 protocols (DUAL
).
For more information, see * Working with a DB instance in a VPC in the Amazon Aurora User Guide. *
Valid for Cluster Type: Aurora DB clusters only
Valid Values:
* IPV4 | DUAL
The network type of the DB cluster.
The network type is determined by
* the DBSubnetGroup
specified for the DB cluster. A
* DBSubnetGroup
can support only the IPv4 protocol or the IPv4 and
* the IPv6 protocols (DUAL
).
For more information, see * Working with a DB instance in a VPC in the Amazon Aurora User Guide. *
Valid for Cluster Type: Aurora DB clusters only
Valid Values:
* IPV4 | DUAL
Specifies whether to manage the master user password with Amazon Web Services * Secrets Manager.
If the DB cluster doesn't manage the master user
* password with Amazon Web Services Secrets Manager, you can turn on this
* management. In this case, you can't specify MasterUserPassword
.
If the DB cluster already manages the master user password with Amazon Web
* Services Secrets Manager, and you specify that the master user password is not
* managed with Amazon Web Services Secrets Manager, then you must specify
* MasterUserPassword
. In this case, RDS deletes the secret and uses
* the new password for the master user specified by
* MasterUserPassword
.
For more information, see Password * management with Amazon Web Services Secrets Manager in the Amazon RDS * User Guide and Password * management with Amazon Web Services Secrets Manager in the Amazon Aurora * User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ * DB clusters
*/ inline bool GetManageMasterUserPassword() const{ return m_manageMasterUserPassword; } /** *Specifies whether to manage the master user password with Amazon Web Services * Secrets Manager.
If the DB cluster doesn't manage the master user
* password with Amazon Web Services Secrets Manager, you can turn on this
* management. In this case, you can't specify MasterUserPassword
.
If the DB cluster already manages the master user password with Amazon Web
* Services Secrets Manager, and you specify that the master user password is not
* managed with Amazon Web Services Secrets Manager, then you must specify
* MasterUserPassword
. In this case, RDS deletes the secret and uses
* the new password for the master user specified by
* MasterUserPassword
.
For more information, see Password * management with Amazon Web Services Secrets Manager in the Amazon RDS * User Guide and Password * management with Amazon Web Services Secrets Manager in the Amazon Aurora * User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ * DB clusters
*/ inline bool ManageMasterUserPasswordHasBeenSet() const { return m_manageMasterUserPasswordHasBeenSet; } /** *Specifies whether to manage the master user password with Amazon Web Services * Secrets Manager.
If the DB cluster doesn't manage the master user
* password with Amazon Web Services Secrets Manager, you can turn on this
* management. In this case, you can't specify MasterUserPassword
.
If the DB cluster already manages the master user password with Amazon Web
* Services Secrets Manager, and you specify that the master user password is not
* managed with Amazon Web Services Secrets Manager, then you must specify
* MasterUserPassword
. In this case, RDS deletes the secret and uses
* the new password for the master user specified by
* MasterUserPassword
.
For more information, see Password * management with Amazon Web Services Secrets Manager in the Amazon RDS * User Guide and Password * management with Amazon Web Services Secrets Manager in the Amazon Aurora * User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ * DB clusters
*/ inline void SetManageMasterUserPassword(bool value) { m_manageMasterUserPasswordHasBeenSet = true; m_manageMasterUserPassword = value; } /** *Specifies whether to manage the master user password with Amazon Web Services * Secrets Manager.
If the DB cluster doesn't manage the master user
* password with Amazon Web Services Secrets Manager, you can turn on this
* management. In this case, you can't specify MasterUserPassword
.
If the DB cluster already manages the master user password with Amazon Web
* Services Secrets Manager, and you specify that the master user password is not
* managed with Amazon Web Services Secrets Manager, then you must specify
* MasterUserPassword
. In this case, RDS deletes the secret and uses
* the new password for the master user specified by
* MasterUserPassword
.
For more information, see Password * management with Amazon Web Services Secrets Manager in the Amazon RDS * User Guide and Password * management with Amazon Web Services Secrets Manager in the Amazon Aurora * User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ * DB clusters
*/ inline ModifyDBClusterRequest& WithManageMasterUserPassword(bool value) { SetManageMasterUserPassword(value); return *this;} /** *Specifies whether to rotate the secret managed by Amazon Web Services Secrets * Manager for the master user password.
This setting is valid only if the * master user password is managed by RDS in Amazon Web Services Secrets Manager * for the DB cluster. The secret value contains the updated password.
For * more information, see Password * management with Amazon Web Services Secrets Manager in the Amazon RDS * User Guide and Password * management with Amazon Web Services Secrets Manager in the Amazon Aurora * User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ * DB clusters
Constraints:
You must apply the change * immediately when rotating the master user password.
Specifies whether to rotate the secret managed by Amazon Web Services Secrets * Manager for the master user password.
This setting is valid only if the * master user password is managed by RDS in Amazon Web Services Secrets Manager * for the DB cluster. The secret value contains the updated password.
For * more information, see Password * management with Amazon Web Services Secrets Manager in the Amazon RDS * User Guide and Password * management with Amazon Web Services Secrets Manager in the Amazon Aurora * User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ * DB clusters
Constraints:
You must apply the change * immediately when rotating the master user password.
Specifies whether to rotate the secret managed by Amazon Web Services Secrets * Manager for the master user password.
This setting is valid only if the * master user password is managed by RDS in Amazon Web Services Secrets Manager * for the DB cluster. The secret value contains the updated password.
For * more information, see Password * management with Amazon Web Services Secrets Manager in the Amazon RDS * User Guide and Password * management with Amazon Web Services Secrets Manager in the Amazon Aurora * User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ * DB clusters
Constraints:
You must apply the change * immediately when rotating the master user password.
Specifies whether to rotate the secret managed by Amazon Web Services Secrets * Manager for the master user password.
This setting is valid only if the * master user password is managed by RDS in Amazon Web Services Secrets Manager * for the DB cluster. The secret value contains the updated password.
For * more information, see Password * management with Amazon Web Services Secrets Manager in the Amazon RDS * User Guide and Password * management with Amazon Web Services Secrets Manager in the Amazon Aurora * User Guide.
Valid for Cluster Type: Aurora DB clusters and Multi-AZ * DB clusters
Constraints:
You must apply the change * immediately when rotating the master user password.
The Amazon Web Services KMS key identifier to encrypt a secret that is * automatically generated and managed in Amazon Web Services Secrets Manager.
*This setting is valid only if both of the following conditions are met:
*The DB cluster doesn't manage the master user password in Amazon * Web Services Secrets Manager.
If the DB cluster already manages the * master user password in Amazon Web Services Secrets Manager, you can't change * the KMS key that is used to encrypt the secret.
You are
* turning on ManageMasterUserPassword
to manage the master user
* password in Amazon Web Services Secrets Manager.
If you are turning on
* ManageMasterUserPassword
and don't specify
* MasterUserSecretKmsKeyId
, then the aws/secretsmanager
* KMS key is used to encrypt the secret. If the secret is in a different Amazon
* Web Services account, then you can't use the aws/secretsmanager
KMS
* key to encrypt the secret, and you must use a customer managed KMS key.
The Amazon Web Services KMS key identifier is the key ARN, key * ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different * Amazon Web Services account, specify the key ARN or alias ARN.
There is a * default KMS key for your Amazon Web Services account. Your Amazon Web Services * account has a different default KMS key for each Amazon Web Services Region.
*Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
*/ inline const Aws::String& GetMasterUserSecretKmsKeyId() const{ return m_masterUserSecretKmsKeyId; } /** *The Amazon Web Services KMS key identifier to encrypt a secret that is * automatically generated and managed in Amazon Web Services Secrets Manager.
*This setting is valid only if both of the following conditions are met:
*The DB cluster doesn't manage the master user password in Amazon * Web Services Secrets Manager.
If the DB cluster already manages the * master user password in Amazon Web Services Secrets Manager, you can't change * the KMS key that is used to encrypt the secret.
You are
* turning on ManageMasterUserPassword
to manage the master user
* password in Amazon Web Services Secrets Manager.
If you are turning on
* ManageMasterUserPassword
and don't specify
* MasterUserSecretKmsKeyId
, then the aws/secretsmanager
* KMS key is used to encrypt the secret. If the secret is in a different Amazon
* Web Services account, then you can't use the aws/secretsmanager
KMS
* key to encrypt the secret, and you must use a customer managed KMS key.
The Amazon Web Services KMS key identifier is the key ARN, key * ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different * Amazon Web Services account, specify the key ARN or alias ARN.
There is a * default KMS key for your Amazon Web Services account. Your Amazon Web Services * account has a different default KMS key for each Amazon Web Services Region.
*Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
*/ inline bool MasterUserSecretKmsKeyIdHasBeenSet() const { return m_masterUserSecretKmsKeyIdHasBeenSet; } /** *The Amazon Web Services KMS key identifier to encrypt a secret that is * automatically generated and managed in Amazon Web Services Secrets Manager.
*This setting is valid only if both of the following conditions are met:
*The DB cluster doesn't manage the master user password in Amazon * Web Services Secrets Manager.
If the DB cluster already manages the * master user password in Amazon Web Services Secrets Manager, you can't change * the KMS key that is used to encrypt the secret.
You are
* turning on ManageMasterUserPassword
to manage the master user
* password in Amazon Web Services Secrets Manager.
If you are turning on
* ManageMasterUserPassword
and don't specify
* MasterUserSecretKmsKeyId
, then the aws/secretsmanager
* KMS key is used to encrypt the secret. If the secret is in a different Amazon
* Web Services account, then you can't use the aws/secretsmanager
KMS
* key to encrypt the secret, and you must use a customer managed KMS key.
The Amazon Web Services KMS key identifier is the key ARN, key * ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different * Amazon Web Services account, specify the key ARN or alias ARN.
There is a * default KMS key for your Amazon Web Services account. Your Amazon Web Services * account has a different default KMS key for each Amazon Web Services Region.
*Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
*/ inline void SetMasterUserSecretKmsKeyId(const Aws::String& value) { m_masterUserSecretKmsKeyIdHasBeenSet = true; m_masterUserSecretKmsKeyId = value; } /** *The Amazon Web Services KMS key identifier to encrypt a secret that is * automatically generated and managed in Amazon Web Services Secrets Manager.
*This setting is valid only if both of the following conditions are met:
*The DB cluster doesn't manage the master user password in Amazon * Web Services Secrets Manager.
If the DB cluster already manages the * master user password in Amazon Web Services Secrets Manager, you can't change * the KMS key that is used to encrypt the secret.
You are
* turning on ManageMasterUserPassword
to manage the master user
* password in Amazon Web Services Secrets Manager.
If you are turning on
* ManageMasterUserPassword
and don't specify
* MasterUserSecretKmsKeyId
, then the aws/secretsmanager
* KMS key is used to encrypt the secret. If the secret is in a different Amazon
* Web Services account, then you can't use the aws/secretsmanager
KMS
* key to encrypt the secret, and you must use a customer managed KMS key.
The Amazon Web Services KMS key identifier is the key ARN, key * ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different * Amazon Web Services account, specify the key ARN or alias ARN.
There is a * default KMS key for your Amazon Web Services account. Your Amazon Web Services * account has a different default KMS key for each Amazon Web Services Region.
*Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
*/ inline void SetMasterUserSecretKmsKeyId(Aws::String&& value) { m_masterUserSecretKmsKeyIdHasBeenSet = true; m_masterUserSecretKmsKeyId = std::move(value); } /** *The Amazon Web Services KMS key identifier to encrypt a secret that is * automatically generated and managed in Amazon Web Services Secrets Manager.
*This setting is valid only if both of the following conditions are met:
*The DB cluster doesn't manage the master user password in Amazon * Web Services Secrets Manager.
If the DB cluster already manages the * master user password in Amazon Web Services Secrets Manager, you can't change * the KMS key that is used to encrypt the secret.
You are
* turning on ManageMasterUserPassword
to manage the master user
* password in Amazon Web Services Secrets Manager.
If you are turning on
* ManageMasterUserPassword
and don't specify
* MasterUserSecretKmsKeyId
, then the aws/secretsmanager
* KMS key is used to encrypt the secret. If the secret is in a different Amazon
* Web Services account, then you can't use the aws/secretsmanager
KMS
* key to encrypt the secret, and you must use a customer managed KMS key.
The Amazon Web Services KMS key identifier is the key ARN, key * ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different * Amazon Web Services account, specify the key ARN or alias ARN.
There is a * default KMS key for your Amazon Web Services account. Your Amazon Web Services * account has a different default KMS key for each Amazon Web Services Region.
*Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
*/ inline void SetMasterUserSecretKmsKeyId(const char* value) { m_masterUserSecretKmsKeyIdHasBeenSet = true; m_masterUserSecretKmsKeyId.assign(value); } /** *The Amazon Web Services KMS key identifier to encrypt a secret that is * automatically generated and managed in Amazon Web Services Secrets Manager.
*This setting is valid only if both of the following conditions are met:
*The DB cluster doesn't manage the master user password in Amazon * Web Services Secrets Manager.
If the DB cluster already manages the * master user password in Amazon Web Services Secrets Manager, you can't change * the KMS key that is used to encrypt the secret.
You are
* turning on ManageMasterUserPassword
to manage the master user
* password in Amazon Web Services Secrets Manager.
If you are turning on
* ManageMasterUserPassword
and don't specify
* MasterUserSecretKmsKeyId
, then the aws/secretsmanager
* KMS key is used to encrypt the secret. If the secret is in a different Amazon
* Web Services account, then you can't use the aws/secretsmanager
KMS
* key to encrypt the secret, and you must use a customer managed KMS key.
The Amazon Web Services KMS key identifier is the key ARN, key * ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different * Amazon Web Services account, specify the key ARN or alias ARN.
There is a * default KMS key for your Amazon Web Services account. Your Amazon Web Services * account has a different default KMS key for each Amazon Web Services Region.
*Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
*/ inline ModifyDBClusterRequest& WithMasterUserSecretKmsKeyId(const Aws::String& value) { SetMasterUserSecretKmsKeyId(value); return *this;} /** *The Amazon Web Services KMS key identifier to encrypt a secret that is * automatically generated and managed in Amazon Web Services Secrets Manager.
*This setting is valid only if both of the following conditions are met:
*The DB cluster doesn't manage the master user password in Amazon * Web Services Secrets Manager.
If the DB cluster already manages the * master user password in Amazon Web Services Secrets Manager, you can't change * the KMS key that is used to encrypt the secret.
You are
* turning on ManageMasterUserPassword
to manage the master user
* password in Amazon Web Services Secrets Manager.
If you are turning on
* ManageMasterUserPassword
and don't specify
* MasterUserSecretKmsKeyId
, then the aws/secretsmanager
* KMS key is used to encrypt the secret. If the secret is in a different Amazon
* Web Services account, then you can't use the aws/secretsmanager
KMS
* key to encrypt the secret, and you must use a customer managed KMS key.
The Amazon Web Services KMS key identifier is the key ARN, key * ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different * Amazon Web Services account, specify the key ARN or alias ARN.
There is a * default KMS key for your Amazon Web Services account. Your Amazon Web Services * account has a different default KMS key for each Amazon Web Services Region.
*Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
*/ inline ModifyDBClusterRequest& WithMasterUserSecretKmsKeyId(Aws::String&& value) { SetMasterUserSecretKmsKeyId(std::move(value)); return *this;} /** *The Amazon Web Services KMS key identifier to encrypt a secret that is * automatically generated and managed in Amazon Web Services Secrets Manager.
*This setting is valid only if both of the following conditions are met:
*The DB cluster doesn't manage the master user password in Amazon * Web Services Secrets Manager.
If the DB cluster already manages the * master user password in Amazon Web Services Secrets Manager, you can't change * the KMS key that is used to encrypt the secret.
You are
* turning on ManageMasterUserPassword
to manage the master user
* password in Amazon Web Services Secrets Manager.
If you are turning on
* ManageMasterUserPassword
and don't specify
* MasterUserSecretKmsKeyId
, then the aws/secretsmanager
* KMS key is used to encrypt the secret. If the secret is in a different Amazon
* Web Services account, then you can't use the aws/secretsmanager
KMS
* key to encrypt the secret, and you must use a customer managed KMS key.
The Amazon Web Services KMS key identifier is the key ARN, key * ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different * Amazon Web Services account, specify the key ARN or alias ARN.
There is a * default KMS key for your Amazon Web Services account. Your Amazon Web Services * account has a different default KMS key for each Amazon Web Services Region.
*Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
*/ inline ModifyDBClusterRequest& WithMasterUserSecretKmsKeyId(const char* value) { SetMasterUserSecretKmsKeyId(value); return *this;} /** *The DB engine mode of the DB cluster, either provisioned
or
* serverless
.
The DB engine mode can be modified only
* from serverless
to provisioned
.
For * more information, see * CreateDBCluster.
Valid for Cluster Type: Aurora DB clusters only
*/ inline const Aws::String& GetEngineMode() const{ return m_engineMode; } /** *The DB engine mode of the DB cluster, either provisioned
or
* serverless
.
The DB engine mode can be modified only
* from serverless
to provisioned
.
For * more information, see * CreateDBCluster.
Valid for Cluster Type: Aurora DB clusters only
*/ inline bool EngineModeHasBeenSet() const { return m_engineModeHasBeenSet; } /** *The DB engine mode of the DB cluster, either provisioned
or
* serverless
.
The DB engine mode can be modified only
* from serverless
to provisioned
.
For * more information, see * CreateDBCluster.
Valid for Cluster Type: Aurora DB clusters only
*/ inline void SetEngineMode(const Aws::String& value) { m_engineModeHasBeenSet = true; m_engineMode = value; } /** *The DB engine mode of the DB cluster, either provisioned
or
* serverless
.
The DB engine mode can be modified only
* from serverless
to provisioned
.
For * more information, see * CreateDBCluster.
Valid for Cluster Type: Aurora DB clusters only
*/ inline void SetEngineMode(Aws::String&& value) { m_engineModeHasBeenSet = true; m_engineMode = std::move(value); } /** *The DB engine mode of the DB cluster, either provisioned
or
* serverless
.
The DB engine mode can be modified only
* from serverless
to provisioned
.
For * more information, see * CreateDBCluster.
Valid for Cluster Type: Aurora DB clusters only
*/ inline void SetEngineMode(const char* value) { m_engineModeHasBeenSet = true; m_engineMode.assign(value); } /** *The DB engine mode of the DB cluster, either provisioned
or
* serverless
.
The DB engine mode can be modified only
* from serverless
to provisioned
.
For * more information, see * CreateDBCluster.
Valid for Cluster Type: Aurora DB clusters only
*/ inline ModifyDBClusterRequest& WithEngineMode(const Aws::String& value) { SetEngineMode(value); return *this;} /** *The DB engine mode of the DB cluster, either provisioned
or
* serverless
.
The DB engine mode can be modified only
* from serverless
to provisioned
.
For * more information, see * CreateDBCluster.
Valid for Cluster Type: Aurora DB clusters only
*/ inline ModifyDBClusterRequest& WithEngineMode(Aws::String&& value) { SetEngineMode(std::move(value)); return *this;} /** *The DB engine mode of the DB cluster, either provisioned
or
* serverless
.
The DB engine mode can be modified only
* from serverless
to provisioned
.
For * more information, see * CreateDBCluster.
Valid for Cluster Type: Aurora DB clusters only
*/ inline ModifyDBClusterRequest& WithEngineMode(const char* value) { SetEngineMode(value); return *this;} /** *Specifies whether engine mode changes from serverless
to
* provisioned
are allowed.
Valid for Cluster Type: Aurora * Serverless v1 DB clusters only
Constraints:
You must
* allow engine mode changes when specifying a different value for the
* EngineMode
parameter from the DB cluster's current engine mode.
Specifies whether engine mode changes from serverless
to
* provisioned
are allowed.
Valid for Cluster Type: Aurora * Serverless v1 DB clusters only
Constraints:
You must
* allow engine mode changes when specifying a different value for the
* EngineMode
parameter from the DB cluster's current engine mode.
Specifies whether engine mode changes from serverless
to
* provisioned
are allowed.
Valid for Cluster Type: Aurora * Serverless v1 DB clusters only
Constraints:
You must
* allow engine mode changes when specifying a different value for the
* EngineMode
parameter from the DB cluster's current engine mode.
Specifies whether engine mode changes from serverless
to
* provisioned
are allowed.
Valid for Cluster Type: Aurora * Serverless v1 DB clusters only
Constraints:
You must
* allow engine mode changes when specifying a different value for the
* EngineMode
parameter from the DB cluster's current engine mode.