aws_sdk_neptune/client/

modify_db_cluster.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ModifyDBCluster`](crate::operation::modify_db_cluster::builders::ModifyDBClusterFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`db_cluster_identifier(impl Into<String>)`](crate::operation::modify_db_cluster::builders::ModifyDBClusterFluentBuilder::db_cluster_identifier) / [`set_db_cluster_identifier(Option<String>)`](crate::operation::modify_db_cluster::builders::ModifyDBClusterFluentBuilder::set_db_cluster_identifier):<br>required: **true**<br><p>The DB cluster identifier for the cluster being modified. This parameter is not case-sensitive.</p> <p>Constraints:</p> <ul>  <li>   <p>Must match the identifier of an existing DBCluster.</p></li> </ul><br>
    ///   - [`new_db_cluster_identifier(impl Into<String>)`](crate::operation::modify_db_cluster::builders::ModifyDBClusterFluentBuilder::new_db_cluster_identifier) / [`set_new_db_cluster_identifier(Option<String>)`](crate::operation::modify_db_cluster::builders::ModifyDBClusterFluentBuilder::set_new_db_cluster_identifier):<br>required: **false**<br><p>The new DB cluster identifier for the DB cluster when renaming a DB 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><br>
    ///   - [`apply_immediately(bool)`](crate::operation::modify_db_cluster::builders::ModifyDBClusterFluentBuilder::apply_immediately) / [`set_apply_immediately(Option<bool>)`](crate::operation::modify_db_cluster::builders::ModifyDBClusterFluentBuilder::set_apply_immediately):<br>required: **false**<br><p>A value that specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the <code>PreferredMaintenanceWindow</code> setting for the DB cluster. If this parameter is set to <code>false</code>, changes to the DB cluster are applied during the next maintenance window.</p> <p>The <code>ApplyImmediately</code> parameter only affects <code>NewDBClusterIdentifier</code> values. If you set the <code>ApplyImmediately</code> parameter value to false, then changes to <code>NewDBClusterIdentifier</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><br>
    ///   - [`backup_retention_period(i32)`](crate::operation::modify_db_cluster::builders::ModifyDBClusterFluentBuilder::backup_retention_period) / [`set_backup_retention_period(Option<i32>)`](crate::operation::modify_db_cluster::builders::ModifyDBClusterFluentBuilder::set_backup_retention_period):<br>required: **false**<br><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><br>
    ///   - [`db_cluster_parameter_group_name(impl Into<String>)`](crate::operation::modify_db_cluster::builders::ModifyDBClusterFluentBuilder::db_cluster_parameter_group_name) / [`set_db_cluster_parameter_group_name(Option<String>)`](crate::operation::modify_db_cluster::builders::ModifyDBClusterFluentBuilder::set_db_cluster_parameter_group_name):<br>required: **false**<br><p>The name of the DB cluster parameter group to use for the DB cluster.</p><br>
    ///   - [`vpc_security_group_ids(impl Into<String>)`](crate::operation::modify_db_cluster::builders::ModifyDBClusterFluentBuilder::vpc_security_group_ids) / [`set_vpc_security_group_ids(Option<Vec::<String>>)`](crate::operation::modify_db_cluster::builders::ModifyDBClusterFluentBuilder::set_vpc_security_group_ids):<br>required: **false**<br><p>A list of VPC security groups that the DB cluster will belong to.</p><br>
    ///   - [`port(i32)`](crate::operation::modify_db_cluster::builders::ModifyDBClusterFluentBuilder::port) / [`set_port(Option<i32>)`](crate::operation::modify_db_cluster::builders::ModifyDBClusterFluentBuilder::set_port):<br>required: **false**<br><p>The port number on which the DB cluster accepts connections.</p> <p>Constraints: Value must be <code>1150-65535</code></p> <p>Default: The same port as the original DB cluster.</p><br>
    ///   - [`master_user_password(impl Into<String>)`](crate::operation::modify_db_cluster::builders::ModifyDBClusterFluentBuilder::master_user_password) / [`set_master_user_password(Option<String>)`](crate::operation::modify_db_cluster::builders::ModifyDBClusterFluentBuilder::set_master_user_password):<br>required: **false**<br><p>Not supported by Neptune.</p><br>
    ///   - [`option_group_name(impl Into<String>)`](crate::operation::modify_db_cluster::builders::ModifyDBClusterFluentBuilder::option_group_name) / [`set_option_group_name(Option<String>)`](crate::operation::modify_db_cluster::builders::ModifyDBClusterFluentBuilder::set_option_group_name):<br>required: **false**<br><p><i>Not supported by Neptune.</i></p><br>
    ///   - [`preferred_backup_window(impl Into<String>)`](crate::operation::modify_db_cluster::builders::ModifyDBClusterFluentBuilder::preferred_backup_window) / [`set_preferred_backup_window(Option<String>)`](crate::operation::modify_db_cluster::builders::ModifyDBClusterFluentBuilder::set_preferred_backup_window):<br>required: **false**<br><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 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><br>
    ///   - [`preferred_maintenance_window(impl Into<String>)`](crate::operation::modify_db_cluster::builders::ModifyDBClusterFluentBuilder::preferred_maintenance_window) / [`set_preferred_maintenance_window(Option<String>)`](crate::operation::modify_db_cluster::builders::ModifyDBClusterFluentBuilder::set_preferred_maintenance_window):<br>required: **false**<br><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 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><br>
    ///   - [`enable_iam_database_authentication(bool)`](crate::operation::modify_db_cluster::builders::ModifyDBClusterFluentBuilder::enable_iam_database_authentication) / [`set_enable_iam_database_authentication(Option<bool>)`](crate::operation::modify_db_cluster::builders::ModifyDBClusterFluentBuilder::set_enable_iam_database_authentication):<br>required: **false**<br><p>True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false.</p> <p>Default: <code>false</code></p><br>
    ///   - [`cloudwatch_logs_export_configuration(CloudwatchLogsExportConfiguration)`](crate::operation::modify_db_cluster::builders::ModifyDBClusterFluentBuilder::cloudwatch_logs_export_configuration) / [`set_cloudwatch_logs_export_configuration(Option<CloudwatchLogsExportConfiguration>)`](crate::operation::modify_db_cluster::builders::ModifyDBClusterFluentBuilder::set_cloudwatch_logs_export_configuration):<br>required: **false**<br><p>The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html#cloudwatch-logs-cli">Using the CLI to publish Neptune audit logs to CloudWatch Logs</a>.</p><br>
    ///   - [`engine_version(impl Into<String>)`](crate::operation::modify_db_cluster::builders::ModifyDBClusterFluentBuilder::engine_version) / [`set_engine_version(Option<String>)`](crate::operation::modify_db_cluster::builders::ModifyDBClusterFluentBuilder::set_engine_version):<br>required: **false**<br><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 the <code>ApplyImmediately</code> parameter is set to true.</p> <p>For a list of valid engine versions, see <a href="https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases.html">Engine Releases for Amazon Neptune</a>, or call <code>DescribeDBEngineVersions</code>.</p><br>
    ///   - [`allow_major_version_upgrade(bool)`](crate::operation::modify_db_cluster::builders::ModifyDBClusterFluentBuilder::allow_major_version_upgrade) / [`set_allow_major_version_upgrade(Option<bool>)`](crate::operation::modify_db_cluster::builders::ModifyDBClusterFluentBuilder::set_allow_major_version_upgrade):<br>required: **false**<br><p>A value that indicates whether upgrades between different major versions are allowed.</p> <p>Constraints: You must set the allow-major-version-upgrade flag when providing an <code>EngineVersion</code> parameter that uses a different major version than the DB cluster's current version.</p><br>
    ///   - [`db_instance_parameter_group_name(impl Into<String>)`](crate::operation::modify_db_cluster::builders::ModifyDBClusterFluentBuilder::db_instance_parameter_group_name) / [`set_db_instance_parameter_group_name(Option<String>)`](crate::operation::modify_db_cluster::builders::ModifyDBClusterFluentBuilder::set_db_instance_parameter_group_name):<br>required: **false**<br><p>The name of the DB parameter group to apply to all instances of the DB cluster.</p><note>  <p>When you apply a parameter group using <code>DBInstanceParameterGroupName</code>, parameter changes aren't applied during the next maintenance window but instead are applied immediately.</p> </note> <p>Default: The existing name setting</p> <p>Constraints:</p> <ul>  <li>   <p>The DB parameter group must be in the same DB parameter group family as the target DB cluster version.</p></li>  <li>   <p>The <code>DBInstanceParameterGroupName</code> parameter is only valid in combination with the <code>AllowMajorVersionUpgrade</code> parameter.</p></li> </ul><br>
    ///   - [`deletion_protection(bool)`](crate::operation::modify_db_cluster::builders::ModifyDBClusterFluentBuilder::deletion_protection) / [`set_deletion_protection(Option<bool>)`](crate::operation::modify_db_cluster::builders::ModifyDBClusterFluentBuilder::set_deletion_protection):<br>required: **false**<br><p>A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.</p><br>
    ///   - [`copy_tags_to_snapshot(bool)`](crate::operation::modify_db_cluster::builders::ModifyDBClusterFluentBuilder::copy_tags_to_snapshot) / [`set_copy_tags_to_snapshot(Option<bool>)`](crate::operation::modify_db_cluster::builders::ModifyDBClusterFluentBuilder::set_copy_tags_to_snapshot):<br>required: **false**<br><p><i>If set to <code>true</code>, tags are copied to any snapshot of the DB cluster that is created.</i></p><br>
    ///   - [`serverless_v2_scaling_configuration(ServerlessV2ScalingConfiguration)`](crate::operation::modify_db_cluster::builders::ModifyDBClusterFluentBuilder::serverless_v2_scaling_configuration) / [`set_serverless_v2_scaling_configuration(Option<ServerlessV2ScalingConfiguration>)`](crate::operation::modify_db_cluster::builders::ModifyDBClusterFluentBuilder::set_serverless_v2_scaling_configuration):<br>required: **false**<br><p>Contains the scaling configuration of a Neptune Serverless DB cluster.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html">Using Amazon Neptune Serverless</a> in the <i>Amazon Neptune User Guide</i>.</p><br>
    ///   - [`storage_type(impl Into<String>)`](crate::operation::modify_db_cluster::builders::ModifyDBClusterFluentBuilder::storage_type) / [`set_storage_type(Option<String>)`](crate::operation::modify_db_cluster::builders::ModifyDBClusterFluentBuilder::set_storage_type):<br>required: **false**<br><p>The storage type to associate with the DB cluster.</p> <p>Valid Values:</p> <ul>  <li>   <p><b> <code>standard</code> </b> &nbsp; – &nbsp; ( <i>the default</i> ) Configures cost-effective database storage for applications with moderate to small I/O usage.</p></li>  <li>   <p><b> <code>iopt1</code> </b> &nbsp; – &nbsp; Enables <a href="https://docs.aws.amazon.com/neptune/latest/userguide/storage-types.html#provisioned-iops-storage">I/O-Optimized storage</a> that's designed to meet the needs of I/O-intensive graph workloads that require predictable pricing with low I/O latency and consistent I/O throughput.</p>   <p>Neptune I/O-Optimized storage is only available starting with engine release 1.3.0.0.</p></li> </ul><br>
    /// - On success, responds with [`ModifyDbClusterOutput`](crate::operation::modify_db_cluster::ModifyDbClusterOutput) with field(s):
    ///   - [`db_cluster(Option<DbCluster>)`](crate::operation::modify_db_cluster::ModifyDbClusterOutput::db_cluster): <p>Contains the details of an Amazon Neptune DB cluster.</p> <p>This data type is used as a response element in the <code>DescribeDBClusters</code>.</p>
    /// - On failure, responds with [`SdkError<ModifyDBClusterError>`](crate::operation::modify_db_cluster::ModifyDBClusterError)
    pub fn modify_db_cluster(&self) -> crate::operation::modify_db_cluster::builders::ModifyDBClusterFluentBuilder {
        crate::operation::modify_db_cluster::builders::ModifyDBClusterFluentBuilder::new(self.handle.clone())
    }
}