AWS API Changes

2018/11/28 - Amazon Relational Database Service - 5 new11 updated api methods

Changes Update rds client to latest version

DeleteGlobalCluster (new)

Link ¶

Deletes a global database cluster. The primary and secondary clusters must already be detached or destroyed first.

Request Syntax

client.delete_global_cluster(
    GlobalClusterIdentifier='string'
)

type GlobalClusterIdentifier:

string

param GlobalClusterIdentifier:

[REQUIRED]

The cluster identifier of the global database cluster being deleted.

rtype:

dict

returns:

Response Syntax

{
    'GlobalCluster': {
        'GlobalClusterIdentifier': 'string',
        'GlobalClusterResourceId': 'string',
        'GlobalClusterArn': 'string',
        'Status': 'string',
        'Engine': 'string',
        'EngineVersion': 'string',
        'DatabaseName': 'string',
        'StorageEncrypted': True|False,
        'DeletionProtection': True|False,
        'GlobalClusterMembers': [
            {
                'DBClusterArn': 'string',
                'Readers': [
                    'string',
                ],
                'IsWriter': True|False
            },
        ]
    }
}

Response Structure

(dict) --
- GlobalCluster (dict) --
  
  A data type representing an Aurora global database.
  - GlobalClusterIdentifier (string) --
    
    Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster.
  - GlobalClusterResourceId (string) --
    
    The AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
  - GlobalClusterArn (string) --
    
    The Amazon Resource Name (ARN) for the global database cluster.
  - Status (string) --
    
    Specifies the current state of this global database cluster.
  - Engine (string) --
    
    The Aurora database engine used by the global database cluster.
  - EngineVersion (string) --
    
    Indicates the database engine version.
  - DatabaseName (string) --
    
    The default database name within the new global database cluster.
  - StorageEncrypted (boolean) --
    
    The storage encryption setting for the global database cluster.
  - DeletionProtection (boolean) --
    
    The deletion protection setting for the new global database cluster.
  - GlobalClusterMembers (list) --
    
    The list of cluster IDs for secondary clusters within the global database cluster. Currently limited to 1 item.
    - (dict) --
      
      A data structure with information about any primary and secondary clusters associated with an Aurora global database.
      - DBClusterArn (string) --
        
        The Amazon Resource Name (ARN) for each Aurora cluster.
      - Readers (list) --
        
        The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global database.
        
        (string) --
      - IsWriter (boolean) --
        
        Specifies whether the Aurora cluster is the primary cluster (that is, has read-write capability) for the Aurora global database with which it is associated.

RemoveFromGlobalCluster (new)

Link ¶

Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary cluster in a different region.

See also: AWS API Documentation

Request Syntax

client.remove_from_global_cluster(
    GlobalClusterIdentifier='string',
    DbClusterIdentifier='string'
)

type GlobalClusterIdentifier:

string

param GlobalClusterIdentifier:

The cluster identifier to detach from the Aurora global database cluster.

type DbClusterIdentifier:

string

param DbClusterIdentifier:

The Amazon Resource Name (ARN) identifying the cluster that was detached from the Aurora global database cluster.

rtype:

dict

returns:

Response Syntax

{
    'GlobalCluster': {
        'GlobalClusterIdentifier': 'string',
        'GlobalClusterResourceId': 'string',
        'GlobalClusterArn': 'string',
        'Status': 'string',
        'Engine': 'string',
        'EngineVersion': 'string',
        'DatabaseName': 'string',
        'StorageEncrypted': True|False,
        'DeletionProtection': True|False,
        'GlobalClusterMembers': [
            {
                'DBClusterArn': 'string',
                'Readers': [
                    'string',
                ],
                'IsWriter': True|False
            },
        ]
    }
}

Response Structure

(dict) --
- GlobalCluster (dict) --
  
  A data type representing an Aurora global database.
  - GlobalClusterIdentifier (string) --
    
    Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster.
  - GlobalClusterResourceId (string) --
    
    The AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
  - GlobalClusterArn (string) --
    
    The Amazon Resource Name (ARN) for the global database cluster.
  - Status (string) --
    
    Specifies the current state of this global database cluster.
  - Engine (string) --
    
    The Aurora database engine used by the global database cluster.
  - EngineVersion (string) --
    
    Indicates the database engine version.
  - DatabaseName (string) --
    
    The default database name within the new global database cluster.
  - StorageEncrypted (boolean) --
    
    The storage encryption setting for the global database cluster.
  - DeletionProtection (boolean) --
    
    The deletion protection setting for the new global database cluster.
  - GlobalClusterMembers (list) --
    
    The list of cluster IDs for secondary clusters within the global database cluster. Currently limited to 1 item.
    - (dict) --
      
      A data structure with information about any primary and secondary clusters associated with an Aurora global database.
      - DBClusterArn (string) --
        
        The Amazon Resource Name (ARN) for each Aurora cluster.
      - Readers (list) --
        
        The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global database.
        
        (string) --
      - IsWriter (boolean) --
        
        Specifies whether the Aurora cluster is the primary cluster (that is, has read-write capability) for the Aurora global database with which it is associated.

CreateGlobalCluster (new)

Link ¶

Creates an Aurora global database spread across multiple regions. The global database contains a single primary cluster with read-write capability, and a read-only secondary cluster that receives data from the primary cluster through high-speed replication performed by the Aurora storage subsystem.

You can create a global database that is initially empty, and then add a primary cluster and a secondary cluster to it. Or you can specify an existing Aurora cluster during the create operation, and this cluster becomes the primary cluster of the global database.

See also: AWS API Documentation

Request Syntax

client.create_global_cluster(
    GlobalClusterIdentifier='string',
    SourceDBClusterIdentifier='string',
    Engine='string',
    EngineVersion='string',
    DeletionProtection=True|False,
    DatabaseName='string',
    StorageEncrypted=True|False
)

type GlobalClusterIdentifier:

string

param GlobalClusterIdentifier:

The cluster identifier of the new global database cluster.

type SourceDBClusterIdentifier:

string

param SourceDBClusterIdentifier:

The Amazon Resource Name (ARN) to use as the primary cluster of the global database. This parameter is optional.

type Engine:

string

param Engine:

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

type EngineVersion:

string

param EngineVersion:

The engine version of the Aurora global database.

type DeletionProtection:

boolean

param DeletionProtection:

The deletion protection setting for the new global database. The global database can't be deleted when this value is set to true.

type DatabaseName:

string

param DatabaseName:

The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon Aurora will not create a database in the global database cluster you are creating.

type StorageEncrypted:

boolean

param StorageEncrypted:

The storage encryption setting for the new global database cluster.

rtype:

dict

returns:

Response Syntax

{
    'GlobalCluster': {
        'GlobalClusterIdentifier': 'string',
        'GlobalClusterResourceId': 'string',
        'GlobalClusterArn': 'string',
        'Status': 'string',
        'Engine': 'string',
        'EngineVersion': 'string',
        'DatabaseName': 'string',
        'StorageEncrypted': True|False,
        'DeletionProtection': True|False,
        'GlobalClusterMembers': [
            {
                'DBClusterArn': 'string',
                'Readers': [
                    'string',
                ],
                'IsWriter': True|False
            },
        ]
    }
}

Response Structure

(dict) --
- GlobalCluster (dict) --
  
  A data type representing an Aurora global database.
  - GlobalClusterIdentifier (string) --
    
    Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster.
  - GlobalClusterResourceId (string) --
    
    The AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
  - GlobalClusterArn (string) --
    
    The Amazon Resource Name (ARN) for the global database cluster.
  - Status (string) --
    
    Specifies the current state of this global database cluster.
  - Engine (string) --
    
    The Aurora database engine used by the global database cluster.
  - EngineVersion (string) --
    
    Indicates the database engine version.
  - DatabaseName (string) --
    
    The default database name within the new global database cluster.
  - StorageEncrypted (boolean) --
    
    The storage encryption setting for the global database cluster.
  - DeletionProtection (boolean) --
    
    The deletion protection setting for the new global database cluster.
  - GlobalClusterMembers (list) --
    
    The list of cluster IDs for secondary clusters within the global database cluster. Currently limited to 1 item.
    - (dict) --
      
      A data structure with information about any primary and secondary clusters associated with an Aurora global database.
      - DBClusterArn (string) --
        
        The Amazon Resource Name (ARN) for each Aurora cluster.
      - Readers (list) --
        
        The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global database.
        
        (string) --
      - IsWriter (boolean) --
        
        Specifies whether the Aurora cluster is the primary cluster (that is, has read-write capability) for the Aurora global database with which it is associated.

ModifyGlobalCluster (new)

Link ¶

Modify a setting for an Amazon Aurora global cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

See also: AWS API Documentation

Request Syntax

client.modify_global_cluster(
    GlobalClusterIdentifier='string',
    NewGlobalClusterIdentifier='string',
    DeletionProtection=True|False
)

