RDS / Client / modify_db_cluster
modify_db_cluster#
- RDS.Client.modify_db_cluster(**kwargs)#
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.
See also: AWS API Documentation
Request Syntax
response = client.modify_db_cluster( DBClusterIdentifier='string', NewDBClusterIdentifier='string', ApplyImmediately=True|False, BackupRetentionPeriod=123, DBClusterParameterGroupName='string', VpcSecurityGroupIds=[ 'string', ], Port=123, MasterUserPassword='string', OptionGroupName='string', PreferredBackupWindow='string', PreferredMaintenanceWindow='string', EnableIAMDatabaseAuthentication=True|False, BacktrackWindow=123, CloudwatchLogsExportConfiguration={ 'EnableLogTypes': [ 'string', ], 'DisableLogTypes': [ 'string', ] }, EngineVersion='string', AllowMajorVersionUpgrade=True|False, DBInstanceParameterGroupName='string', Domain='string', DomainIAMRoleName='string', ScalingConfiguration={ 'MinCapacity': 123, 'MaxCapacity': 123, 'AutoPause': True|False, 'SecondsUntilAutoPause': 123, 'TimeoutAction': 'string', 'SecondsBeforeTimeout': 123 }, DeletionProtection=True|False, EnableHttpEndpoint=True|False, CopyTagsToSnapshot=True|False, EnableGlobalWriteForwarding=True|False, DBClusterInstanceClass='string', AllocatedStorage=123, StorageType='string', Iops=123, AutoMinorVersionUpgrade=True|False, MonitoringInterval=123, MonitoringRoleArn='string', EnablePerformanceInsights=True|False, PerformanceInsightsKMSKeyId='string', PerformanceInsightsRetentionPeriod=123, ServerlessV2ScalingConfiguration={ 'MinCapacity': 123.0, 'MaxCapacity': 123.0 }, NetworkType='string', ManageMasterUserPassword=True|False, RotateMasterUserPassword=True|False, MasterUserSecretKmsKeyId='string', EngineMode='string', AllowEngineModeChange=True|False )
- Parameters:
DBClusterIdentifier (string) –
[REQUIRED]
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.
NewDBClusterIdentifier (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-cluster2ApplyImmediately (boolean) –
Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the
PreferredMaintenanceWindowsetting 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
BackupRetentionPeriod (integer) –
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:
1Constraints:
Must be a value from 1 to 35.
DBClusterParameterGroupName (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
VpcSecurityGroupIds (list) –
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
(string) –
Port (integer) –
The port number on which the DB cluster accepts connections.
Valid for Cluster Type: Aurora DB clusters only
Valid Values:
1150-65535Default: The same port as the original DB cluster.
MasterUserPassword (string) –
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
ManageMasterUserPasswordis turned on.
OptionGroupName (string) –
The option group to associate the DB cluster with.
DB clusters are associated with a default option group that can’t be modified.
PreferredBackupWindow (string) –
The daily time range during which automated backups are created if automated backups are enabled, using the
BackupRetentionPeriodparameter.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.
PreferredMaintenanceWindow (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.
EnableIAMDatabaseAuthentication (boolean) –
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
BacktrackWindow (integer) –
The target backtrack window, in seconds. To disable backtracking, set this value to
0.Valid for Cluster Type: Aurora MySQL DB clusters only
Default:
0Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
CloudwatchLogsExportConfiguration (dict) –
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 | slowqueryAurora PostgreSQL -
postgresqlRDS for MySQL -
error | general | slowqueryRDS 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.
EnableLogTypes (list) –
The list of log types to enable.
(string) –
DisableLogTypes (list) –
The list of log types to disable.
(string) –
EngineVersion (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
ApplyImmediatelyis 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
AllowMajorVersionUpgrade (boolean) –
Specifies whether major version upgrades are allowed.
Valid for Cluster Type: Aurora DB clusters only
Constraints:
You must allow major version upgrades when specifying a value for the
EngineVersionparameter that is a different major version than the DB cluster’s current version.
DBInstanceParameterGroupName (string) –
The name of the DB parameter group to apply to all instances of the DB cluster.
Note
When you apply a parameter group using the
DBInstanceParameterGroupNameparameter, 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
DBInstanceParameterGroupNameparameter is valid in combination with theAllowMajorVersionUpgradeparameter for a major version upgrade only.
Domain (string) –
The Active Directory directory ID to move the DB cluster to. Specify
noneto 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
DomainIAMRoleName (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
ScalingConfiguration (dict) –
The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in
serverlessDB engine mode.Valid for Cluster Type: Aurora DB clusters only
MinCapacity (integer) –
The minimum capacity for an Aurora DB cluster in
serverlessDB engine mode.For Aurora MySQL, valid capacity values are
1,2,4,8,16,32,64,128, and256.For Aurora PostgreSQL, valid capacity values are
2,4,8,16,32,64,192, and384.The minimum capacity must be less than or equal to the maximum capacity.
MaxCapacity (integer) –
The maximum capacity for an Aurora DB cluster in
serverlessDB engine mode.For Aurora MySQL, valid capacity values are
1,2,4,8,16,32,64,128, and256.For Aurora PostgreSQL, valid capacity values are
2,4,8,16,32,64,192, and384.The maximum capacity must be greater than or equal to the minimum capacity.
AutoPause (boolean) –
A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in
serverlessDB engine mode. A DB cluster can be paused only when it’s idle (it has no connections).Note
If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.
SecondsUntilAutoPause (integer) –
The time, in seconds, before an Aurora DB cluster in
serverlessmode is paused.Specify a value between 300 and 86,400 seconds.
TimeoutAction (string) –
The action to take when the timeout is reached, either
ForceApplyCapacityChangeorRollbackCapacityChange.ForceApplyCapacityChangesets the capacity to the specified value as soon as possible.RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn’t found in the timeout period.Warning
If you specify
ForceApplyCapacityChange, connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped.For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide.
SecondsBeforeTimeout (integer) –
The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.
Specify a value between 60 and 600 seconds.
DeletionProtection (boolean) –
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
EnableHttpEndpoint (boolean) –
Specifies 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 in the Amazon Aurora User Guide.
Valid for Cluster Type: Aurora DB clusters only
CopyTagsToSnapshot (boolean) –
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
EnableGlobalWriteForwarding (boolean) –
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
DBClusterInstanceClass (string) –
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
AllocatedStorage (integer) –
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
StorageType (string) –
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
Iopsparameter is required.Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
Valid Values:
Aurora DB clusters -
aurora | aurora-iopt1Multi-AZ DB clusters -
io1
Default:
Aurora DB clusters -
auroraMulti-AZ DB clusters -
io1
Iops (integer) –
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.
AutoMinorVersionUpgrade (boolean) –
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
MonitoringInterval (integer) –
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
MonitoringRoleArnis specified, also setMonitoringIntervalto a value other than0.Valid for Cluster Type: Multi-AZ DB clusters only
Valid Values:
0 | 1 | 5 | 10 | 15 | 30 | 60Default:
0MonitoringRoleArn (string) –
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
MonitoringIntervalis set to a value other than0, supply aMonitoringRoleArnvalue.Valid for Cluster Type: Multi-AZ DB clusters only
EnablePerformanceInsights (boolean) –
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
PerformanceInsightsKMSKeyId (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
PerformanceInsightsRetentionPeriod (integer) –
The number of days to retain Performance Insights data.
Valid for Cluster Type: Multi-AZ DB clusters only
Valid Values:
7month * 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:
7daysIf you specify a retention period that isn’t valid, such as
94, Amazon RDS issues an error.ServerlessV2ScalingConfiguration (dict) –
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.
MinCapacity (float) –
The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.
MaxCapacity (float) –
The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128.
NetworkType (string) –
The network type of the DB cluster.
The network type is determined by the
DBSubnetGroupspecified for the DB cluster. ADBSubnetGroupcan 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 | DUALManageMasterUserPassword (boolean) –
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 byMasterUserPassword.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
RotateMasterUserPassword (boolean) –
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.
MasterUserSecretKmsKeyId (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
ManageMasterUserPasswordto manage the master user password in Amazon Web Services Secrets Manager. If you are turning onManageMasterUserPasswordand don’t specifyMasterUserSecretKmsKeyId, then theaws/secretsmanagerKMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can’t use theaws/secretsmanagerKMS 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
EngineMode (string) –
The DB engine mode of the DB cluster, either
provisionedorserverless.Note
The DB engine mode can be modified only from
serverlesstoprovisioned.For more information, see CreateDBCluster.
Valid for Cluster Type: Aurora DB clusters only
AllowEngineModeChange (boolean) –
Specifies whether engine mode changes from
serverlesstoprovisionedare 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
EngineModeparameter from the DB cluster’s current engine mode.
- Return type:
dict
- Returns:
Response Syntax
{ 'DBCluster': { 'AllocatedStorage': 123, 'AvailabilityZones': [ 'string', ], 'BackupRetentionPeriod': 123, 'CharacterSetName': 'string', 'DatabaseName': 'string', 'DBClusterIdentifier': 'string', 'DBClusterParameterGroup': 'string', 'DBSubnetGroup': 'string', 'Status': 'string', 'AutomaticRestartTime': datetime(2015, 1, 1), 'PercentProgress': 'string', 'EarliestRestorableTime': datetime(2015, 1, 1), 'Endpoint': 'string', 'ReaderEndpoint': 'string', 'CustomEndpoints': [ 'string', ], 'MultiAZ': True|False, 'Engine': 'string', 'EngineVersion': 'string', 'LatestRestorableTime': datetime(2015, 1, 1), 'Port': 123, 'MasterUsername': 'string', 'DBClusterOptionGroupMemberships': [ { 'DBClusterOptionGroupName': 'string', 'Status': 'string' }, ], 'PreferredBackupWindow': 'string', 'PreferredMaintenanceWindow': 'string', 'ReplicationSourceIdentifier': 'string', 'ReadReplicaIdentifiers': [ 'string', ], 'DBClusterMembers': [ { 'DBInstanceIdentifier': 'string', 'IsClusterWriter': True|False, 'DBClusterParameterGroupStatus': 'string', 'PromotionTier': 123 }, ], 'VpcSecurityGroups': [ { 'VpcSecurityGroupId': 'string', 'Status': 'string' }, ], 'HostedZoneId': 'string', 'StorageEncrypted': True|False, 'KmsKeyId': 'string', 'DbClusterResourceId': 'string', 'DBClusterArn': 'string', 'AssociatedRoles': [ { 'RoleArn': 'string', 'Status': 'string', 'FeatureName': 'string' }, ], 'IAMDatabaseAuthenticationEnabled': True|False, 'CloneGroupId': 'string', 'ClusterCreateTime': datetime(2015, 1, 1), 'EarliestBacktrackTime': datetime(2015, 1, 1), 'BacktrackWindow': 123, 'BacktrackConsumedChangeRecords': 123, 'EnabledCloudwatchLogsExports': [ 'string', ], 'Capacity': 123, 'EngineMode': 'string', 'ScalingConfigurationInfo': { 'MinCapacity': 123, 'MaxCapacity': 123, 'AutoPause': True|False, 'SecondsUntilAutoPause': 123, 'TimeoutAction': 'string', 'SecondsBeforeTimeout': 123 }, 'DeletionProtection': True|False, 'HttpEndpointEnabled': True|False, 'ActivityStreamMode': 'sync'|'async', 'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping', 'ActivityStreamKmsKeyId': 'string', 'ActivityStreamKinesisStreamName': 'string', 'CopyTagsToSnapshot': True|False, 'CrossAccountClone': True|False, 'DomainMemberships': [ { 'Domain': 'string', 'Status': 'string', 'FQDN': 'string', 'IAMRoleName': 'string', 'OU': 'string', 'AuthSecretArn': 'string', 'DnsIps': [ 'string', ] }, ], 'TagList': [ { 'Key': 'string', 'Value': 'string' }, ], 'GlobalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'unknown', 'GlobalWriteForwardingRequested': True|False, 'PendingModifiedValues': { 'PendingCloudwatchLogsExports': { 'LogTypesToEnable': [ 'string', ], 'LogTypesToDisable': [ 'string', ] }, 'DBClusterIdentifier': 'string', 'MasterUserPassword': 'string', 'IAMDatabaseAuthenticationEnabled': True|False, 'EngineVersion': 'string', 'BackupRetentionPeriod': 123, 'AllocatedStorage': 123, 'Iops': 123, 'StorageType': 'string' }, 'DBClusterInstanceClass': 'string', 'StorageType': 'string', 'Iops': 123, 'PubliclyAccessible': True|False, 'AutoMinorVersionUpgrade': True|False, 'MonitoringInterval': 123, 'MonitoringRoleArn': 'string', 'PerformanceInsightsEnabled': True|False, 'PerformanceInsightsKMSKeyId': 'string', 'PerformanceInsightsRetentionPeriod': 123, 'ServerlessV2ScalingConfiguration': { 'MinCapacity': 123.0, 'MaxCapacity': 123.0 }, 'NetworkType': 'string', 'DBSystemId': 'string', 'MasterUserSecret': { 'SecretArn': 'string', 'SecretStatus': 'string', 'KmsKeyId': 'string' }, 'IOOptimizedNextAllowedModificationTime': datetime(2015, 1, 1) } }
Response Structure
(dict) –
DBCluster (dict) –
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, andStopDBCluster.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, andRestoreDBClusterToPointInTime.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.
AllocatedStorage (integer) –
For all database engines except Amazon Aurora,
AllocatedStoragespecifies the allocated storage size in gibibytes (GiB). For Aurora,AllocatedStoragealways returns 1, because Aurora DB cluster storage size isn’t fixed, but instead automatically adjusts as needed.AvailabilityZones (list) –
The list of Availability Zones (AZs) where instances in the DB cluster can be created.
(string) –
BackupRetentionPeriod (integer) –
The number of days for which automatic DB snapshots are retained.
CharacterSetName (string) –
If present, specifies the name of the character set that this cluster is associated with.
DatabaseName (string) –
The name of the initial database that was specified for the DB cluster when it was created, if one was provided. This same name is returned for the life of the DB cluster.
DBClusterIdentifier (string) –
The user-supplied identifier for the DB cluster. This identifier is the unique key that identifies a DB cluster.
DBClusterParameterGroup (string) –
The name of the DB cluster parameter group for the DB cluster.
DBSubnetGroup (string) –
Information about the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
Status (string) –
The current state of this DB cluster.
AutomaticRestartTime (datetime) –
The time when a stopped DB cluster is restarted automatically.
PercentProgress (string) –
The progress of the operation as a percentage.
EarliestRestorableTime (datetime) –
The earliest time to which a database can be restored with point-in-time restore.
Endpoint (string) –
The connection endpoint for the primary instance of the DB cluster.
ReaderEndpoint (string) –
The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.
If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
CustomEndpoints (list) –
The custom endpoints associated with the DB cluster.
(string) –
MultiAZ (boolean) –
Indicates whether the DB cluster has instances in multiple Availability Zones.
Engine (string) –
The database engine used for this DB cluster.
EngineVersion (string) –
The version of the database engine.
LatestRestorableTime (datetime) –
The latest time to which a database can be restored with point-in-time restore.
Port (integer) –
The port that the database engine is listening on.
MasterUsername (string) –
The master username for the DB cluster.
DBClusterOptionGroupMemberships (list) –
The list of option group memberships for this DB cluster.
(dict) –
Contains status information for a DB cluster option group.
DBClusterOptionGroupName (string) –
Specifies the name of the DB cluster option group.
Status (string) –
Specifies the status of the DB cluster option group.
PreferredBackupWindow (string) –
The daily time range during which automated backups are created if automated backups are enabled, as determined by the
BackupRetentionPeriod.PreferredMaintenanceWindow (string) –
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
ReplicationSourceIdentifier (string) –
The identifier of the source DB cluster if this DB cluster is a read replica.
ReadReplicaIdentifiers (list) –
Contains one or more identifiers of the read replicas associated with this DB cluster.
(string) –
DBClusterMembers (list) –
The list of DB instances that make up the DB cluster.
(dict) –
Contains information about an instance that is part of a DB cluster.
DBInstanceIdentifier (string) –
Specifies the instance identifier for this member of the DB cluster.
IsClusterWriter (boolean) –
Value that is
trueif the cluster member is the primary instance for the DB cluster andfalseotherwise.DBClusterParameterGroupStatus (string) –
Specifies the status of the DB cluster parameter group for this member of the DB cluster.
PromotionTier (integer) –
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 in the Amazon Aurora User Guide.
VpcSecurityGroups (list) –
The list of VPC security groups that the DB cluster belongs to.
(dict) –
This data type is used as a response element for queries on VPC security group membership.
VpcSecurityGroupId (string) –
The name of the VPC security group.
Status (string) –
The membership status of the VPC security group.
Currently, the only valid status is
active.
HostedZoneId (string) –
The ID that Amazon Route 53 assigns when you create a hosted zone.
StorageEncrypted (boolean) –
Indicates whether the DB cluster is encrypted.
KmsKeyId (string) –
If
StorageEncryptedis enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
DbClusterResourceId (string) –
The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
DBClusterArn (string) –
The Amazon Resource Name (ARN) for the DB cluster.
AssociatedRoles (list) –
A list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.
(dict) –
Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB cluster.
RoleArn (string) –
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
Status (string) –
Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:
ACTIVE- the IAM role ARN is associated with the DB cluster and can be used to access other Amazon Web Services on your behalf.PENDING- the IAM role ARN is being associated with the DB cluster.INVALID- the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other Amazon Web Services on your behalf.
FeatureName (string) –
The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion.
IAMDatabaseAuthenticationEnabled (boolean) –
Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
CloneGroupId (string) –
The ID of the clone group with which the DB cluster is associated.
ClusterCreateTime (datetime) –
The time when the DB cluster was created, in Universal Coordinated Time (UTC).
EarliestBacktrackTime (datetime) –
The earliest time to which a DB cluster can be backtracked.
BacktrackWindow (integer) –
The target backtrack window, in seconds. If this value is set to
0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.BacktrackConsumedChangeRecords (integer) –
The number of change records stored for Backtrack.
EnabledCloudwatchLogsExports (list) –
A list of log types that this DB cluster is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.
(string) –
Capacity (integer) –
The current capacity of an Aurora Serverless v1 DB cluster. The capacity is
0(zero) when the cluster is paused.For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
EngineMode (string) –
The DB engine mode of the DB cluster, either
provisionedorserverless.For more information, see CreateDBCluster.
ScalingConfigurationInfo (dict) –
The scaling configuration for an Aurora DB cluster in
serverlessDB engine mode.For more information, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
MinCapacity (integer) –
The minimum capacity for an Aurora DB cluster in
serverlessDB engine mode.MaxCapacity (integer) –
The maximum capacity for an Aurora DB cluster in
serverlessDB engine mode.AutoPause (boolean) –
A value that indicates whether automatic pause is allowed for the Aurora DB cluster in
serverlessDB engine mode.When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.
SecondsUntilAutoPause (integer) –
The remaining amount of time, in seconds, before the Aurora DB cluster in
serverlessmode is paused. A DB cluster can be paused only when it’s idle (it has no connections).TimeoutAction (string) –
The action that occurs when Aurora times out while attempting to change the capacity of an Aurora Serverless v1 cluster. The value is either
ForceApplyCapacityChangeorRollbackCapacityChange.ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.RollbackCapacityChangeignores the capacity change if a scaling point isn’t found in the timeout period.SecondsBeforeTimeout (integer) –
The number of seconds before scaling times out. What happens when an attempted scaling action times out is determined by the
TimeoutActionsetting.
DeletionProtection (boolean) –
Indicates whether the DB cluster has deletion protection enabled. The database can’t be deleted when deletion protection is enabled.
HttpEndpointEnabled (boolean) –
Indicates whether the HTTP endpoint for an Aurora Serverless v1 DB cluster is enabled.
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 in the Amazon Aurora User Guide.
ActivityStreamMode (string) –
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.
ActivityStreamStatus (string) –
The status of the database activity stream.
ActivityStreamKmsKeyId (string) –
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
ActivityStreamKinesisStreamName (string) –
The name of the Amazon Kinesis data stream used for the database activity stream.
CopyTagsToSnapshot (boolean) –
Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster.
CrossAccountClone (boolean) –
Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
DomainMemberships (list) –
The Active Directory Domain membership records associated with the DB cluster.
(dict) –
An Active Directory Domain membership record associated with the DB instance or cluster.
Domain (string) –
The identifier of the Active Directory Domain.
Status (string) –
The status of the Active Directory Domain membership for the DB instance or cluster. Values include
joined,pending-join,failed, and so on.FQDN (string) –
The fully qualified domain name (FQDN) of the Active Directory Domain.
IAMRoleName (string) –
The name of the IAM role used when making API calls to the Directory Service.
OU (string) –
The Active Directory organizational unit for the DB instance or cluster.
AuthSecretArn (string) –
The ARN for the Secrets Manager secret with the credentials for the user that’s a member of the domain.
DnsIps (list) –
The IPv4 DNS IP addresses of the primary and secondary Active Directory domain controllers.
(string) –
TagList (list) –
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
(dict) –
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
Key (string) –
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can’t be prefixed with
aws:orrds:. The string can only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-’, ‘@’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$”).Value (string) –
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can’t be prefixed with
aws:orrds:. The string can only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-’, ‘@’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$”).
GlobalWriteForwardingStatus (string) –
The status of write forwarding for a secondary cluster in an Aurora global database.
GlobalWriteForwardingRequested (boolean) –
Specifies whether write forwarding is enabled for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of
GlobalWriteForwardingStatusto confirm that the request has completed before using the write forwarding feature for this cluster.PendingModifiedValues (dict) –
Information about pending changes to the DB cluster. This information is returned only when there are pending changes. Specific changes are identified by subelements.
PendingCloudwatchLogsExports (dict) –
A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.
LogTypesToEnable (list) –
Log types that are in the process of being deactivated. After they are deactivated, these log types aren’t exported to CloudWatch Logs.
(string) –
LogTypesToDisable (list) –
Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.
(string) –
DBClusterIdentifier (string) –
The DBClusterIdentifier value for the DB cluster.
MasterUserPassword (string) –
The master credentials for the DB cluster.
IAMDatabaseAuthenticationEnabled (boolean) –
A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
EngineVersion (string) –
The database engine version.
BackupRetentionPeriod (integer) –
The number of days for which automatic DB snapshots are retained.
AllocatedStorage (integer) –
The allocated storage size in gibibytes (GiB) for all database engines except Amazon Aurora. For Aurora,
AllocatedStoragealways returns 1, because Aurora DB cluster storage size isn’t fixed, but instead automatically adjusts as needed.Iops (integer) –
The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.
StorageType (string) –
The storage type for the DB cluster.
DBClusterInstanceClass (string) –
The name of the compute and memory capacity class of the DB instance.
This setting is only for non-Aurora Multi-AZ DB clusters.
StorageType (string) –
The storage type associated with the DB cluster.
Iops (integer) –
The Provisioned IOPS (I/O operations per second) value.
This setting is only for non-Aurora Multi-AZ DB clusters.
PubliclyAccessible (boolean) –
Indicates whether the DB cluster 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 cluster isn’t publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
For more information, see CreateDBCluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
AutoMinorVersionUpgrade (boolean) –
Indicates whether minor version patches are applied automatically.
This setting is only for non-Aurora Multi-AZ DB clusters.
MonitoringInterval (integer) –
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
MonitoringRoleArn (string) –
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
This setting is only for non-Aurora Multi-AZ DB clusters.
PerformanceInsightsEnabled (boolean) –
Indicates whether Performance Insights is enabled for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
PerformanceInsightsKMSKeyId (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.
This setting is only for non-Aurora Multi-AZ DB clusters.
PerformanceInsightsRetentionPeriod (integer) –
The number of days to retain Performance Insights data.
This setting is only for non-Aurora Multi-AZ DB clusters.
Valid Values:
7month * 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:
7daysServerlessV2ScalingConfiguration (dict) –
The scaling configuration for an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide.
MinCapacity (float) –
The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.
MaxCapacity (float) –
The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128.
NetworkType (string) –
The network type of the DB instance.
The network type is determined by the
DBSubnetGroupspecified for the DB cluster. ADBSubnetGroupcan 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.
This setting is only for Aurora DB clusters.
Valid Values:
IPV4 | DUALDBSystemId (string) –
Reserved for future use.
MasterUserSecret (dict) –
The secret managed by RDS in Amazon Web Services Secrets Manager for the master user 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.
SecretArn (string) –
The Amazon Resource Name (ARN) of the secret.
SecretStatus (string) –
The status of the secret.
The possible status values include the following:
creating- The secret is being created.active- The secret is available for normal use and rotation.rotating- The secret is being rotated.impaired- The secret can be used to access database credentials, but it can’t be rotated. A secret might have this status if, for example, permissions are changed so that RDS can no longer access either the secret or the KMS key for the secret. When a secret has this status, you can correct the condition that caused the status. Alternatively, modify the DB instance to turn off automatic management of database credentials, and then modify the DB instance again to turn on automatic management of database credentials.
KmsKeyId (string) –
The Amazon Web Services KMS key identifier that is used to encrypt the secret.
IOOptimizedNextAllowedModificationTime (datetime) –
The next time you can modify the DB cluster to use the
aurora-iopt1storage type.This setting is only for Aurora DB clusters.
Exceptions
RDS.Client.exceptions.DBClusterNotFoundFaultRDS.Client.exceptions.InvalidDBClusterStateFaultRDS.Client.exceptions.StorageQuotaExceededFaultRDS.Client.exceptions.DBSubnetGroupNotFoundFaultRDS.Client.exceptions.InvalidVPCNetworkStateFaultRDS.Client.exceptions.InvalidDBSubnetGroupStateFaultRDS.Client.exceptions.InvalidSubnetRDS.Client.exceptions.DBClusterParameterGroupNotFoundFaultRDS.Client.exceptions.InvalidDBSecurityGroupStateFaultRDS.Client.exceptions.InvalidDBInstanceStateFaultRDS.Client.exceptions.DBClusterAlreadyExistsFaultRDS.Client.exceptions.DBInstanceAlreadyExistsFaultRDS.Client.exceptions.DomainNotFoundFaultRDS.Client.exceptions.StorageTypeNotAvailableFault
Examples
This example changes the specified settings for the specified DB cluster.
response = client.modify_db_cluster( ApplyImmediately=True, DBClusterIdentifier='mydbcluster', MasterUserPassword='mynewpassword', NewDBClusterIdentifier='mynewdbcluster', PreferredBackupWindow='04:00-04:30', PreferredMaintenanceWindow='Tue:05:00-Tue:05:30', ) print(response)
Expected Output:
{ 'DBCluster': { }, 'ResponseMetadata': { '...': '...', }, }