1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package rds
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/service/rds/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Modifies the settings of an Amazon Aurora DB cluster or a Multi-AZ DB cluster.
// You can change one or more settings by specifying these parameters and the new
// values in the request.
//
// For more information on Amazon Aurora DB clusters, see [What is Amazon Aurora?] in the Amazon Aurora
// User Guide.
//
// For more information on Multi-AZ DB clusters, see [Multi-AZ DB cluster deployments] in the Amazon RDS User Guide.
//
// [What is Amazon Aurora?]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
// [Multi-AZ DB cluster deployments]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html
func (c *Client) ModifyDBCluster(ctx context.Context, params *ModifyDBClusterInput, optFns ...func(*Options)) (*ModifyDBClusterOutput, error) {
if params == nil {
params = &ModifyDBClusterInput{}
}
result, metadata, err := c.invokeOperation(ctx, "ModifyDBCluster", params, optFns, c.addOperationModifyDBClusterMiddlewares)
if err != nil {
return nil, err
}
out := result.(*ModifyDBClusterOutput)
out.ResultMetadata = metadata
return out, nil
}
type ModifyDBClusterInput struct {
// 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.
//
// This member is required.
DBClusterIdentifier *string
// 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
AllocatedStorage *int32
// 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.
AllowEngineModeChange *bool
// Specifies whether major version upgrades are allowed.
//
// Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
//
// 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.
AllowMajorVersionUpgrade *bool
// 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
ApplyImmediately *bool
// 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
AutoMinorVersionUpgrade *bool
// The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services
// Backup.
AwsBackupRecoveryPointArn *string
// 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).
BacktrackWindow *int64
// 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.
BackupRetentionPeriod *int32
// The CA certificate identifier to use for the DB cluster's server certificate.
//
// For more information, see [Using SSL/TLS to encrypt a connection to a DB instance] in the Amazon RDS User Guide.
//
// Valid for Cluster Type: Multi-AZ DB clusters
//
// [Using SSL/TLS to encrypt a connection to a DB instance]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html
CACertificateIdentifier *string
// 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.
//
// [Publishing Database Logs to Amazon CloudWatch Logs]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
CloudwatchLogsExportConfiguration *types.CloudwatchLogsExportConfiguration
// 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
CopyTagsToSnapshot *bool
// 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
//
// [DB Instance Class]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html
DBClusterInstanceClass *string
// 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
DBClusterParameterGroupName *string
// 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.
DBInstanceParameterGroupName *string
// 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
DeletionProtection *bool
// 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
//
// [Kerberos Authentication]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html
Domain *string
// The name of the IAM role to use when making API calls to the Directory Service.
//
// Valid for Cluster Type: Aurora DB clusters only
DomainIAMRoleName *string
// 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
EnableGlobalWriteForwarding *bool
// Specifies whether to enable the HTTP endpoint for an Aurora Serverless v1 DB
// cluster. By default, the HTTP endpoint isn't enabled.
//
// When enabled, the HTTP endpoint provides a connectionless web service API (RDS
// Data 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 RDS query
// editor.
//
// For more information, see [Using RDS Data API] in the Amazon Aurora User Guide.
//
// This parameter applies only to Aurora Serverless v1 DB clusters. To enable or
// disable the HTTP endpoint for an Aurora PostgreSQL Serverless v2 or provisioned
// DB cluster, use the EnableHttpEndpoint and DisableHttpEndpoint operations.
//
// Valid for Cluster Type: Aurora DB clusters only
//
// [Using RDS Data API]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html
EnableHttpEndpoint *bool
// 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
//
// [IAM Database Authentication]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html
EnableIAMDatabaseAuthentication *bool
// Specifies whether to enable Aurora Limitless Database. You must enable Aurora
// Limitless Database to create a DB shard group.
//
// Valid for: Aurora DB clusters only
EnableLimitlessDatabase *bool
// Specifies whether read replicas can forward write operations to the writer DB
// instance in the DB cluster. By default, write operations aren't allowed on
// reader DB instances.
//
// Valid for: Aurora DB clusters only
EnableLocalWriteForwarding *bool
// 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
//
// [Using Amazon Performance Insights]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html
EnablePerformanceInsights *bool
// 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
//
// [CreateDBCluster]: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html
EngineMode *string
// 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
EngineVersion *string
// 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.
//
// [Amazon RDS Provisioned IOPS storage]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS
Iops *int32
// 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
//
// [Password management with Amazon Web Services Secrets Manager]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html
ManageMasterUserPassword *bool
// 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.
MasterUserPassword *string
// 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
MasterUserSecretKmsKeyId *string
// 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
MonitoringInterval *int32
// 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
//
// [To create an IAM role for Amazon RDS Enhanced Monitoring]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html#USER_Monitoring.OS.IAMRole
MonitoringRoleArn *string
// 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
//
// [Working with a DB instance in a VPC]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
NetworkType *string
// 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
NewDBClusterIdentifier *string
// The option group to associate the DB cluster with.
//
// DB clusters are associated with a default option group that can't be modified.
OptionGroupName *string
// 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
PerformanceInsightsKMSKeyId *string
// 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.
PerformanceInsightsRetentionPeriod *int32
// 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.
Port *int32
// 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.
//
// [Backup window]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow
PreferredBackupWindow *string
// 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.
//
// [Adjusting the Preferred DB Cluster Maintenance Window]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora
PreferredMaintenanceWindow *string
// 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.
//
// [Password management with Amazon Web Services Secrets Manager]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html
RotateMasterUserPassword *bool
// 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
ScalingConfiguration *types.ScalingConfiguration
// Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
//
// For more information, see [Using Amazon Aurora Serverless v2] in the Amazon Aurora User Guide.
//
// [Using Amazon Aurora Serverless v2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html
ServerlessV2ScalingConfiguration *types.ServerlessV2ScalingConfiguration
// 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 | io2 | gp3
//
// Default:
//
// - Aurora DB clusters - aurora
//
// - Multi-AZ DB clusters - io1
//
// [Storage configurations for Amazon Aurora DB clusters]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.StorageReliability.html#aurora-storage-type
// [Settings for creating Multi-AZ DB clusters]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/create-multi-az-db-cluster.html#create-multi-az-db-cluster-settings
StorageType *string
// 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
VpcSecurityGroupIds []string
noSmithyDocumentSerde
}
type ModifyDBClusterOutput struct {
// Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
//
// For an Amazon Aurora DB cluster, this data type is used as a response element
// in the operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters ,
// FailoverDBCluster , ModifyDBCluster , PromoteReadReplicaDBCluster ,
// RestoreDBClusterFromS3 , RestoreDBClusterFromSnapshot ,
// RestoreDBClusterToPointInTime , StartDBCluster , and StopDBCluster .
//
// For a Multi-AZ DB cluster, this data type is used as a response element in the
// operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters ,
// FailoverDBCluster , ModifyDBCluster , RebootDBCluster ,
// RestoreDBClusterFromSnapshot , and RestoreDBClusterToPointInTime .
//
// For more information on Amazon Aurora DB clusters, see [What is Amazon Aurora?] in the Amazon Aurora
// User Guide.
//
// For more information on Multi-AZ DB clusters, see [Multi-AZ deployments with two readable standby DB instances] in the Amazon RDS User
// Guide.
//
// [Multi-AZ deployments with two readable standby DB instances]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html
// [What is Amazon Aurora?]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
DBCluster *types.DBCluster
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationModifyDBClusterMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsquery_serializeOpModifyDBCluster{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsquery_deserializeOpModifyDBCluster{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "ModifyDBCluster"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = addClientRequestID(stack); err != nil {
return err
}
if err = addComputeContentLength(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = addComputePayloadSHA256(stack); err != nil {
return err
}
if err = addRetry(stack, options); err != nil {
return err
}
if err = addRawResponseToMetadata(stack); err != nil {
return err
}
if err = addRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addTimeOffsetBuild(stack, c); err != nil {
return err
}
if err = addUserAgentRetryMode(stack, options); err != nil {
return err
}
if err = addOpModifyDBClusterValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opModifyDBCluster(options.Region), middleware.Before); err != nil {
return err
}
if err = addRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opModifyDBCluster(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "ModifyDBCluster",
}
}
|