type GlobalClusterIdentifier:

string

param GlobalClusterIdentifier:

The DB cluster identifier for the global cluster being modified. This parameter is not case-sensitive.

Constraints:

Must match the identifier of an existing global database cluster.

type NewGlobalClusterIdentifier:

string

param NewGlobalClusterIdentifier:

The new cluster identifier for the global database cluster when modifying a global database cluster. This value is stored as a lowercase string.

Constraints:

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

Example: my-cluster2

type DeletionProtection:

boolean

param DeletionProtection:

Indicates if the global database cluster has deletion protection enabled. The global database cluster can't be deleted when this value is set to true.

rtype:

dict

returns:

Response Syntax

{
    'GlobalCluster': {
        'GlobalClusterIdentifier': 'string',
        'GlobalClusterResourceId': 'string',
        'GlobalClusterArn': 'string',
        'Status': 'string',
        'Engine': 'string',
        'EngineVersion': 'string',
        'DatabaseName': 'string',
        'StorageEncrypted': True|False,
        'DeletionProtection': True|False,
        'GlobalClusterMembers': [
            {
                'DBClusterArn': 'string',
                'Readers': [
                    'string',
                ],
                'IsWriter': True|False
            },
        ]
    }
}

Response Structure

(dict) --
- GlobalCluster (dict) --
  
  A data type representing an Aurora global database.
  - GlobalClusterIdentifier (string) --
    
    Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster.
  - GlobalClusterResourceId (string) --
    
    The AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
  - GlobalClusterArn (string) --
    
    The Amazon Resource Name (ARN) for the global database cluster.
  - Status (string) --
    
    Specifies the current state of this global database cluster.
  - Engine (string) --
    
    The Aurora database engine used by the global database cluster.
  - EngineVersion (string) --
    
    Indicates the database engine version.
  - DatabaseName (string) --
    
    The default database name within the new global database cluster.
  - StorageEncrypted (boolean) --
    
    The storage encryption setting for the global database cluster.
  - DeletionProtection (boolean) --
    
    The deletion protection setting for the new global database cluster.
  - GlobalClusterMembers (list) --
    
    The list of cluster IDs for secondary clusters within the global database cluster. Currently limited to 1 item.
    - (dict) --
      
      A data structure with information about any primary and secondary clusters associated with an Aurora global database.
      - DBClusterArn (string) --
        
        The Amazon Resource Name (ARN) for each Aurora cluster.
      - Readers (list) --
        
        The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global database.
        
        (string) --
      - IsWriter (boolean) --
        
        Specifies whether the Aurora cluster is the primary cluster (that is, has read-write capability) for the Aurora global database with which it is associated.

DescribeGlobalClusters (new)

Link ¶

Returns information about Aurora global database clusters. This API supports pagination.

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

See also: AWS API Documentation

Request Syntax

client.describe_global_clusters(
    GlobalClusterIdentifier='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    Marker='string'
)

type GlobalClusterIdentifier:

string

param GlobalClusterIdentifier:

The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.

Constraints:

If supplied, must match an existing DBClusterIdentifier.

type Filters:

list

param Filters:

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

Supported filters:

db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB clusters identified by these ARNs.

(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 that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

type Marker:

string

param Marker:

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

rtype:

dict

returns:

Response Syntax

{
    'Marker': 'string',
    'GlobalClusters': [
        {
            'GlobalClusterIdentifier': 'string',
            'GlobalClusterResourceId': 'string',
            'GlobalClusterArn': 'string',
            'Status': 'string',
            'Engine': 'string',
            'EngineVersion': 'string',
            'DatabaseName': 'string',
            'StorageEncrypted': True|False,
            'DeletionProtection': True|False,
            'GlobalClusterMembers': [
                {
                    'DBClusterArn': 'string',
                    'Readers': [
                        'string',
                    ],
                    'IsWriter': True|False
                },
            ]
        },
    ]
}

Response Structure

(dict) --
- Marker (string) --
  
  An optional pagination token provided by a previous DescribeGlobalClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
- GlobalClusters (list) --
  
  The list of global clusters returned by this request.
  - (dict) --
    
    A data type representing an Aurora global database.
    - GlobalClusterIdentifier (string) --
      
      Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster.
    - GlobalClusterResourceId (string) --
      
      The AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
    - GlobalClusterArn (string) --
      
      The Amazon Resource Name (ARN) for the global database cluster.
    - Status (string) --
      
      Specifies the current state of this global database cluster.
    - Engine (string) --
      
      The Aurora database engine used by the global database cluster.
    - EngineVersion (string) --
      
      Indicates the database engine version.
    - DatabaseName (string) --
      
      The default database name within the new global database cluster.
    - StorageEncrypted (boolean) --
      
      The storage encryption setting for the global database cluster.
    - DeletionProtection (boolean) --
      
      The deletion protection setting for the new global database cluster.
    - GlobalClusterMembers (list) --
      
      The list of cluster IDs for secondary clusters within the global database cluster. Currently limited to 1 item.
      - (dict) --
        
        A data structure with information about any primary and secondary clusters associated with an Aurora global database.
        
        DBClusterArn (string) --
        
        The Amazon Resource Name (ARN) for each Aurora cluster.
        
        Readers (list) --
        
        The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global database.
        
        (string) --
        
        IsWriter (boolean) --
        
        Specifies whether the Aurora cluster is the primary cluster (that is, has read-write capability) for the Aurora global database with which it is associated.

CreateDBCluster (updated)

Link ¶
Changes (request, response)
Request

{'GlobalClusterIdentifier': 'string'}

Response

{'DBCluster': {'HttpEndpointEnabled': 'boolean'}}

Creates a new Amazon Aurora DB cluster.

You can use the ReplicationSourceIdentifier parameter to create the DB cluster as a Read Replica of another DB cluster or Amazon RDS MySQL DB instance. For cross-region replication where the DB cluster identified by ReplicationSourceIdentifier is encrypted, you must also specify the PreSignedUrl parameter.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora 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
    },
    DeletionProtection=True|False,
    GlobalClusterIdentifier='string'
)

type AvailabilityZones:

list

param AvailabilityZones:

A list of EC2 Availability Zones that instances in the DB cluster can be created in. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.

(string) --

type BackupRetentionPeriod:

integer

param BackupRetentionPeriod:

The number of days for which automated backups 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 DB cluster should be associated with the specified CharacterSet.

type DatabaseName:

string

param DatabaseName:

The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon RDS will not create a database in the DB cluster you are creating.

type DBClusterIdentifier:

string

param DBClusterIdentifier:

[REQUIRED]

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

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 this argument is omitted, default.aurora5.6 is used.

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.

(string) --

type DBSubnetGroupName:

string

param DBSubnetGroupName:

A DB subnet group to associate with this DB cluster.

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

Example: mySubnetgroup

type Engine:

string

param Engine:

[REQUIRED]

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

Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql

type EngineVersion:

string

param EngineVersion:

The version number of the database engine to use.

Aurora MySQL

Example: 5.6.10a, 5.7.12

Aurora PostgreSQL

Example: 9.6.3

type Port:

integer

param Port:

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

Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql.

type MasterUsername:

string

param MasterUsername:

The name of the master user for the 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.

type OptionGroupName:

string

param OptionGroupName:

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

Permanent options can't be removed from an option group. The 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.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. 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 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 AWS 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.

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

Constraints: Minimum 30-minute window.

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.

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

type KmsKeyId:

string

param KmsKeyId:

The AWS KMS key identifier for an encrypted DB cluster.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

If an encryption key is not specified in KmsKeyId:

If ReplicationSourceIdentifier identifies an encrypted source, then Amazon RDS will use the encryption key used to encrypt the source. Otherwise, Amazon RDS will use your default encryption key.
If the StorageEncrypted parameter is true and ReplicationSourceIdentifier is not specified, then Amazon RDS will use your default encryption key.

AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

If you create a Read Replica of an encrypted DB cluster in another AWS Region, you must set KmsKeyId to a KMS key ID that is valid in the destination AWS Region. This key is used to encrypt the Read Replica in that AWS Region.

type PreSignedUrl:

string

param PreSignedUrl:

A URL that contains a Signature Version 4 signed request for the CreateDBCluster action to be called in the source AWS Region where the DB cluster is replicated from. You only need to specify PreSignedUrl when you are performing cross-region replication from an encrypted DB cluster.

The pre-signed URL must be a valid request for the CreateDBCluster API action that can be executed in the source AWS Region that contains the encrypted DB cluster to be copied.

The pre-signed URL request must contain the following parameter values:

KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB cluster in the destination AWS Region. This should refer to the same KMS key for both the CreateDBCluster action that is called in the destination AWS Region, and the action contained in the pre-signed URL.
DestinationRegion - The name of the AWS 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 AWS Region. For example, if you are copying an encrypted DB cluster from the us-west-2 AWS 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 (AWS Signature Version 4) and Signature Version 4 Signing Process.

