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
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package rds
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"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 settings for a DB instance. You can change one or more database
// configuration parameters by specifying these parameters and the new values in
// the request. To learn what modifications you can make to your DB instance, call
// DescribeValidDBInstanceModifications before you call ModifyDBInstance.
func (c *Client) ModifyDBInstance(ctx context.Context, params *ModifyDBInstanceInput, optFns ...func(*Options)) (*ModifyDBInstanceOutput, error) {
if params == nil {
params = &ModifyDBInstanceInput{}
}
result, metadata, err := c.invokeOperation(ctx, "ModifyDBInstance", params, optFns, c.addOperationModifyDBInstanceMiddlewares)
if err != nil {
return nil, err
}
out := result.(*ModifyDBInstanceOutput)
out.ResultMetadata = metadata
return out, nil
}
type ModifyDBInstanceInput struct {
// The DB instance identifier. This value is stored as a lowercase string.
// Constraints:
//
// * Must match the identifier of an existing DBInstance.
//
// This member is required.
DBInstanceIdentifier *string
// The new amount of storage in gibibytes (GiB) to allocate for the DB instance.
// For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be at least
// 10% greater than the current value. Values that are not at least 10% greater
// than the existing value are rounded up so that they are 10% greater than the
// current value. For the valid values for allocated storage for each engine, see
// CreateDBInstance.
AllocatedStorage *int32
// A value that indicates whether major version upgrades are allowed. Changing this
// parameter doesn't result in an outage and the change is asynchronously applied
// as soon as possible. This setting doesn't apply to RDS Custom. Constraints:
// Major version upgrades must be allowed when specifying a value for the
// EngineVersion parameter that is a different major version than the DB instance's
// current version.
AllowMajorVersionUpgrade bool
// A value that indicates 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 instance. By default, this
// parameter is disabled. If this parameter is disabled, changes to the DB instance
// are applied during the next maintenance window. Some parameter changes can cause
// an outage and are applied on the next call to RebootDBInstance, or the next
// failure reboot. Review the table of parameters in Modifying a DB Instance
// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Modifying.html)
// in the Amazon RDS User Guide to see the impact of enabling or disabling
// ApplyImmediately for each modified parameter and to determine when the changes
// are applied.
ApplyImmediately bool
// A value that indicates whether minor version upgrades are applied automatically
// to the DB instance during the maintenance window. An outage occurs when all the
// following conditions are met:
//
// * The automatic upgrade is enabled for the
// maintenance window.
//
// * A newer minor version is available.
//
// * RDS has enabled
// automatic patching for the engine version.
//
// If any of the preceding conditions
// isn't met, RDS applies the change as soon as possible and doesn't cause an
// outage. For an RDS Custom DB instance, set AutoMinorVersionUpgrade to false.
// Otherwise, the operation returns an error.
AutoMinorVersionUpgrade *bool
// The automation mode of the RDS Custom DB instance: full or all paused. If full,
// the DB instance automates monitoring and instance recovery. If all paused, the
// instance pauses automation for the duration set by
// ResumeFullAutomationModeMinutes.
AutomationMode types.AutomationMode
// The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services
// Backup. This setting doesn't apply to RDS Custom.
AwsBackupRecoveryPointArn *string
// The number of days to retain automated backups. Setting this parameter to a
// positive number enables backups. Setting this parameter to 0 disables automated
// backups. Enabling and disabling backups can result in a brief I/O suspension
// that lasts from a few seconds to a few minutes, depending on the size and class
// of your DB instance. These changes are applied during the next maintenance
// window unless the ApplyImmediately parameter is enabled for this request. If you
// change the parameter from one non-zero value to another non-zero value, the
// change is asynchronously applied as soon as possible. Amazon Aurora Not
// applicable. The retention period for automated backups is managed by the DB
// cluster. For more information, see ModifyDBCluster. Default: Uses existing
// setting Constraints:
//
// * It must be a value from 0 to 35. It can't be set to 0 if
// the DB instance is a source to read replicas. It can't be set to 0 for an RDS
// Custom for Oracle DB instance.
//
// * It can be specified for a MySQL read replica
// only if the source is running MySQL 5.6 or later.
//
// * It can be specified for a
// PostgreSQL read replica only if the source is running PostgreSQL 9.3.5.
BackupRetentionPeriod *int32
// Specifies the certificate to associate with the DB instance. This setting
// doesn't apply to RDS Custom.
CACertificateIdentifier *string
// A value that indicates whether the DB instance is restarted when you rotate your
// SSL/TLS certificate. By default, the DB instance is restarted when you rotate
// your SSL/TLS certificate. The certificate is not updated until the DB instance
// is restarted. Set this parameter only if you are not using SSL/TLS to connect to
// the DB instance. If you are using SSL/TLS to connect to the DB instance, follow
// the appropriate instructions for your DB engine to rotate your SSL/TLS
// certificate:
//
// * For more information about rotating your SSL/TLS certificate for
// RDS DB engines, see Rotating Your SSL/TLS Certificate.
// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html)
// in the Amazon RDS User Guide.
//
// * For more information about rotating your
// SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS
// Certificate
// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html)
// in the Amazon Aurora User Guide.
//
// This setting doesn't apply to RDS Custom.
CertificateRotationRestart *bool
// The configuration setting for the log types to be enabled for export to
// CloudWatch Logs for a specific DB instance. A change to the
// CloudwatchLogsExportConfiguration parameter is always applied to the DB instance
// immediately. Therefore, the ApplyImmediately parameter has no effect. This
// setting doesn't apply to RDS Custom.
CloudwatchLogsExportConfiguration *types.CloudwatchLogsExportConfiguration
// A value that indicates whether to copy all tags from the DB instance to
// snapshots of the DB instance. By default, tags are not copied. Amazon Aurora Not
// applicable. Copying tags to snapshots is managed by the DB cluster. Setting this
// value for an Aurora DB instance has no effect on the DB cluster setting. For
// more information, see ModifyDBCluster.
CopyTagsToSnapshot *bool
// The new compute and memory capacity of the DB instance, for example db.m4.large.
// 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 classes
// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html)
// in the Amazon RDS User Guide or Aurora DB instance classes
// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html)
// in the Amazon Aurora User Guide. If you modify the DB instance class, an outage
// occurs during the change. The change is applied during the next maintenance
// window, unless ApplyImmediately is enabled for this request. This setting
// doesn't apply to RDS Custom for Oracle. Default: Uses existing setting
DBInstanceClass *string
// The name of the DB parameter group to apply to the DB instance. Changing this
// setting doesn't result in an outage. The parameter group name itself is changed
// immediately, but the actual parameter changes are not applied until you reboot
// the instance without failover. In this case, the DB instance isn't rebooted
// automatically, and the parameter changes aren't applied during the next
// maintenance window. However, if you modify dynamic parameters in the newly
// associated DB parameter group, these changes are applied immediately without a
// reboot. This setting doesn't apply to RDS Custom. Default: Uses existing setting
// Constraints: The DB parameter group must be in the same DB parameter group
// family as the DB instance.
DBParameterGroupName *string
// The port number on which the database accepts connections. The value of the
// DBPortNumber parameter must not match any of the port values specified for
// options in the option group for the DB instance. If you change the DBPortNumber
// value, your database restarts regardless of the value of the ApplyImmediately
// parameter. This setting doesn't apply to RDS Custom. MySQL Default: 3306 Valid
// values: 1150-65535 MariaDB Default: 3306 Valid values: 1150-65535 PostgreSQL
// Default: 5432 Valid values: 1150-65535 Type: Integer Oracle Default: 1521 Valid
// values: 1150-65535 SQL Server Default: 1433 Valid values: 1150-65535 except
// 1234, 1434, 3260, 3343, 3389, 47001, and 49152-49156. Amazon Aurora Default:
// 3306 Valid values: 1150-65535
DBPortNumber *int32
// A list of DB security groups to authorize on this DB instance. Changing this
// setting doesn't result in an outage and the change is asynchronously applied as
// soon as possible. This setting doesn't apply to RDS Custom. Constraints:
//
// * If
// supplied, must match existing DBSecurityGroups.
DBSecurityGroups []string
// The new DB subnet group for the DB instance. You can use this parameter to move
// your DB instance to a different VPC. If your DB instance isn't in a VPC, you can
// also use this parameter to move your DB instance into a VPC. For more
// information, see Working with a DB instance in a VPC
// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html#USER_VPC.Non-VPC2VPC)
// in the Amazon RDS User Guide. Changing the subnet group causes an outage during
// the change. The change is applied during the next maintenance window, unless you
// enable ApplyImmediately. This parameter doesn't apply to RDS Custom.
// Constraints: If supplied, must match the name of an existing DBSubnetGroup.
// Example: mydbsubnetgroup
DBSubnetGroupName *string
// A value that indicates whether the DB instance has deletion protection enabled.
// The database can't be deleted when deletion protection is enabled. By default,
// deletion protection isn't enabled. For more information, see Deleting a DB
// Instance
// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html).
DeletionProtection *bool
// The Active Directory directory ID to move the DB instance to. Specify none to
// remove the instance from its current domain. You must create the domain before
// this operation. Currently, you can create only MySQL, Microsoft SQL Server,
// Oracle, and PostgreSQL DB instances in an Active Directory Domain. For more
// information, see Kerberos Authentication
// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html)
// in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom.
Domain *string
// The name of the IAM role to use when making API calls to the Directory Service.
// This setting doesn't apply to RDS Custom.
DomainIAMRoleName *string
// A value that indicates whether to enable a customer-owned IP address (CoIP) for
// an RDS on Outposts DB instance. A CoIP provides local or external connectivity
// to resources in your Outpost subnets through your on-premises network. For some
// use cases, a CoIP can provide lower latency for connections to the DB instance
// from outside of its virtual private cloud (VPC) on your local network. For more
// information about RDS on Outposts, see Working with Amazon RDS on Amazon Web
// Services Outposts
// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) in
// the Amazon RDS User Guide. For more information about CoIPs, see Customer-owned
// IP addresses
// (https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing)
// in the Amazon Web Services Outposts User Guide.
EnableCustomerOwnedIp *bool
// A value that indicates whether to enable mapping of Amazon Web Services Identity
// and Access Management (IAM) accounts to database accounts. By default, mapping
// isn't enabled. This setting doesn't apply to Amazon Aurora. Mapping Amazon Web
// Services IAM accounts to database accounts is managed by the DB cluster. For
// more information about IAM database authentication, see IAM Database
// Authentication for MySQL and PostgreSQL
// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html)
// in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom.
EnableIAMDatabaseAuthentication *bool
// A value that indicates whether to enable Performance Insights for the DB
// instance. For more information, see Using Amazon Performance Insights
// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html)
// in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom.
EnablePerformanceInsights *bool
// The version number of the database engine to upgrade to. Changing this parameter
// results in an outage and the change is applied during the next maintenance
// window unless the ApplyImmediately parameter is enabled for this request. For
// major version upgrades, if a nondefault DB parameter group is currently in use,
// a new DB parameter group in the DB parameter group family for the new engine
// version must be specified. The new DB parameter group can be the default for
// that DB parameter group family. If you specify only a major version, Amazon RDS
// will update the DB instance to the default minor version if the current minor
// version is lower. For information about valid engine versions, see
// CreateDBInstance, or call DescribeDBEngineVersions. In RDS Custom for Oracle,
// this parameter is supported for read replicas only if they are in the
// PATCH_DB_FAILURE lifecycle.
EngineVersion *string
// The new Provisioned IOPS (I/O operations per second) value for the RDS instance.
// Changing this setting doesn't result in an outage and the change is applied
// during the next maintenance window unless the ApplyImmediately parameter is
// enabled for this request. If you are migrating from Provisioned IOPS to standard
// storage, set this value to 0. The DB instance will require a reboot for the
// change in storage type to take effect. If you choose to migrate your DB instance
// from using standard storage to using Provisioned IOPS, or from using Provisioned
// IOPS to using standard storage, the process can take time. The duration of the
// migration depends on several factors such as database load, storage size,
// storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if
// any), and the number of prior scale storage operations. Typical migration times
// are under 24 hours, but the process can take up to several days in some cases.
// During the migration, the DB instance is available for use, but might experience
// performance degradation. While the migration takes place, nightly backups for
// the instance are suspended. No other Amazon RDS operations can take place for
// the instance, including modifying the instance, rebooting the instance, deleting
// the instance, creating a read replica for the instance, and creating a DB
// snapshot of the instance. Constraints: For MariaDB, MySQL, Oracle, and
// PostgreSQL, the value supplied must be at least 10% greater than the current
// value. Values that are not at least 10% greater than the existing value are
// rounded up so that they are 10% greater than the current value. Default: Uses
// existing setting
Iops *int32
// The license model for the DB instance. This setting doesn't apply to RDS Custom.
// Valid values: license-included | bring-your-own-license | general-public-license
LicenseModel *string
// The new password for the master user. The password can include any printable
// ASCII character except "/", """, or "@". Changing this parameter doesn't result
// in an outage and the change is asynchronously applied as soon as possible.
// Between the time of the request and the completion of the request, the
// MasterUserPassword element exists in the PendingModifiedValues element of the
// operation response. This setting doesn't apply to RDS Custom. Amazon Aurora Not
// applicable. The password for the master user is managed by the DB cluster. For
// more information, see ModifyDBCluster. Default: Uses existing setting MariaDB
// Constraints: Must contain from 8 to 41 characters. Microsoft SQL Server
// Constraints: Must contain from 8 to 128 characters. MySQL Constraints: Must
// contain from 8 to 41 characters. Oracle Constraints: Must contain from 8 to 30
// characters. PostgreSQL Constraints: Must contain from 8 to 128 characters.
// Amazon RDS API operations never return the password, so this action provides a
// way to regain access to a primary instance user if the password is lost. This
// includes restoring privileges that might have been accidentally revoked.
MasterUserPassword *string
// The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale
// the storage of the DB instance. For more information about this setting,
// including limitations that apply to it, see Managing capacity automatically
// with Amazon RDS storage autoscaling
// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling)
// in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom.
MaxAllocatedStorage *int32
// The interval, in seconds, between points when Enhanced Monitoring metrics are
// collected for the DB instance. To disable collecting Enhanced Monitoring
// metrics, specify 0, which is the default. If MonitoringRoleArn is specified, set
// MonitoringInterval to a value other than 0. This setting doesn't apply to RDS
// Custom. Valid Values: 0, 1, 5, 10, 15, 30, 60
MonitoringInterval *int32
// The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to
// Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For
// information on creating a monitoring role, see 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)
// in the Amazon RDS User Guide. If MonitoringInterval is set to a value other than
// 0, supply a MonitoringRoleArn value. This setting doesn't apply to RDS Custom.
MonitoringRoleArn *string
// A value that indicates whether the DB instance is a Multi-AZ deployment.
// Changing this parameter doesn't result in an outage. The change is applied
// during the next maintenance window unless the ApplyImmediately parameter is
// enabled for this request. This setting doesn't apply to RDS Custom.
MultiAZ *bool
// The network type of the DB instance. Valid values:
//
// * IPV4
//
// * DUAL
//
// The network
// type is determined by the DBSubnetGroup specified for the DB instance. 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
// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html)
// in the Amazon RDS User Guide.
NetworkType *string
// The new DB instance identifier for the DB instance when renaming a DB instance.
// When you change the DB instance identifier, an instance reboot occurs
// immediately if you enable ApplyImmediately, or will occur during the next
// maintenance window if you disable Apply Immediately. This value is stored as a
// lowercase string. This setting doesn't apply to RDS Custom. 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: mydbinstance
NewDBInstanceIdentifier *string
// A value that indicates the DB instance should be associated with the specified
// option group. Changing this parameter doesn't result in an outage, with one
// exception. If the parameter change results in an option group that enables OEM,
// it can cause a brief period, lasting less than a second, during which new
// connections are rejected but existing connections aren't interrupted. The change
// is applied during the next maintenance window unless the ApplyImmediately
// parameter is enabled for this request. Permanent options, such as the TDE option
// for Oracle Advanced Security TDE, can't be removed from an option group, and
// that option group can't be removed from a DB instance after it is associated
// with a DB instance. This setting doesn't apply to RDS Custom.
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 do not 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.
// This setting doesn't apply to RDS Custom.
PerformanceInsightsKMSKeyId *string
// The number of days to retain Performance Insights data. The default is 7 days.
// The following values are valid:
//
// * 7
//
// * month * 31, where month is a number of
// months from 1-23
//
// * 731
//
// For example, the following values are valid:
//
// * 93 (3
// months * 31)
//
// * 341 (11 months * 31)
//
// * 589 (19 months * 31)
//
// * 731
//
// If you
// specify a retention period such as 94, which isn't a valid value, RDS issues an
// error. This setting doesn't apply to RDS Custom.
PerformanceInsightsRetentionPeriod *int32
// The daily time range during which automated backups are created if automated
// backups are enabled, as determined by the BackupRetentionPeriod parameter.
// Changing this parameter doesn't result in an outage and the change is
// asynchronously applied as soon as possible. The default is a 30-minute window
// selected at random from an 8-hour block of time for each Amazon Web Services
// Region. For more information, see Backup window
// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow)
// in the Amazon RDS User Guide. Amazon Aurora Not applicable. The daily time range
// for creating automated backups is managed by the DB cluster. For more
// information, see ModifyDBCluster. Constraints:
//
// * Must be in the format
// hh24:mi-hh24:mi
//
// * Must be in Universal Time Coordinated (UTC)
//
// * Must not
// conflict with the preferred maintenance window
//
// * Must be at least 30 minutes
PreferredBackupWindow *string
// The weekly time range (in UTC) during which system maintenance can occur, which
// might result in an outage. Changing this parameter doesn't result in an outage,
// except in the following situation, and the change is asynchronously applied as
// soon as possible. If there are pending actions that cause a reboot, and the
// maintenance window is changed to include the current time, then changing this
// parameter will cause a reboot of the DB instance. If moving this window to the
// current time, there must be at least 30 minutes between the current time and end
// of the window to ensure pending changes are applied. For more information, see
// Amazon RDS Maintenance Window
// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance)
// in the Amazon RDS User Guide. Default: Uses existing setting Format:
// ddd:hh24:mi-ddd:hh24:mi Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
// Constraints: Must be at least 30 minutes
PreferredMaintenanceWindow *string
// The number of CPU cores and the number of threads per core for the DB instance
// class of the DB instance. This setting doesn't apply to RDS Custom.
ProcessorFeatures []types.ProcessorFeature
// A value that specifies the order in which an Aurora Replica is promoted to the
// primary instance after a failure of the existing primary instance. For more
// information, see Fault Tolerance for an Aurora DB Cluster
// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance)
// in the Amazon Aurora User Guide. This setting doesn't apply to RDS Custom.
// Default: 1 Valid Values: 0 - 15
PromotionTier *int32
// A value that indicates whether the DB instance is publicly accessible. When the
// DB cluster is publicly accessible, its Domain Name System (DNS) endpoint
// resolves to the private IP address from within the DB cluster's virtual private
// cloud (VPC). It resolves to the public IP address from outside of the DB
// cluster's VPC. Access to the DB cluster is ultimately controlled by the security
// group it uses. That public access isn't permitted if the security group assigned
// to the DB cluster doesn't permit it. When the DB instance isn't publicly
// accessible, it is an internal DB instance with a DNS name that resolves to a
// private IP address. PubliclyAccessible only applies to DB instances in a VPC.
// The DB instance must be part of a public subnet and PubliclyAccessible must be
// enabled for it to be publicly accessible. Changes to the PubliclyAccessible
// parameter are applied immediately regardless of the value of the
// ApplyImmediately parameter.
PubliclyAccessible *bool
// A value that sets the open mode of a replica database to either mounted or
// read-only. Currently, this parameter is only supported for Oracle DB instances.
// Mounted DB replicas are included in Oracle Enterprise Edition. The main use case
// for mounted replicas is cross-Region disaster recovery. The primary database
// doesn't use Active Data Guard to transmit information to the mounted replica.
// Because it doesn't accept user connections, a mounted replica can't serve a
// read-only workload. For more information, see Working with Oracle Read Replicas
// for Amazon RDS
// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html)
// in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom.
ReplicaMode types.ReplicaMode
// The number of minutes to pause the automation. When the time period ends, RDS
// Custom resumes full automation. The minimum value is 60 (default). The maximum
// value is 1,440.
ResumeFullAutomationModeMinutes *int32
// Specifies the storage type to be associated with the DB instance. If you specify
// Provisioned IOPS (io1), you must also include a value for the Iops parameter. If
// you choose to migrate your DB instance from using standard storage to using
// Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the
// process can take time. The duration of the migration depends on several factors
// such as database load, storage size, storage type (standard or Provisioned
// IOPS), amount of IOPS provisioned (if any), and the number of prior scale
// storage operations. Typical migration times are under 24 hours, but the process
// can take up to several days in some cases. During the migration, the DB instance
// is available for use, but might experience performance degradation. While the
// migration takes place, nightly backups for the instance are suspended. No other
// Amazon RDS operations can take place for the instance, including modifying the
// instance, rebooting the instance, deleting the instance, creating a read replica
// for the instance, and creating a DB snapshot of the instance. Valid values:
// standard | gp2 | io1 Default: io1 if the Iops parameter is specified, otherwise
// gp2
StorageType *string
// The ARN from the key store with which to associate the instance for TDE
// encryption. This setting doesn't apply to RDS Custom.
TdeCredentialArn *string
// The password for the given ARN from the key store in order to access the device.
// This setting doesn't apply to RDS Custom.
TdeCredentialPassword *string
// A value that indicates whether the DB instance class of the DB instance uses its
// default processor features. This setting doesn't apply to RDS Custom.
UseDefaultProcessorFeatures *bool
// A list of Amazon EC2 VPC security groups to authorize on this DB instance. This
// change is asynchronously applied as soon as possible. This setting doesn't apply
// to RDS Custom. Amazon Aurora Not applicable. The associated list of EC2 VPC
// security groups is managed by the DB cluster. For more information, see
// ModifyDBCluster. Constraints:
//
// * If supplied, must match existing
// VpcSecurityGroupIds.
VpcSecurityGroupIds []string
noSmithyDocumentSerde
}
type ModifyDBInstanceOutput struct {
// Contains the details of an Amazon RDS DB instance. This data type is used as a
// response element in the operations CreateDBInstance,
// CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances,
// ModifyDBInstance, PromoteReadReplica, RebootDBInstance,
// RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3,
// RestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance.
DBInstance *types.DBInstance
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationModifyDBInstanceMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsAwsquery_serializeOpModifyDBInstance{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsquery_deserializeOpModifyDBInstance{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpModifyDBInstanceValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opModifyDBInstance(options.Region), middleware.Before); 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
}
return nil
}
func newServiceMetadataMiddleware_opModifyDBInstance(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "rds",
OperationName: "ModifyDBInstance",
}
}
|