AWS API Changes

2017/06/13 - Amazon Relational Database Service - 10 updated api methods

Changes API Update for RDS: this update enables copy-on-write, a new Aurora MySQL Compatible Edition feature that allows users to restore their database, and support copy of TDE enabled snapshot cross region.

CopyDBSnapshot (updated)

Link ¶
Changes (request)

{'OptionGroupName': 'string'}

Copies the specified DB snapshot. The source DB snapshot must be in the "available" state.

You can copy a snapshot from one AWS region to another. In that case, the region where you call the CopyDBSnapshot action is the destination region for the DB snapshot copy.

You cannot copy an encrypted, shared DB snapshot from one AWS region to another.

For more information about copying snapshots, see Copying a DB Snapshot in the Amazon RDS User Guide.

See also: AWS API Documentation

Request Syntax

client.copy_db_snapshot(
    SourceDBSnapshotIdentifier='string',
    TargetDBSnapshotIdentifier='string',
    KmsKeyId='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    CopyTags=True|False,
    PreSignedUrl='string',
    OptionGroupName='string',
    SourceRegion='string'
)

type SourceDBSnapshotIdentifier

string

param SourceDBSnapshotIdentifier

[REQUIRED]

The identifier for the source DB snapshot.

If the source snapshot is in the same region as the copy, specify a valid DB snapshot identifier. For example, rds:mysql-instance1-snapshot-20130805 .

If the source snapshot is in a different region than the copy, specify a valid DB snapshot ARN. For example, arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805 .

If you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot.

If you are copying an encrypted snapshot this parameter must be in the ARN format for the source region, and must match the SourceDBSnapshotIdentifier in the PreSignedUrl parameter.

Constraints:

Must specify a valid system snapshot in the "available" state.

Example: rds:mydb-2012-04-02-00-01

Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805

type TargetDBSnapshotIdentifier

string

param TargetDBSnapshotIdentifier

[REQUIRED]

The identifier for the copy of the snapshot.

Constraints:

Cannot be null, empty, or blank
Must contain from 1 to 255 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens

Example: my-db-snapshot

type KmsKeyId

string

param KmsKeyId

The AWS KMS key ID for an encrypted DB snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

If you copy an encrypted DB snapshot from your AWS account, you can specify a value for this parameter to encrypt the copy with a new KMS encryption key. If you don't specify a value for this parameter, then the copy of the DB snapshot is encrypted with the same KMS key as the source DB snapshot.

If you copy an encrypted DB snapshot that is shared from another AWS account, then you must specify a value for this parameter.

If you specify this parameter when you copy an unencrypted snapshot, the copy is encrypted.

If you copy an encrypted snapshot to a different AWS region, then you must specify a KMS key for the destination AWS region. KMS encryption keys are specific to the region that they are created in, and you cannot use encryption keys from one region in another region.

type Tags

list

param Tags

A list of tags.