type EnableIAMDatabaseAuthentication:

boolean

param EnableIAMDatabaseAuthentication:

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

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

type EnableCloudwatchLogsExports:

list

param EnableCloudwatchLogsExports:

The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, 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, serverless, parallelquery, or global.

type ScalingConfiguration:

dict

param ScalingConfiguration:

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

MinCapacity (integer) --

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

Valid capacity values are 2, 4, 8, 16, 32, 64, 128, and 256.

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.

Valid capacity values are 2, 4, 8, 16, 32, 64, 128, and 256.

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

A value that specifies 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.

type DeletionProtection:

boolean

param DeletionProtection:

Indicates if the DB cluster should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.

type GlobalClusterIdentifier:

string

param GlobalClusterIdentifier:

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

rtype:

dict

returns:

Response Syntax

{
    'DBCluster': {
        'AllocatedStorage': 123,
        'AvailabilityZones': [
            'string',
        ],
        'BackupRetentionPeriod': 123,
        'CharacterSetName': 'string',
        'DatabaseName': 'string',
        'DBClusterIdentifier': 'string',
        'DBClusterParameterGroup': 'string',
        'DBSubnetGroup': 'string',
        'Status': 'string',
        '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
        },
        'DeletionProtection': True|False,
        'HttpEndpointEnabled': True|False
    }
}

Response Structure

(dict) --
- DBCluster (dict) --
  
  Contains the details of an Amazon Aurora DB cluster.
  
  This data type is used as a response element in the DescribeDBClusters, StopDBCluster, and StartDBCluster actions.
  - 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 is not fixed, but instead automatically adjusts as needed.
  - AvailabilityZones (list) --
    
    Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
    - (string) --
  - BackupRetentionPeriod (integer) --
    
    Specifies 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) --
    
    Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.
  - DBClusterIdentifier (string) --
    
    Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
  - DBClusterParameterGroup (string) --
    
    Specifies the name of the DB cluster parameter group for the DB cluster.
  - DBSubnetGroup (string) --
    
    Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
  - Status (string) --
    
    Specifies the current state of this DB cluster.
  - PercentProgress (string) --
    
    Specifies 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) --
    
    Specifies 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) --
    
    Identifies all custom endpoints associated with the cluster.
    - (string) --
  - MultiAZ (boolean) --
    
    Specifies whether the DB cluster has instances in multiple Availability Zones.
  - Engine (string) --
    
    Provides the name of the database engine to be used for this DB cluster.
  - EngineVersion (string) --
    
    Indicates the database engine version.
  - LatestRestorableTime (datetime) --
    
    Specifies the latest time to which a database can be restored with point-in-time restore.
  - Port (integer) --
    
    Specifies the port that the database engine is listening on.
  - MasterUsername (string) --
    
    Contains the master username for the DB cluster.
  - DBClusterOptionGroupMemberships (list) --
    
    Provides 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) --
    
    Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
  - PreferredMaintenanceWindow (string) --
    
    Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
  - ReplicationSourceIdentifier (string) --
    
    Contains 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) --
    
    Provides the list of instances that make up the DB cluster.
    - (dict) --
      
      Contains information about an instance that is part of a DB cluster.
      - DBInstanceIdentifier (string) --
        
        Specifies the instance identifier for this member of the DB cluster.
      - IsClusterWriter (boolean) --
        
        Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
      - 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) --
    
    Provides a 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 status of the VPC security group.
  - HostedZoneId (string) --
    
    Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
  - StorageEncrypted (boolean) --
    
    Specifies whether the DB cluster is encrypted.
  - KmsKeyId (string) --
    
    If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster.
  - DbClusterResourceId (string) --
    
    The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
  - DBClusterArn (string) --
    
    The Amazon Resource Name (ARN) for the DB cluster.
  - AssociatedRoles (list) --
    
    Provides a list of the AWS 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 AWS services on your behalf.
    - (dict) --
      
      Describes an AWS 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 AWS 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 AWS services on your behalf.
      - FeatureName (string) --
  - IAMDatabaseAuthenticationEnabled (boolean) --
    
    True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
  - CloneGroupId (string) --
    
    Identifies the clone group to which the DB cluster is associated.
  - ClusterCreateTime (datetime) --
    
    Specifies 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) --
  - EngineMode (string) --
    
    The DB engine mode of the DB cluster, either provisioned, serverless, or parallelquery.
  - ScalingConfigurationInfo (dict) --
    
    Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.
    
    For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.
    - MinCapacity (integer) --
      
      The maximum capacity for the 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) --
      
      A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.
    - 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).
  - DeletionProtection (boolean) --
    
    Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when this value is set to true.
  - HttpEndpointEnabled (boolean) --
    
    Note
    
    HTTP endpoint functionality is in beta for Aurora Serverless and is subject to change.
    
    Value that is true if the HTTP endpoint for an Aurora Serverless DB cluster is enabled and false otherwise.
    
    When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
    
    For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

DeleteDBCluster (updated)

Link ¶
Changes (response)

{'DBCluster': {'HttpEndpointEnabled': 'boolean'}}

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.

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

See also: AWS API Documentation

Request Syntax

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

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:

Determines whether a final DB cluster snapshot is created before the DB cluster is deleted. If true is specified, no DB cluster snapshot is created. If false is specified, a DB cluster snapshot is created before the DB cluster is deleted.

Default: false

type FinalDBSnapshotIdentifier:

string

param FinalDBSnapshotIdentifier:

The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is set to false.

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

rtype:

dict

returns:

Response Syntax

{
    'DBCluster': {
        'AllocatedStorage': 123,
        'AvailabilityZones': [
            'string',
        ],
        'BackupRetentionPeriod': 123,
        'CharacterSetName': 'string',
        'DatabaseName': 'string',
        'DBClusterIdentifier': 'string',
        'DBClusterParameterGroup': 'string',
        'DBSubnetGroup': 'string',
        'Status': 'string',
        '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
        },
        'DeletionProtection': True|False,
        'HttpEndpointEnabled': True|False
    }
}

Response Structure

(dict) --
- DBCluster (dict) --
  
  Contains the details of an Amazon Aurora DB cluster.
  
  This data type is used as a response element in the DescribeDBClusters, StopDBCluster, and StartDBCluster actions.
  - 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 is not fixed, but instead automatically adjusts as needed.
  - AvailabilityZones (list) --
    
    Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
    - (string) --
  - BackupRetentionPeriod (integer) --
    
    Specifies 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) --
    
    Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.
  - DBClusterIdentifier (string) --
    
    Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
  - DBClusterParameterGroup (string) --
    
    Specifies the name of the DB cluster parameter group for the DB cluster.
  - DBSubnetGroup (string) --
    
    Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
  - Status (string) --
    
    Specifies the current state of this DB cluster.
  - PercentProgress (string) --
    
    Specifies 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) --
    
    Specifies 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) --
    
    Identifies all custom endpoints associated with the cluster.
    - (string) --
  - MultiAZ (boolean) --
    
    Specifies whether the DB cluster has instances in multiple Availability Zones.
  - Engine (string) --
    
    Provides the name of the database engine to be used for this DB cluster.
  - EngineVersion (string) --
    
    Indicates the database engine version.
  - LatestRestorableTime (datetime) --
    
    Specifies the latest time to which a database can be restored with point-in-time restore.
  - Port (integer) --
    
    Specifies the port that the database engine is listening on.
  - MasterUsername (string) --
    
    Contains the master username for the DB cluster.
  - DBClusterOptionGroupMemberships (list) --
    
    Provides 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) --
    
    Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
  - PreferredMaintenanceWindow (string) --
    
    Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
  - ReplicationSourceIdentifier (string) --
    
    Contains 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) --
    
    Provides the list of instances that make up the DB cluster.
    - (dict) --
      
      Contains information about an instance that is part of a DB cluster.
      - DBInstanceIdentifier (string) --
        
        Specifies the instance identifier for this member of the DB cluster.
      - IsClusterWriter (boolean) --
        
        Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
      - 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) --
    
    Provides a 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 status of the VPC security group.
  - HostedZoneId (string) --
    
    Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
  - StorageEncrypted (boolean) --
    
    Specifies whether the DB cluster is encrypted.
  - KmsKeyId (string) --
    
    If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster.
  - DbClusterResourceId (string) --
    
    The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
  - DBClusterArn (string) --
    
    The Amazon Resource Name (ARN) for the DB cluster.
  - AssociatedRoles (list) --
    
    Provides a list of the AWS 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 AWS services on your behalf.
    - (dict) --
      
      Describes an AWS 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 AWS 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 AWS services on your behalf.
      - FeatureName (string) --
  - IAMDatabaseAuthenticationEnabled (boolean) --
    
    True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
  - CloneGroupId (string) --
    
    Identifies the clone group to which the DB cluster is associated.
  - ClusterCreateTime (datetime) --
    
    Specifies 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) --
  - EngineMode (string) --
    
    The DB engine mode of the DB cluster, either provisioned, serverless, or parallelquery.
  - ScalingConfigurationInfo (dict) --
    
    Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.
    
    For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.
    - MinCapacity (integer) --
      
      The maximum capacity for the 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) --
      
      A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.
    - 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).
  - DeletionProtection (boolean) --
    
    Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when this value is set to true.
  - HttpEndpointEnabled (boolean) --
    
    Note
    
    HTTP endpoint functionality is in beta for Aurora Serverless and is subject to change.
    
    Value that is true if the HTTP endpoint for an Aurora Serverless DB cluster is enabled and false otherwise.
    
    When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
    
    For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

