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
|
// 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"
)
// Modify the settings for 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?
// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html)
// in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters,
// see Multi-AZ deployments with two readable standby DB instances
// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html)
// in the Amazon RDS User Guide.
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. Constraints: This identifier must match the identifier of an
// existing DB cluster. Valid for: Aurora DB clusters and Multi-AZ DB clusters
//
// 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. Type: Integer Valid for: Multi-AZ DB clusters only
AllocatedStorage *int32
// A value that indicates whether major version upgrades are allowed. 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. Valid for: Aurora DB clusters only
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 cluster. If this parameter is
// disabled, changes to the DB cluster are applied during the next maintenance
// window. The ApplyImmediately parameter only affects the
// EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier
// values. If the ApplyImmediately parameter is disabled, then changes to the
// EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier
// values are applied during the next maintenance window. All other changes are
// applied immediately, regardless of the value of the ApplyImmediately parameter.
// By default, this parameter is disabled. Valid for: Aurora DB clusters and
// Multi-AZ DB clusters
ApplyImmediately bool
// A value that indicates 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: Multi-AZ DB clusters only
AutoMinorVersionUpgrade *bool
// The target backtrack window, in seconds. To disable backtracking, set this value
// to 0. Default: 0 Constraints:
//
// * If specified, this value must be set to a
// number from 0 to 259,200 (72 hours).
//
// Valid for: Aurora MySQL DB clusters only
BacktrackWindow *int64
// The number of days for which automated backups are retained. Specify a minimum
// value of 1. Default: 1 Constraints:
//
// * Must be a value from 1 to 35
//
// Valid for:
// Aurora DB clusters and Multi-AZ DB clusters
BackupRetentionPeriod *int32
// The configuration setting for the log types to be enabled for export to
// CloudWatch Logs for a specific DB cluster. The values in the list depend on the
// DB engine being used. RDS for MySQL Possible values are error, general, and
// slowquery. RDS for PostgreSQL Possible values are postgresql and upgrade. Aurora
// MySQL Possible values are audit, error, general, and slowquery. Aurora
// PostgreSQL Possible value is postgresql. For more information about exporting
// CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon
// CloudWatch Logs
// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch)
// in the Amazon RDS User Guide. For more information about exporting CloudWatch
// Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs
// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch)
// in the Amazon Aurora User Guide. Valid for: Aurora DB clusters and Multi-AZ DB
// clusters
CloudwatchLogsExportConfiguration *types.CloudwatchLogsExportConfiguration
// A value that indicates whether to copy all tags from the DB cluster to snapshots
// of the DB cluster. The default is not to copy them. Valid for: 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
// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html)
// in the Amazon RDS User Guide. Valid for: Multi-AZ DB clusters only
DBClusterInstanceClass *string
// The name of the DB cluster parameter group to use for the DB cluster. Valid for:
// 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. 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.
//
// Valid for:
// Aurora DB clusters only
DBInstanceParameterGroupName *string
// 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 isn't enabled. Valid for: 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
// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html)
// in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only
Domain *string
// Specify the name of the IAM role to be used when making API calls to the
// Directory Service. Valid for: Aurora DB clusters only
DomainIAMRoleName *string
// A value that indicates whether to enable this DB cluster to forward write
// operations to the primary cluster of an Aurora global database (GlobalCluster).
// 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 the FailoverGlobalCluster API operation, but it
// does nothing until then. Valid for: Aurora DB clusters only
EnableGlobalWriteForwarding *bool
// A value that indicates whether to enable the HTTP endpoint for an Aurora
// Serverless v1 DB cluster. By default, the HTTP endpoint is disabled. When
// enabled, the HTTP endpoint provides a connectionless web service API for running
// SQL queries on the Aurora Serverless v1 DB cluster. You can also query your
// database from inside the RDS console with the query editor. For more
// information, see Using the Data API for Aurora Serverless v1
// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) in
// the Amazon Aurora User Guide. Valid for: Aurora DB clusters only
EnableHttpEndpoint *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. For more information, see IAM Database Authentication
// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html)
// in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only
EnableIAMDatabaseAuthentication *bool
// A value that indicates whether to turn on Performance Insights for the DB
// cluster. 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. Valid for: Multi-AZ DB clusters only
EnablePerformanceInsights *bool
// 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. To list all of the
// available engine versions for MySQL 5.6-compatible Aurora, use the following
// command: aws rds describe-db-engine-versions --engine aurora --query
// "DBEngineVersions[].EngineVersion" To list all of the available engine versions
// for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora, 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: 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 to
// Improve Performance
// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS)
// in the Amazon RDS User Guide. Constraints: Must be a multiple between .5 and 50
// of the storage amount for the DB cluster. Valid for: Multi-AZ DB clusters only
Iops *int32
// The new password for the master database user. This password can contain any
// printable ASCII character except "/", """, or "@". Constraints: Must contain
// from 8 to 41 characters. Valid for: Aurora DB clusters and Multi-AZ DB clusters
MasterUserPassword *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. The default is 0. If MonitoringRoleArn is specified, also
// set MonitoringInterval to a value other than 0. Valid Values: 0, 1, 5, 10, 15,
// 30, 60 Valid for: Multi-AZ DB clusters only
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
// (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. Valid for: Multi-AZ DB clusters only
MonitoringRoleArn *string
// The network type of the DB cluster. Valid values:
//
// * IPV4
//
// * DUAL
//
// 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
// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html)
// in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only
NetworkType *string
// The new DB cluster identifier for the DB cluster when renaming a DB cluster.
// This value is stored as a lowercase string. 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
// Valid for: Aurora DB clusters only
NewDBClusterIdentifier *string
// A value that indicates that the DB cluster should be associated with the
// specified option group. 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: Multi-AZ DB clusters only
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. Valid for: Multi-AZ DB clusters only
PerformanceInsightsRetentionPeriod *int32
// The port number on which the DB cluster accepts connections. Constraints: Value
// must be 1150-65535 Default: The same port as the original DB cluster. Valid for:
// Aurora DB clusters only
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
// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow)
// in the Amazon Aurora User Guide. 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.
//
// Valid for: Aurora DB clusters and Multi-AZ DB clusters
PreferredBackupWindow *string
// The weekly time range during which system maintenance can occur, in Universal
// Coordinated Time (UTC). Format: ddd:hh24:mi-ddd:hh24:mi 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
// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora)
// in the Amazon Aurora User Guide. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
// Constraints: Minimum 30-minute window. Valid for: Aurora DB clusters and
// Multi-AZ DB clusters
PreferredMaintenanceWindow *string
// The scaling properties of the DB cluster. You can only modify scaling properties
// for DB clusters in serverless DB engine mode. Valid for: 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
// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html)
// in the Amazon Aurora User Guide.
ServerlessV2ScalingConfiguration *types.ServerlessV2ScalingConfiguration
// Specifies the storage type to be associated with the DB cluster. Valid values:
// io1 When specified, a value for the Iops parameter is required. Default: io1
// Valid for: Multi-AZ DB clusters only
StorageType *string
// A list of VPC security groups that the DB cluster will belong to. Valid for:
// 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?
// (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html)
// in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters,
// see Multi-AZ deployments with two readable standby DB instances
// (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html)
// in the Amazon RDS User Guide.
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) {
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 = 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 = addOpModifyDBClusterValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opModifyDBCluster(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_opModifyDBCluster(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "rds",
OperationName: "ModifyDBCluster",
}
}
|