(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 cannot 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 cannot 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 CopyTags

boolean

param CopyTags

True to copy all tags from the source DB snapshot to the target DB snapshot; otherwise false. The default is false.

type PreSignedUrl

string

param PreSignedUrl

The URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API action in the source AWS region that contains the source DB snapshot to copy.

You must specify this parameter when you copy an encrypted DB snapshot from another AWS region by using the Amazon RDS API. You can specify the source region option instead of this parameter when you copy an encrypted DB snapshot from another AWS region by using the AWS CLI.

The presigned URL must be a valid request for the CopyDBSnapshot API action that can be executed in the source region that contains the encrypted DB snapshot to be copied. The presigned URL request must contain the following parameter values:

DestinationRegion - The AWS Region that the encrypted DB snapshot will be copied to. This region is the same one where the CopyDBSnapshot action is called that contains this presigned URL. For example, if you copy an encrypted DB snapshot from the us-west-2 region to the us-east-1 region, then you will call the CopyDBSnapshot action in the us-east-1 region and provide a presigned URL that contains a call to the CopyDBSnapshot action in the us-west-2 region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 region.
KmsKeyId - The KMS key identifier for the key to use to encrypt the copy of the DB snapshot in the destination region. This is the same identifier for both the CopyDBSnapshot action that is called in the destination region, and the action contained in the presigned URL.
SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source region. For example, if you are copying an encrypted DB snapshot from the us-west-2 region, then your SourceDBSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115 .

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.

Note

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

type OptionGroupName

string

param OptionGroupName

The name of an option group to associate with the copy.

Specify this option if you are copying a snapshot from one AWS region to another, and your DB instance uses a non-default option group. If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, you must specify this option when copying across regions. For more information, see Option Group Considerations.

type SourceRegion

string

param SourceRegion

The ID of the region that contains the snapshot to be copied.

rtype

dict

returns

Response Syntax

{
    'DBSnapshot': {
        'DBSnapshotIdentifier': 'string',
        'DBInstanceIdentifier': 'string',
        'SnapshotCreateTime': datetime(2015, 1, 1),
        'Engine': 'string',
        'AllocatedStorage': 123,
        'Status': 'string',
        'Port': 123,
        'AvailabilityZone': 'string',
        'VpcId': 'string',
        'InstanceCreateTime': datetime(2015, 1, 1),
        'MasterUsername': 'string',
        'EngineVersion': 'string',
        'LicenseModel': 'string',
        'SnapshotType': 'string',
        'Iops': 123,
        'OptionGroupName': 'string',
        'PercentProgress': 123,
        'SourceRegion': 'string',
        'SourceDBSnapshotIdentifier': 'string',
        'StorageType': 'string',
        'TdeCredentialArn': 'string',
        'Encrypted': True|False,
        'KmsKeyId': 'string',
        'DBSnapshotArn': 'string',
        'Timezone': 'string',
        'IAMDatabaseAuthenticationEnabled': True|False
    }
}

Response Structure

(dict) --
- DBSnapshot (dict) --
  
  Contains the result of a successful invocation of the following actions:
  - CreateDBSnapshot
  - DeleteDBSnapshot
  This data type is used as a response element in the DescribeDBSnapshots action.
  - DBSnapshotIdentifier (string) --
    
    Specifies the identifier for the DB snapshot.
  - DBInstanceIdentifier (string) --
    
    Specifies the DB instance identifier of the DB instance this DB snapshot was created from.
  - SnapshotCreateTime (datetime) --
    
    Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
  - Engine (string) --
    
    Specifies the name of the database engine.
  - AllocatedStorage (integer) --
    
    Specifies the allocated storage size in gigabytes (GB).
  - Status (string) --
    
    Specifies the status of this DB snapshot.
  - Port (integer) --
    
    Specifies the port that the database engine was listening on at the time of the snapshot.
  - AvailabilityZone (string) --
    
    Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
  - VpcId (string) --
    
    Provides the VPC ID associated with the DB snapshot.
  - InstanceCreateTime (datetime) --
    
    Specifies the time when the snapshot was taken, in Universal Coordinated Time (UTC).
  - MasterUsername (string) --
    
    Provides the master username for the DB snapshot.
  - EngineVersion (string) --
    
    Specifies the version of the database engine.
  - LicenseModel (string) --
    
    License model information for the restored DB instance.
  - SnapshotType (string) --
    
    Provides the type of the DB snapshot.
  - Iops (integer) --
    
    Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
  - OptionGroupName (string) --
    
    Provides the option group name for the DB snapshot.
  - PercentProgress (integer) --
    
    The percentage of the estimated data that has been transferred.
  - SourceRegion (string) --
    
    The region that the DB snapshot was created in or copied from.
  - SourceDBSnapshotIdentifier (string) --
    
    The DB snapshot Arn that the DB snapshot was copied from. It only has value in case of cross customer or cross region copy.
  - StorageType (string) --
    
    Specifies the storage type associated with DB snapshot.
  - TdeCredentialArn (string) --
    
    The ARN from the key store with which to associate the instance for TDE encryption.
  - Encrypted (boolean) --
    
    Specifies whether the DB snapshot is encrypted.
  - KmsKeyId (string) --
    
    If Encrypted is true, the KMS key identifier for the encrypted DB snapshot.
  - DBSnapshotArn (string) --
    
    The Amazon Resource Name (ARN) for the DB snapshot.
  - Timezone (string) --
    
    The time zone of the DB snapshot. In most cases, the Timezone element is empty. Timezone content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.
  - IAMDatabaseAuthenticationEnabled (boolean) --
    
    True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled; otherwise false.

CreateDBCluster (updated)

Link ¶
Changes (response)

{'DBCluster': {'CloneGroupId': 'string'}}

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

See also: AWS API Documentation

Request Syntax

client.create_db_cluster(
    AvailabilityZones=[
        'string',
    ],
    BackupRetentionPeriod=123,
    CharacterSetName='string',
    DatabaseName='string',
    DBClusterIdentifier='string',
    DBClusterParameterGroupName='string',
    VpcSecurityGroupIds=[
        'string',
    ],
    DBSubnetGroupName='string',
    Engine='string',
    EngineVersion='string',
    Port=123,
    MasterUsername='string',
    MasterUserPassword='string',
    OptionGroupName='string',
    PreferredBackupWindow='string',
    PreferredMaintenanceWindow='string',
    ReplicationSourceIdentifier='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    StorageEncrypted=True|False,
    KmsKeyId='string',
    PreSignedUrl='string',
    EnableIAMDatabaseAuthentication=True|False,
    SourceRegion='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 regions and Availability Zones, see Regions and Availability Zones.

(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 alphanumeric characters or hyphens.
First character must be a letter.
Cannot 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 will be used.

Constraints:

Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens

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 contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. 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

type EngineVersion

string

param EngineVersion

The version number of the database engine to use.

Aurora

Example: 5.6.10a

type Port

integer

param Port

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

Default: 3306

type MasterUsername

string

param MasterUsername

The name of the master user for the DB cluster.

Constraints:

Must be 1 to 16 alphanumeric characters.
First character must be a letter.
Cannot 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 cannot be removed from an option group. The option group cannot 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.

Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

Constraints:

Must be in the format hh24:mi-hh24:mi .
Times should 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

Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS 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.

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

If you create a Read Replica of an encrypted DB cluster in another region, you must set KmsKeyId to a KMS key ID that is valid in the destination region. This key is used to encrypt the Read Replica in that 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 region where the DB cluster will be 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 region that contains the encrypted DB cluster to be copied.

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

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

Note

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

type EnableIAMDatabaseAuthentication

boolean

param EnableIAMDatabaseAuthentication

A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

type SourceRegion

string

param SourceRegion

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

rtype

dict

returns

Response Syntax

{
    'DBCluster': {
        'AllocatedStorage': 123,
        'AvailabilityZones': [
            'string',
        ],
        'BackupRetentionPeriod': 123,
        'CharacterSetName': 'string',
        'DatabaseName': 'string',
        'DBClusterIdentifier': 'string',
        'DBClusterParameterGroup': 'string',
        'DBSubnetGroup': 'string',
        'Status': 'string',
        'PercentProgress': 'string',
        'EarliestRestorableTime': datetime(2015, 1, 1),
        'Endpoint': 'string',
        'ReaderEndpoint': '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'
            },
        ],
        'IAMDatabaseAuthenticationEnabled': True|False,
        'CloneGroupId': 'string',
        'ClusterCreateTime': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) --
- DBCluster (dict) --
  
  Contains the result of a successful invocation of the following actions:
  - CreateDBCluster
  - DeleteDBCluster
  - FailoverDBCluster
  - ModifyDBCluster
  - RestoreDBClusterFromSnapshot
  - RestoreDBClusterToPointInTime
  This data type is used as a response element in the DescribeDBClusters action.
  - AllocatedStorage (integer) --
    
    For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gigabytes (GB). 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) --
    
    Specifies 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 will be dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
  - 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.
  - 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 KMS key identifier for the encrypted DB cluster.
  - DbClusterResourceId (string) --
    
    The region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
  - DBClusterArn (string) --
    
    The Amazon Resource Name (ARN) for the DB cluster.
  - AssociatedRoles (list) --
    
    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.
  - IAMDatabaseAuthenticationEnabled (boolean) --
    
    True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled; 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).

