AWS API Changes

2023/11/01 - Amazon Relational Database Service - 12 updated api methods

Changes This release adds support for customized networking resources to Amazon RDS Custom.

CreateDBCluster (updated)

Link ¶
Changes (request, response)
Request

{'RdsCustomClusterConfiguration': {'InterconnectSubnetId': 'string',
                                   'TransitGatewayMulticastDomainId': 'string'}}

Response

{'DBCluster': {'PendingModifiedValues': {'RdsCustomClusterConfiguration': {'InterconnectSubnetId': 'string',
                                                                           'TransitGatewayMulticastDomainId': 'string'}},
               'RdsCustomClusterConfiguration': {'InterconnectSubnetId': 'string',
                                                 'TransitGatewayMulticastDomainId': 'string'}}}

Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.

If you create an Aurora DB cluster, the request creates an empty cluster. You must explicitly create the writer instance for your DB cluster using the CreateDBInstance operation. If you create a Multi-AZ DB cluster, the request creates a writer and two reader DB instances for you, each in a different Availability Zone.

You can use the ReplicationSourceIdentifier parameter to create an Amazon Aurora DB cluster as a read replica of another DB cluster or Amazon RDS for MySQL or PostgreSQL DB instance. For more information about Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide .

You can also use the ReplicationSourceIdentifier parameter to create a Multi-AZ DB cluster read replica with an RDS for MySQL or PostgreSQL DB instance as the source. For more information about Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide .

See also: AWS API Documentation

Request Syntax

client.create_db_cluster(
    AvailabilityZones=[
        'string',
    ],
    BackupRetentionPeriod=123,
    CharacterSetName='string',
    DatabaseName='string',
    DBClusterIdentifier='string',
    DBClusterParameterGroupName='string',
    VpcSecurityGroupIds=[
        'string',
    ],
    DBSubnetGroupName='string',
    Engine='string',
    EngineVersion='string',
    Port=123,
    MasterUsername='string',
    MasterUserPassword='string',
    OptionGroupName='string',
    PreferredBackupWindow='string',
    PreferredMaintenanceWindow='string',
    ReplicationSourceIdentifier='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    StorageEncrypted=True|False,
    KmsKeyId='string',
    PreSignedUrl='string',
    EnableIAMDatabaseAuthentication=True|False,
    BacktrackWindow=123,
    EnableCloudwatchLogsExports=[
        'string',
    ],
    EngineMode='string',
    ScalingConfiguration={
        'MinCapacity': 123,
        'MaxCapacity': 123,
        'AutoPause': True|False,
        'SecondsUntilAutoPause': 123,
        'TimeoutAction': 'string',
        'SecondsBeforeTimeout': 123
    },
    RdsCustomClusterConfiguration={
        'InterconnectSubnetId': 'string',
        'TransitGatewayMulticastDomainId': 'string'
    },
    DeletionProtection=True|False,
    GlobalClusterIdentifier='string',
    EnableHttpEndpoint=True|False,
    CopyTagsToSnapshot=True|False,
    Domain='string',
    DomainIAMRoleName='string',
    EnableGlobalWriteForwarding=True|False,
    DBClusterInstanceClass='string',
    AllocatedStorage=123,
    StorageType='string',
    Iops=123,
    PubliclyAccessible=True|False,
    AutoMinorVersionUpgrade=True|False,
    MonitoringInterval=123,
    MonitoringRoleArn='string',
    EnablePerformanceInsights=True|False,
    PerformanceInsightsKMSKeyId='string',
    PerformanceInsightsRetentionPeriod=123,
    ServerlessV2ScalingConfiguration={
        'MinCapacity': 123.0,
        'MaxCapacity': 123.0
    },
    NetworkType='string',
    DBSystemId='string',
    ManageMasterUserPassword=True|False,
    MasterUserSecretKmsKeyId='string',
    EnableLocalWriteForwarding=True|False,
    SourceRegion='string'
)

type AvailabilityZones

list

param AvailabilityZones

A list of Availability Zones (AZs) where DB instances in the DB cluster can be created.

For information on Amazon Web Services Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide .

Valid for Cluster Type: Aurora DB clusters only

(string) --

type BackupRetentionPeriod

integer

param BackupRetentionPeriod

The number of days for which automated backups are retained.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Default: 1

Constraints:

Must be a value from 1 to 35.

type CharacterSetName

string

param CharacterSetName

The name of the character set (CharacterSet ) to associate the DB cluster with.

Valid for Cluster Type: Aurora DB clusters only

type DatabaseName

string

param DatabaseName

The name for your database of up to 64 alphanumeric characters. If you don't provide a name, Amazon RDS doesn't create a database in the DB cluster you are creating.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

type DBClusterIdentifier

string

param DBClusterIdentifier

[REQUIRED]

The identifier for this DB cluster. This parameter 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.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.

Example: my-cluster1

type DBClusterParameterGroupName

string

param DBClusterParameterGroupName

The name of the DB cluster parameter group to associate with this DB cluster. If you don't specify a value, then the default DB cluster parameter group for the specified DB engine and version is used.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Constraints:

If supplied, must match the name of an existing DB cluster parameter group.

type VpcSecurityGroupIds

list

param VpcSecurityGroupIds

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) --

type DBSubnetGroupName

string

param DBSubnetGroupName

A DB subnet group to associate with this DB cluster.

This setting is required to create a Multi-AZ DB cluster.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Constraints:

Must match the name of an existing DB subnet group.
Must not be default .

Example: mydbsubnetgroup

type Engine

string

param Engine

[REQUIRED]

The database engine to use for this DB cluster.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Valid Values: aurora-mysql | aurora-postgresql | mysql | postgres

type EngineVersion

string

param EngineVersion

The version number of the database engine to use.

To list all of the available engine versions for Aurora MySQL version 2 (5.7-compatible) and version 3 (MySQL 8.0-compatible), use the following command:

aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"

You can supply either 5.7 or 8.0 to use the default engine version for Aurora MySQL version 2 or version 3, respectively.

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"

For information about a specific engine, see the following topics:

Aurora MySQL - see Database engine updates for Amazon Aurora MySQL in the Amazon Aurora User Guide .
Aurora PostgreSQL - see Amazon Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide .
RDS for MySQL - see Amazon RDS for MySQL in the Amazon RDS User Guide .
RDS for PostgreSQL - see Amazon RDS for PostgreSQL in the Amazon RDS User Guide .

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

type Port

integer

param Port

The port number on which the instances in the DB cluster accept connections.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Valid Values: 1150-65535

Default:

RDS for MySQL and Aurora MySQL - 3306
RDS for PostgreSQL and Aurora PostgreSQL - 5432

type MasterUsername

string

param MasterUsername

The name of the master user for the DB cluster.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Constraints:

Must be 1 to 16 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.

type MasterUserPassword

string

param MasterUserPassword

The password for the master database user.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Constraints:

Must contain from 8 to 41 characters.
Can contain any printable ASCII character except "/", """, or "@".
Can't be specified if ManageMasterUserPassword is turned on.

type OptionGroupName

string

param OptionGroupName

The option group to associate the DB cluster with.

DB clusters are associated with a default option group that can't be modified.

type PreferredBackupWindow

string

param PreferredBackupWindow

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

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. To view the time blocks available, see Backup window 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.

type PreferredMaintenanceWindow

string

param PreferredMaintenanceWindow

The weekly time range during which system maintenance can occur.

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.

type ReplicationSourceIdentifier

string

param ReplicationSourceIdentifier

The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

type Tags

list

param Tags

Tags to assign to the DB cluster.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

(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: or rds: . 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: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").

type StorageEncrypted

boolean

param StorageEncrypted

Specifies whether the DB cluster is encrypted.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

type KmsKeyId

string

param KmsKeyId

The Amazon Web Services KMS key identifier for an 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. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

When a KMS key isn't specified in KmsKeyId :

If ReplicationSourceIdentifier identifies an encrypted source, then Amazon RDS uses the KMS key used to encrypt the source. Otherwise, Amazon RDS uses your default KMS key.
If the StorageEncrypted parameter is enabled and ReplicationSourceIdentifier isn't specified, 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.

If you create a read replica of an encrypted DB cluster in another Amazon Web Services Region, make sure to set KmsKeyId to a KMS key identifier that is valid in the destination Amazon Web Services Region. This KMS key is used to encrypt the read replica in that Amazon Web Services Region.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

type PreSignedUrl

string

param PreSignedUrl

When you are replicating a DB cluster from one Amazon Web Services GovCloud (US) Region to another, an URL that contains a Signature Version 4 signed request for the CreateDBCluster operation to be called in the source Amazon Web Services Region where the DB cluster is replicated from. Specify PreSignedUrl only when you are performing cross-Region replication from an encrypted DB cluster.

The presigned URL must be a valid request for the CreateDBCluster API operation that can run in the source Amazon Web Services Region that contains the encrypted DB cluster to copy.

The presigned URL request must contain the following parameter values:

KmsKeyId - The KMS key identifier for the KMS key to use to encrypt the copy of the DB cluster in the destination Amazon Web Services Region. This should refer to the same KMS key for both the CreateDBCluster operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL.
DestinationRegion - The name of the Amazon Web Services Region that Aurora read replica will be created in.
ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted DB cluster from the us-west-2 Amazon Web Services Region, then your ReplicationSourceIdentifier would look like Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1 .

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process .

Note

If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.

Valid for Cluster Type: Aurora DB clusters only

Note

If you supply a value for this operation's SourceRegion parameter, a pre-signed URL will be calculated on your behalf.

type EnableIAMDatabaseAuthentication

boolean

param EnableIAMDatabaseAuthentication

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

type BacktrackWindow

integer

param BacktrackWindow

The target backtrack window, in seconds. To disable backtracking, set this value to 0 .

Valid for Cluster Type: Aurora MySQL DB clusters only

Default: 0

Constraints:

If specified, this value must be set to a number from 0 to 259,200 (72 hours).

type EnableCloudwatchLogsExports

list

param EnableCloudwatchLogsExports

The list of log types that need to be enabled for exporting to CloudWatch Logs.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

The following values are valid for each DB engine:

Aurora MySQL - audit | error | general | slowquery
Aurora PostgreSQL - postgresql
RDS for MySQL - error | general | slowquery
RDS for PostgreSQL - postgresql | upgrade

For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide .

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide .

(string) --

type EngineMode

string

param EngineMode

The DB engine mode of the DB cluster, either provisioned or serverless .

The serverless engine mode only applies for Aurora Serverless v1 DB clusters.

For information about limitations and requirements for Serverless DB clusters, see the following sections in the Amazon Aurora User Guide :

Valid for Cluster Type: Aurora DB clusters only

type ScalingConfiguration

dict

param ScalingConfiguration

For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

Valid for Cluster Type: Aurora DB clusters only

MinCapacity (integer) --

The minimum capacity for an Aurora DB cluster in serverless DB engine mode.

For Aurora MySQL, valid capacity values are 1 , 2 , 4 , 8 , 16 , 32 , 64 , 128 , and 256 .

For Aurora PostgreSQL, valid capacity values are 2 , 4 , 8 , 16 , 32 , 64 , 192 , and 384 .

The minimum capacity must be less than or equal to the maximum capacity.
MaxCapacity (integer) --

The maximum capacity for an Aurora DB cluster in serverless DB engine mode.

For Aurora MySQL, valid capacity values are 1 , 2 , 4 , 8 , 16 , 32 , 64 , 128 , and 256 .

For Aurora PostgreSQL, valid capacity values are 2 , 4 , 8 , 16 , 32 , 64 , 192 , and 384 .

The maximum capacity must be greater than or equal to the minimum capacity.
AutoPause (boolean) --

Indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB 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 serverless mode is paused.

Specify a value between 300 and 86,400 seconds.
TimeoutAction (string) --

The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange .

ForceApplyCapacityChange sets 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.

type RdsCustomClusterConfiguration

dict

param RdsCustomClusterConfiguration

Reserved for future use.

InterconnectSubnetId (string) --

Reserved for future use.
TransitGatewayMulticastDomainId (string) --

Reserved for future use.

type DeletionProtection

boolean

param DeletionProtection

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

type GlobalClusterIdentifier

string

param GlobalClusterIdentifier

The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.

Valid for Cluster Type: Aurora DB clusters only

type EnableHttpEndpoint

boolean

param EnableHttpEndpoint

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

type CopyTagsToSnapshot

boolean

param CopyTagsToSnapshot

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

type Domain

string

param Domain

The Active Directory directory ID to create the DB cluster in.

For Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster.

For more information, see Kerberos authentication in the Amazon Aurora User Guide .

Valid for Cluster Type: Aurora DB clusters only

type DomainIAMRoleName

string

param DomainIAMRoleName

The name of the IAM role to use when making API calls to the Directory Service.

Valid for Cluster Type: Aurora DB clusters only

type EnableGlobalWriteForwarding

boolean

param EnableGlobalWriteForwarding

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

type DBClusterInstanceClass

string

param DBClusterInstanceClass

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 .

This setting is required to create a Multi-AZ DB cluster.

Valid for Cluster Type: Multi-AZ DB clusters only

type AllocatedStorage

integer

param AllocatedStorage

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

This setting is required to create a Multi-AZ DB cluster.

type StorageType

string

param StorageType

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 .

This setting is required to create a Multi-AZ DB cluster.

When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Valid Values:

Aurora DB clusters - aurora | aurora-iopt1
Multi-AZ DB clusters - io1

Default:

Aurora DB clusters - aurora
Multi-AZ DB clusters - io1

Note

When you create an Aurora DB cluster with the storage type set to aurora-iopt1 , the storage type is returned in the response. The storage type isn't returned when you set it to aurora .

type Iops

integer

param Iops

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 Provisioned IOPS storage in the Amazon RDS User Guide .

This setting is required to create a Multi-AZ DB cluster.

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.

type PubliclyAccessible

boolean

param PubliclyAccessible

Specifies 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.

Valid for Cluster Type: Multi-AZ DB clusters only

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.

type AutoMinorVersionUpgrade

boolean

param AutoMinorVersionUpgrade

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

type MonitoringInterval

integer

param MonitoringInterval

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0 .

If MonitoringRoleArn is specified, also set MonitoringInterval to a value other than 0 .

Valid for Cluster Type: Multi-AZ DB clusters only

Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60

Default: 0

type MonitoringRoleArn

string

param MonitoringRoleArn

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 Setting up and enabling Enhanced Monitoring in the Amazon RDS User Guide .

If MonitoringInterval is set to a value other than 0 , supply a MonitoringRoleArn value.

Valid for Cluster Type: Multi-AZ DB clusters only

type EnablePerformanceInsights

boolean

param EnablePerformanceInsights

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

type PerformanceInsightsKMSKeyId

string

param PerformanceInsightsKMSKeyId

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

type PerformanceInsightsRetentionPeriod

integer

param PerformanceInsightsRetentionPeriod

The number of days to retain Performance Insights data.

Valid for Cluster Type: Multi-AZ DB clusters only

Valid Values:

7
month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
731

Default: 7 days

If you specify a retention period that isn't valid, such as 94 , Amazon RDS issues an error.

type ServerlessV2ScalingConfiguration

dict

param ServerlessV2ScalingConfiguration

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.

type NetworkType

string

param NetworkType

The network type of the DB cluster.

The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).

For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.

Valid for Cluster Type: Aurora DB clusters only

Valid Values: IPV4 | DUAL

type DBSystemId

string

param DBSystemId

Reserved for future use.

type ManageMasterUserPassword

boolean

param ManageMasterUserPassword

Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.

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:

Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.

type MasterUserSecretKmsKeyId

string

param MasterUserSecretKmsKeyId

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 the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster.

If you don't specify MasterUserSecretKmsKeyId , then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.

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

type EnableLocalWriteForwarding

boolean

param EnableLocalWriteForwarding

Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.

Valid for: Aurora DB clusters only

type SourceRegion

string

param SourceRegion

The ID of the region that contains the source for the read replica.

rtype

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
        },
        'RdsCustomClusterConfiguration': {
            'InterconnectSubnetId': 'string',
            'TransitGatewayMulticastDomainId': 'string'
        },
        '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,
            'RdsCustomClusterConfiguration': {
                'InterconnectSubnetId': 'string',
                'TransitGatewayMulticastDomainId': 'string'
            },
            '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),
        'LocalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'requested',
        'AwsBackupRecoveryPointArn': 'string'
    }
}

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 , and StopDBCluster .
  
  For a Multi-AZ DB cluster, this data type is used as a response element in the operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , FailoverDBCluster , ModifyDBCluster , RebootDBCluster , RestoreDBClusterFromSnapshot , and RestoreDBClusterToPointInTime .
  
  For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
  
  For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
  - AllocatedStorage (integer) --
    
    For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always 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) --
        
        Indicates whether the cluster member is the primary DB instance for the DB cluster.
      - 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 StorageEncrypted is 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 provisioned or serverless .
    
    For more information, see CreateDBCluster .
  - ScalingConfigurationInfo (dict) --
    
    The scaling configuration for an Aurora DB cluster in serverless DB 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 serverless DB engine mode.
    - MaxCapacity (integer) --
      
      The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
    - AutoPause (boolean) --
      
      Indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB 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 serverless mode 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 ForceApplyCapacityChange or RollbackCapacityChange .
      
      ForceApplyCapacityChange , the default, sets the capacity to the specified value as soon as possible.
      
      RollbackCapacityChange ignores 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 TimeoutAction setting.
  - RdsCustomClusterConfiguration (dict) --
    
    Reserved for future use.
    - InterconnectSubnetId (string) --
      
      Reserved for future use.
    - TransitGatewayMulticastDomainId (string) --
      
      Reserved for future use.
  - 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: or rds: . 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: or rds: . 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) --
    
    Indicates 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 GlobalWriteForwardingStatus to 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) --
      
      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, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
    - RdsCustomClusterConfiguration (dict) --
      
      Reserved for future use.
      - InterconnectSubnetId (string) --
        
        Reserved for future use.
      - TransitGatewayMulticastDomainId (string) --
        
        Reserved for future use.
    - 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:
    - 7
    - month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
    - 731
    Default: 7 days
  - ServerlessV2ScalingConfiguration (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 DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
    
    For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
    
    This setting is only for Aurora DB clusters.
    
    Valid Values: IPV4 | DUAL
  - DBSystemId (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-iopt1 storage type.
    
    This setting is only for Aurora DB clusters.
  - LocalWriteForwardingStatus (string) --
    
    Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it.
  - AwsBackupRecoveryPointArn (string) --
    
    The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

DeleteDBCluster (updated)

Link ¶
Changes (response)

{'DBCluster': {'PendingModifiedValues': {'RdsCustomClusterConfiguration': {'InterconnectSubnetId': 'string',
                                                                           'TransitGatewayMulticastDomainId': 'string'}},
               'RdsCustomClusterConfiguration': {'InterconnectSubnetId': 'string',
                                                 'TransitGatewayMulticastDomainId': 'string'}}}

The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.

If you're deleting a Multi-AZ DB cluster with read replicas, all cluster members are terminated and read replicas are promoted to standalone instances.

For more information on Amazon Aurora, 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

client.delete_db_cluster(
    DBClusterIdentifier='string',
    SkipFinalSnapshot=True|False,
    FinalDBSnapshotIdentifier='string',
    DeleteAutomatedBackups=True|False
)

type DBClusterIdentifier

string

param DBClusterIdentifier

[REQUIRED]

The DB cluster identifier for the DB cluster to be deleted. This parameter isn't case-sensitive.

Constraints:

Must match an existing DBClusterIdentifier.

type SkipFinalSnapshot

boolean

param SkipFinalSnapshot

Specifies whether to skip the creation of a final DB cluster snapshot before the DB cluster is deleted. If skip is specified, no DB cluster snapshot is created. If skip isn't specified, a DB cluster snapshot is created before the DB cluster is deleted. By default, skip isn't specified, and the DB cluster snapshot is created. By default, this parameter is disabled.

Note

You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is disabled.

type FinalDBSnapshotIdentifier

string

param FinalDBSnapshotIdentifier

The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is disabled.

Note

Specifying this parameter and also skipping the creation of a final DB cluster snapshot with the SkipFinalShapshot parameter results in an error.

Constraints:

Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens

type DeleteAutomatedBackups

boolean

param DeleteAutomatedBackups

Specifies whether to remove automated backups immediately after the DB cluster is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB cluster is deleted.

rtype

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
        },
        'RdsCustomClusterConfiguration': {
            'InterconnectSubnetId': 'string',
            'TransitGatewayMulticastDomainId': 'string'
        },
        '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,
            'RdsCustomClusterConfiguration': {
                'InterconnectSubnetId': 'string',
                'TransitGatewayMulticastDomainId': 'string'
            },
            '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),
        'LocalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'requested',
        'AwsBackupRecoveryPointArn': 'string'
    }
}

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 , and StopDBCluster .
  
  For a Multi-AZ DB cluster, this data type is used as a response element in the operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , FailoverDBCluster , ModifyDBCluster , RebootDBCluster , RestoreDBClusterFromSnapshot , and RestoreDBClusterToPointInTime .
  
  For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
  
  For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
  - AllocatedStorage (integer) --
    
    For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always 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) --
        
        Indicates whether the cluster member is the primary DB instance for the DB cluster.
      - 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 StorageEncrypted is 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 provisioned or serverless .
    
    For more information, see CreateDBCluster .
  - ScalingConfigurationInfo (dict) --
    
    The scaling configuration for an Aurora DB cluster in serverless DB 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 serverless DB engine mode.
    - MaxCapacity (integer) --
      
      The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
    - AutoPause (boolean) --
      
      Indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB 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 serverless mode 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 ForceApplyCapacityChange or RollbackCapacityChange .
      
      ForceApplyCapacityChange , the default, sets the capacity to the specified value as soon as possible.
      
      RollbackCapacityChange ignores 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 TimeoutAction setting.
  - RdsCustomClusterConfiguration (dict) --
    
    Reserved for future use.
    - InterconnectSubnetId (string) --
      
      Reserved for future use.
    - TransitGatewayMulticastDomainId (string) --
      
      Reserved for future use.
  - 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: or rds: . 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: or rds: . 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) --
    
    Indicates 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 GlobalWriteForwardingStatus to 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) --
      
      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, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
    - RdsCustomClusterConfiguration (dict) --
      
      Reserved for future use.
      - InterconnectSubnetId (string) --
        
        Reserved for future use.
      - TransitGatewayMulticastDomainId (string) --
        
        Reserved for future use.
    - 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:
    - 7
    - month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
    - 731
    Default: 7 days
  - ServerlessV2ScalingConfiguration (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 DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
    
    For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
    
    This setting is only for Aurora DB clusters.
    
    Valid Values: IPV4 | DUAL
  - DBSystemId (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-iopt1 storage type.
    
    This setting is only for Aurora DB clusters.
  - LocalWriteForwardingStatus (string) --
    
    Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it.
  - AwsBackupRecoveryPointArn (string) --
    
    The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

DescribeDBClusters (updated)

Link ¶
Changes (response)

{'DBClusters': {'PendingModifiedValues': {'RdsCustomClusterConfiguration': {'InterconnectSubnetId': 'string',
                                                                            'TransitGatewayMulticastDomainId': 'string'}},
                'RdsCustomClusterConfiguration': {'InterconnectSubnetId': 'string',
                                                  'TransitGatewayMulticastDomainId': 'string'}}}

Describes existing Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination.

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 .

This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.

See also: AWS API Documentation

Request Syntax

client.describe_db_clusters(
    DBClusterIdentifier='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    Marker='string',
    IncludeShared=True|False
)

type DBClusterIdentifier

string

param DBClusterIdentifier

The user-supplied DB cluster identifier or the Amazon Resource Name (ARN) of the DB cluster. If this parameter is specified, information for only the specific DB cluster is returned. This parameter isn't case-sensitive.

Constraints:

If supplied, must match an existing DB cluster identifier.

type Filters

list

param Filters

A filter that specifies one or more DB clusters to describe.

Supported Filters:

clone-group-id - Accepts clone group identifiers. The results list only includes information about the DB clusters associated with these clone groups.
db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB clusters identified by these ARNs.
db-cluster-resource-id - Accepts DB cluster resource identifiers. The results list will only include information about the DB clusters identified by these DB cluster resource identifiers.
domain - Accepts Active Directory directory IDs. The results list only includes information about the DB clusters associated with these domains.
engine - Accepts engine names. The results list only includes information about the DB clusters for these engines.

(dict) --

A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.

Note

Currently, wildcards are not supported in filters.

The following actions can be filtered:
- DescribeDBClusterBacktracks
- DescribeDBClusterEndpoints
- DescribeDBClusters
- DescribeDBInstances
- DescribePendingMaintenanceActions
- Name (string) -- [REQUIRED]
  
  The name of the filter. Filter names are case-sensitive.
- Values (list) -- [REQUIRED]
  
  One or more filter values. Filter values are case-sensitive.
  - (string) --

type MaxRecords

integer

param MaxRecords

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

type Marker

string

param Marker

An optional pagination token provided by a previous DescribeDBClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

type IncludeShared

boolean

param IncludeShared

Specifies whether the output includes information about clusters shared from other Amazon Web Services accounts.

rtype

dict

returns

Response Syntax

{
    'Marker': 'string',
    'DBClusters': [
        {
            '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
            },
            'RdsCustomClusterConfiguration': {
                'InterconnectSubnetId': 'string',
                'TransitGatewayMulticastDomainId': 'string'
            },
            '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,
                'RdsCustomClusterConfiguration': {
                    'InterconnectSubnetId': 'string',
                    'TransitGatewayMulticastDomainId': 'string'
                },
                '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),
            'LocalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'requested',
            'AwsBackupRecoveryPointArn': 'string'
        },
    ]
}

Response Structure

(dict) --

Contains the result of a successful invocation of the DescribeDBClusters action.
- Marker (string) --
  
  A pagination token that can be used in a later DescribeDBClusters request.
- DBClusters (list) --
  
  Contains a list of DB clusters for the user.
  - (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 , and StopDBCluster .
    
    For a Multi-AZ DB cluster, this data type is used as a response element in the operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , FailoverDBCluster , ModifyDBCluster , RebootDBCluster , RestoreDBClusterFromSnapshot , and RestoreDBClusterToPointInTime .
    
    For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
    
    For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
    - AllocatedStorage (integer) --
      
      For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always 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) --
        
        Indicates whether the cluster member is the primary DB instance for the DB cluster.
        
        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 StorageEncrypted is 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 provisioned or serverless .
      
      For more information, see CreateDBCluster .
    - ScalingConfigurationInfo (dict) --
      
      The scaling configuration for an Aurora DB cluster in serverless DB 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 serverless DB engine mode.
      - MaxCapacity (integer) --
        
        The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
      - AutoPause (boolean) --
        
        Indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB 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 serverless mode 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 ForceApplyCapacityChange or RollbackCapacityChange .
        
        ForceApplyCapacityChange , the default, sets the capacity to the specified value as soon as possible.
        
        RollbackCapacityChange ignores 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 TimeoutAction setting.
    - RdsCustomClusterConfiguration (dict) --
      
      Reserved for future use.
      - InterconnectSubnetId (string) --
        
        Reserved for future use.
      - TransitGatewayMulticastDomainId (string) --
        
        Reserved for future use.
    - 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: or rds: . 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: or rds: . 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) --
      
      Indicates 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 GlobalWriteForwardingStatus to 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) --
        
        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, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
      - RdsCustomClusterConfiguration (dict) --
        
        Reserved for future use.
        
        InterconnectSubnetId (string) --
        
        Reserved for future use.
        
        TransitGatewayMulticastDomainId (string) --
        
        Reserved for future use.
      - 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:
      - 7
      - month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
      - 731
      Default: 7 days
    - ServerlessV2ScalingConfiguration (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 DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
      
      For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
      
      This setting is only for Aurora DB clusters.
      
      Valid Values: IPV4 | DUAL
    - DBSystemId (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-iopt1 storage type.
      
      This setting is only for Aurora DB clusters.
    - LocalWriteForwardingStatus (string) --
      
      Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it.
    - AwsBackupRecoveryPointArn (string) --
      
      The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

FailoverDBCluster (updated)

Link ¶
Changes (response)

{'DBCluster': {'PendingModifiedValues': {'RdsCustomClusterConfiguration': {'InterconnectSubnetId': 'string',
                                                                           'TransitGatewayMulticastDomainId': 'string'}},
               'RdsCustomClusterConfiguration': {'InterconnectSubnetId': 'string',
                                                 'TransitGatewayMulticastDomainId': 'string'}}}

Forces a failover for a DB cluster.

For an Aurora DB cluster, failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer).

For a Multi-AZ DB cluster, failover for a DB cluster promotes one of the readable standby DB instances (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer).

An Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists, when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readable standby DB instance when the primary DB instance fails.

To simulate a failure of a primary instance for testing, you can force a failover. Because each instance in a DB cluster has its own endpoint address, make sure to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.

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

client.failover_db_cluster(
    DBClusterIdentifier='string',
    TargetDBInstanceIdentifier='string'
)

type DBClusterIdentifier

string

param DBClusterIdentifier

[REQUIRED]

The identifier of the DB cluster to force a failover for. This parameter isn't case-sensitive.

Constraints:

Must match the identifier of an existing DB cluster.

type TargetDBInstanceIdentifier

string

param TargetDBInstanceIdentifier

The name of the DB instance to promote to the primary DB instance.

Specify the DB instance identifier for an Aurora Replica or a Multi-AZ readable standby in the DB cluster, for example mydbcluster-replica1 .

This setting isn't supported for RDS for MySQL Multi-AZ DB clusters.

rtype

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
        },
        'RdsCustomClusterConfiguration': {
            'InterconnectSubnetId': 'string',
            'TransitGatewayMulticastDomainId': 'string'
        },
        '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,
            'RdsCustomClusterConfiguration': {
                'InterconnectSubnetId': 'string',
                'TransitGatewayMulticastDomainId': 'string'
            },
            '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),
        'LocalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'requested',
        'AwsBackupRecoveryPointArn': 'string'
    }
}

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 , and StopDBCluster .
  
  For a Multi-AZ DB cluster, this data type is used as a response element in the operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , FailoverDBCluster , ModifyDBCluster , RebootDBCluster , RestoreDBClusterFromSnapshot , and RestoreDBClusterToPointInTime .
  
  For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
  
  For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
  - AllocatedStorage (integer) --
    
    For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always 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) --
        
        Indicates whether the cluster member is the primary DB instance for the DB cluster.
      - 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 StorageEncrypted is 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 provisioned or serverless .
    
    For more information, see CreateDBCluster .
  - ScalingConfigurationInfo (dict) --
    
    The scaling configuration for an Aurora DB cluster in serverless DB 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 serverless DB engine mode.
    - MaxCapacity (integer) --
      
      The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
    - AutoPause (boolean) --
      
      Indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB 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 serverless mode 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 ForceApplyCapacityChange or RollbackCapacityChange .
      
      ForceApplyCapacityChange , the default, sets the capacity to the specified value as soon as possible.
      
      RollbackCapacityChange ignores 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 TimeoutAction setting.
  - RdsCustomClusterConfiguration (dict) --
    
    Reserved for future use.
    - InterconnectSubnetId (string) --
      
      Reserved for future use.
    - TransitGatewayMulticastDomainId (string) --
      
      Reserved for future use.
  - 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: or rds: . 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: or rds: . 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) --
    
    Indicates 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 GlobalWriteForwardingStatus to 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) --
      
      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, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
    - RdsCustomClusterConfiguration (dict) --
      
      Reserved for future use.
      - InterconnectSubnetId (string) --
        
        Reserved for future use.
      - TransitGatewayMulticastDomainId (string) --
        
        Reserved for future use.
    - 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:
    - 7
    - month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
    - 731
    Default: 7 days
  - ServerlessV2ScalingConfiguration (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 DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
    
    For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
    
    This setting is only for Aurora DB clusters.
    
    Valid Values: IPV4 | DUAL
  - DBSystemId (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-iopt1 storage type.
    
    This setting is only for Aurora DB clusters.
  - LocalWriteForwardingStatus (string) --
    
    Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it.
  - AwsBackupRecoveryPointArn (string) --
    
    The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

ModifyDBCluster (updated)

Link ¶
Changes (response)

{'DBCluster': {'PendingModifiedValues': {'RdsCustomClusterConfiguration': {'InterconnectSubnetId': 'string',
                                                                           'TransitGatewayMulticastDomainId': 'string'}},
               'RdsCustomClusterConfiguration': {'InterconnectSubnetId': 'string',
                                                 'TransitGatewayMulticastDomainId': 'string'}}}

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

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,
    EnableLocalWriteForwarding=True|False,
    AwsBackupRecoveryPointArn='string'
)

type DBClusterIdentifier

string

param DBClusterIdentifier

[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.

type NewDBClusterIdentifier

string

param NewDBClusterIdentifier

The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Constraints:

Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.

Example: my-cluster2

type ApplyImmediately

boolean

param ApplyImmediately

Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB cluster. If this parameter is disabled, changes to the DB cluster are applied during the next maintenance window.

Most modifications can be applied immediately or during the next scheduled maintenance window. Some modifications, such as turning on deletion protection and changing the master password, are applied immediately—regardless of when you choose to apply them.

By default, this parameter is disabled.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

type BackupRetentionPeriod

integer

param BackupRetentionPeriod

The number of days for which automated backups are retained. Specify a minimum value of 1 .

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Default: 1

Constraints:

Must be a value from 1 to 35.

type DBClusterParameterGroupName

string

param DBClusterParameterGroupName

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

type VpcSecurityGroupIds

list

param VpcSecurityGroupIds

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) --

type Port

integer

param Port

The port number on which the DB cluster accepts connections.

Valid for Cluster Type: Aurora DB clusters only

Valid Values: 1150-65535

Default: The same port as the original DB cluster.

type MasterUserPassword

string

param MasterUserPassword

The new password for the master database user.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Constraints:

Must contain from 8 to 41 characters.
Can contain any printable ASCII character except "/", """, or "@".
Can't be specified if ManageMasterUserPassword is turned on.