DescribeDBClusters (updated)

Link ¶
Changes (response)

{'DBClusters': {'HttpEndpointEnabled': 'boolean'}}

Returns information about provisioned Aurora DB clusters. This API supports pagination.

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

See also: AWS API Documentation

Request Syntax

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

type DBClusterIdentifier:

string

param DBClusterIdentifier:

The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.

Constraints:

If supplied, must match an existing DBClusterIdentifier.

type Filters:

list

param Filters:

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

Supported filters:

db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB clusters identified by these ARNs.

(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:

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.

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',
            '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
            },
            'DeletionProtection': True|False,
            'HttpEndpointEnabled': True|False
        },
    ]
}

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 subsequent DescribeDBClusters request.
- DBClusters (list) --
  
  Contains a list of DB clusters for the user.
  - (dict) --
    
    Contains the details of an Amazon Aurora DB cluster.
    
    This data type is used as a response element in the DescribeDBClusters, StopDBCluster, and StartDBCluster actions.
    - 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 is not fixed, but instead automatically adjusts as needed.
    - AvailabilityZones (list) --
      
      Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
      - (string) --
    - BackupRetentionPeriod (integer) --
      
      Specifies 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) --
      
      Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.
    - DBClusterIdentifier (string) --
      
      Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
    - DBClusterParameterGroup (string) --
      
      Specifies the name of the DB cluster parameter group for the DB cluster.
    - DBSubnetGroup (string) --
      
      Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
    - Status (string) --
      
      Specifies the current state of this DB cluster.
    - PercentProgress (string) --
      
      Specifies 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) --
      
      Specifies 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) --
      
      Identifies all custom endpoints associated with the cluster.
      - (string) --
    - MultiAZ (boolean) --
      
      Specifies whether the DB cluster has instances in multiple Availability Zones.
    - Engine (string) --
      
      Provides the name of the database engine to be used for this DB cluster.
    - EngineVersion (string) --
      
      Indicates the database engine version.
    - LatestRestorableTime (datetime) --
      
      Specifies the latest time to which a database can be restored with point-in-time restore.
    - Port (integer) --
      
      Specifies the port that the database engine is listening on.
    - MasterUsername (string) --
      
      Contains the master username for the DB cluster.
    - DBClusterOptionGroupMemberships (list) --
      
      Provides 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) --
      
      Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
    - PreferredMaintenanceWindow (string) --
      
      Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
    - ReplicationSourceIdentifier (string) --
      
      Contains 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) --
      
      Provides the list of instances that make up the DB cluster.
      - (dict) --
        
        Contains information about an instance that is part of a DB cluster.
        
        DBInstanceIdentifier (string) --
        
        Specifies the instance identifier for this member of the DB cluster.
        
        IsClusterWriter (boolean) --
        
        Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
        
        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) --
      
      Provides a 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 status of the VPC security group.
    - HostedZoneId (string) --
      
      Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
    - StorageEncrypted (boolean) --
      
      Specifies whether the DB cluster is encrypted.
    - KmsKeyId (string) --
      
      If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster.
    - DbClusterResourceId (string) --
      
      The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
    - DBClusterArn (string) --
      
      The Amazon Resource Name (ARN) for the DB cluster.
    - AssociatedRoles (list) --
      
      Provides a list of the AWS 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 AWS services on your behalf.
      - (dict) --
        
        Describes an AWS 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 AWS 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 AWS services on your behalf.
        
        FeatureName (string) --
    - IAMDatabaseAuthenticationEnabled (boolean) --
      
      True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
    - CloneGroupId (string) --
      
      Identifies the clone group to which the DB cluster is associated.
    - ClusterCreateTime (datetime) --
      
      Specifies 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) --
    - EngineMode (string) --
      
      The DB engine mode of the DB cluster, either provisioned, serverless, or parallelquery.
    - ScalingConfigurationInfo (dict) --
      
      Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.
      
      For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.
      - MinCapacity (integer) --
        
        The maximum capacity for the 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) --
        
        A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.
      - 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).
    - DeletionProtection (boolean) --
      
      Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when this value is set to true.
    - HttpEndpointEnabled (boolean) --
      
      Note
      
      HTTP endpoint functionality is in beta for Aurora Serverless and is subject to change.
      
      Value that is true if the HTTP endpoint for an Aurora Serverless DB cluster is enabled and false otherwise.
      
      When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
      
      For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

FailoverDBCluster (updated)

Link ¶
Changes (response)

{'DBCluster': {'HttpEndpointEnabled': 'boolean'}}

Forces a failover for a DB cluster.

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

Amazon Aurora will automatically fail over to an Aurora Replica, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a primary instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need 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, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

See also: AWS API Documentation

Request Syntax

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

type DBClusterIdentifier:

string

param DBClusterIdentifier:

[REQUIRED]

A DB cluster identifier to force a failover for. This parameter is not case-sensitive.

Constraints:

Must match the identifier of an existing DBCluster.

type TargetDBInstanceIdentifier:

string

param TargetDBInstanceIdentifier:

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

You must specify the instance identifier for an Aurora Replica in the DB cluster. For example, mydbcluster-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',
        '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
        },
        'DeletionProtection': True|False,
        'HttpEndpointEnabled': True|False
    }
}

Response Structure

(dict) --
- DBCluster (dict) --
  
  Contains the details of an Amazon Aurora DB cluster.
  
  This data type is used as a response element in the DescribeDBClusters, StopDBCluster, and StartDBCluster actions.
  - 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 is not fixed, but instead automatically adjusts as needed.
  - AvailabilityZones (list) --
    
    Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
    - (string) --
  - BackupRetentionPeriod (integer) --
    
    Specifies 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) --
    
    Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.
  - DBClusterIdentifier (string) --
    
    Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
  - DBClusterParameterGroup (string) --
    
    Specifies the name of the DB cluster parameter group for the DB cluster.
  - DBSubnetGroup (string) --
    
    Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
  - Status (string) --
    
    Specifies the current state of this DB cluster.
  - PercentProgress (string) --
    
    Specifies 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) --
    
    Specifies 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) --
    
    Identifies all custom endpoints associated with the cluster.
    - (string) --
  - MultiAZ (boolean) --
    
    Specifies whether the DB cluster has instances in multiple Availability Zones.
  - Engine (string) --
    
    Provides the name of the database engine to be used for this DB cluster.
  - EngineVersion (string) --
    
    Indicates the database engine version.
  - LatestRestorableTime (datetime) --
    
    Specifies the latest time to which a database can be restored with point-in-time restore.
  - Port (integer) --
    
    Specifies the port that the database engine is listening on.
  - MasterUsername (string) --
    
    Contains the master username for the DB cluster.
  - DBClusterOptionGroupMemberships (list) --
    
    Provides 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) --
    
    Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
  - PreferredMaintenanceWindow (string) --
    
    Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
  - ReplicationSourceIdentifier (string) --
    
    Contains 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) --
    
    Provides the list of instances that make up the DB cluster.
    - (dict) --
      
      Contains information about an instance that is part of a DB cluster.
      - DBInstanceIdentifier (string) --
        
        Specifies the instance identifier for this member of the DB cluster.
      - IsClusterWriter (boolean) --
        
        Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
      - 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) --
    
    Provides a 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 status of the VPC security group.
  - HostedZoneId (string) --
    
    Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
  - StorageEncrypted (boolean) --
    
    Specifies whether the DB cluster is encrypted.
  - KmsKeyId (string) --
    
    If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster.
  - DbClusterResourceId (string) --
    
    The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
  - DBClusterArn (string) --
    
    The Amazon Resource Name (ARN) for the DB cluster.
  - AssociatedRoles (list) --
    
    Provides a list of the AWS 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 AWS services on your behalf.
    - (dict) --
      
      Describes an AWS 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 AWS 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 AWS services on your behalf.
      - FeatureName (string) --
  - IAMDatabaseAuthenticationEnabled (boolean) --
    
    True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
  - CloneGroupId (string) --
    
    Identifies the clone group to which the DB cluster is associated.
  - ClusterCreateTime (datetime) --
    
    Specifies 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) --
  - EngineMode (string) --
    
    The DB engine mode of the DB cluster, either provisioned, serverless, or parallelquery.
  - ScalingConfigurationInfo (dict) --
    
    Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.
    
    For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.
    - MinCapacity (integer) --
      
      The maximum capacity for the 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) --
      
      A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.
    - 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).
  - DeletionProtection (boolean) --
    
    Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when this value is set to true.
  - HttpEndpointEnabled (boolean) --
    
    Note
    
    HTTP endpoint functionality is in beta for Aurora Serverless and is subject to change.
    
    Value that is true if the HTTP endpoint for an Aurora Serverless DB cluster is enabled and false otherwise.
    
    When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
    
    For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

