// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
/// <p>Represents the input to <code>ModifyDBCluster</code>.</p>
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct ModifyDbClusterInput {
/// <p>The cluster identifier for the cluster that is being modified. This parameter is not case sensitive.</p>
/// <p>Constraints:</p>
/// <ul>
/// <li>
/// <p>Must match the identifier of an existing <code>DBCluster</code>.</p></li>
/// </ul>
pub db_cluster_identifier: ::std::option::Option<::std::string::String>,
/// <p>The new cluster identifier for the cluster when renaming a cluster. This value is stored as a lowercase string.</p>
/// <p>Constraints:</p>
/// <ul>
/// <li>
/// <p>Must contain from 1 to 63 letters, numbers, or hyphens.</p></li>
/// <li>
/// <p>The first character must be a letter.</p></li>
/// <li>
/// <p>Cannot end with a hyphen or contain two consecutive hyphens.</p></li>
/// </ul>
/// <p>Example: <code>my-cluster2</code></p>
pub new_db_cluster_identifier: ::std::option::Option<::std::string::String>,
/// <p>A value that specifies whether the changes in this request and any pending changes are asynchronously applied as soon as possible, regardless of the <code>PreferredMaintenanceWindow</code> setting for the cluster. If this parameter is set to <code>false</code>, changes to the cluster are applied during the next maintenance window.</p>
/// <p>The <code>ApplyImmediately</code> parameter affects only the <code>NewDBClusterIdentifier</code> and <code>MasterUserPassword</code> values. If you set this parameter value to <code>false</code>, the changes to the <code>NewDBClusterIdentifier</code> and <code>MasterUserPassword</code> values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the <code>ApplyImmediately</code> parameter.</p>
/// <p>Default: <code>false</code></p>
pub apply_immediately: ::std::option::Option<bool>,
/// <p>The number of days for which automated backups are retained. You must specify a minimum value of 1.</p>
/// <p>Default: 1</p>
/// <p>Constraints:</p>
/// <ul>
/// <li>
/// <p>Must be a value from 1 to 35.</p></li>
/// </ul>
pub backup_retention_period: ::std::option::Option<i32>,
/// <p>The name of the cluster parameter group to use for the cluster.</p>
pub db_cluster_parameter_group_name: ::std::option::Option<::std::string::String>,
/// <p>A list of virtual private cloud (VPC) security groups that the cluster will belong to.</p>
pub vpc_security_group_ids: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
/// <p>The port number on which the cluster accepts connections.</p>
/// <p>Constraints: Must be a value from <code>1150</code> to <code>65535</code>.</p>
/// <p>Default: The same port as the original cluster.</p>
pub port: ::std::option::Option<i32>,
/// <p>The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).</p>
/// <p>Constraints: Must contain from 8 to 100 characters.</p>
pub master_user_password: ::std::option::Option<::std::string::String>,
/// <p>The daily time range during which automated backups are created if automated backups are enabled, using the <code>BackupRetentionPeriod</code> parameter.</p>
/// <p>The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region.</p>
/// <p>Constraints:</p>
/// <ul>
/// <li>
/// <p>Must be in the format <code>hh24:mi-hh24:mi</code>.</p></li>
/// <li>
/// <p>Must be in Universal Coordinated Time (UTC).</p></li>
/// <li>
/// <p>Must not conflict with the preferred maintenance window.</p></li>
/// <li>
/// <p>Must be at least 30 minutes.</p></li>
/// </ul>
pub preferred_backup_window: ::std::option::Option<::std::string::String>,
/// <p>The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).</p>
/// <p>Format: <code>ddd:hh24:mi-ddd:hh24:mi</code></p>
/// <p>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.</p>
/// <p>Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun</p>
/// <p>Constraints: Minimum 30-minute window.</p>
pub preferred_maintenance_window: ::std::option::Option<::std::string::String>,
/// <p>The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific instance or cluster. The <code>EnableLogTypes</code> and <code>DisableLogTypes</code> arrays determine which logs are exported (or not exported) to CloudWatch Logs.</p>
pub cloudwatch_logs_export_configuration: ::std::option::Option<crate::types::CloudwatchLogsExportConfiguration>,
/// <p>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 <code>ApplyImmediately</code> is enabled.</p>
/// <p>To list all of the available engine versions for Amazon DocumentDB use the following command:</p>
/// <p><code>aws docdb describe-db-engine-versions --engine docdb --query "DBEngineVersions\[\].EngineVersion"</code></p>
pub engine_version: ::std::option::Option<::std::string::String>,
/// <p>A value that indicates whether major version upgrades are allowed.</p>
/// <p>Constraints:</p>
/// <ul>
/// <li>
/// <p>You must allow major version upgrades when specifying a value for the <code>EngineVersion</code> parameter that is a different major version than the cluster's current version.</p></li>
/// <li>
/// <p>Since some parameters are version specific, changing them requires executing a new <code>ModifyDBCluster</code> API call after the in-place MVU completes.</p></li>
/// </ul><note>
/// <p>Performing an MVU directly impacts the following parameters:</p>
/// <ul>
/// <li>
/// <p><code>MasterUserPassword</code></p></li>
/// <li>
/// <p><code>NewDBClusterIdentifier</code></p></li>
/// <li>
/// <p><code>VpcSecurityGroupIds</code></p></li>
/// <li>
/// <p><code>Port</code></p></li>
/// </ul>
/// </note>
pub allow_major_version_upgrade: ::std::option::Option<bool>,
/// <p>Specifies whether this cluster can be deleted. If <code>DeletionProtection</code> is enabled, the cluster cannot be deleted unless it is modified and <code>DeletionProtection</code> is disabled. <code>DeletionProtection</code> protects clusters from being accidentally deleted.</p>
pub deletion_protection: ::std::option::Option<bool>,
/// <p>The storage type to associate with the DB cluster.</p>
/// <p>For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the <i>Amazon DocumentDB Developer Guide</i>.</p>
/// <p>Valid values for storage type - <code>standard | iopt1</code></p>
/// <p>Default value is <code>standard </code></p>
pub storage_type: ::std::option::Option<::std::string::String>,
/// <p>Contains the scaling configuration of an Amazon DocumentDB Serverless cluster.</p>
pub serverless_v2_scaling_configuration: ::std::option::Option<crate::types::ServerlessV2ScalingConfiguration>,
/// <p>Specifies whether to manage the master user password with Amazon Web Services Secrets Manager. If the 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 <code>MasterUserPassword</code>. If the 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 <code>MasterUserPassword</code>. In this case, Amazon DocumentDB deletes the secret and uses the new password for the master user specified by <code>MasterUserPassword</code>.</p>
pub manage_master_user_password: ::std::option::Option<bool>,
/// <p>The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.</p>
/// <p>This setting is valid only if both of the following conditions are met:</p>
/// <ul>
/// <li>
/// <p>The cluster doesn't manage the master user password in Amazon Web Services Secrets Manager. If the 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.</p></li>
/// <li>
/// <p>You are enabling <code>ManageMasterUserPassword</code> to manage the master user password in Amazon Web Services Secrets Manager. If you are turning on <code>ManageMasterUserPassword</code> and don't specify <code>MasterUserSecretKmsKeyId</code>, then the <code>aws/secretsmanager</code> 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 <code>aws/secretsmanager</code> KMS key to encrypt the secret, and you must use a customer managed KMS key.</p></li>
/// </ul>
/// <p>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.</p>
/// <p>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.</p>
pub master_user_secret_kms_key_id: ::std::option::Option<::std::string::String>,
/// <p>Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.</p>
/// <p>This setting is valid only if the master user password is managed by Amazon DocumentDB in Amazon Web Services Secrets Manager for the cluster. The secret value contains the updated password.</p>
/// <p>Constraint: You must apply the change immediately when rotating the master user password.</p>
pub rotate_master_user_password: ::std::option::Option<bool>,
/// <p>The network type of the cluster.</p>
/// <p>The network type is determined by the <code>DBSubnetGroup</code> specified for the cluster. A <code>DBSubnetGroup</code> can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (<code>DUAL</code>).</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html">DocumentDB clusters in a VPC</a> in the Amazon DocumentDB Developer Guide.</p>
/// <p>Valid Values: <code>IPV4</code> | <code>DUAL</code></p>
pub network_type: ::std::option::Option<::std::string::String>,
}
impl ModifyDbClusterInput {
/// <p>The cluster identifier for the cluster that is being modified. This parameter is not case sensitive.</p>
/// <p>Constraints:</p>
/// <ul>
/// <li>
/// <p>Must match the identifier of an existing <code>DBCluster</code>.</p></li>
/// </ul>
pub fn db_cluster_identifier(&self) -> ::std::option::Option<&str> {
self.db_cluster_identifier.as_deref()
}
/// <p>The new cluster identifier for the cluster when renaming a cluster. This value is stored as a lowercase string.</p>
/// <p>Constraints:</p>
/// <ul>
/// <li>
/// <p>Must contain from 1 to 63 letters, numbers, or hyphens.</p></li>
/// <li>
/// <p>The first character must be a letter.</p></li>
/// <li>
/// <p>Cannot end with a hyphen or contain two consecutive hyphens.</p></li>
/// </ul>
/// <p>Example: <code>my-cluster2</code></p>
pub fn new_db_cluster_identifier(&self) -> ::std::option::Option<&str> {
self.new_db_cluster_identifier.as_deref()
}
/// <p>A value that specifies whether the changes in this request and any pending changes are asynchronously applied as soon as possible, regardless of the <code>PreferredMaintenanceWindow</code> setting for the cluster. If this parameter is set to <code>false</code>, changes to the cluster are applied during the next maintenance window.</p>
/// <p>The <code>ApplyImmediately</code> parameter affects only the <code>NewDBClusterIdentifier</code> and <code>MasterUserPassword</code> values. If you set this parameter value to <code>false</code>, the changes to the <code>NewDBClusterIdentifier</code> and <code>MasterUserPassword</code> values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the <code>ApplyImmediately</code> parameter.</p>
/// <p>Default: <code>false</code></p>
pub fn apply_immediately(&self) -> ::std::option::Option<bool> {
self.apply_immediately
}
/// <p>The number of days for which automated backups are retained. You must specify a minimum value of 1.</p>
/// <p>Default: 1</p>
/// <p>Constraints:</p>
/// <ul>
/// <li>
/// <p>Must be a value from 1 to 35.</p></li>
/// </ul>
pub fn backup_retention_period(&self) -> ::std::option::Option<i32> {
self.backup_retention_period
}
/// <p>The name of the cluster parameter group to use for the cluster.</p>
pub fn db_cluster_parameter_group_name(&self) -> ::std::option::Option<&str> {
self.db_cluster_parameter_group_name.as_deref()
}
/// <p>A list of virtual private cloud (VPC) security groups that the cluster will belong to.</p>
///
/// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.vpc_security_group_ids.is_none()`.
pub fn vpc_security_group_ids(&self) -> &[::std::string::String] {
self.vpc_security_group_ids.as_deref().unwrap_or_default()
}
/// <p>The port number on which the cluster accepts connections.</p>
/// <p>Constraints: Must be a value from <code>1150</code> to <code>65535</code>.</p>
/// <p>Default: The same port as the original cluster.</p>
pub fn port(&self) -> ::std::option::Option<i32> {
self.port
}
/// <p>The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).</p>
/// <p>Constraints: Must contain from 8 to 100 characters.</p>
pub fn master_user_password(&self) -> ::std::option::Option<&str> {
self.master_user_password.as_deref()
}
/// <p>The daily time range during which automated backups are created if automated backups are enabled, using the <code>BackupRetentionPeriod</code> parameter.</p>
/// <p>The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region.</p>
/// <p>Constraints:</p>
/// <ul>
/// <li>
/// <p>Must be in the format <code>hh24:mi-hh24:mi</code>.</p></li>
/// <li>
/// <p>Must be in Universal Coordinated Time (UTC).</p></li>
/// <li>
/// <p>Must not conflict with the preferred maintenance window.</p></li>
/// <li>
/// <p>Must be at least 30 minutes.</p></li>
/// </ul>
pub fn preferred_backup_window(&self) -> ::std::option::Option<&str> {
self.preferred_backup_window.as_deref()
}
/// <p>The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).</p>
/// <p>Format: <code>ddd:hh24:mi-ddd:hh24:mi</code></p>
/// <p>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.</p>
/// <p>Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun</p>
/// <p>Constraints: Minimum 30-minute window.</p>
pub fn preferred_maintenance_window(&self) -> ::std::option::Option<&str> {
self.preferred_maintenance_window.as_deref()
}
/// <p>The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific instance or cluster. The <code>EnableLogTypes</code> and <code>DisableLogTypes</code> arrays determine which logs are exported (or not exported) to CloudWatch Logs.</p>
pub fn cloudwatch_logs_export_configuration(&self) -> ::std::option::Option<&crate::types::CloudwatchLogsExportConfiguration> {
self.cloudwatch_logs_export_configuration.as_ref()
}
/// <p>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 <code>ApplyImmediately</code> is enabled.</p>
/// <p>To list all of the available engine versions for Amazon DocumentDB use the following command:</p>
/// <p><code>aws docdb describe-db-engine-versions --engine docdb --query "DBEngineVersions\[\].EngineVersion"</code></p>
pub fn engine_version(&self) -> ::std::option::Option<&str> {
self.engine_version.as_deref()
}
/// <p>A value that indicates whether major version upgrades are allowed.</p>
/// <p>Constraints:</p>
/// <ul>
/// <li>
/// <p>You must allow major version upgrades when specifying a value for the <code>EngineVersion</code> parameter that is a different major version than the cluster's current version.</p></li>
/// <li>
/// <p>Since some parameters are version specific, changing them requires executing a new <code>ModifyDBCluster</code> API call after the in-place MVU completes.</p></li>
/// </ul><note>
/// <p>Performing an MVU directly impacts the following parameters:</p>
/// <ul>
/// <li>
/// <p><code>MasterUserPassword</code></p></li>
/// <li>
/// <p><code>NewDBClusterIdentifier</code></p></li>
/// <li>
/// <p><code>VpcSecurityGroupIds</code></p></li>
/// <li>
/// <p><code>Port</code></p></li>
/// </ul>
/// </note>
pub fn allow_major_version_upgrade(&self) -> ::std::option::Option<bool> {
self.allow_major_version_upgrade
}
/// <p>Specifies whether this cluster can be deleted. If <code>DeletionProtection</code> is enabled, the cluster cannot be deleted unless it is modified and <code>DeletionProtection</code> is disabled. <code>DeletionProtection</code> protects clusters from being accidentally deleted.</p>
pub fn deletion_protection(&self) -> ::std::option::Option<bool> {
self.deletion_protection
}
/// <p>The storage type to associate with the DB cluster.</p>
/// <p>For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the <i>Amazon DocumentDB Developer Guide</i>.</p>
/// <p>Valid values for storage type - <code>standard | iopt1</code></p>
/// <p>Default value is <code>standard </code></p>
pub fn storage_type(&self) -> ::std::option::Option<&str> {
self.storage_type.as_deref()
}
/// <p>Contains the scaling configuration of an Amazon DocumentDB Serverless cluster.</p>
pub fn serverless_v2_scaling_configuration(&self) -> ::std::option::Option<&crate::types::ServerlessV2ScalingConfiguration> {
self.serverless_v2_scaling_configuration.as_ref()
}
/// <p>Specifies whether to manage the master user password with Amazon Web Services Secrets Manager. If the 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 <code>MasterUserPassword</code>. If the 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 <code>MasterUserPassword</code>. In this case, Amazon DocumentDB deletes the secret and uses the new password for the master user specified by <code>MasterUserPassword</code>.</p>
pub fn manage_master_user_password(&self) -> ::std::option::Option<bool> {
self.manage_master_user_password
}
/// <p>The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.</p>
/// <p>This setting is valid only if both of the following conditions are met:</p>
/// <ul>
/// <li>
/// <p>The cluster doesn't manage the master user password in Amazon Web Services Secrets Manager. If the 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.</p></li>
/// <li>
/// <p>You are enabling <code>ManageMasterUserPassword</code> to manage the master user password in Amazon Web Services Secrets Manager. If you are turning on <code>ManageMasterUserPassword</code> and don't specify <code>MasterUserSecretKmsKeyId</code>, then the <code>aws/secretsmanager</code> 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 <code>aws/secretsmanager</code> KMS key to encrypt the secret, and you must use a customer managed KMS key.</p></li>
/// </ul>
/// <p>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.</p>
/// <p>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.</p>
pub fn master_user_secret_kms_key_id(&self) -> ::std::option::Option<&str> {
self.master_user_secret_kms_key_id.as_deref()
}
/// <p>Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.</p>
/// <p>This setting is valid only if the master user password is managed by Amazon DocumentDB in Amazon Web Services Secrets Manager for the cluster. The secret value contains the updated password.</p>
/// <p>Constraint: You must apply the change immediately when rotating the master user password.</p>
pub fn rotate_master_user_password(&self) -> ::std::option::Option<bool> {
self.rotate_master_user_password
}
/// <p>The network type of the cluster.</p>
/// <p>The network type is determined by the <code>DBSubnetGroup</code> specified for the cluster. A <code>DBSubnetGroup</code> can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (<code>DUAL</code>).</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html">DocumentDB clusters in a VPC</a> in the Amazon DocumentDB Developer Guide.</p>
/// <p>Valid Values: <code>IPV4</code> | <code>DUAL</code></p>
pub fn network_type(&self) -> ::std::option::Option<&str> {
self.network_type.as_deref()
}
}
impl ModifyDbClusterInput {
/// Creates a new builder-style object to manufacture [`ModifyDbClusterInput`](crate::operation::modify_db_cluster::ModifyDbClusterInput).
pub fn builder() -> crate::operation::modify_db_cluster::builders::ModifyDbClusterInputBuilder {
crate::operation::modify_db_cluster::builders::ModifyDbClusterInputBuilder::default()
}
}
/// A builder for [`ModifyDbClusterInput`](crate::operation::modify_db_cluster::ModifyDbClusterInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct ModifyDbClusterInputBuilder {
pub(crate) db_cluster_identifier: ::std::option::Option<::std::string::String>,
pub(crate) new_db_cluster_identifier: ::std::option::Option<::std::string::String>,
pub(crate) apply_immediately: ::std::option::Option<bool>,
pub(crate) backup_retention_period: ::std::option::Option<i32>,
pub(crate) db_cluster_parameter_group_name: ::std::option::Option<::std::string::String>,
pub(crate) vpc_security_group_ids: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
pub(crate) port: ::std::option::Option<i32>,
pub(crate) master_user_password: ::std::option::Option<::std::string::String>,
pub(crate) preferred_backup_window: ::std::option::Option<::std::string::String>,
pub(crate) preferred_maintenance_window: ::std::option::Option<::std::string::String>,
pub(crate) cloudwatch_logs_export_configuration: ::std::option::Option<crate::types::CloudwatchLogsExportConfiguration>,
pub(crate) engine_version: ::std::option::Option<::std::string::String>,
pub(crate) allow_major_version_upgrade: ::std::option::Option<bool>,
pub(crate) deletion_protection: ::std::option::Option<bool>,
pub(crate) storage_type: ::std::option::Option<::std::string::String>,
pub(crate) serverless_v2_scaling_configuration: ::std::option::Option<crate::types::ServerlessV2ScalingConfiguration>,
pub(crate) manage_master_user_password: ::std::option::Option<bool>,
pub(crate) master_user_secret_kms_key_id: ::std::option::Option<::std::string::String>,
pub(crate) rotate_master_user_password: ::std::option::Option<bool>,
pub(crate) network_type: ::std::option::Option<::std::string::String>,
}
impl ModifyDbClusterInputBuilder {
/// <p>The cluster identifier for the cluster that is being modified. This parameter is not case sensitive.</p>
/// <p>Constraints:</p>
/// <ul>
/// <li>
/// <p>Must match the identifier of an existing <code>DBCluster</code>.</p></li>
/// </ul>
/// This field is required.
pub fn db_cluster_identifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.db_cluster_identifier = ::std::option::Option::Some(input.into());
self
}
/// <p>The cluster identifier for the cluster that is being modified. This parameter is not case sensitive.</p>
/// <p>Constraints:</p>
/// <ul>
/// <li>
/// <p>Must match the identifier of an existing <code>DBCluster</code>.</p></li>
/// </ul>
pub fn set_db_cluster_identifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.db_cluster_identifier = input;
self
}
/// <p>The cluster identifier for the cluster that is being modified. This parameter is not case sensitive.</p>
/// <p>Constraints:</p>
/// <ul>
/// <li>
/// <p>Must match the identifier of an existing <code>DBCluster</code>.</p></li>
/// </ul>
pub fn get_db_cluster_identifier(&self) -> &::std::option::Option<::std::string::String> {
&self.db_cluster_identifier
}
/// <p>The new cluster identifier for the cluster when renaming a cluster. This value is stored as a lowercase string.</p>
/// <p>Constraints:</p>
/// <ul>
/// <li>
/// <p>Must contain from 1 to 63 letters, numbers, or hyphens.</p></li>
/// <li>
/// <p>The first character must be a letter.</p></li>
/// <li>
/// <p>Cannot end with a hyphen or contain two consecutive hyphens.</p></li>
/// </ul>
/// <p>Example: <code>my-cluster2</code></p>
pub fn new_db_cluster_identifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.new_db_cluster_identifier = ::std::option::Option::Some(input.into());
self
}
/// <p>The new cluster identifier for the cluster when renaming a cluster. This value is stored as a lowercase string.</p>
/// <p>Constraints:</p>
/// <ul>
/// <li>
/// <p>Must contain from 1 to 63 letters, numbers, or hyphens.</p></li>
/// <li>
/// <p>The first character must be a letter.</p></li>
/// <li>
/// <p>Cannot end with a hyphen or contain two consecutive hyphens.</p></li>
/// </ul>
/// <p>Example: <code>my-cluster2</code></p>
pub fn set_new_db_cluster_identifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.new_db_cluster_identifier = input;
self
}
/// <p>The new cluster identifier for the cluster when renaming a cluster. This value is stored as a lowercase string.</p>
/// <p>Constraints:</p>
/// <ul>
/// <li>
/// <p>Must contain from 1 to 63 letters, numbers, or hyphens.</p></li>
/// <li>
/// <p>The first character must be a letter.</p></li>
/// <li>
/// <p>Cannot end with a hyphen or contain two consecutive hyphens.</p></li>
/// </ul>
/// <p>Example: <code>my-cluster2</code></p>
pub fn get_new_db_cluster_identifier(&self) -> &::std::option::Option<::std::string::String> {
&self.new_db_cluster_identifier
}
/// <p>A value that specifies whether the changes in this request and any pending changes are asynchronously applied as soon as possible, regardless of the <code>PreferredMaintenanceWindow</code> setting for the cluster. If this parameter is set to <code>false</code>, changes to the cluster are applied during the next maintenance window.</p>
/// <p>The <code>ApplyImmediately</code> parameter affects only the <code>NewDBClusterIdentifier</code> and <code>MasterUserPassword</code> values. If you set this parameter value to <code>false</code>, the changes to the <code>NewDBClusterIdentifier</code> and <code>MasterUserPassword</code> values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the <code>ApplyImmediately</code> parameter.</p>
/// <p>Default: <code>false</code></p>
pub fn apply_immediately(mut self, input: bool) -> Self {
self.apply_immediately = ::std::option::Option::Some(input);
self
}
/// <p>A value that specifies whether the changes in this request and any pending changes are asynchronously applied as soon as possible, regardless of the <code>PreferredMaintenanceWindow</code> setting for the cluster. If this parameter is set to <code>false</code>, changes to the cluster are applied during the next maintenance window.</p>
/// <p>The <code>ApplyImmediately</code> parameter affects only the <code>NewDBClusterIdentifier</code> and <code>MasterUserPassword</code> values. If you set this parameter value to <code>false</code>, the changes to the <code>NewDBClusterIdentifier</code> and <code>MasterUserPassword</code> values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the <code>ApplyImmediately</code> parameter.</p>
/// <p>Default: <code>false</code></p>
pub fn set_apply_immediately(mut self, input: ::std::option::Option<bool>) -> Self {
self.apply_immediately = input;
self
}
/// <p>A value that specifies whether the changes in this request and any pending changes are asynchronously applied as soon as possible, regardless of the <code>PreferredMaintenanceWindow</code> setting for the cluster. If this parameter is set to <code>false</code>, changes to the cluster are applied during the next maintenance window.</p>
/// <p>The <code>ApplyImmediately</code> parameter affects only the <code>NewDBClusterIdentifier</code> and <code>MasterUserPassword</code> values. If you set this parameter value to <code>false</code>, the changes to the <code>NewDBClusterIdentifier</code> and <code>MasterUserPassword</code> values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the <code>ApplyImmediately</code> parameter.</p>
/// <p>Default: <code>false</code></p>
pub fn get_apply_immediately(&self) -> &::std::option::Option<bool> {
&self.apply_immediately
}
/// <p>The number of days for which automated backups are retained. You must specify a minimum value of 1.</p>
/// <p>Default: 1</p>
/// <p>Constraints:</p>
/// <ul>
/// <li>
/// <p>Must be a value from 1 to 35.</p></li>
/// </ul>
pub fn backup_retention_period(mut self, input: i32) -> Self {
self.backup_retention_period = ::std::option::Option::Some(input);
self
}
/// <p>The number of days for which automated backups are retained. You must specify a minimum value of 1.</p>
/// <p>Default: 1</p>
/// <p>Constraints:</p>
/// <ul>
/// <li>
/// <p>Must be a value from 1 to 35.</p></li>
/// </ul>
pub fn set_backup_retention_period(mut self, input: ::std::option::Option<i32>) -> Self {
self.backup_retention_period = input;
self
}
/// <p>The number of days for which automated backups are retained. You must specify a minimum value of 1.</p>
/// <p>Default: 1</p>
/// <p>Constraints:</p>
/// <ul>
/// <li>
/// <p>Must be a value from 1 to 35.</p></li>
/// </ul>
pub fn get_backup_retention_period(&self) -> &::std::option::Option<i32> {
&self.backup_retention_period
}
/// <p>The name of the cluster parameter group to use for the cluster.</p>
pub fn db_cluster_parameter_group_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.db_cluster_parameter_group_name = ::std::option::Option::Some(input.into());
self
}
/// <p>The name of the cluster parameter group to use for the cluster.</p>
pub fn set_db_cluster_parameter_group_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.db_cluster_parameter_group_name = input;
self
}
/// <p>The name of the cluster parameter group to use for the cluster.</p>
pub fn get_db_cluster_parameter_group_name(&self) -> &::std::option::Option<::std::string::String> {
&self.db_cluster_parameter_group_name
}
/// Appends an item to `vpc_security_group_ids`.
///
/// To override the contents of this collection use [`set_vpc_security_group_ids`](Self::set_vpc_security_group_ids).
///
/// <p>A list of virtual private cloud (VPC) security groups that the cluster will belong to.</p>
pub fn vpc_security_group_ids(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
let mut v = self.vpc_security_group_ids.unwrap_or_default();
v.push(input.into());
self.vpc_security_group_ids = ::std::option::Option::Some(v);
self
}
/// <p>A list of virtual private cloud (VPC) security groups that the cluster will belong to.</p>
pub fn set_vpc_security_group_ids(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
self.vpc_security_group_ids = input;
self
}
/// <p>A list of virtual private cloud (VPC) security groups that the cluster will belong to.</p>
pub fn get_vpc_security_group_ids(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
&self.vpc_security_group_ids
}
/// <p>The port number on which the cluster accepts connections.</p>
/// <p>Constraints: Must be a value from <code>1150</code> to <code>65535</code>.</p>
/// <p>Default: The same port as the original cluster.</p>
pub fn port(mut self, input: i32) -> Self {
self.port = ::std::option::Option::Some(input);
self
}
/// <p>The port number on which the cluster accepts connections.</p>
/// <p>Constraints: Must be a value from <code>1150</code> to <code>65535</code>.</p>
/// <p>Default: The same port as the original cluster.</p>
pub fn set_port(mut self, input: ::std::option::Option<i32>) -> Self {
self.port = input;
self
}
/// <p>The port number on which the cluster accepts connections.</p>
/// <p>Constraints: Must be a value from <code>1150</code> to <code>65535</code>.</p>
/// <p>Default: The same port as the original cluster.</p>
pub fn get_port(&self) -> &::std::option::Option<i32> {
&self.port
}
/// <p>The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).</p>
/// <p>Constraints: Must contain from 8 to 100 characters.</p>
pub fn master_user_password(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.master_user_password = ::std::option::Option::Some(input.into());
self
}
/// <p>The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).</p>
/// <p>Constraints: Must contain from 8 to 100 characters.</p>
pub fn set_master_user_password(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.master_user_password = input;
self
}
/// <p>The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).</p>
/// <p>Constraints: Must contain from 8 to 100 characters.</p>
pub fn get_master_user_password(&self) -> &::std::option::Option<::std::string::String> {
&self.master_user_password
}
/// <p>The daily time range during which automated backups are created if automated backups are enabled, using the <code>BackupRetentionPeriod</code> parameter.</p>
/// <p>The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region.</p>
/// <p>Constraints:</p>
/// <ul>
/// <li>
/// <p>Must be in the format <code>hh24:mi-hh24:mi</code>.</p></li>
/// <li>
/// <p>Must be in Universal Coordinated Time (UTC).</p></li>
/// <li>
/// <p>Must not conflict with the preferred maintenance window.</p></li>
/// <li>
/// <p>Must be at least 30 minutes.</p></li>
/// </ul>
pub fn preferred_backup_window(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.preferred_backup_window = ::std::option::Option::Some(input.into());
self
}
/// <p>The daily time range during which automated backups are created if automated backups are enabled, using the <code>BackupRetentionPeriod</code> parameter.</p>
/// <p>The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region.</p>
/// <p>Constraints:</p>
/// <ul>
/// <li>
/// <p>Must be in the format <code>hh24:mi-hh24:mi</code>.</p></li>
/// <li>
/// <p>Must be in Universal Coordinated Time (UTC).</p></li>
/// <li>
/// <p>Must not conflict with the preferred maintenance window.</p></li>
/// <li>
/// <p>Must be at least 30 minutes.</p></li>
/// </ul>
pub fn set_preferred_backup_window(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.preferred_backup_window = input;
self
}
/// <p>The daily time range during which automated backups are created if automated backups are enabled, using the <code>BackupRetentionPeriod</code> parameter.</p>
/// <p>The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region.</p>
/// <p>Constraints:</p>
/// <ul>
/// <li>
/// <p>Must be in the format <code>hh24:mi-hh24:mi</code>.</p></li>
/// <li>
/// <p>Must be in Universal Coordinated Time (UTC).</p></li>
/// <li>
/// <p>Must not conflict with the preferred maintenance window.</p></li>
/// <li>
/// <p>Must be at least 30 minutes.</p></li>
/// </ul>
pub fn get_preferred_backup_window(&self) -> &::std::option::Option<::std::string::String> {
&self.preferred_backup_window
}
/// <p>The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).</p>
/// <p>Format: <code>ddd:hh24:mi-ddd:hh24:mi</code></p>
/// <p>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.</p>
/// <p>Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun</p>
/// <p>Constraints: Minimum 30-minute window.</p>
pub fn preferred_maintenance_window(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.preferred_maintenance_window = ::std::option::Option::Some(input.into());
self
}
/// <p>The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).</p>
/// <p>Format: <code>ddd:hh24:mi-ddd:hh24:mi</code></p>
/// <p>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.</p>
/// <p>Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun</p>
/// <p>Constraints: Minimum 30-minute window.</p>
pub fn set_preferred_maintenance_window(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.preferred_maintenance_window = input;
self
}
/// <p>The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).</p>
/// <p>Format: <code>ddd:hh24:mi-ddd:hh24:mi</code></p>
/// <p>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.</p>
/// <p>Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun</p>
/// <p>Constraints: Minimum 30-minute window.</p>
pub fn get_preferred_maintenance_window(&self) -> &::std::option::Option<::std::string::String> {
&self.preferred_maintenance_window
}
/// <p>The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific instance or cluster. The <code>EnableLogTypes</code> and <code>DisableLogTypes</code> arrays determine which logs are exported (or not exported) to CloudWatch Logs.</p>
pub fn cloudwatch_logs_export_configuration(mut self, input: crate::types::CloudwatchLogsExportConfiguration) -> Self {
self.cloudwatch_logs_export_configuration = ::std::option::Option::Some(input);
self
}
/// <p>The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific instance or cluster. The <code>EnableLogTypes</code> and <code>DisableLogTypes</code> arrays determine which logs are exported (or not exported) to CloudWatch Logs.</p>
pub fn set_cloudwatch_logs_export_configuration(mut self, input: ::std::option::Option<crate::types::CloudwatchLogsExportConfiguration>) -> Self {
self.cloudwatch_logs_export_configuration = input;
self
}
/// <p>The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific instance or cluster. The <code>EnableLogTypes</code> and <code>DisableLogTypes</code> arrays determine which logs are exported (or not exported) to CloudWatch Logs.</p>
pub fn get_cloudwatch_logs_export_configuration(&self) -> &::std::option::Option<crate::types::CloudwatchLogsExportConfiguration> {
&self.cloudwatch_logs_export_configuration
}
/// <p>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 <code>ApplyImmediately</code> is enabled.</p>
/// <p>To list all of the available engine versions for Amazon DocumentDB use the following command:</p>
/// <p><code>aws docdb describe-db-engine-versions --engine docdb --query "DBEngineVersions\[\].EngineVersion"</code></p>
pub fn engine_version(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.engine_version = ::std::option::Option::Some(input.into());
self
}
/// <p>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 <code>ApplyImmediately</code> is enabled.</p>
/// <p>To list all of the available engine versions for Amazon DocumentDB use the following command:</p>
/// <p><code>aws docdb describe-db-engine-versions --engine docdb --query "DBEngineVersions\[\].EngineVersion"</code></p>
pub fn set_engine_version(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.engine_version = input;
self
}
/// <p>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 <code>ApplyImmediately</code> is enabled.</p>
/// <p>To list all of the available engine versions for Amazon DocumentDB use the following command:</p>
/// <p><code>aws docdb describe-db-engine-versions --engine docdb --query "DBEngineVersions\[\].EngineVersion"</code></p>
pub fn get_engine_version(&self) -> &::std::option::Option<::std::string::String> {
&self.engine_version
}
/// <p>A value that indicates whether major version upgrades are allowed.</p>
/// <p>Constraints:</p>
/// <ul>
/// <li>
/// <p>You must allow major version upgrades when specifying a value for the <code>EngineVersion</code> parameter that is a different major version than the cluster's current version.</p></li>
/// <li>
/// <p>Since some parameters are version specific, changing them requires executing a new <code>ModifyDBCluster</code> API call after the in-place MVU completes.</p></li>
/// </ul><note>
/// <p>Performing an MVU directly impacts the following parameters:</p>
/// <ul>
/// <li>
/// <p><code>MasterUserPassword</code></p></li>
/// <li>
/// <p><code>NewDBClusterIdentifier</code></p></li>
/// <li>
/// <p><code>VpcSecurityGroupIds</code></p></li>
/// <li>
/// <p><code>Port</code></p></li>
/// </ul>
/// </note>
pub fn allow_major_version_upgrade(mut self, input: bool) -> Self {
self.allow_major_version_upgrade = ::std::option::Option::Some(input);
self
}
/// <p>A value that indicates whether major version upgrades are allowed.</p>
/// <p>Constraints:</p>
/// <ul>
/// <li>
/// <p>You must allow major version upgrades when specifying a value for the <code>EngineVersion</code> parameter that is a different major version than the cluster's current version.</p></li>
/// <li>
/// <p>Since some parameters are version specific, changing them requires executing a new <code>ModifyDBCluster</code> API call after the in-place MVU completes.</p></li>
/// </ul><note>
/// <p>Performing an MVU directly impacts the following parameters:</p>
/// <ul>
/// <li>
/// <p><code>MasterUserPassword</code></p></li>
/// <li>
/// <p><code>NewDBClusterIdentifier</code></p></li>
/// <li>
/// <p><code>VpcSecurityGroupIds</code></p></li>
/// <li>
/// <p><code>Port</code></p></li>
/// </ul>
/// </note>
pub fn set_allow_major_version_upgrade(mut self, input: ::std::option::Option<bool>) -> Self {
self.allow_major_version_upgrade = input;
self
}
/// <p>A value that indicates whether major version upgrades are allowed.</p>
/// <p>Constraints:</p>
/// <ul>
/// <li>
/// <p>You must allow major version upgrades when specifying a value for the <code>EngineVersion</code> parameter that is a different major version than the cluster's current version.</p></li>
/// <li>
/// <p>Since some parameters are version specific, changing them requires executing a new <code>ModifyDBCluster</code> API call after the in-place MVU completes.</p></li>
/// </ul><note>
/// <p>Performing an MVU directly impacts the following parameters:</p>
/// <ul>
/// <li>
/// <p><code>MasterUserPassword</code></p></li>
/// <li>
/// <p><code>NewDBClusterIdentifier</code></p></li>
/// <li>
/// <p><code>VpcSecurityGroupIds</code></p></li>
/// <li>
/// <p><code>Port</code></p></li>
/// </ul>
/// </note>
pub fn get_allow_major_version_upgrade(&self) -> &::std::option::Option<bool> {
&self.allow_major_version_upgrade
}
/// <p>Specifies whether this cluster can be deleted. If <code>DeletionProtection</code> is enabled, the cluster cannot be deleted unless it is modified and <code>DeletionProtection</code> is disabled. <code>DeletionProtection</code> protects clusters from being accidentally deleted.</p>
pub fn deletion_protection(mut self, input: bool) -> Self {
self.deletion_protection = ::std::option::Option::Some(input);
self
}
/// <p>Specifies whether this cluster can be deleted. If <code>DeletionProtection</code> is enabled, the cluster cannot be deleted unless it is modified and <code>DeletionProtection</code> is disabled. <code>DeletionProtection</code> protects clusters from being accidentally deleted.</p>
pub fn set_deletion_protection(mut self, input: ::std::option::Option<bool>) -> Self {
self.deletion_protection = input;
self
}
/// <p>Specifies whether this cluster can be deleted. If <code>DeletionProtection</code> is enabled, the cluster cannot be deleted unless it is modified and <code>DeletionProtection</code> is disabled. <code>DeletionProtection</code> protects clusters from being accidentally deleted.</p>
pub fn get_deletion_protection(&self) -> &::std::option::Option<bool> {
&self.deletion_protection
}
/// <p>The storage type to associate with the DB cluster.</p>
/// <p>For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the <i>Amazon DocumentDB Developer Guide</i>.</p>
/// <p>Valid values for storage type - <code>standard | iopt1</code></p>
/// <p>Default value is <code>standard </code></p>
pub fn storage_type(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.storage_type = ::std::option::Option::Some(input.into());
self
}
/// <p>The storage type to associate with the DB cluster.</p>
/// <p>For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the <i>Amazon DocumentDB Developer Guide</i>.</p>
/// <p>Valid values for storage type - <code>standard | iopt1</code></p>
/// <p>Default value is <code>standard </code></p>
pub fn set_storage_type(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.storage_type = input;
self
}
/// <p>The storage type to associate with the DB cluster.</p>
/// <p>For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the <i>Amazon DocumentDB Developer Guide</i>.</p>
/// <p>Valid values for storage type - <code>standard | iopt1</code></p>
/// <p>Default value is <code>standard </code></p>
pub fn get_storage_type(&self) -> &::std::option::Option<::std::string::String> {
&self.storage_type
}
/// <p>Contains the scaling configuration of an Amazon DocumentDB Serverless cluster.</p>
pub fn serverless_v2_scaling_configuration(mut self, input: crate::types::ServerlessV2ScalingConfiguration) -> Self {
self.serverless_v2_scaling_configuration = ::std::option::Option::Some(input);
self
}
/// <p>Contains the scaling configuration of an Amazon DocumentDB Serverless cluster.</p>
pub fn set_serverless_v2_scaling_configuration(mut self, input: ::std::option::Option<crate::types::ServerlessV2ScalingConfiguration>) -> Self {
self.serverless_v2_scaling_configuration = input;
self
}
/// <p>Contains the scaling configuration of an Amazon DocumentDB Serverless cluster.</p>
pub fn get_serverless_v2_scaling_configuration(&self) -> &::std::option::Option<crate::types::ServerlessV2ScalingConfiguration> {
&self.serverless_v2_scaling_configuration
}
/// <p>Specifies whether to manage the master user password with Amazon Web Services Secrets Manager. If the 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 <code>MasterUserPassword</code>. If the 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 <code>MasterUserPassword</code>. In this case, Amazon DocumentDB deletes the secret and uses the new password for the master user specified by <code>MasterUserPassword</code>.</p>
pub fn manage_master_user_password(mut self, input: bool) -> Self {
self.manage_master_user_password = ::std::option::Option::Some(input);
self
}
/// <p>Specifies whether to manage the master user password with Amazon Web Services Secrets Manager. If the 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 <code>MasterUserPassword</code>. If the 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 <code>MasterUserPassword</code>. In this case, Amazon DocumentDB deletes the secret and uses the new password for the master user specified by <code>MasterUserPassword</code>.</p>
pub fn set_manage_master_user_password(mut self, input: ::std::option::Option<bool>) -> Self {
self.manage_master_user_password = input;
self
}
/// <p>Specifies whether to manage the master user password with Amazon Web Services Secrets Manager. If the 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 <code>MasterUserPassword</code>. If the 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 <code>MasterUserPassword</code>. In this case, Amazon DocumentDB deletes the secret and uses the new password for the master user specified by <code>MasterUserPassword</code>.</p>
pub fn get_manage_master_user_password(&self) -> &::std::option::Option<bool> {
&self.manage_master_user_password
}
/// <p>The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.</p>
/// <p>This setting is valid only if both of the following conditions are met:</p>
/// <ul>
/// <li>
/// <p>The cluster doesn't manage the master user password in Amazon Web Services Secrets Manager. If the 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.</p></li>
/// <li>
/// <p>You are enabling <code>ManageMasterUserPassword</code> to manage the master user password in Amazon Web Services Secrets Manager. If you are turning on <code>ManageMasterUserPassword</code> and don't specify <code>MasterUserSecretKmsKeyId</code>, then the <code>aws/secretsmanager</code> 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 <code>aws/secretsmanager</code> KMS key to encrypt the secret, and you must use a customer managed KMS key.</p></li>
/// </ul>
/// <p>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.</p>
/// <p>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.</p>
pub fn master_user_secret_kms_key_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.master_user_secret_kms_key_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.</p>
/// <p>This setting is valid only if both of the following conditions are met:</p>
/// <ul>
/// <li>
/// <p>The cluster doesn't manage the master user password in Amazon Web Services Secrets Manager. If the 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.</p></li>
/// <li>
/// <p>You are enabling <code>ManageMasterUserPassword</code> to manage the master user password in Amazon Web Services Secrets Manager. If you are turning on <code>ManageMasterUserPassword</code> and don't specify <code>MasterUserSecretKmsKeyId</code>, then the <code>aws/secretsmanager</code> 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 <code>aws/secretsmanager</code> KMS key to encrypt the secret, and you must use a customer managed KMS key.</p></li>
/// </ul>
/// <p>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.</p>
/// <p>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.</p>
pub fn set_master_user_secret_kms_key_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.master_user_secret_kms_key_id = input;
self
}
/// <p>The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.</p>
/// <p>This setting is valid only if both of the following conditions are met:</p>
/// <ul>
/// <li>
/// <p>The cluster doesn't manage the master user password in Amazon Web Services Secrets Manager. If the 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.</p></li>
/// <li>
/// <p>You are enabling <code>ManageMasterUserPassword</code> to manage the master user password in Amazon Web Services Secrets Manager. If you are turning on <code>ManageMasterUserPassword</code> and don't specify <code>MasterUserSecretKmsKeyId</code>, then the <code>aws/secretsmanager</code> 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 <code>aws/secretsmanager</code> KMS key to encrypt the secret, and you must use a customer managed KMS key.</p></li>
/// </ul>
/// <p>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.</p>
/// <p>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.</p>
pub fn get_master_user_secret_kms_key_id(&self) -> &::std::option::Option<::std::string::String> {
&self.master_user_secret_kms_key_id
}
/// <p>Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.</p>
/// <p>This setting is valid only if the master user password is managed by Amazon DocumentDB in Amazon Web Services Secrets Manager for the cluster. The secret value contains the updated password.</p>
/// <p>Constraint: You must apply the change immediately when rotating the master user password.</p>
pub fn rotate_master_user_password(mut self, input: bool) -> Self {
self.rotate_master_user_password = ::std::option::Option::Some(input);
self
}
/// <p>Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.</p>
/// <p>This setting is valid only if the master user password is managed by Amazon DocumentDB in Amazon Web Services Secrets Manager for the cluster. The secret value contains the updated password.</p>
/// <p>Constraint: You must apply the change immediately when rotating the master user password.</p>
pub fn set_rotate_master_user_password(mut self, input: ::std::option::Option<bool>) -> Self {
self.rotate_master_user_password = input;
self
}
/// <p>Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.</p>
/// <p>This setting is valid only if the master user password is managed by Amazon DocumentDB in Amazon Web Services Secrets Manager for the cluster. The secret value contains the updated password.</p>
/// <p>Constraint: You must apply the change immediately when rotating the master user password.</p>
pub fn get_rotate_master_user_password(&self) -> &::std::option::Option<bool> {
&self.rotate_master_user_password
}
/// <p>The network type of the cluster.</p>
/// <p>The network type is determined by the <code>DBSubnetGroup</code> specified for the cluster. A <code>DBSubnetGroup</code> can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (<code>DUAL</code>).</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html">DocumentDB clusters in a VPC</a> in the Amazon DocumentDB Developer Guide.</p>
/// <p>Valid Values: <code>IPV4</code> | <code>DUAL</code></p>
pub fn network_type(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.network_type = ::std::option::Option::Some(input.into());
self
}
/// <p>The network type of the cluster.</p>
/// <p>The network type is determined by the <code>DBSubnetGroup</code> specified for the cluster. A <code>DBSubnetGroup</code> can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (<code>DUAL</code>).</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html">DocumentDB clusters in a VPC</a> in the Amazon DocumentDB Developer Guide.</p>
/// <p>Valid Values: <code>IPV4</code> | <code>DUAL</code></p>
pub fn set_network_type(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.network_type = input;
self
}
/// <p>The network type of the cluster.</p>
/// <p>The network type is determined by the <code>DBSubnetGroup</code> specified for the cluster. A <code>DBSubnetGroup</code> can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (<code>DUAL</code>).</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html">DocumentDB clusters in a VPC</a> in the Amazon DocumentDB Developer Guide.</p>
/// <p>Valid Values: <code>IPV4</code> | <code>DUAL</code></p>
pub fn get_network_type(&self) -> &::std::option::Option<::std::string::String> {
&self.network_type
}
/// Consumes the builder and constructs a [`ModifyDbClusterInput`](crate::operation::modify_db_cluster::ModifyDbClusterInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::modify_db_cluster::ModifyDbClusterInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::modify_db_cluster::ModifyDbClusterInput {
db_cluster_identifier: self.db_cluster_identifier,
new_db_cluster_identifier: self.new_db_cluster_identifier,
apply_immediately: self.apply_immediately,
backup_retention_period: self.backup_retention_period,
db_cluster_parameter_group_name: self.db_cluster_parameter_group_name,
vpc_security_group_ids: self.vpc_security_group_ids,
port: self.port,
master_user_password: self.master_user_password,
preferred_backup_window: self.preferred_backup_window,
preferred_maintenance_window: self.preferred_maintenance_window,
cloudwatch_logs_export_configuration: self.cloudwatch_logs_export_configuration,
engine_version: self.engine_version,
allow_major_version_upgrade: self.allow_major_version_upgrade,
deletion_protection: self.deletion_protection,
storage_type: self.storage_type,
serverless_v2_scaling_configuration: self.serverless_v2_scaling_configuration,
manage_master_user_password: self.manage_master_user_password,
master_user_secret_kms_key_id: self.master_user_secret_kms_key_id,
rotate_master_user_password: self.rotate_master_user_password,
network_type: self.network_type,
})
}
}