type OptionGroupName

string

param OptionGroupName

The option group to associate the DB cluster with.

DB clusters are associated with a default option group that can't be modified.

type PreferredBackupWindow

string

param PreferredBackupWindow

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

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.

type PreferredMaintenanceWindow

string

param PreferredMaintenanceWindow

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

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.

type EnableIAMDatabaseAuthentication

boolean

param EnableIAMDatabaseAuthentication

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

type BacktrackWindow

integer

param BacktrackWindow

The target backtrack window, in seconds. To disable backtracking, set this value to 0 .

Valid for Cluster Type: Aurora MySQL DB clusters only

Default: 0

Constraints:

If specified, this value must be set to a number from 0 to 259,200 (72 hours).

type CloudwatchLogsExportConfiguration

dict

param CloudwatchLogsExportConfiguration

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

The following values are valid for each DB engine:

Aurora MySQL - audit | error | general | slowquery
Aurora PostgreSQL - postgresql
RDS for MySQL - error | general | slowquery
RDS for PostgreSQL - postgresql | upgrade

For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide .

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide .

EnableLogTypes (list) --

The list of log types to enable.
- (string) --
DisableLogTypes (list) --

The list of log types to disable.
- (string) --

type EngineVersion

string

param EngineVersion

The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless ApplyImmediately is enabled.