ModifyDBCluster (updated)

Link ¶
Changes (request, response)
Request

{'EnableHttpEndpoint': 'boolean'}

Response

{'DBCluster': {'HttpEndpointEnabled': 'boolean'}}

Modify a setting for an Amazon Aurora DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora 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',
    ScalingConfiguration={
        'MinCapacity': 123,
        'MaxCapacity': 123,
        'AutoPause': True|False,
        'SecondsUntilAutoPause': 123
    },
    DeletionProtection=True|False,
    EnableHttpEndpoint=True|False
)

type DBClusterIdentifier:

string

param DBClusterIdentifier:

[REQUIRED]

The DB cluster identifier for the cluster being modified. This parameter is not case-sensitive.

Constraints:

Must match the identifier of an existing DBCluster.

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.

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:

A value that 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 set to false, changes to the DB cluster are applied during the next maintenance window.

The ApplyImmediately parameter only affects the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values. If you set the ApplyImmediately parameter value to false, then changes to the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.

Default: false

type BackupRetentionPeriod:

integer

param BackupRetentionPeriod:

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

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.

type VpcSecurityGroupIds:

list

param VpcSecurityGroupIds:

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

(string) --

type Port:

integer

param Port:

The port number on which the DB cluster accepts connections.

Constraints: Value must be 1150-65535

Default: The same port as the original DB cluster.

type MasterUserPassword:

string

param MasterUserPassword:

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

Constraints: Must contain from 8 to 41 characters.

type OptionGroupName:

string

param OptionGroupName:

A value that indicates that the DB cluster should be associated with the specified option group. Changing this parameter doesn't result in an outage except in the following case, and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

Permanent options can't be removed from an option group. The 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

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

Constraints: Minimum 30-minute window.

type EnableIAMDatabaseAuthentication:

boolean

param EnableIAMDatabaseAuthentication:

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

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

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.

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 the ApplyImmediately parameter is set to true.

For a list of valid engine versions, see CreateDBCluster, or call DescribeDBEngineVersions.

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.

MinCapacity (integer) --

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

Valid capacity values are 2, 4, 8, 16, 32, 64, 128, and 256.

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.

Valid capacity values are 2, 4, 8, 16, 32, 64, 128, and 256.

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

A value that specifies 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.

type DeletionProtection:

boolean

param DeletionProtection:

Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when this value is set to true.

type EnableHttpEndpoint:

boolean

param EnableHttpEndpoint:

A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless 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 DB cluster. You can also query your database from inside the RDS console with the query editor.

For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

rtype:

dict

returns:

Response Syntax

{
    'DBCluster': {
        'AllocatedStorage': 123,
        'AvailabilityZones': [
            'string',
        ],
        'BackupRetentionPeriod': 123,
        'CharacterSetName': 'string',
        'DatabaseName': 'string',
        'DBClusterIdentifier': 'string',
        'DBClusterParameterGroup': 'string',
        'DBSubnetGroup': 'string',
        'Status': 'string',
        '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
        },
        'DeletionProtection': True|False,
        'HttpEndpointEnabled': True|False
    }
}

Response Structure

(dict) --
- DBCluster (dict) --
  
  Contains the details of an Amazon Aurora DB cluster.
  
  This data type is used as a response element in the DescribeDBClusters, StopDBCluster, and StartDBCluster actions.
  - 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 is not fixed, but instead automatically adjusts as needed.
  - AvailabilityZones (list) --
    
    Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
    - (string) --
  - BackupRetentionPeriod (integer) --
    
    Specifies 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) --
    
    Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.
  - DBClusterIdentifier (string) --
    
    Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
  - DBClusterParameterGroup (string) --
    
    Specifies the name of the DB cluster parameter group for the DB cluster.
  - DBSubnetGroup (string) --
    
    Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
  - Status (string) --
    
    Specifies the current state of this DB cluster.
  - PercentProgress (string) --
    
    Specifies 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) --
    
    Specifies 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) --
    
    Identifies all custom endpoints associated with the cluster.
    - (string) --
  - MultiAZ (boolean) --
    
    Specifies whether the DB cluster has instances in multiple Availability Zones.
  - Engine (string) --
    
    Provides the name of the database engine to be used for this DB cluster.
  - EngineVersion (string) --
    
    Indicates the database engine version.
  - LatestRestorableTime (datetime) --
    
    Specifies the latest time to which a database can be restored with point-in-time restore.
  - Port (integer) --
    
    Specifies the port that the database engine is listening on.
  - MasterUsername (string) --
    
    Contains the master username for the DB cluster.
  - DBClusterOptionGroupMemberships (list) --
    
    Provides 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) --
    
    Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
  - PreferredMaintenanceWindow (string) --
    
    Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
  - ReplicationSourceIdentifier (string) --
    
    Contains 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) --
    
    Provides the list of instances that make up the DB cluster.
    - (dict) --
      
      Contains information about an instance that is part of a DB cluster.
      - DBInstanceIdentifier (string) --
        
        Specifies the instance identifier for this member of the DB cluster.
      - IsClusterWriter (boolean) --
        
        Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
      - 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) --
    
    Provides a 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 status of the VPC security group.
  - HostedZoneId (string) --
    
    Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
  - StorageEncrypted (boolean) --
    
    Specifies whether the DB cluster is encrypted.
  - KmsKeyId (string) --
    
    If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster.
  - DbClusterResourceId (string) --
    
    The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
  - DBClusterArn (string) --
    
    The Amazon Resource Name (ARN) for the DB cluster.
  - AssociatedRoles (list) --
    
    Provides a list of the AWS 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 AWS services on your behalf.
    - (dict) --
      
      Describes an AWS 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 AWS 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 AWS services on your behalf.
      - FeatureName (string) --
  - IAMDatabaseAuthenticationEnabled (boolean) --
    
    True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
  - CloneGroupId (string) --
    
    Identifies the clone group to which the DB cluster is associated.
  - ClusterCreateTime (datetime) --
    
    Specifies 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) --
  - EngineMode (string) --
    
    The DB engine mode of the DB cluster, either provisioned, serverless, or parallelquery.
  - ScalingConfigurationInfo (dict) --
    
    Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.
    
    For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.
    - MinCapacity (integer) --
      
      The maximum capacity for the 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) --
      
      A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.
    - 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).
  - DeletionProtection (boolean) --
    
    Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when this value is set to true.
  - HttpEndpointEnabled (boolean) --
    
    Note
    
    HTTP endpoint functionality is in beta for Aurora Serverless and is subject to change.
    
    Value that is true if the HTTP endpoint for an Aurora Serverless DB cluster is enabled and false otherwise.
    
    When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
    
    For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

PromoteReadReplicaDBCluster (updated)

Link ¶
Changes (response)

{'DBCluster': {'HttpEndpointEnabled': 'boolean'}}

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 is not case-sensitive.

Constraints:

Must match the identifier of an existing DBCluster 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',
        '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
        },
        'DeletionProtection': True|False,
        'HttpEndpointEnabled': True|False
    }
}

Response Structure