DeleteDBCluster (updated)

Link ¶
Changes (response)

{'DBCluster': {'CloneGroupId': 'string'}}

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

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS 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 contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens

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.

Note

You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is false .

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 .

Note

Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.

Constraints:

Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot 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',
        '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'
            },
        ],
        'IAMDatabaseAuthenticationEnabled': True|False,
        'CloneGroupId': 'string',
        'ClusterCreateTime': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) --
- DBCluster (dict) --
  
  Contains the result of a successful invocation of the following actions:
  - CreateDBCluster
  - DeleteDBCluster
  - FailoverDBCluster
  - ModifyDBCluster
  - RestoreDBClusterFromSnapshot
  - RestoreDBClusterToPointInTime
  This data type is used as a response element in the DescribeDBClusters action.
  - AllocatedStorage (integer) --
    
    For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gigabytes (GB). 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) --
    
    Specifies 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 will be dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
  - 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.
  - 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 KMS key identifier for the encrypted DB cluster.
  - DbClusterResourceId (string) --
    
    The region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
  - DBClusterArn (string) --
    
    The Amazon Resource Name (ARN) for the DB cluster.
  - AssociatedRoles (list) --
    
    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.
  - IAMDatabaseAuthenticationEnabled (boolean) --
    
    True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled; 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).