If the cluster that you're modifying has one or more read replicas, all replicas must be running an engine version that's the same or later than the version you specify.

To list all of the available engine versions for Aurora MySQL, use the following command:

aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for Aurora PostgreSQL, use the following command:

aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for RDS for MySQL, use the following command:

aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"

To list all of the available engine versions for RDS for PostgreSQL, use the following command:

aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

type AllowMajorVersionUpgrade

boolean

param AllowMajorVersionUpgrade

Specifies whether major version upgrades are allowed.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Constraints:

You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.

type DBInstanceParameterGroupName

string

param DBInstanceParameterGroupName

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 DBInstanceParameterGroupName parameter, the DB cluster isn't rebooted automatically. Also, parameter changes are applied immediately rather than during the next maintenance window.

Valid for Cluster Type: Aurora DB clusters only

Default: The existing name setting

Constraints:

The DB parameter group must be in the same DB parameter group family as this DB cluster.
The DBInstanceParameterGroupName parameter is valid in combination with the AllowMajorVersionUpgrade parameter for a major version upgrade only.

type Domain

string

param Domain

The Active Directory directory ID to move the DB cluster to. Specify none to remove the cluster from its current domain. The domain must be created prior to this operation.

For more information, see Kerberos Authentication in the Amazon Aurora User Guide .

Valid for Cluster Type: Aurora DB clusters only

type DomainIAMRoleName

string

param DomainIAMRoleName

The name of the IAM role to use when making API calls to the Directory Service.

Valid for Cluster Type: Aurora DB clusters only

type ScalingConfiguration

dict

param ScalingConfiguration

The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.

Valid for Cluster Type: Aurora DB clusters only

MinCapacity (integer) --

The minimum capacity for an Aurora DB cluster in serverless DB engine mode.

For Aurora MySQL, valid capacity values are 1 , 2 , 4 , 8 , 16 , 32 , 64 , 128 , and 256 .

For Aurora PostgreSQL, valid capacity values are 2 , 4 , 8 , 16 , 32 , 64 , 192 , and 384 .

The minimum capacity must be less than or equal to the maximum capacity.
MaxCapacity (integer) --

The maximum capacity for an Aurora DB cluster in serverless DB engine mode.

For Aurora MySQL, valid capacity values are 1 , 2 , 4 , 8 , 16 , 32 , 64 , 128 , and 256 .

For Aurora PostgreSQL, valid capacity values are 2 , 4 , 8 , 16 , 32 , 64 , 192 , and 384 .

The maximum capacity must be greater than or equal to the minimum capacity.
AutoPause (boolean) --

Indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB 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 serverless mode is paused.

Specify a value between 300 and 86,400 seconds.
TimeoutAction (string) --

The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange .

ForceApplyCapacityChange sets 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.

type DeletionProtection

boolean

param DeletionProtection

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

type EnableHttpEndpoint

boolean

param EnableHttpEndpoint

Specifies whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint is disabled.

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

type CopyTagsToSnapshot

boolean

param CopyTagsToSnapshot

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

type EnableGlobalWriteForwarding

boolean

param EnableGlobalWriteForwarding

Valid for Cluster Type: Aurora DB clusters only

type DBClusterInstanceClass

string

param DBClusterInstanceClass

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

type AllocatedStorage

integer

param AllocatedStorage

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

type StorageType

string

param StorageType

The storage type to associate with the DB cluster.

When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

Valid Values:

Aurora DB clusters - aurora | aurora-iopt1
Multi-AZ DB clusters - io1

Default:

Aurora DB clusters - aurora
Multi-AZ DB clusters - io1

type Iops

integer

param Iops

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.

type AutoMinorVersionUpgrade

boolean

param AutoMinorVersionUpgrade

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

type MonitoringInterval

integer

param MonitoringInterval

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0 .

If MonitoringRoleArn is specified, also set MonitoringInterval to a value other than 0 .

Valid for Cluster Type: Multi-AZ DB clusters only

Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60

Default: 0

type MonitoringRoleArn

string

param MonitoringRoleArn

The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is arn:aws:iam:123456789012:role/emaccess . For information on creating a monitoring role, see To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.

If MonitoringInterval is set to a value other than 0 , supply a MonitoringRoleArn value.

Valid for Cluster Type: Multi-AZ DB clusters only

type EnablePerformanceInsights

boolean

param EnablePerformanceInsights

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

type PerformanceInsightsKMSKeyId

string

param PerformanceInsightsKMSKeyId

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.

Valid for Cluster Type: Multi-AZ DB clusters only

type PerformanceInsightsRetentionPeriod

integer

param PerformanceInsightsRetentionPeriod

The number of days to retain Performance Insights data.

Valid for Cluster Type: Multi-AZ DB clusters only

Valid Values:

7
month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
731

Default: 7 days

If you specify a retention period that isn't valid, such as 94 , Amazon RDS issues an error.

type ServerlessV2ScalingConfiguration

dict

param ServerlessV2ScalingConfiguration

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.

type NetworkType

string

param NetworkType

The network type of the DB cluster.

The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).

For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.

Valid for Cluster Type: Aurora DB clusters only

Valid Values: IPV4 | DUAL

type ManageMasterUserPassword

boolean

param ManageMasterUserPassword

Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.

If the DB cluster doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn on this management. In this case, you can't specify MasterUserPassword .

If the DB cluster already manages the master user password with Amazon Web Services Secrets Manager, and you specify that the master user password is not managed with Amazon Web Services Secrets Manager, then you must specify MasterUserPassword . In this case, RDS deletes the secret and uses the new password for the master user specified by MasterUserPassword .

Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters

type RotateMasterUserPassword

boolean

param RotateMasterUserPassword

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.

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.

type MasterUserSecretKmsKeyId

string

param MasterUserSecretKmsKeyId

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.

This setting is valid only if both of the following conditions are met:

The DB cluster doesn't manage the master user password in Amazon Web Services Secrets Manager. If the DB cluster already manages the master user password in Amazon Web Services Secrets Manager, you can't change the KMS key that is used to encrypt the secret.
You are turning on ManageMasterUserPassword to manage the master user password in Amazon Web Services Secrets Manager. If you are turning on ManageMasterUserPassword and don't specify MasterUserSecretKmsKeyId , then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.

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

type EngineMode

string

param EngineMode

The DB engine mode of the DB cluster, either provisioned or serverless .

Note

The DB engine mode can be modified only from serverless to provisioned .

For more information, see CreateDBCluster .

Valid for Cluster Type: Aurora DB clusters only

type AllowEngineModeChange

boolean

param AllowEngineModeChange

Specifies whether engine mode changes from serverless to provisioned are allowed.

Valid for Cluster Type: Aurora Serverless v1 DB clusters only

Constraints:

You must allow engine mode changes when specifying a different value for the EngineMode parameter from the DB cluster's current engine mode.

type EnableLocalWriteForwarding

boolean

param EnableLocalWriteForwarding

Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.

Valid for: Aurora DB clusters only

type AwsBackupRecoveryPointArn

string

param AwsBackupRecoveryPointArn

The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