(dict) --
- DBCluster (dict) --
  
  Contains the details of an Amazon Aurora DB cluster.
  
  This data type is used as a response element in the DescribeDBClusters, StopDBCluster, and StartDBCluster actions.
  - 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 is not fixed, but instead automatically adjusts as needed.
  - AvailabilityZones (list) --
    
    Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
    - (string) --
  - BackupRetentionPeriod (integer) --
    
    Specifies 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) --
    
    Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.
  - DBClusterIdentifier (string) --
    
    Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
  - DBClusterParameterGroup (string) --
    
    Specifies the name of the DB cluster parameter group for the DB cluster.
  - DBSubnetGroup (string) --
    
    Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
  - Status (string) --
    
    Specifies the current state of this DB cluster.
  - PercentProgress (string) --
    
    Specifies 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) --
    
    Specifies 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) --
    
    Identifies all custom endpoints associated with the cluster.
    - (string) --
  - MultiAZ (boolean) --
    
    Specifies whether the DB cluster has instances in multiple Availability Zones.
  - Engine (string) --
    
    Provides the name of the database engine to be used for this DB cluster.
  - EngineVersion (string) --
    
    Indicates the database engine version.
  - LatestRestorableTime (datetime) --
    
    Specifies the latest time to which a database can be restored with point-in-time restore.
  - Port (integer) --
    
    Specifies the port that the database engine is listening on.
  - MasterUsername (string) --
    
    Contains the master username for the DB cluster.
  - DBClusterOptionGroupMemberships (list) --
    
    Provides 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) --
    
    Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
  - PreferredMaintenanceWindow (string) --
    
    Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
  - ReplicationSourceIdentifier (string) --
    
    Contains 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) --
    
    Provides the list of instances that make up the DB cluster.
    - (dict) --
      
      Contains information about an instance that is part of a DB cluster.
      - DBInstanceIdentifier (string) --
        
        Specifies the instance identifier for this member of the DB cluster.
      - IsClusterWriter (boolean) --
        
        Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
      - 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) --
    
    Provides a 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 status of the VPC security group.
  - HostedZoneId (string) --
    
    Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
  - StorageEncrypted (boolean) --
    
    Specifies whether the DB cluster is encrypted.
  - KmsKeyId (string) --
    
    If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster.
  - DbClusterResourceId (string) --
    
    The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
  - DBClusterArn (string) --
    
    The Amazon Resource Name (ARN) for the DB cluster.
  - AssociatedRoles (list) --
    
    Provides a list of the AWS 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 AWS services on your behalf.
    - (dict) --
      
      Describes an AWS 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 AWS 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 AWS services on your behalf.
      - FeatureName (string) --
  - IAMDatabaseAuthenticationEnabled (boolean) --
    
    True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
  - CloneGroupId (string) --
    
    Identifies the clone group to which the DB cluster is associated.
  - ClusterCreateTime (datetime) --
    
    Specifies 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) --
  - EngineMode (string) --
    
    The DB engine mode of the DB cluster, either provisioned, serverless, or parallelquery.
  - ScalingConfigurationInfo (dict) --
    
    Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.
    
    For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.
    - MinCapacity (integer) --
      
      The maximum capacity for the 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) --
      
      A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.
    - 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).
  - DeletionProtection (boolean) --
    
    Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when this value is set to true.
  - HttpEndpointEnabled (boolean) --
    
    Note
    
    HTTP endpoint functionality is in beta for Aurora Serverless and is subject to change.
    
    Value that is true if the HTTP endpoint for an Aurora Serverless DB cluster is enabled and false otherwise.
    
    When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
    
    For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

RestoreDBClusterFromS3 (updated)

Link ¶
Changes (response)

{'DBCluster': {'HttpEndpointEnabled': 'boolean'}}

Creates an Amazon Aurora DB cluster from 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 to an Amazon Aurora MySQL DB Cluster in the Amazon Aurora User Guide.

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
)

type AvailabilityZones:

list

param AvailabilityZones:

A list of EC2 Availability Zones that instances in the restored DB cluster can be created in.

(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 is 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, default.aurora5.6 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: mySubnetgroup

type Engine:

string

param Engine:

[REQUIRED]

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

Valid Values: aurora, aurora-postgresql

type EngineVersion:

string

param EngineVersion:

The version number of the database engine to use.

Aurora MySQL

Example: 5.6.10a

Aurora PostgreSQL

Example: 9.6.3

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:

[REQUIRED]

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.

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.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred Maintenance 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, 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 AWS 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.
- 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 AWS KMS key identifier for an encrypted DB cluster.

If the StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

type EnableIAMDatabaseAuthentication:

boolean

param EnableIAMDatabaseAuthentication:

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

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 version 5.5 and 5.6 are supported.

Example: 5.6.22

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

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. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

(string) --

type DeletionProtection:

boolean

param DeletionProtection:

Indicates if the DB cluster should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.

rtype:

dict

returns:

Response Syntax

{
    'DBCluster': {
        'AllocatedStorage': 123,
        'AvailabilityZones': [
            'string',
        ],
        'BackupRetentionPeriod': 123,
        'CharacterSetName': 'string',
        'DatabaseName': 'string',
        'DBClusterIdentifier': 'string',
        'DBClusterParameterGroup': 'string',
        'DBSubnetGroup': 'string',
        'Status': 'string',
        '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
        },
        'DeletionProtection': True|False,
        'HttpEndpointEnabled': True|False
    }
}

Response Structure

(dict) --
- DBCluster (dict) --
  
  Contains the details of an Amazon Aurora DB cluster.
  
  This data type is used as a response element in the DescribeDBClusters, StopDBCluster, and StartDBCluster actions.
  - 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 is not fixed, but instead automatically adjusts as needed.
  - AvailabilityZones (list) --
    
    Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
    - (string) --
  - BackupRetentionPeriod (integer) --
    
    Specifies 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) --
    
    Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.
  - DBClusterIdentifier (string) --
    
    Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
  - DBClusterParameterGroup (string) --
    
    Specifies the name of the DB cluster parameter group for the DB cluster.
  - DBSubnetGroup (string) --
    
    Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
  - Status (string) --
    
    Specifies the current state of this DB cluster.
  - PercentProgress (string) --
    
    Specifies 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) --
    
    Specifies 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) --
    
    Identifies all custom endpoints associated with the cluster.
    - (string) --
  - MultiAZ (boolean) --
    
    Specifies whether the DB cluster has instances in multiple Availability Zones.
  - Engine (string) --
    
    Provides the name of the database engine to be used for this DB cluster.
  - EngineVersion (string) --
    
    Indicates the database engine version.
  - LatestRestorableTime (datetime) --
    
    Specifies the latest time to which a database can be restored with point-in-time restore.
  - Port (integer) --
    
    Specifies the port that the database engine is listening on.
  - MasterUsername (string) --
    
    Contains the master username for the DB cluster.
  - DBClusterOptionGroupMemberships (list) --
    
    Provides 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) --
    
    Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
  - PreferredMaintenanceWindow (string) --
    
    Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
  - ReplicationSourceIdentifier (string) --
    
    Contains 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) --
    
    Provides the list of instances that make up the DB cluster.
    - (dict) --
      
      Contains information about an instance that is part of a DB cluster.
      - DBInstanceIdentifier (string) --
        
        Specifies the instance identifier for this member of the DB cluster.
      - IsClusterWriter (boolean) --
        
        Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
      - 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) --
    
    Provides a 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 status of the VPC security group.
  - HostedZoneId (string) --
    
    Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
  - StorageEncrypted (boolean) --
    
    Specifies whether the DB cluster is encrypted.
  - KmsKeyId (string) --
    
    If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster.
  - DbClusterResourceId (string) --
    
    The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
  - DBClusterArn (string) --
    
    The Amazon Resource Name (ARN) for the DB cluster.
  - AssociatedRoles (list) --
    
    Provides a list of the AWS 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 AWS services on your behalf.
    - (dict) --
      
      Describes an AWS 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 AWS 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 AWS services on your behalf.
      - FeatureName (string) --
  - IAMDatabaseAuthenticationEnabled (boolean) --
    
    True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
  - CloneGroupId (string) --
    
    Identifies the clone group to which the DB cluster is associated.
  - ClusterCreateTime (datetime) --
    
    Specifies 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) --
  - EngineMode (string) --
    
    The DB engine mode of the DB cluster, either provisioned, serverless, or parallelquery.
  - ScalingConfigurationInfo (dict) --
    
    Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.
    
    For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.
    - MinCapacity (integer) --
      
      The maximum capacity for the 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) --
      
      A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.
    - 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).
  - DeletionProtection (boolean) --
    
    Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when this value is set to true.
  - HttpEndpointEnabled (boolean) --
    
    Note
    
    HTTP endpoint functionality is in beta for Aurora Serverless and is subject to change.
    
    Value that is true if the HTTP endpoint for an Aurora Serverless DB cluster is enabled and false otherwise.
    
    When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
    
    For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

RestoreDBClusterFromSnapshot (updated)

Link ¶
Changes (response)

{'DBCluster': {'HttpEndpointEnabled': 'boolean'}}

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

If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.

If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora 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
    },
    DBClusterParameterGroupName='string',
    DeletionProtection=True|False
)

type AvailabilityZones:

list

param AvailabilityZones:

Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.