DescribeDBClusters (updated)

Link ¶
Changes (response)

{'DBClusters': {'CloneGroupId': 'string'}}

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

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS 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:

Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens

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

This type is not currently supported.
- Name (string) -- [REQUIRED]
  
  This parameter is not currently supported.
- Values (list) -- [REQUIRED]
  
  This parameter is not currently supported.
  - (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 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',
            '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'
                },
            ],
            'IAMDatabaseAuthenticationEnabled': True|False,
            'CloneGroupId': 'string',
            'ClusterCreateTime': datetime(2015, 1, 1)
        },
    ]
}

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 result of a successful invocation of the following actions:
    - CreateDBCluster
    - DeleteDBCluster
    - FailoverDBCluster
    - ModifyDBCluster
    - RestoreDBClusterFromSnapshot
    - RestoreDBClusterToPointInTime
    This data type is used as a response element in the DescribeDBClusters action.
    - AllocatedStorage (integer) --
      
      For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gigabytes (GB). 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) --
      
      Specifies 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 will be dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
    - 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.
    - 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 KMS key identifier for the encrypted DB cluster.
    - DbClusterResourceId (string) --
      
      The region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
    - DBClusterArn (string) --
      
      The Amazon Resource Name (ARN) for the DB cluster.
    - AssociatedRoles (list) --
      
      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.
    - IAMDatabaseAuthenticationEnabled (boolean) --
      
      True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled; 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).

FailoverDBCluster (updated)

Link ¶
Changes (response)

{'DBCluster': {'CloneGroupId': 'string'}}

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

See also: AWS API Documentation

Request Syntax

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

type DBClusterIdentifier

string

param DBClusterIdentifier

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

Constraints:

Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens

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',
        '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'
            },
        ],
        'IAMDatabaseAuthenticationEnabled': True|False,
        'CloneGroupId': 'string',
        'ClusterCreateTime': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) --