rtype

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
        },
        'RdsCustomClusterConfiguration': {
            'InterconnectSubnetId': 'string',
            'TransitGatewayMulticastDomainId': 'string'
        },
        '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,
            'RdsCustomClusterConfiguration': {
                'InterconnectSubnetId': 'string',
                'TransitGatewayMulticastDomainId': 'string'
            },
            '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),
        'LocalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'requested',
        'AwsBackupRecoveryPointArn': 'string'
    }
}

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 , and StopDBCluster .
  
  For a Multi-AZ DB cluster, this data type is used as a response element in the operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , FailoverDBCluster , ModifyDBCluster , RebootDBCluster , RestoreDBClusterFromSnapshot , and RestoreDBClusterToPointInTime .
  
  For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
  
  For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
  - AllocatedStorage (integer) --
    
    For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always 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) --
        
        Indicates whether the cluster member is the primary DB instance for the DB cluster.
      - 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 StorageEncrypted is 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 provisioned or serverless .
    
    For more information, see CreateDBCluster .
  - ScalingConfigurationInfo (dict) --
    
    The scaling configuration for an Aurora DB cluster in serverless DB 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 serverless DB engine mode.
    - MaxCapacity (integer) --
      
      The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
    - AutoPause (boolean) --
      
      Indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB 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 serverless mode 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 ForceApplyCapacityChange or RollbackCapacityChange .
      
      ForceApplyCapacityChange , the default, sets the capacity to the specified value as soon as possible.
      
      RollbackCapacityChange ignores 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 TimeoutAction setting.
  - RdsCustomClusterConfiguration (dict) --
    
    Reserved for future use.
    - InterconnectSubnetId (string) --
      
      Reserved for future use.
    - TransitGatewayMulticastDomainId (string) --
      
      Reserved for future use.
  - 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: or rds: . 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: or rds: . 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) --
    
    Indicates 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 GlobalWriteForwardingStatus to 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) --
      
      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, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
    - RdsCustomClusterConfiguration (dict) --
      
      Reserved for future use.
      - InterconnectSubnetId (string) --
        
        Reserved for future use.
      - TransitGatewayMulticastDomainId (string) --
        
        Reserved for future use.
    - 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:
    - 7
    - month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
    - 731
    Default: 7 days
  - ServerlessV2ScalingConfiguration (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 DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
    
    For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
    
    This setting is only for Aurora DB clusters.
    
    Valid Values: IPV4 | DUAL
  - DBSystemId (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-iopt1 storage type.
    
    This setting is only for Aurora DB clusters.
  - LocalWriteForwardingStatus (string) --
    
    Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it.
  - AwsBackupRecoveryPointArn (string) --
    
    The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

PromoteReadReplicaDBCluster (updated)

Link ¶
Changes (response)

{'DBCluster': {'PendingModifiedValues': {'RdsCustomClusterConfiguration': {'InterconnectSubnetId': 'string',
                                                                           'TransitGatewayMulticastDomainId': 'string'}},
               'RdsCustomClusterConfiguration': {'InterconnectSubnetId': 'string',
                                                 'TransitGatewayMulticastDomainId': 'string'}}}

Promotes a read replica DB cluster to a standalone DB cluster.

See also: AWS API Documentation

Request Syntax

client.promote_read_replica_db_cluster(
    DBClusterIdentifier='string'
)

type DBClusterIdentifier

string

param DBClusterIdentifier

[REQUIRED]

The identifier of the DB cluster read replica to promote. This parameter isn't case-sensitive.

Constraints:

Must match the identifier of an existing DB cluster read replica.

Example: my-cluster-replica1

rtype

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
        },
        'RdsCustomClusterConfiguration': {
            'InterconnectSubnetId': 'string',
            'TransitGatewayMulticastDomainId': 'string'
        },
        '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,
            'RdsCustomClusterConfiguration': {
                'InterconnectSubnetId': 'string',
                'TransitGatewayMulticastDomainId': 'string'
            },
            '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),
        'LocalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'requested',
        'AwsBackupRecoveryPointArn': 'string'
    }
}

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 , and StopDBCluster .
  
  For a Multi-AZ DB cluster, this data type is used as a response element in the operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , FailoverDBCluster , ModifyDBCluster , RebootDBCluster , RestoreDBClusterFromSnapshot , and RestoreDBClusterToPointInTime .
  
  For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
  
  For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
  - AllocatedStorage (integer) --
    
    For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always 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) --
        
        Indicates whether the cluster member is the primary DB instance for the DB cluster.
      - 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 StorageEncrypted is 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 provisioned or serverless .
    
    For more information, see CreateDBCluster .
  - ScalingConfigurationInfo (dict) --
    
    The scaling configuration for an Aurora DB cluster in serverless DB 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 serverless DB engine mode.
    - MaxCapacity (integer) --
      
      The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
    - AutoPause (boolean) --
      
      Indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB 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 serverless mode 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 ForceApplyCapacityChange or RollbackCapacityChange .
      
      ForceApplyCapacityChange , the default, sets the capacity to the specified value as soon as possible.
      
      RollbackCapacityChange ignores 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 TimeoutAction setting.
  - RdsCustomClusterConfiguration (dict) --
    
    Reserved for future use.
    - InterconnectSubnetId (string) --
      
      Reserved for future use.
    - TransitGatewayMulticastDomainId (string) --
      
      Reserved for future use.
  - 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: or rds: . 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: or rds: . 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) --
    
    Indicates 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 GlobalWriteForwardingStatus to 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) --
      
      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, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
    - RdsCustomClusterConfiguration (dict) --
      
      Reserved for future use.
      - InterconnectSubnetId (string) --
        
        Reserved for future use.
      - TransitGatewayMulticastDomainId (string) --
        
        Reserved for future use.
    - 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:
    - 7
    - month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
    - 731
    Default: 7 days
  - ServerlessV2ScalingConfiguration (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 DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
    
    For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
    
    This setting is only for Aurora DB clusters.
    
    Valid Values: IPV4 | DUAL
  - DBSystemId (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-iopt1 storage type.
    
    This setting is only for Aurora DB clusters.
  - LocalWriteForwardingStatus (string) --
    
    Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it.
  - AwsBackupRecoveryPointArn (string) --
    
    The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

RebootDBCluster (updated)

Link ¶
Changes (response)

{'DBCluster': {'PendingModifiedValues': {'RdsCustomClusterConfiguration': {'InterconnectSubnetId': 'string',
                                                                           'TransitGatewayMulticastDomainId': 'string'}},
               'RdsCustomClusterConfiguration': {'InterconnectSubnetId': 'string',
                                                 'TransitGatewayMulticastDomainId': 'string'}}}

You might need to reboot your DB cluster, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB cluster parameter group associated with the DB cluster, reboot the DB cluster for the changes to take effect.

Rebooting a DB cluster restarts the database engine service. Rebooting a DB cluster results in a momentary outage, during which the DB cluster status is set to rebooting.

Use this operation only for a non-Aurora Multi-AZ DB cluster.

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

client.reboot_db_cluster(
    DBClusterIdentifier='string'
)

type DBClusterIdentifier

string

param DBClusterIdentifier

[REQUIRED]

The DB cluster identifier. This parameter is stored as a lowercase string.

Constraints:

Must match the identifier of an existing DBCluster.

rtype

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
        },
        'RdsCustomClusterConfiguration': {
            'InterconnectSubnetId': 'string',
            'TransitGatewayMulticastDomainId': 'string'
        },
        '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,
            'RdsCustomClusterConfiguration': {
                'InterconnectSubnetId': 'string',
                'TransitGatewayMulticastDomainId': 'string'
            },
            '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),
        'LocalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'requested',
        'AwsBackupRecoveryPointArn': 'string'
    }
}

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 , and StopDBCluster .
  
  For a Multi-AZ DB cluster, this data type is used as a response element in the operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , FailoverDBCluster , ModifyDBCluster , RebootDBCluster , RestoreDBClusterFromSnapshot , and RestoreDBClusterToPointInTime .
  
  For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
  
  For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
  - AllocatedStorage (integer) --
    
    For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always 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) --
        
        Indicates whether the cluster member is the primary DB instance for the DB cluster.
      - 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 StorageEncrypted is 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 provisioned or serverless .
    
    For more information, see CreateDBCluster .
  - ScalingConfigurationInfo (dict) --
    
    The scaling configuration for an Aurora DB cluster in serverless DB 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 serverless DB engine mode.
    - MaxCapacity (integer) --
      
      The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
    - AutoPause (boolean) --
      
      Indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB 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 serverless mode 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 ForceApplyCapacityChange or RollbackCapacityChange .
      
      ForceApplyCapacityChange , the default, sets the capacity to the specified value as soon as possible.
      
      RollbackCapacityChange ignores 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 TimeoutAction setting.
  - RdsCustomClusterConfiguration (dict) --
    
    Reserved for future use.
    - InterconnectSubnetId (string) --
      
      Reserved for future use.
    - TransitGatewayMulticastDomainId (string) --
      
      Reserved for future use.
  - 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: or rds: . 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: or rds: . 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) --
    
    Indicates 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 GlobalWriteForwardingStatus to 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) --
      
      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, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
    - RdsCustomClusterConfiguration (dict) --
      
      Reserved for future use.
      - InterconnectSubnetId (string) --
        
        Reserved for future use.
      - TransitGatewayMulticastDomainId (string) --
        
        Reserved for future use.
    - 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:
    - 7
    - month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
    - 731
    Default: 7 days
  - ServerlessV2ScalingConfiguration (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 DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
    
    For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
    
    This setting is only for Aurora DB clusters.
    
    Valid Values: IPV4 | DUAL
  - DBSystemId (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-iopt1 storage type.
    
    This setting is only for Aurora DB clusters.
  - LocalWriteForwardingStatus (string) --
    
    Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it.
  - AwsBackupRecoveryPointArn (string) --
    
    The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

RestoreDBClusterFromS3 (updated)

Link ¶
Changes (response)

{'DBCluster': {'PendingModifiedValues': {'RdsCustomClusterConfiguration': {'InterconnectSubnetId': 'string',
                                                                           'TransitGatewayMulticastDomainId': 'string'}},
               'RdsCustomClusterConfiguration': {'InterconnectSubnetId': 'string',
                                                 'TransitGatewayMulticastDomainId': 'string'}}}

Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket in the Amazon Aurora User Guide .

Note

This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier . You can create DB instances only after the RestoreDBClusterFromS3 action has completed and the DB cluster is available.

For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide .

Note

This action only applies to Aurora DB clusters. The source DB engine must be MySQL.

See also: AWS API Documentation

Request Syntax

client.restore_db_cluster_from_s3(
    AvailabilityZones=[
        'string',
    ],
    BackupRetentionPeriod=123,
    CharacterSetName='string',
    DatabaseName='string',
    DBClusterIdentifier='string',
    DBClusterParameterGroupName='string',
    VpcSecurityGroupIds=[
        'string',
    ],
    DBSubnetGroupName='string',
    Engine='string',
    EngineVersion='string',
    Port=123,
    MasterUsername='string',
    MasterUserPassword='string',
    OptionGroupName='string',
    PreferredBackupWindow='string',
    PreferredMaintenanceWindow='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    StorageEncrypted=True|False,
    KmsKeyId='string',
    EnableIAMDatabaseAuthentication=True|False,
    SourceEngine='string',
    SourceEngineVersion='string',
    S3BucketName='string',
    S3Prefix='string',
    S3IngestionRoleArn='string',
    BacktrackWindow=123,
    EnableCloudwatchLogsExports=[
        'string',
    ],
    DeletionProtection=True|False,
    CopyTagsToSnapshot=True|False,
    Domain='string',
    DomainIAMRoleName='string',
    ServerlessV2ScalingConfiguration={
        'MinCapacity': 123.0,
        'MaxCapacity': 123.0
    },
    NetworkType='string',
    ManageMasterUserPassword=True|False,
    MasterUserSecretKmsKeyId='string',
    StorageType='string'
)

type AvailabilityZones

list

param AvailabilityZones

A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.

(string) --

type BackupRetentionPeriod

integer

param BackupRetentionPeriod

The number of days for which automated backups of the restored DB cluster are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

Must be a value from 1 to 35

type CharacterSetName

string

param CharacterSetName

A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.

type DatabaseName

string

param DatabaseName

The database name for the restored DB cluster.

type DBClusterIdentifier

string

param DBClusterIdentifier

[REQUIRED]

The name of the DB cluster to create from the source data in the Amazon S3 bucket. This parameter isn't case-sensitive.

Constraints:

Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.

Example: my-cluster1

type DBClusterParameterGroupName

string

param DBClusterParameterGroupName

The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is omitted, the default parameter group for the engine version is used.

Constraints:

If supplied, must match the name of an existing DBClusterParameterGroup.

type VpcSecurityGroupIds

list

param VpcSecurityGroupIds

A list of EC2 VPC security groups to associate with the restored DB cluster.

(string) --

type DBSubnetGroupName

string

param DBSubnetGroupName

A DB subnet group to associate with the restored DB cluster.

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

Example: mydbsubnetgroup

type Engine

string

param Engine

[REQUIRED]

The name of the database engine to be used for this DB cluster.

Valid Values: aurora-mysql (for Aurora MySQL)

type EngineVersion

string

param EngineVersion

The version number of the database engine to use.

To list all of the available engine versions for aurora-mysql (Aurora MySQL), use the following command:

aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"

Aurora MySQL

Examples: 5.7.mysql_aurora.2.12.0 , 8.0.mysql_aurora.3.04.0

type Port

integer

param Port

The port number on which the instances in the restored DB cluster accept connections.

Default: 3306

type MasterUsername

string

param MasterUsername

[REQUIRED]

The name of the master user for the restored DB cluster.

Constraints:

Must be 1 to 16 letters or numbers.
First character must be a letter.
Can't be a reserved word for the chosen database engine.

type MasterUserPassword

string

param MasterUserPassword

The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".

Constraints:

Must contain from 8 to 41 characters.
Can't be specified if ManageMasterUserPassword is turned on.

type OptionGroupName

string

param OptionGroupName

A value that indicates that the restored DB cluster should be associated with the specified option group.

Permanent options can't be removed from an option group. An option group can't be removed from a DB cluster once it is associated with a DB cluster.

type PreferredBackupWindow

string

param PreferredBackupWindow

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

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.

type PreferredMaintenanceWindow

string

param PreferredMaintenanceWindow

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 Maintenance Window in the Amazon Aurora User Guide .

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

type Tags

list

param Tags

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: or rds: . 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: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").

type StorageEncrypted

boolean

param StorageEncrypted

Specifies whether the restored DB cluster is encrypted.

type KmsKeyId

string

param KmsKeyId

The Amazon Web Services KMS key identifier for an encrypted DB cluster.

If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use 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.

type EnableIAMDatabaseAuthentication

boolean

param EnableIAMDatabaseAuthentication

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 .

type SourceEngine

string

param SourceEngine

[REQUIRED]

The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.

Valid Values: mysql

type SourceEngineVersion

string

param SourceEngineVersion

[REQUIRED]

The version of the database that the backup files were created from.

MySQL versions 5.7 and 8.0 are supported.

Example: 5.7.40 , 8.0.28

type S3BucketName

string

param S3BucketName

[REQUIRED]

The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.

type S3Prefix

string

param S3Prefix

The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster. If you do not specify a SourceS3Prefix value, then the Amazon Aurora DB cluster is created by using all of the files in the Amazon S3 bucket.

type S3IngestionRoleArn

string

param S3IngestionRoleArn

[REQUIRED]

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.

type BacktrackWindow

integer

param BacktrackWindow

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

Note

Currently, Backtrack is only supported for Aurora MySQL DB clusters.

Default: 0

Constraints:

If specified, this value must be set to a number from 0 to 259,200 (72 hours).

type EnableCloudwatchLogsExports

list

param EnableCloudwatchLogsExports

The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used.

Aurora MySQL

Possible values are audit , error , general , and slowquery .

For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide .

(string) --

type DeletionProtection

boolean

param DeletionProtection

Specifies whether to enable deletion protection for the DB cluster. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.

type CopyTagsToSnapshot

boolean

param CopyTagsToSnapshot

Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

type Domain

string

param Domain

Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.

For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide .

type DomainIAMRoleName

string

param DomainIAMRoleName

Specify the name of the IAM role to be used when making API calls to the Directory Service.

type ServerlessV2ScalingConfiguration

dict

param ServerlessV2ScalingConfiguration

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.

type NetworkType

string

param NetworkType

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 in the Amazon Aurora User Guide.

type ManageMasterUserPassword

boolean

param ManageMasterUserPassword

Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.

Constraints:

Can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.

type MasterUserSecretKmsKeyId

string

param MasterUserSecretKmsKeyId

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 the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB cluster.

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.

type StorageType

string

param StorageType

Specifies the storage type to be associated with the DB cluster.

Valid Values: aurora , aurora-iopt1

Default: aurora

Valid for: Aurora DB clusters only

rtype

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
        },
        'RdsCustomClusterConfiguration': {
            'InterconnectSubnetId': 'string',
            'TransitGatewayMulticastDomainId': 'string'
        },
        '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,
            'RdsCustomClusterConfiguration': {
                'InterconnectSubnetId': 'string',
                'TransitGatewayMulticastDomainId': 'string'
            },
            '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),
        'LocalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'requested',
        'AwsBackupRecoveryPointArn': 'string'
    }
}

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 , and StopDBCluster .
  
  For a Multi-AZ DB cluster, this data type is used as a response element in the operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , FailoverDBCluster , ModifyDBCluster , RebootDBCluster , RestoreDBClusterFromSnapshot , and RestoreDBClusterToPointInTime .
  
  For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
  
  For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
  - AllocatedStorage (integer) --
    
    For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always 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) --
        
        Indicates whether the cluster member is the primary DB instance for the DB cluster.
      - 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 StorageEncrypted is 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 provisioned or serverless .
    
    For more information, see CreateDBCluster .
  - ScalingConfigurationInfo (dict) --
    
    The scaling configuration for an Aurora DB cluster in serverless DB 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 serverless DB engine mode.
    - MaxCapacity (integer) --
      
      The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
    - AutoPause (boolean) --
      
      Indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB 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 serverless mode 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 ForceApplyCapacityChange or RollbackCapacityChange .
      
      ForceApplyCapacityChange , the default, sets the capacity to the specified value as soon as possible.
      
      RollbackCapacityChange ignores 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 TimeoutAction setting.
  - RdsCustomClusterConfiguration (dict) --
    
    Reserved for future use.
    - InterconnectSubnetId (string) --
      
      Reserved for future use.
    - TransitGatewayMulticastDomainId (string) --
      
      Reserved for future use.
  - 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: or rds: . 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: or rds: . 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) --
    
    Indicates 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 GlobalWriteForwardingStatus to 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) --
      
      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, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
    - RdsCustomClusterConfiguration (dict) --
      
      Reserved for future use.
      - InterconnectSubnetId (string) --
        
        Reserved for future use.
      - TransitGatewayMulticastDomainId (string) --
        
        Reserved for future use.
    - 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:
    - 7
    - month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
    - 731
    Default: 7 days
  - ServerlessV2ScalingConfiguration (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 DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
    
    For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
    
    This setting is only for Aurora DB clusters.
    
    Valid Values: IPV4 | DUAL
  - DBSystemId (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-iopt1 storage type.
    
    This setting is only for Aurora DB clusters.
  - LocalWriteForwardingStatus (string) --
    
    Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it.
  - AwsBackupRecoveryPointArn (string) --
    
    The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

RestoreDBClusterFromSnapshot (updated)

Link ¶
Changes (request, response)
Request

{'RdsCustomClusterConfiguration': {'InterconnectSubnetId': 'string',
                                   'TransitGatewayMulticastDomainId': 'string'}}

Response

{'DBCluster': {'PendingModifiedValues': {'RdsCustomClusterConfiguration': {'InterconnectSubnetId': 'string',
                                                                           'TransitGatewayMulticastDomainId': 'string'}},
               'RdsCustomClusterConfiguration': {'InterconnectSubnetId': 'string',
                                                 'TransitGatewayMulticastDomainId': 'string'}}}

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

The target DB cluster is created from the source snapshot with a default configuration. If you don't specify a security group, the new DB cluster is associated with the default security group.

Note

This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier . You can create DB instances only after the RestoreDBClusterFromSnapshot action has completed and the DB cluster is available.

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

client.restore_db_cluster_from_snapshot(
    AvailabilityZones=[
        'string',
    ],
    DBClusterIdentifier='string',
    SnapshotIdentifier='string',
    Engine='string',
    EngineVersion='string',
    Port=123,
    DBSubnetGroupName='string',
    DatabaseName='string',
    OptionGroupName='string',
    VpcSecurityGroupIds=[
        'string',
    ],
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    KmsKeyId='string',
    EnableIAMDatabaseAuthentication=True|False,
    BacktrackWindow=123,
    EnableCloudwatchLogsExports=[
        'string',
    ],
    EngineMode='string',
    ScalingConfiguration={
        'MinCapacity': 123,
        'MaxCapacity': 123,
        'AutoPause': True|False,
        'SecondsUntilAutoPause': 123,
        'TimeoutAction': 'string',
        'SecondsBeforeTimeout': 123
    },
    DBClusterParameterGroupName='string',
    DeletionProtection=True|False,
    CopyTagsToSnapshot=True|False,
    Domain='string',
    DomainIAMRoleName='string',
    DBClusterInstanceClass='string',
    StorageType='string',
    Iops=123,
    PubliclyAccessible=True|False,
    ServerlessV2ScalingConfiguration={
        'MinCapacity': 123.0,
        'MaxCapacity': 123.0
    },
    NetworkType='string',
    RdsCustomClusterConfiguration={
        'InterconnectSubnetId': 'string',
        'TransitGatewayMulticastDomainId': 'string'
    }
)

type AvailabilityZones

list

param AvailabilityZones

Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be created.

Valid for: Aurora DB clusters only

(string) --

type DBClusterIdentifier

string

param DBClusterIdentifier

[REQUIRED]

The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't case-sensitive.

Constraints:

Must contain from 1 to 63 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

Valid for: Aurora DB clusters and Multi-AZ DB clusters

type SnapshotIdentifier

string

param SnapshotIdentifier

[REQUIRED]

The identifier for the DB snapshot or DB cluster snapshot to restore from.

You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.

Constraints:

Must match the identifier of an existing Snapshot.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

type Engine

string

param Engine

[REQUIRED]

The database engine to use for the new DB cluster.

Default: The same as source

Constraint: Must be compatible with the engine of the source

Valid for: Aurora DB clusters and Multi-AZ DB clusters

type EngineVersion

string

param EngineVersion

The version of the database engine to use for the new DB cluster. If you don't specify an engine version, the default version for the database engine in the Amazon Web Services Region is used.

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"

Aurora MySQL

See Database engine updates for Amazon Aurora MySQL in the Amazon Aurora User Guide .

Aurora PostgreSQL

See Amazon Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide .

MySQL

See Amazon RDS for MySQL in the Amazon RDS User Guide.

PostgreSQL

See Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

type Port

integer

param Port

The port number on which the new DB cluster accepts connections.

Constraints: This value must be 1150-65535

Default: The same port as the original DB cluster.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

type DBSubnetGroupName

string

param DBSubnetGroupName

The name of the DB subnet group to use for the new DB cluster.

Constraints: If supplied, must match the name of an existing DB subnet group.

Example: mydbsubnetgroup

Valid for: Aurora DB clusters and Multi-AZ DB clusters

type DatabaseName

string

param DatabaseName

The database name for the restored DB cluster.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

type OptionGroupName

string

param OptionGroupName

The name of the option group to use for the restored DB cluster.

DB clusters are associated with a default option group that can't be modified.

type VpcSecurityGroupIds

list

param VpcSecurityGroupIds

A list of VPC security groups that the new DB cluster will belong to.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

(string) --

type Tags

list

param Tags

The tags to be assigned to the restored DB cluster.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

(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: or rds: . 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: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").

type KmsKeyId

string

param KmsKeyId

The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.

When you don't specify a value for the KmsKeyId parameter, then the following occurs:

If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot.
If the DB snapshot or DB cluster snapshot in SnapshotIdentifier isn't encrypted, then the restored DB cluster isn't encrypted.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

type EnableIAMDatabaseAuthentication

boolean

param EnableIAMDatabaseAuthentication

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: Aurora DB clusters only

type BacktrackWindow

integer

param BacktrackWindow

The target backtrack window, in seconds. To disable backtracking, set this value to 0.

Note

Currently, Backtrack is only supported for Aurora MySQL DB clusters.

Default: 0

Constraints:

If specified, this value must be set to a number from 0 to 259,200 (72 hours).

Valid for: Aurora DB clusters only

type EnableCloudwatchLogsExports

list

param EnableCloudwatchLogsExports

The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. 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 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 .

Valid for: Aurora DB clusters and Multi-AZ DB clusters

(string) --

type EngineMode

string

param EngineMode

The DB engine mode of the DB cluster, either provisioned or serverless .

For more information, see CreateDBCluster .

Valid for: Aurora DB clusters only

type ScalingConfiguration

dict

param ScalingConfiguration

For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

Valid for: Aurora DB clusters only

MinCapacity (integer) --

The minimum capacity for an Aurora DB cluster in serverless DB engine mode.

For Aurora MySQL, valid capacity values are 1 , 2 , 4 , 8 , 16 , 32 , 64 , 128 , and 256 .

For Aurora PostgreSQL, valid capacity values are 2 , 4 , 8 , 16 , 32 , 64 , 192 , and 384 .

The minimum capacity must be less than or equal to the maximum capacity.
MaxCapacity (integer) --

The maximum capacity for an Aurora DB cluster in serverless DB engine mode.

For Aurora MySQL, valid capacity values are 1 , 2 , 4 , 8 , 16 , 32 , 64 , 128 , and 256 .

For Aurora PostgreSQL, valid capacity values are 2 , 4 , 8 , 16 , 32 , 64 , 192 , and 384 .

The maximum capacity must be greater than or equal to the minimum capacity.
AutoPause (boolean) --

Indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB 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 serverless mode is paused.

Specify a value between 300 and 86,400 seconds.
TimeoutAction (string) --

The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange .

ForceApplyCapacityChange sets 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.

type DBClusterParameterGroupName

string

param DBClusterParameterGroupName

The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.

Constraints:

If supplied, must match the name of an existing default DB cluster parameter group.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

type DeletionProtection

boolean

param DeletionProtection

Specifies whether to enable deletion protection for the DB cluster. 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

type CopyTagsToSnapshot

boolean

param CopyTagsToSnapshot

Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

type Domain

string

param Domain

The Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.

For more information, see Kerberos Authentication in the Amazon RDS User Guide .

Valid for: Aurora DB clusters only

type DomainIAMRoleName

string

param DomainIAMRoleName

The name of the IAM role to be used when making API calls to the Directory Service.

Valid for: Aurora DB clusters only

type DBClusterInstanceClass

string

param DBClusterInstanceClass

The compute and memory capacity of the 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: Multi-AZ DB clusters only

type StorageType

string

param StorageType

Specifies the storage type to be associated with the DB cluster.

When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.

Valid Values: aurora , aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB clusters)

Default: aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters)

Valid for: Aurora DB clusters and Multi-AZ DB clusters

type Iops

integer

param Iops

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 .

Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

type PubliclyAccessible

boolean

param PubliclyAccessible

Specifies 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 is not 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.

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

type ServerlessV2ScalingConfiguration

dict

param ServerlessV2ScalingConfiguration

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.

type NetworkType

string

param NetworkType

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 in the Amazon Aurora User Guide.

Valid for: Aurora DB clusters only

type RdsCustomClusterConfiguration

dict

param RdsCustomClusterConfiguration

Reserved for future use.

InterconnectSubnetId (string) --

Reserved for future use.
TransitGatewayMulticastDomainId (string) --

Reserved for future use.

rtype

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
        },
        'RdsCustomClusterConfiguration': {
            'InterconnectSubnetId': 'string',
            'TransitGatewayMulticastDomainId': 'string'
        },
        '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,
            'RdsCustomClusterConfiguration': {
                'InterconnectSubnetId': 'string',
                'TransitGatewayMulticastDomainId': 'string'
            },
            '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),
        'LocalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'requested',
        'AwsBackupRecoveryPointArn': 'string'
    }
}

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 , and StopDBCluster .
  
  For a Multi-AZ DB cluster, this data type is used as a response element in the operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , FailoverDBCluster , ModifyDBCluster , RebootDBCluster , RestoreDBClusterFromSnapshot , and RestoreDBClusterToPointInTime .
  
  For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
  
  For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
  - AllocatedStorage (integer) --
    
    For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always 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) --
        
        Indicates whether the cluster member is the primary DB instance for the DB cluster.
      - 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 StorageEncrypted is 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 provisioned or serverless .
    
    For more information, see CreateDBCluster .
  - ScalingConfigurationInfo (dict) --
    
    The scaling configuration for an Aurora DB cluster in serverless DB 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 serverless DB engine mode.
    - MaxCapacity (integer) --
      
      The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
    - AutoPause (boolean) --
      
      Indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB 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 serverless mode 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 ForceApplyCapacityChange or RollbackCapacityChange .
      
      ForceApplyCapacityChange , the default, sets the capacity to the specified value as soon as possible.
      
      RollbackCapacityChange ignores 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 TimeoutAction setting.
  - RdsCustomClusterConfiguration (dict) --
    
    Reserved for future use.
    - InterconnectSubnetId (string) --
      
      Reserved for future use.
    - TransitGatewayMulticastDomainId (string) --
      
      Reserved for future use.
  - 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: or rds: . 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: or rds: . 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) --
    
    Indicates 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 GlobalWriteForwardingStatus to 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) --
      
      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, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
    - RdsCustomClusterConfiguration (dict) --
      
      Reserved for future use.
      - InterconnectSubnetId (string) --
        
        Reserved for future use.
      - TransitGatewayMulticastDomainId (string) --
        
        Reserved for future use.
    - 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:
    - 7
    - month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
    - 731
    Default: 7 days
  - ServerlessV2ScalingConfiguration (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 DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
    
    For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
    
    This setting is only for Aurora DB clusters.
    
    Valid Values: IPV4 | DUAL
  - DBSystemId (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-iopt1 storage type.
    
    This setting is only for Aurora DB clusters.
  - LocalWriteForwardingStatus (string) --
    
    Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it.
  - AwsBackupRecoveryPointArn (string) --
    
    The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

RestoreDBClusterToPointInTime (updated)

Link ¶
Changes (request, response)
Request

{'RdsCustomClusterConfiguration': {'InterconnectSubnetId': 'string',
                                   'TransitGatewayMulticastDomainId': 'string'}}

Response

{'DBCluster': {'PendingModifiedValues': {'RdsCustomClusterConfiguration': {'InterconnectSubnetId': 'string',
                                                                           'TransitGatewayMulticastDomainId': 'string'}},
               'RdsCustomClusterConfiguration': {'InterconnectSubnetId': 'string',
                                                 'TransitGatewayMulticastDomainId': 'string'}}}

Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group.

Note

For Aurora, this action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier . You can create DB instances only after the RestoreDBClusterToPointInTime action has completed and the DB cluster is available.

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

client.restore_db_cluster_to_point_in_time(
    DBClusterIdentifier='string',
    RestoreType='string',
    SourceDBClusterIdentifier='string',
    RestoreToTime=datetime(2015, 1, 1),
    UseLatestRestorableTime=True|False,
    Port=123,
    DBSubnetGroupName='string',
    OptionGroupName='string',
    VpcSecurityGroupIds=[
        'string',
    ],
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    KmsKeyId='string',
    EnableIAMDatabaseAuthentication=True|False,
    BacktrackWindow=123,
    EnableCloudwatchLogsExports=[
        'string',
    ],
    DBClusterParameterGroupName='string',
    DeletionProtection=True|False,
    CopyTagsToSnapshot=True|False,
    Domain='string',
    DomainIAMRoleName='string',
    ScalingConfiguration={
        'MinCapacity': 123,
        'MaxCapacity': 123,
        'AutoPause': True|False,
        'SecondsUntilAutoPause': 123,
        'TimeoutAction': 'string',
        'SecondsBeforeTimeout': 123
    },
    EngineMode='string',
    DBClusterInstanceClass='string',
    StorageType='string',
    PubliclyAccessible=True|False,
    Iops=123,
    ServerlessV2ScalingConfiguration={
        'MinCapacity': 123.0,
        'MaxCapacity': 123.0
    },
    NetworkType='string',
    SourceDbClusterResourceId='string',
    RdsCustomClusterConfiguration={
        'InterconnectSubnetId': 'string',
        'TransitGatewayMulticastDomainId': 'string'
    }
)

type DBClusterIdentifier

string

param DBClusterIdentifier

[REQUIRED]

The name of the new DB cluster to be created.

Constraints:

Must contain from 1 to 63 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens

Valid for: Aurora DB clusters and Multi-AZ DB clusters

type RestoreType

string

param RestoreType

The type of restore to be performed. You can specify one of the following values:

full-copy - The new DB cluster is restored as a full copy of the source DB cluster.
copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.

If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

type SourceDBClusterIdentifier

string

param SourceDBClusterIdentifier

The identifier of the source DB cluster from which to restore.

Constraints:

Must match the identifier of an existing DBCluster.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

type RestoreToTime

datetime

param RestoreToTime

The date and time to restore the DB cluster to.

Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

Constraints:

Must be before the latest restorable time for the DB instance
Must be specified if UseLatestRestorableTime parameter isn't provided
Can't be specified if the UseLatestRestorableTime parameter is enabled
Can't be specified if the RestoreType parameter is copy-on-write

Example: 2015-03-07T23:45:00Z

Valid for: Aurora DB clusters and Multi-AZ DB clusters

type UseLatestRestorableTime

boolean

param UseLatestRestorableTime

Specifies whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster isn't restored to the latest restorable backup time.

Constraints: Can't be specified if RestoreToTime parameter is provided.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

type Port

integer

param Port

The port number on which the new DB cluster accepts connections.

Constraints: A value from 1150-65535 .

Default: The default port for the engine.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

type DBSubnetGroupName

string

param DBSubnetGroupName

The DB subnet group name to use for the new DB cluster.

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

Example: mydbsubnetgroup

Valid for: Aurora DB clusters and Multi-AZ DB clusters

type OptionGroupName

string

param OptionGroupName

The name of the option group for the new DB cluster.

DB clusters are associated with a default option group that can't be modified.

type VpcSecurityGroupIds

list

param VpcSecurityGroupIds

A list of VPC security groups that the new DB cluster belongs to.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

(string) --

type Tags

list

param Tags

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: or rds: . 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: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").

type KmsKeyId

string

param KmsKeyId

The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.

You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different from the KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key identified by the KmsKeyId parameter.

If you don't specify a value for the KmsKeyId parameter, then the following occurs:

If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster.
If the DB cluster isn't encrypted, then the restored DB cluster isn't encrypted.

If DBClusterIdentifier refers to a DB cluster that isn't encrypted, then the restore request is rejected.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

type EnableIAMDatabaseAuthentication

boolean

param EnableIAMDatabaseAuthentication

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: Aurora DB clusters only

type BacktrackWindow

integer

param BacktrackWindow

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

type EnableCloudwatchLogsExports

list

param EnableCloudwatchLogsExports

The list of logs that the restored DB cluster is to export to CloudWatch Logs. 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 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 .

Valid for: Aurora DB clusters and Multi-AZ DB clusters

(string) --

type DBClusterParameterGroupName

string

param DBClusterParameterGroupName

The name of the custom DB cluster parameter group to associate with this DB cluster.

If the DBClusterParameterGroupName parameter is omitted, the default DB cluster parameter group for the specified engine is used.

Constraints:

If supplied, must match the name of an existing DB cluster parameter group.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

type DeletionProtection

boolean

param DeletionProtection

Specifies whether to enable deletion protection for the DB cluster. 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

type CopyTagsToSnapshot

boolean

param CopyTagsToSnapshot

Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

Valid for: Aurora DB clusters and Multi-AZ DB clusters

type Domain

string

param Domain

The Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.

Valid for: Aurora DB clusters only

type DomainIAMRoleName

string

param DomainIAMRoleName

The name of the IAM role to be used when making API calls to the Directory Service.

Valid for: Aurora DB clusters only

type ScalingConfiguration

dict

param ScalingConfiguration

For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

Valid for: Aurora DB clusters only

MinCapacity (integer) --

The minimum capacity for an Aurora DB cluster in serverless DB engine mode.

For Aurora MySQL, valid capacity values are 1 , 2 , 4 , 8 , 16 , 32 , 64 , 128 , and 256 .

For Aurora PostgreSQL, valid capacity values are 2 , 4 , 8 , 16 , 32 , 64 , 192 , and 384 .

The minimum capacity must be less than or equal to the maximum capacity.
MaxCapacity (integer) --

The maximum capacity for an Aurora DB cluster in serverless DB engine mode.

For Aurora MySQL, valid capacity values are 1 , 2 , 4 , 8 , 16 , 32 , 64 , 128 , and 256 .

For Aurora PostgreSQL, valid capacity values are 2 , 4 , 8 , 16 , 32 , 64 , 192 , and 384 .

The maximum capacity must be greater than or equal to the minimum capacity.
AutoPause (boolean) --

Indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB 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 serverless mode is paused.

Specify a value between 300 and 86,400 seconds.
TimeoutAction (string) --

The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange .

ForceApplyCapacityChange sets 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.

type EngineMode

string

param EngineMode

The engine mode of the new cluster. Specify provisioned or serverless , depending on the type of the cluster you are creating. You can create an Aurora Serverless v1 clone from a provisioned cluster, or a provisioned clone from an Aurora Serverless v1 cluster. To create a clone that is an Aurora Serverless v1 cluster, the original cluster must be an Aurora Serverless v1 cluster or an encrypted provisioned cluster.

Valid for: Aurora DB clusters only

type DBClusterInstanceClass

string

param DBClusterInstanceClass

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: Multi-AZ DB clusters only

type StorageType

string

param StorageType

Specifies the storage type to be associated with the DB cluster.

When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.

Valid Values: aurora , aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB clusters)

Default: aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters)