(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

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.

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

type EngineVersion:

string

param EngineVersion:

The version of the database engine to use for the new DB cluster.

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.

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: mySubnetgroup

type DatabaseName:

string

param DatabaseName:

The database name for the restored DB cluster.

type OptionGroupName:

string

param OptionGroupName:

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

type VpcSecurityGroupIds:

list

param VpcSecurityGroupIds:

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

(string) --

type Tags:

list

param Tags:

The tags to be assigned to the restored DB cluster.

(dict) --

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
- 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 AWS KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

If 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 is not encrypted, then the restored DB cluster is not encrypted.

type EnableIAMDatabaseAuthentication:

boolean

param EnableIAMDatabaseAuthentication:

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

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

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. For more information, 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, serverless, or parallelquery.

type ScalingConfiguration:

dict

param ScalingConfiguration:

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

MinCapacity (integer) --

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

Valid capacity values are 2, 4, 8, 16, 32, 64, 128, and 256.

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.

Valid capacity values are 2, 4, 8, 16, 32, 64, 128, and 256.

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

A value that specifies 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.

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.

type DeletionProtection:

boolean

param DeletionProtection:

Indicates if the DB cluster should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.

rtype:

dict

returns:

Response Syntax

{
    'DBCluster': {
        'AllocatedStorage': 123,
        'AvailabilityZones': [
            'string',
        ],
        'BackupRetentionPeriod': 123,
        'CharacterSetName': 'string',
        'DatabaseName': 'string',
        'DBClusterIdentifier': 'string',
        'DBClusterParameterGroup': 'string',
        'DBSubnetGroup': 'string',
        'Status': 'string',
        '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
        },
        'DeletionProtection': True|False,
        'HttpEndpointEnabled': True|False
    }
}

Response Structure

(dict) --
- DBCluster (dict) --
  
  Contains the details of an Amazon Aurora DB cluster.
  
  This data type is used as a response element in the DescribeDBClusters, StopDBCluster, and StartDBCluster actions.
  - 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 is not fixed, but instead automatically adjusts as needed.
  - AvailabilityZones (list) --
    
    Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
    - (string) --
  - BackupRetentionPeriod (integer) --
    
    Specifies 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) --
    
    Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.
  - DBClusterIdentifier (string) --
    
    Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
  - DBClusterParameterGroup (string) --
    
    Specifies the name of the DB cluster parameter group for the DB cluster.
  - DBSubnetGroup (string) --
    
    Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
  - Status (string) --
    
    Specifies the current state of this DB cluster.
  - PercentProgress (string) --
    
    Specifies 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) --
    
    Specifies 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) --
    
    Identifies all custom endpoints associated with the cluster.
    - (string) --
  - MultiAZ (boolean) --
    
    Specifies whether the DB cluster has instances in multiple Availability Zones.
  - Engine (string) --
    
    Provides the name of the database engine to be used for this DB cluster.
  - EngineVersion (string) --
    
    Indicates the database engine version.
  - LatestRestorableTime (datetime) --
    
    Specifies the latest time to which a database can be restored with point-in-time restore.
  - Port (integer) --
    
    Specifies the port that the database engine is listening on.
  - MasterUsername (string) --
    
    Contains the master username for the DB cluster.
  - DBClusterOptionGroupMemberships (list) --
    
    Provides 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) --
    
    Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
  - PreferredMaintenanceWindow (string) --
    
    Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
  - ReplicationSourceIdentifier (string) --
    
    Contains 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) --
    
    Provides the list of instances that make up the DB cluster.
    - (dict) --
      
      Contains information about an instance that is part of a DB cluster.
      - DBInstanceIdentifier (string) --
        
        Specifies the instance identifier for this member of the DB cluster.
      - IsClusterWriter (boolean) --
        
        Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
      - 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) --
    
    Provides a 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 status of the VPC security group.
  - HostedZoneId (string) --
    
    Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
  - StorageEncrypted (boolean) --
    
    Specifies whether the DB cluster is encrypted.
  - KmsKeyId (string) --
    
    If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster.
  - DbClusterResourceId (string) --
    
    The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
  - DBClusterArn (string) --
    
    The Amazon Resource Name (ARN) for the DB cluster.
  - AssociatedRoles (list) --
    
    Provides a list of the AWS 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 AWS services on your behalf.
    - (dict) --
      
      Describes an AWS 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 AWS 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 AWS services on your behalf.
      - FeatureName (string) --
  - IAMDatabaseAuthenticationEnabled (boolean) --
    
    True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
  - CloneGroupId (string) --
    
    Identifies the clone group to which the DB cluster is associated.
  - ClusterCreateTime (datetime) --
    
    Specifies 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) --
  - EngineMode (string) --
    
    The DB engine mode of the DB cluster, either provisioned, serverless, or parallelquery.
  - ScalingConfigurationInfo (dict) --
    
    Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.
    
    For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.
    - MinCapacity (integer) --
      
      The maximum capacity for the 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) --
      
      A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.
    - 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).
  - DeletionProtection (boolean) --
    
    Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when this value is set to true.
  - HttpEndpointEnabled (boolean) --
    
    Note
    
    HTTP endpoint functionality is in beta for Aurora Serverless and is subject to change.
    
    Value that is true if the HTTP endpoint for an Aurora Serverless DB cluster is enabled and false otherwise.
    
    When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
    
    For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

RestoreDBClusterToPointInTime (updated)

Link ¶
Changes (response)

{'DBCluster': {'HttpEndpointEnabled': 'boolean'}}

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.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora 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
)

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

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.

Constraints: You can't specify copy-on-write if the engine version of the source DB cluster is earlier than 1.11.

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

type SourceDBClusterIdentifier:

string

param SourceDBClusterIdentifier:

[REQUIRED]

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

Constraints:

Must match the identifier of an existing DBCluster.

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 is not provided
Can't be specified if UseLatestRestorableTime parameter is true
Can't be specified if RestoreType parameter is copy-on-write

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

type UseLatestRestorableTime:

boolean

param UseLatestRestorableTime:

A value that is set to true to restore the DB cluster to the latest restorable backup time, and false otherwise.

Default: false

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

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.

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: mySubnetgroup

type OptionGroupName:

string

param OptionGroupName:

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

type VpcSecurityGroupIds:

list

param VpcSecurityGroupIds:

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

(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.
- 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 AWS 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 than 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 is not encrypted, then the restored DB cluster is not encrypted.

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

type EnableIAMDatabaseAuthentication:

boolean

param EnableIAMDatabaseAuthentication:

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

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

type EnableCloudwatchLogsExports:

list

param EnableCloudwatchLogsExports:

(string) --

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

type DeletionProtection:

boolean

param DeletionProtection:

Indicates if the DB cluster should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.

rtype:

dict

returns:

Response Syntax

{
    'DBCluster': {
        'AllocatedStorage': 123,
        'AvailabilityZones': [
            'string',
        ],
        'BackupRetentionPeriod': 123,
        'CharacterSetName': 'string',
        'DatabaseName': 'string',
        'DBClusterIdentifier': 'string',
        'DBClusterParameterGroup': 'string',
        'DBSubnetGroup': 'string',
        'Status': 'string',
        '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
        },
        'DeletionProtection': True|False,
        'HttpEndpointEnabled': True|False
    }
}

Response Structure

(dict) --
- DBCluster (dict) --
  
  Contains the details of an Amazon Aurora DB cluster.
  
  This data type is used as a response element in the DescribeDBClusters, StopDBCluster, and StartDBCluster actions.
  - 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 is not fixed, but instead automatically adjusts as needed.
  - AvailabilityZones (list) --
    
    Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
    - (string) --
  - BackupRetentionPeriod (integer) --
    
    Specifies 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) --
    
    Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.
  - DBClusterIdentifier (string) --
    
    Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
  - DBClusterParameterGroup (string) --
    
    Specifies the name of the DB cluster parameter group for the DB cluster.
  - DBSubnetGroup (string) --
    
    Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
  - Status (string) --
    
    Specifies the current state of this DB cluster.
  - PercentProgress (string) --
    
    Specifies 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) --
    
    Specifies 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) --
    
    Identifies all custom endpoints associated with the cluster.
    - (string) --
  - MultiAZ (boolean) --
    
    Specifies whether the DB cluster has instances in multiple Availability Zones.
  - Engine (string) --
    
    Provides the name of the database engine to be used for this DB cluster.
  - EngineVersion (string) --
    
    Indicates the database engine version.
  - LatestRestorableTime (datetime) --
    
    Specifies the latest time to which a database can be restored with point-in-time restore.
  - Port (integer) --
    
    Specifies the port that the database engine is listening on.
  - MasterUsername (string) --
    
    Contains the master username for the DB cluster.
  - DBClusterOptionGroupMemberships (list) --
    
    Provides 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) --
    
    Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
  - PreferredMaintenanceWindow (string) --
    
    Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
  - ReplicationSourceIdentifier (string) --
    
    Contains 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) --
    
    Provides the list of instances that make up the DB cluster.
    - (dict) --
      
      Contains information about an instance that is part of a DB cluster.
      - DBInstanceIdentifier (string) --
        
        Specifies the instance identifier for this member of the DB cluster.
      - IsClusterWriter (boolean) --
        
        Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
      - 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) --
    
    Provides a 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 status of the VPC security group.
  - HostedZoneId (string) --
    
    Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
  - StorageEncrypted (boolean) --
    
    Specifies whether the DB cluster is encrypted.
  - KmsKeyId (string) --
    
    If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster.
  - DbClusterResourceId (string) --
    
    The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
  - DBClusterArn (string) --
    
    The Amazon Resource Name (ARN) for the DB cluster.
  - AssociatedRoles (list) --
    
    Provides a list of the AWS 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 AWS services on your behalf.
    - (dict) --
      
      Describes an AWS 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 AWS 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 AWS services on your behalf.
      - FeatureName (string) --
  - IAMDatabaseAuthenticationEnabled (boolean) --
    
    True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
  - CloneGroupId (string) --
    
    Identifies the clone group to which the DB cluster is associated.
  - ClusterCreateTime (datetime) --
    
    Specifies 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) --
  - EngineMode (string) --
    
    The DB engine mode of the DB cluster, either provisioned, serverless, or parallelquery.
  - ScalingConfigurationInfo (dict) --
    
    Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.
    
    For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.
    - MinCapacity (integer) --
      
      The maximum capacity for the 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) --
      
      A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.
    - 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).
  - DeletionProtection (boolean) --
    
    Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when this value is set to true.
  - HttpEndpointEnabled (boolean) --
    
    Note
    
    HTTP endpoint functionality is in beta for Aurora Serverless and is subject to change.
    
    Value that is true if the HTTP endpoint for an Aurora Serverless DB cluster is enabled and false otherwise.
    
    When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
    
    For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