- DBCluster (dict) --
  
  Contains the result of a successful invocation of the following actions:
  - CreateDBCluster
  - DeleteDBCluster
  - FailoverDBCluster
  - ModifyDBCluster
  - RestoreDBClusterFromSnapshot
  - RestoreDBClusterToPointInTime
  This data type is used as a response element in the DescribeDBClusters action.
  - AllocatedStorage (integer) --
    
    For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gigabytes (GB). 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) --
    
    Specifies 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 will be dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
  - 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.
  - 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 KMS key identifier for the encrypted DB cluster.
  - DbClusterResourceId (string) --
    
    The region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
  - DBClusterArn (string) --
    
    The Amazon Resource Name (ARN) for the DB cluster.
  - AssociatedRoles (list) --
    
    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.
  - IAMDatabaseAuthenticationEnabled (boolean) --
    
    True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled; 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).

ModifyDBCluster (updated)

Link ¶
Changes (response)

{'DBCluster': {'CloneGroupId': 'string'}}

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

See also: AWS API Documentation

Request Syntax

client.modify_db_cluster(
    DBClusterIdentifier='string',
    NewDBClusterIdentifier='string',
    ApplyImmediately=True|False,
    BackupRetentionPeriod=123,
    DBClusterParameterGroupName='string',
    VpcSecurityGroupIds=[
        'string',
    ],
    Port=123,
    MasterUserPassword='string',
    OptionGroupName='string',
    PreferredBackupWindow='string',
    PreferredMaintenanceWindow='string',
    EnableIAMDatabaseAuthentication=True|False
)

type DBClusterIdentifier

string

param DBClusterIdentifier

[REQUIRED]

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

Constraints:

Must be the identifier for an existing DB cluster.
Must contain from 1 to 63 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.

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 alphanumeric characters or hyphens
First character must be a letter
Cannot 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 NewDBClusterIdentifier and MasterUserPassword values. If you set the ApplyImmediately parameter value to false, then changes to the NewDBClusterIdentifier and MasterUserPassword 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 does not 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 cannot be removed from an option group. The option group cannot 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 .
Times should 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

A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: 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',
        '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'
            },
        ],
        'IAMDatabaseAuthenticationEnabled': True|False,
        'CloneGroupId': 'string',
        'ClusterCreateTime': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) --
- DBCluster (dict) --
  
  Contains the result of a successful invocation of the following actions:
  - CreateDBCluster
  - DeleteDBCluster
  - FailoverDBCluster
  - ModifyDBCluster
  - RestoreDBClusterFromSnapshot
  - RestoreDBClusterToPointInTime
  This data type is used as a response element in the DescribeDBClusters action.
  - AllocatedStorage (integer) --
    
    For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gigabytes (GB). 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) --
    
    Specifies 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 will be dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
  - 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.
  - 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 KMS key identifier for the encrypted DB cluster.
  - DbClusterResourceId (string) --
    
    The region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
  - DBClusterArn (string) --
    
    The Amazon Resource Name (ARN) for the DB cluster.
  - AssociatedRoles (list) --
    
    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.
  - IAMDatabaseAuthenticationEnabled (boolean) --
    
    True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled; 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).

PromoteReadReplicaDBCluster (updated)

Link ¶
Changes (response)

{'DBCluster': {'CloneGroupId': 'string'}}

Promotes a Read Replica DB cluster to a standalone DB cluster.

See also: AWS API Documentation

Request Syntax

client.promote_read_replica_db_cluster(
    DBClusterIdentifier='string'
)

type DBClusterIdentifier

string

param DBClusterIdentifier

[REQUIRED]

The identifier of the DB cluster Read Replica to promote. This parameter is not case-sensitive.

Constraints:

Must contain from 1 to 63 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.

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',
        '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'
            },
        ],
        'IAMDatabaseAuthenticationEnabled': True|False,
        'CloneGroupId': 'string',
        'ClusterCreateTime': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) --