Valid for: Aurora DB clusters and Multi-AZ DB clusters

type PubliclyAccessible

boolean

param PubliclyAccessible

Specifies 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 is not 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.

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.

If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.

Valid for: Multi-AZ DB clusters only

type Iops

integer

param Iops

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 .

Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.

Valid for: Multi-AZ DB clusters only

type ServerlessV2ScalingConfiguration

dict

param ServerlessV2ScalingConfiguration

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.

type NetworkType

string

param NetworkType

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 in the Amazon Aurora User Guide.

Valid for: Aurora DB clusters only

type SourceDbClusterResourceId

string

param SourceDbClusterResourceId

The resource ID of the source DB cluster from which to restore.

type RdsCustomClusterConfiguration

dict

param RdsCustomClusterConfiguration

Reserved for future use.

InterconnectSubnetId (string) --

Reserved for future use.
TransitGatewayMulticastDomainId (string) --

Reserved for future use.

rtype

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
        },
        'RdsCustomClusterConfiguration': {
            'InterconnectSubnetId': 'string',
            'TransitGatewayMulticastDomainId': 'string'
        },
        '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,
            'RdsCustomClusterConfiguration': {
                'InterconnectSubnetId': 'string',
                'TransitGatewayMulticastDomainId': 'string'
            },
            '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),
        'LocalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'requested',
        'AwsBackupRecoveryPointArn': 'string'
    }
}

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 , and StopDBCluster .
  
  For a Multi-AZ DB cluster, this data type is used as a response element in the operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , FailoverDBCluster , ModifyDBCluster , RebootDBCluster , RestoreDBClusterFromSnapshot , and RestoreDBClusterToPointInTime .
  
  For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
  
  For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
  - AllocatedStorage (integer) --
    
    For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always 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) --
        
        Indicates whether the cluster member is the primary DB instance for the DB cluster.
      - 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 StorageEncrypted is 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 provisioned or serverless .
    
    For more information, see CreateDBCluster .
  - ScalingConfigurationInfo (dict) --
    
    The scaling configuration for an Aurora DB cluster in serverless DB 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 serverless DB engine mode.
    - MaxCapacity (integer) --
      
      The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
    - AutoPause (boolean) --
      
      Indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB 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 serverless mode 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 ForceApplyCapacityChange or RollbackCapacityChange .
      
      ForceApplyCapacityChange , the default, sets the capacity to the specified value as soon as possible.
      
      RollbackCapacityChange ignores 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 TimeoutAction setting.
  - RdsCustomClusterConfiguration (dict) --
    
    Reserved for future use.
    - InterconnectSubnetId (string) --
      
      Reserved for future use.
    - TransitGatewayMulticastDomainId (string) --
      
      Reserved for future use.
  - 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: or rds: . 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: or rds: . 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) --
    
    Indicates 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 GlobalWriteForwardingStatus to 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) --
      
      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, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
    - RdsCustomClusterConfiguration (dict) --
      
      Reserved for future use.
      - InterconnectSubnetId (string) --
        
        Reserved for future use.
      - TransitGatewayMulticastDomainId (string) --
        
        Reserved for future use.
    - 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:
    - 7
    - month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
    - 731
    Default: 7 days
  - ServerlessV2ScalingConfiguration (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 DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
    
    For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
    
    This setting is only for Aurora DB clusters.
    
    Valid Values: IPV4 | DUAL
  - DBSystemId (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-iopt1 storage type.
    
    This setting is only for Aurora DB clusters.
  - LocalWriteForwardingStatus (string) --
    
    Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it.
  - AwsBackupRecoveryPointArn (string) --
    
    The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

StartDBCluster (updated)

Link ¶
Changes (response)

{'DBCluster': {'PendingModifiedValues': {'RdsCustomClusterConfiguration': {'InterconnectSubnetId': 'string',
                                                                           'TransitGatewayMulticastDomainId': 'string'}},
               'RdsCustomClusterConfiguration': {'InterconnectSubnetId': 'string',
                                                 'TransitGatewayMulticastDomainId': 'string'}}}

Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster CLI command, or the StopDBCluster action.

For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide .

Note

This action only applies to Aurora DB clusters.

See also: AWS API Documentation

Request Syntax

client.start_db_cluster(
    DBClusterIdentifier='string'
)

type DBClusterIdentifier

string

param DBClusterIdentifier

[REQUIRED]

The DB cluster identifier of the Amazon Aurora DB cluster to be started. This parameter is stored as a lowercase string.

rtype

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
        },
        'RdsCustomClusterConfiguration': {
            'InterconnectSubnetId': 'string',
            'TransitGatewayMulticastDomainId': 'string'
        },
        '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,
            'RdsCustomClusterConfiguration': {
                'InterconnectSubnetId': 'string',
                'TransitGatewayMulticastDomainId': 'string'
            },
            '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),
        'LocalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'requested',
        'AwsBackupRecoveryPointArn': 'string'
    }
}

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 , and StopDBCluster .
  
  For a Multi-AZ DB cluster, this data type is used as a response element in the operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , FailoverDBCluster , ModifyDBCluster , RebootDBCluster , RestoreDBClusterFromSnapshot , and RestoreDBClusterToPointInTime .
  
  For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
  
  For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
  - AllocatedStorage (integer) --
    
    For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always 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) --
        
        Indicates whether the cluster member is the primary DB instance for the DB cluster.
      - 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 StorageEncrypted is 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 provisioned or serverless .
    
    For more information, see CreateDBCluster .
  - ScalingConfigurationInfo (dict) --
    
    The scaling configuration for an Aurora DB cluster in serverless DB 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 serverless DB engine mode.
    - MaxCapacity (integer) --
      
      The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
    - AutoPause (boolean) --
      
      Indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB 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 serverless mode 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 ForceApplyCapacityChange or RollbackCapacityChange .
      
      ForceApplyCapacityChange , the default, sets the capacity to the specified value as soon as possible.
      
      RollbackCapacityChange ignores 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 TimeoutAction setting.
  - RdsCustomClusterConfiguration (dict) --
    
    Reserved for future use.
    - InterconnectSubnetId (string) --
      
      Reserved for future use.
    - TransitGatewayMulticastDomainId (string) --
      
      Reserved for future use.
  - 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: or rds: . 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: or rds: . 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) --
    
    Indicates 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 GlobalWriteForwardingStatus to 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) --
      
      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, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
    - RdsCustomClusterConfiguration (dict) --
      
      Reserved for future use.
      - InterconnectSubnetId (string) --
        
        Reserved for future use.
      - TransitGatewayMulticastDomainId (string) --
        
        Reserved for future use.
    - 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:
    - 7
    - month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
    - 731
    Default: 7 days
  - ServerlessV2ScalingConfiguration (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 DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
    
    For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
    
    This setting is only for Aurora DB clusters.
    
    Valid Values: IPV4 | DUAL
  - DBSystemId (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-iopt1 storage type.
    
    This setting is only for Aurora DB clusters.
  - LocalWriteForwardingStatus (string) --
    
    Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it.
  - AwsBackupRecoveryPointArn (string) --
    
    The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.

StopDBCluster (updated)

Link ¶
Changes (response)

{'DBCluster': {'PendingModifiedValues': {'RdsCustomClusterConfiguration': {'InterconnectSubnetId': 'string',
                                                                           'TransitGatewayMulticastDomainId': 'string'}},
               'RdsCustomClusterConfiguration': {'InterconnectSubnetId': 'string',
                                                 'TransitGatewayMulticastDomainId': 'string'}}}

Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster's metadata, including its endpoints and DB parameter groups. Aurora also retains the transaction logs so you can do a point-in-time restore if necessary.

For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide .

Note

This action only applies to Aurora DB clusters.

See also: AWS API Documentation

Request Syntax

client.stop_db_cluster(
    DBClusterIdentifier='string'
)

type DBClusterIdentifier

string

param DBClusterIdentifier

[REQUIRED]

The DB cluster identifier of the Amazon Aurora DB cluster to be stopped. This parameter is stored as a lowercase string.

rtype

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
        },
        'RdsCustomClusterConfiguration': {
            'InterconnectSubnetId': 'string',
            'TransitGatewayMulticastDomainId': 'string'
        },
        '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,
            'RdsCustomClusterConfiguration': {
                'InterconnectSubnetId': 'string',
                'TransitGatewayMulticastDomainId': 'string'
            },
            '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),
        'LocalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'requested',
        'AwsBackupRecoveryPointArn': 'string'
    }
}

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 , and StopDBCluster .
  
  For a Multi-AZ DB cluster, this data type is used as a response element in the operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , FailoverDBCluster , ModifyDBCluster , RebootDBCluster , RestoreDBClusterFromSnapshot , and RestoreDBClusterToPointInTime .
  
  For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
  
  For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
  - AllocatedStorage (integer) --
    
    For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always 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) --
        
        Indicates whether the cluster member is the primary DB instance for the DB cluster.
      - 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 StorageEncrypted is 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 provisioned or serverless .
    
    For more information, see CreateDBCluster .
  - ScalingConfigurationInfo (dict) --
    
    The scaling configuration for an Aurora DB cluster in serverless DB 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 serverless DB engine mode.
    - MaxCapacity (integer) --
      
      The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
    - AutoPause (boolean) --
      
      Indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB 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 serverless mode 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 ForceApplyCapacityChange or RollbackCapacityChange .
      
      ForceApplyCapacityChange , the default, sets the capacity to the specified value as soon as possible.
      
      RollbackCapacityChange ignores 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 TimeoutAction setting.
  - RdsCustomClusterConfiguration (dict) --
    
    Reserved for future use.
    - InterconnectSubnetId (string) --
      
      Reserved for future use.
    - TransitGatewayMulticastDomainId (string) --
      
      Reserved for future use.
  - 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: or rds: . 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: or rds: . 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) --
    
    Indicates 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 GlobalWriteForwardingStatus to 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) --
      
      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, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
    - RdsCustomClusterConfiguration (dict) --
      
      Reserved for future use.
      - InterconnectSubnetId (string) --
        
        Reserved for future use.
      - TransitGatewayMulticastDomainId (string) --
        
        Reserved for future use.
    - 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:
    - 7
    - month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
    - 731
    Default: 7 days
  - ServerlessV2ScalingConfiguration (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 DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
    
    For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
    
    This setting is only for Aurora DB clusters.
    
    Valid Values: IPV4 | DUAL
  - DBSystemId (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-iopt1 storage type.
    
    This setting is only for Aurora DB clusters.
  - LocalWriteForwardingStatus (string) --
    
    Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it.
  - AwsBackupRecoveryPointArn (string) --
    
    The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.