StartDBCluster (updated)

Link ¶
Changes (response)

{'DBCluster': {'HttpEndpointEnabled': 'boolean'}}

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

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

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',
        '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
        },
        'DeletionProtection': True|False,
        'HttpEndpointEnabled': True|False
    }
}

Response Structure

(dict) --
- DBCluster (dict) --
  
  Contains the details of an Amazon Aurora DB cluster.
  
  This data type is used as a response element in the DescribeDBClusters, StopDBCluster, and StartDBCluster actions.
  - 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 is not fixed, but instead automatically adjusts as needed.
  - AvailabilityZones (list) --
    
    Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
    - (string) --
  - BackupRetentionPeriod (integer) --
    
    Specifies 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) --
    
    Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.
  - DBClusterIdentifier (string) --
    
    Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
  - DBClusterParameterGroup (string) --
    
    Specifies the name of the DB cluster parameter group for the DB cluster.
  - DBSubnetGroup (string) --
    
    Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
  - Status (string) --
    
    Specifies the current state of this DB cluster.
  - PercentProgress (string) --
    
    Specifies 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) --
    
    Specifies 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) --
    
    Identifies all custom endpoints associated with the cluster.
    - (string) --
  - MultiAZ (boolean) --
    
    Specifies whether the DB cluster has instances in multiple Availability Zones.
  - Engine (string) --
    
    Provides the name of the database engine to be used for this DB cluster.
  - EngineVersion (string) --
    
    Indicates the database engine version.
  - LatestRestorableTime (datetime) --
    
    Specifies the latest time to which a database can be restored with point-in-time restore.
  - Port (integer) --
    
    Specifies the port that the database engine is listening on.
  - MasterUsername (string) --
    
    Contains the master username for the DB cluster.
  - DBClusterOptionGroupMemberships (list) --
    
    Provides 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) --
    
    Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
  - PreferredMaintenanceWindow (string) --
    
    Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
  - ReplicationSourceIdentifier (string) --
    
    Contains 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) --
    
    Provides the list of instances that make up the DB cluster.
    - (dict) --
      
      Contains information about an instance that is part of a DB cluster.
      - DBInstanceIdentifier (string) --
        
        Specifies the instance identifier for this member of the DB cluster.
      - IsClusterWriter (boolean) --
        
        Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
      - 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) --
    
    Provides a 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 status of the VPC security group.
  - HostedZoneId (string) --
    
    Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
  - StorageEncrypted (boolean) --
    
    Specifies whether the DB cluster is encrypted.
  - KmsKeyId (string) --
    
    If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster.
  - DbClusterResourceId (string) --
    
    The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
  - DBClusterArn (string) --
    
    The Amazon Resource Name (ARN) for the DB cluster.
  - AssociatedRoles (list) --
    
    Provides a list of the AWS 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 AWS services on your behalf.
    - (dict) --
      
      Describes an AWS 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 AWS 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 AWS services on your behalf.
      - FeatureName (string) --
  - IAMDatabaseAuthenticationEnabled (boolean) --
    
    True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
  - CloneGroupId (string) --
    
    Identifies the clone group to which the DB cluster is associated.
  - ClusterCreateTime (datetime) --
    
    Specifies 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) --
  - EngineMode (string) --
    
    The DB engine mode of the DB cluster, either provisioned, serverless, or parallelquery.
  - ScalingConfigurationInfo (dict) --
    
    Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.
    
    For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.
    - MinCapacity (integer) --
      
      The maximum capacity for the 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) --
      
      A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.
    - 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).
  - DeletionProtection (boolean) --
    
    Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when this value is set to true.
  - HttpEndpointEnabled (boolean) --
    
    Note
    
    HTTP endpoint functionality is in beta for Aurora Serverless and is subject to change.
    
    Value that is true if the HTTP endpoint for an Aurora Serverless DB cluster is enabled and false otherwise.
    
    When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
    
    For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

StopDBCluster (updated)

Link ¶
Changes (response)

{'DBCluster': {'HttpEndpointEnabled': 'boolean'}}

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.

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',
        '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
        },
        'DeletionProtection': True|False,
        'HttpEndpointEnabled': True|False
    }
}

Response Structure

(dict) --
- DBCluster (dict) --
  
  Contains the details of an Amazon Aurora DB cluster.
  
  This data type is used as a response element in the DescribeDBClusters, StopDBCluster, and StartDBCluster actions.
  - 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 is not fixed, but instead automatically adjusts as needed.
  - AvailabilityZones (list) --
    
    Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
    - (string) --
  - BackupRetentionPeriod (integer) --
    
    Specifies 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) --
    
    Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.
  - DBClusterIdentifier (string) --
    
    Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
  - DBClusterParameterGroup (string) --
    
    Specifies the name of the DB cluster parameter group for the DB cluster.
  - DBSubnetGroup (string) --
    
    Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
  - Status (string) --
    
    Specifies the current state of this DB cluster.
  - PercentProgress (string) --
    
    Specifies 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) --
    
    Specifies 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) --
    
    Identifies all custom endpoints associated with the cluster.
    - (string) --
  - MultiAZ (boolean) --
    
    Specifies whether the DB cluster has instances in multiple Availability Zones.
  - Engine (string) --
    
    Provides the name of the database engine to be used for this DB cluster.
  - EngineVersion (string) --
    
    Indicates the database engine version.
  - LatestRestorableTime (datetime) --
    
    Specifies the latest time to which a database can be restored with point-in-time restore.
  - Port (integer) --
    
    Specifies the port that the database engine is listening on.
  - MasterUsername (string) --
    
    Contains the master username for the DB cluster.
  - DBClusterOptionGroupMemberships (list) --
    
    Provides 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) --
    
    Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
  - PreferredMaintenanceWindow (string) --
    
    Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
  - ReplicationSourceIdentifier (string) --
    
    Contains 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) --
    
    Provides the list of instances that make up the DB cluster.
    - (dict) --
      
      Contains information about an instance that is part of a DB cluster.
      - DBInstanceIdentifier (string) --
        
        Specifies the instance identifier for this member of the DB cluster.
      - IsClusterWriter (boolean) --
        
        Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
      - 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) --
    
    Provides a 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 status of the VPC security group.
  - HostedZoneId (string) --
    
    Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
  - StorageEncrypted (boolean) --
    
    Specifies whether the DB cluster is encrypted.
  - KmsKeyId (string) --
    
    If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster.
  - DbClusterResourceId (string) --
    
    The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
  - DBClusterArn (string) --
    
    The Amazon Resource Name (ARN) for the DB cluster.
  - AssociatedRoles (list) --
    
    Provides a list of the AWS 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 AWS services on your behalf.
    - (dict) --
      
      Describes an AWS 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 AWS 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 AWS services on your behalf.
      - FeatureName (string) --
  - IAMDatabaseAuthenticationEnabled (boolean) --
    
    True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
  - CloneGroupId (string) --
    
    Identifies the clone group to which the DB cluster is associated.
  - ClusterCreateTime (datetime) --
    
    Specifies 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) --
  - EngineMode (string) --
    
    The DB engine mode of the DB cluster, either provisioned, serverless, or parallelquery.
  - ScalingConfigurationInfo (dict) --
    
    Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.
    
    For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.
    - MinCapacity (integer) --
      
      The maximum capacity for the 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) --
      
      A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.
    - 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).
  - DeletionProtection (boolean) --
    
    Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when this value is set to true.
  - HttpEndpointEnabled (boolean) --
    
    Note
    
    HTTP endpoint functionality is in beta for Aurora Serverless and is subject to change.
    
    Value that is true if the HTTP endpoint for an Aurora Serverless DB cluster is enabled and false otherwise.
    
    When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
    
    For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.