- DBCluster (dict) --
  
  Contains the result of a successful invocation of the following actions:
  - CreateDBCluster
  - DeleteDBCluster
  - FailoverDBCluster
  - ModifyDBCluster
  - RestoreDBClusterFromSnapshot
  - RestoreDBClusterToPointInTime
  This data type is used as a response element in the DescribeDBClusters action.
  - AllocatedStorage (integer) --
    
    For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gigabytes (GB). 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) --
    
    Specifies 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 will be dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
  - 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.
  - 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 KMS key identifier for the encrypted DB cluster.
  - DbClusterResourceId (string) --
    
    The region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
  - DBClusterArn (string) --
    
    The Amazon Resource Name (ARN) for the DB cluster.
  - AssociatedRoles (list) --
    
    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.
  - IAMDatabaseAuthenticationEnabled (boolean) --
    
    True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled; 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).

RestoreDBClusterFromS3 (updated)

Link ¶
Changes (response)

{'DBCluster': {'CloneGroupId': 'string'}}

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 from MySQL by Using an Amazon S3 Bucket.

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

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 S3 bucket. This parameter is isn't case-sensitive.

Constraints:

Must contain from 1 to 63 alphanumeric characters or hyphens.
First character must be a letter.
Cannot 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 will be used.

Constraints:

Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens

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: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.

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

type EngineVersion

string

param EngineVersion

The version number of the database engine to use.

Aurora

Example: 5.6.10a

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 alphanumeric characters.
First character must be a letter.
Cannot 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 cannot be removed from an option group. An option group cannot 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 .
Times should 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 Tags

list

param Tags

A list of tags.

(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 cannot 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 cannot 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 KMS key identifier for an encrypted DB cluster.

type EnableIAMDatabaseAuthentication

boolean

param EnableIAMDatabaseAuthentication

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

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',
        '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'
            },
        ],
        'IAMDatabaseAuthenticationEnabled': True|False,
        'CloneGroupId': 'string',
        'ClusterCreateTime': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) --
- DBCluster (dict) --
  
  Contains the result of a successful invocation of the following actions:
  - CreateDBCluster
  - DeleteDBCluster
  - FailoverDBCluster
  - ModifyDBCluster
  - RestoreDBClusterFromSnapshot
  - RestoreDBClusterToPointInTime
  This data type is used as a response element in the DescribeDBClusters action.
  - AllocatedStorage (integer) --
    
    For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gigabytes (GB). 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) --
    
    Specifies 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 will be dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
  - 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.
  - 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 KMS key identifier for the encrypted DB cluster.
  - DbClusterResourceId (string) --
    
    The region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
  - DBClusterArn (string) --
    
    The Amazon Resource Name (ARN) for the DB cluster.
  - AssociatedRoles (list) --
    
    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.
  - IAMDatabaseAuthenticationEnabled (boolean) --
    
    True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled; 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).

RestoreDBClusterFromSnapshot (updated)

Link ¶
Changes (response)

{'DBCluster': {'CloneGroupId': 'string'}}

Creates a new DB cluster from a DB cluster snapshot. 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 Aurora on Amazon RDS in the Amazon RDS User Guide.

See also: AWS API Documentation

Request Syntax

client.restore_db_cluster_from_snapshot(
    AvailabilityZones=[
        'string',
    ],
    DBClusterIdentifier='string',
    SnapshotIdentifier='string',
    Engine='string',
    EngineVersion='string',
    Port=123,
    DBSubnetGroupName='string',
    DatabaseName='string',
    OptionGroupName='string',
    VpcSecurityGroupIds=[
        'string',
    ],
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    KmsKeyId='string',
    EnableIAMDatabaseAuthentication=True|False
)

type AvailabilityZones

list

param AvailabilityZones

Provides the list of 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 cluster snapshot. This parameter isn't case-sensitive.

Constraints:

Must contain from 1 to 255 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

type SnapshotIdentifier

string

param SnapshotIdentifier

[REQUIRED]

The identifier for the DB cluster snapshot to restore from.

Constraints:

Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens

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: 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: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.

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 cannot 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 cannot 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 KMS key identifier to use when restoring an encrypted DB cluster from a 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 do not specify a value for the KmsKeyId parameter, then the following will occur:

If the DB cluster snapshot is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB cluster snapshot.
If the DB cluster snapshot is not encrypted, then the restored DB cluster is encrypted using the specified encryption key.

type EnableIAMDatabaseAuthentication

boolean

param EnableIAMDatabaseAuthentication

A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: 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',
        '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'
            },
        ],
        'IAMDatabaseAuthenticationEnabled': True|False,
        'CloneGroupId': 'string',
        'ClusterCreateTime': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) --
- DBCluster (dict) --
  
  Contains the result of a successful invocation of the following actions:
  - CreateDBCluster
  - DeleteDBCluster
  - FailoverDBCluster
  - ModifyDBCluster
  - RestoreDBClusterFromSnapshot
  - RestoreDBClusterToPointInTime
  This data type is used as a response element in the DescribeDBClusters action.
  - AllocatedStorage (integer) --
    
    For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gigabytes (GB). 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) --
    
    Specifies 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 will be dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
  - 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.
  - 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 KMS key identifier for the encrypted DB cluster.
  - DbClusterResourceId (string) --
    
    The region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
  - DBClusterArn (string) --
    
    The Amazon Resource Name (ARN) for the DB cluster.
  - AssociatedRoles (list) --
    
    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.
  - IAMDatabaseAuthenticationEnabled (boolean) --
    
    True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled; 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).

RestoreDBClusterToPointInTime (updated)

Link ¶
Changes (request, response)
Request

{'RestoreType': 'string'}

Response

{'DBCluster': {'CloneGroupId': 'string'}}

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

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

See also: AWS API Documentation

Request Syntax

client.restore_db_cluster_to_point_in_time(
    DBClusterIdentifier='string',
    RestoreType='string',
    SourceDBClusterIdentifier='string',
    RestoreToTime=datetime(2015, 1, 1),
    UseLatestRestorableTime=True|False,
    Port=123,
    DBSubnetGroupName='string',
    OptionGroupName='string',
    VpcSecurityGroupIds=[
        'string',
    ],
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    KmsKeyId='string',
    EnableIAMDatabaseAuthentication=True|False
)

type DBClusterIdentifier

string

param DBClusterIdentifier

[REQUIRED]

The name of the new DB cluster to be created.

Constraints:

Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot 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 cannot 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 be the identifier of an existing database instance
Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens

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
Cannot be specified if UseLatestRestorableTime parameter is true
Cannot 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: Cannot be specified if RestoreToTime parameter is provided.

type Port

integer

param Port

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

Constraints: Value must be 1150-65535

Default: The same port as the original DB cluster.

type DBSubnetGroupName

string

param DBSubnetGroupName

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

Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.

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.

(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 cannot 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 cannot 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 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 will be encrypted with the KMS key identified by the KmsKeyId parameter.

If you do not specify a value for the KmsKeyId parameter, then the following will occur:

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

A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: 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',
        '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'
            },
        ],
        'IAMDatabaseAuthenticationEnabled': True|False,
        'CloneGroupId': 'string',
        'ClusterCreateTime': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) --
- DBCluster (dict) --
  
  Contains the result of a successful invocation of the following actions:
  - CreateDBCluster
  - DeleteDBCluster
  - FailoverDBCluster
  - ModifyDBCluster
  - RestoreDBClusterFromSnapshot
  - RestoreDBClusterToPointInTime
  This data type is used as a response element in the DescribeDBClusters action.
  - AllocatedStorage (integer) --
    
    For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gigabytes (GB). 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) --
    
    Specifies 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 will be dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
  - 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.
  - 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 KMS key identifier for the encrypted DB cluster.
  - DbClusterResourceId (string) --
    
    The region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
  - DBClusterArn (string) --
    
    The Amazon Resource Name (ARN) for the DB cluster.
  - AssociatedRoles (list) --
    
    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.
  - IAMDatabaseAuthenticationEnabled (boolean) --
    
    True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled; 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).