2025/10/15 - Amazon DocumentDB with MongoDB compatibility - 17 updated api methods
Changes Add support for NetworkType field in CreateDbCluster, ModifyDbCluster, RestoreDbClusterFromSnapshot and RestoreDbClusterToPointInTime for DocumentDB.
{'NetworkType': 'string'}
Response {'DBCluster': {'IOOptimizedNextAllowedModificationTime': 'timestamp',
'NetworkType': 'string'}}
Creates a new Amazon DocumentDB cluster.
See also: AWS API Documentation
Request Syntax
client.create_db_cluster(
AvailabilityZones=[
'string',
],
BackupRetentionPeriod=123,
DBClusterIdentifier='string',
DBClusterParameterGroupName='string',
VpcSecurityGroupIds=[
'string',
],
DBSubnetGroupName='string',
Engine='string',
EngineVersion='string',
Port=123,
MasterUsername='string',
MasterUserPassword='string',
PreferredBackupWindow='string',
PreferredMaintenanceWindow='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
StorageEncrypted=True|False,
KmsKeyId='string',
PreSignedUrl='string',
EnableCloudwatchLogsExports=[
'string',
],
DeletionProtection=True|False,
GlobalClusterIdentifier='string',
StorageType='string',
ServerlessV2ScalingConfiguration={
'MinCapacity': 123.0,
'MaxCapacity': 123.0
},
ManageMasterUserPassword=True|False,
MasterUserSecretKmsKeyId='string',
NetworkType='string'
)
list
A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
(string) --
integer
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.
string
[REQUIRED]
The cluster identifier. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: my-cluster
string
The name of the cluster parameter group to associate with this cluster.
list
A list of EC2 VPC security groups to associate with this cluster.
(string) --
string
A subnet group to associate with this cluster.
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example: mySubnetgroup
string
[REQUIRED]
The name of the database engine to be used for this cluster.
Valid values: docdb
string
The version number of the database engine to use. The --engine-version will default to the latest major engine version. For production workloads, we recommend explicitly declaring this parameter with the intended major engine version.
integer
The port number on which the instances in the cluster accept connections.
string
The name of the master user for the cluster.
Constraints:
Must be from 1 to 63 letters or numbers.
The first character must be a letter.
Cannot be a reserved word for the chosen database engine.
string
The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).
Constraints: Must contain from 8 to 100 characters.
string
The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region.
Constraints:
Must be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
string
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
list
The tags to be assigned to the cluster.
(dict) --
Metadata assigned to an Amazon DocumentDB resource consisting of a key-value pair.
Key (string) --
The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with " aws:" or " rds:". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
Value (string) --
The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with " aws:" or " rds:". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
boolean
Specifies whether the cluster is encrypted.
string
The KMS key identifier for an encrypted cluster.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon Web Services account that owns the KMS encryption key that is used to encrypt the new cluster, you can use the KMS key alias instead of the ARN for the KMS encryption key.
If an encryption key is not specified in KmsKeyId:
If the StorageEncrypted parameter is true, Amazon DocumentDB uses your default encryption key.
KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Regions.
string
Not currently supported.
list
A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs. You can enable audit logs or profiler logs. For more information, see Auditing Amazon DocumentDB Events and Profiling Amazon DocumentDB Operations.
(string) --
boolean
Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.
string
The cluster identifier of the new global cluster.
string
The storage type to associate with the DB cluster.
For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.
Valid values for storage type - standard | iopt1
Default value is standard
dict
Contains the scaling configuration of an Amazon DocumentDB Serverless cluster.
MinCapacity (float) --
The minimum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster. You can specify DCU values in half-step increments, such as 8, 8.5, 9, and so on.
MaxCapacity (float) --
The maximum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster. You can specify DCU values in half-step increments, such as 32, 32.5, 33, and so on.
boolean
Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
Constraint: You can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.
string
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager. This setting is valid only if the master user password is managed by Amazon DocumentDB in Amazon Web Services Secrets Manager for the DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If you don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
string
The network type of the cluster.
The network type is determined by the DBSubnetGroup specified for the cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols ( DUAL).
For more information, see DocumentDB clusters in a VPC in the Amazon DocumentDB Developer Guide.
Valid Values: IPV4 | DUAL
dict
Response Syntax
{
'DBCluster': {
'AvailabilityZones': [
'string',
],
'BackupRetentionPeriod': 123,
'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',
'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'
},
],
'CloneGroupId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'EnabledCloudwatchLogsExports': [
'string',
],
'DeletionProtection': True|False,
'IOOptimizedNextAllowedModificationTime': datetime(2015, 1, 1),
'StorageType': 'string',
'ServerlessV2ScalingConfiguration': {
'MinCapacity': 123.0,
'MaxCapacity': 123.0
},
'MasterUserSecret': {
'SecretArn': 'string',
'SecretStatus': 'string',
'KmsKeyId': 'string'
},
'NetworkType': 'string'
}
}
Response Structure
(dict) --
DBCluster (dict) --
Detailed information about a cluster.
AvailabilityZones (list) --
Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
(string) --
BackupRetentionPeriod (integer) --
Specifies the number of days for which automatic snapshots are retained.
DBClusterIdentifier (string) --
Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.
DBClusterParameterGroup (string) --
Specifies the name of the cluster parameter group for the cluster.
DBSubnetGroup (string) --
Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.
Status (string) --
Specifies the current state of this cluster.
PercentProgress (string) --
Specifies the progress of the operation as a percentage.
EarliestRestorableTime (datetime) --
The earliest time to which a database can be restored with point-in-time restore.
Endpoint (string) --
Specifies the connection endpoint for the primary instance of the cluster.
ReaderEndpoint (string) --
The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.
If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.
MultiAZ (boolean) --
Specifies whether the cluster has instances in multiple Availability Zones.
Engine (string) --
Provides the name of the database engine to be used for this 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 user name for the cluster.
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 cluster if this cluster is a secondary cluster.
ReadReplicaIdentifiers (list) --
Contains one or more identifiers of the secondary clusters that are associated with this cluster.
(string) --
DBClusterMembers (list) --
Provides the list of instances that make up the cluster.
(dict) --
Contains information about an instance that is part of a cluster.
DBInstanceIdentifier (string) --
Specifies the instance identifier for this member of the cluster.
IsClusterWriter (boolean) --
A value that is true if the cluster member is the primary instance for the cluster and false otherwise.
DBClusterParameterGroupStatus (string) --
Specifies the status of the cluster parameter group for this member of the DB cluster.
PromotionTier (integer) --
A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
VpcSecurityGroups (list) --
Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.
(dict) --
Used as a response element for queries on virtual private cloud (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 cluster is encrypted.
KmsKeyId (string) --
If StorageEncrypted is true, the KMS key identifier for the encrypted cluster.
DbClusterResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the cluster. This identifier is found in CloudTrail log entries whenever the KMS key for the cluster is accessed.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for the cluster.
AssociatedRoles (list) --
Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.
(dict) --
Describes an Identity and Access Management (IAM) role that is associated with a cluster.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAMrole that is associated with the DB cluster.
Status (string) --
Describes the state of association between the IAMrole and the cluster. The Status property returns one of the following values:
ACTIVE - The IAMrole ARN is associated with the cluster and can be used to access other Amazon Web Services services on your behalf.
PENDING - The IAMrole ARN is being associated with the cluster.
INVALID - The IAMrole ARN is associated with the cluster, but the cluster cannot assume the IAMrole to access other Amazon Web Services services on your behalf.
CloneGroupId (string) --
Identifies the clone group to which the DB cluster is associated.
ClusterCreateTime (datetime) --
Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
EnabledCloudwatchLogsExports (list) --
A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.
(string) --
DeletionProtection (boolean) --
Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.
IOOptimizedNextAllowedModificationTime (datetime) --
The next time you can modify the Amazon DocumentDB cluster to use the iopt1 storage type.
StorageType (string) --
Storage type associated with your cluster
For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.
Valid values for storage type - standard | iopt1
Default value is standard
ServerlessV2ScalingConfiguration (dict) --
The scaling configuration of an Amazon DocumentDB Serverless cluster.
MinCapacity (float) --
The minimum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster. You can specify DCU values in half-step increments, such as 8, 8.5, 9, and so on.
MaxCapacity (float) --
The maximum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster. You can specify DCU values in half-step increments, such as 32, 32.5, 33, and so on.
MasterUserSecret (dict) --
The secret managed by Amazon DocumentDB in Amazon Web Services Secrets Manager for the master user password.
SecretArn (string) --
The Amazon Resource Name (ARN) of the secret.
SecretStatus (string) --
The status of the secret.
The possible status values include the following:
creating - The secret is being created.
active - The secret is available for normal use and rotation.
rotating - The secret is being rotated.
impaired - The secret can be used to access database credentials, but it can't be rotated. A secret might have this status if, for example, permissions are changed so that Amazon DocumentDB can no longer access either the secret or the KMS key for the secret. When a secret has this status, you can correct the condition that caused the status. Alternatively, modify the instance to turn off automatic management of database credentials, and then modify the instance again to turn on automatic management of database credentials.
KmsKeyId (string) --
The Amazon Web Services KMS key identifier that is used to encrypt the secret.
NetworkType (string) --
The network type of the cluster.
The network type is determined by the DBSubnetGroup specified for the cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols ( DUAL).
For more information, see DocumentDB clusters in a VPC in the Amazon DocumentDB Developer Guide.
Valid Values: IPV4 | DUAL
{'DBInstance': {'DBSubnetGroup': {'SupportedNetworkTypes': ['string']}}}
Creates a new instance.
See also: AWS API Documentation
Request Syntax
client.create_db_instance(
DBInstanceIdentifier='string',
DBInstanceClass='string',
Engine='string',
AvailabilityZone='string',
PreferredMaintenanceWindow='string',
AutoMinorVersionUpgrade=True|False,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
DBClusterIdentifier='string',
CopyTagsToSnapshot=True|False,
PromotionTier=123,
EnablePerformanceInsights=True|False,
PerformanceInsightsKMSKeyId='string',
CACertificateIdentifier='string'
)
string
[REQUIRED]
The instance identifier. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
string
[REQUIRED]
The compute and memory capacity of the instance; for example, db.r5.large.
string
[REQUIRED]
The name of the database engine to be used for this instance.
Valid value: docdb
string
The Amazon EC2 Availability Zone that the instance is created in.
Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.
Example: us-east-1d
string
The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
boolean
This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.
Default: false
list
The tags to be assigned to the instance. You can assign up to 10 tags to an instance.
(dict) --
Metadata assigned to an Amazon DocumentDB resource consisting of a key-value pair.
Key (string) --
The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with " aws:" or " rds:". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
Value (string) --
The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with " aws:" or " rds:". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
string
[REQUIRED]
The identifier of the cluster that the instance will belong to.
boolean
A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
integer
A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
Default: 1
Valid values: 0-15
boolean
A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights.
string
The KMS key identifier for encryption of Performance Insights data.
The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services region.
string
The CA certificate identifier to use for the DB instance's server certificate.
For more information, see Updating Your Amazon DocumentDB TLS Certificates and Encrypting Data in Transit in the Amazon DocumentDB Developer Guide.
dict
Response Syntax
{
'DBInstance': {
'DBInstanceIdentifier': 'string',
'DBInstanceClass': 'string',
'Engine': 'string',
'DBInstanceStatus': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123,
'HostedZoneId': 'string'
},
'InstanceCreateTime': datetime(2015, 1, 1),
'PreferredBackupWindow': 'string',
'BackupRetentionPeriod': 123,
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'AvailabilityZone': 'string',
'DBSubnetGroup': {
'DBSubnetGroupName': 'string',
'DBSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetStatus': 'string'
},
],
'DBSubnetGroupArn': 'string',
'SupportedNetworkTypes': [
'string',
]
},
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'DBInstanceClass': 'string',
'AllocatedStorage': 123,
'MasterUserPassword': 'string',
'Port': 123,
'BackupRetentionPeriod': 123,
'MultiAZ': True|False,
'EngineVersion': 'string',
'LicenseModel': 'string',
'Iops': 123,
'DBInstanceIdentifier': 'string',
'StorageType': 'string',
'CACertificateIdentifier': 'string',
'DBSubnetGroupName': 'string',
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
}
},
'LatestRestorableTime': datetime(2015, 1, 1),
'EngineVersion': 'string',
'AutoMinorVersionUpgrade': True|False,
'PubliclyAccessible': True|False,
'StatusInfos': [
{
'StatusType': 'string',
'Normal': True|False,
'Status': 'string',
'Message': 'string'
},
],
'DBClusterIdentifier': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbiResourceId': 'string',
'CACertificateIdentifier': 'string',
'CopyTagsToSnapshot': True|False,
'PromotionTier': 123,
'DBInstanceArn': 'string',
'EnabledCloudwatchLogsExports': [
'string',
],
'CertificateDetails': {
'CAIdentifier': 'string',
'ValidTill': datetime(2015, 1, 1)
},
'PerformanceInsightsEnabled': True|False,
'PerformanceInsightsKMSKeyId': 'string'
}
}
Response Structure
(dict) --
DBInstance (dict) --
Detailed information about an instance.
DBInstanceIdentifier (string) --
Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.
DBInstanceClass (string) --
Contains the name of the compute and memory capacity class of the instance.
Engine (string) --
Provides the name of the database engine to be used for this instance.
DBInstanceStatus (string) --
Specifies the current state of this database.
Endpoint (dict) --
Specifies the connection endpoint.
Address (string) --
Specifies the DNS address of the instance.
Port (integer) --
Specifies the port that the database engine is listening on.
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
InstanceCreateTime (datetime) --
Provides the date and time that the instance was created.
PreferredBackupWindow (string) --
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
BackupRetentionPeriod (integer) --
Specifies the number of days for which automatic snapshots are retained.
VpcSecurityGroups (list) --
Provides a list of VPC security group elements that the instance belongs to.
(dict) --
Used as a response element for queries on virtual private cloud (VPC) security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The status of the VPC security group.
AvailabilityZone (string) --
Specifies the name of the Availability Zone that the instance is located in.
DBSubnetGroup (dict) --
Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group.
DBSubnetGroupName (string) --
The name of the subnet group.
DBSubnetGroupDescription (string) --
Provides the description of the subnet group.
VpcId (string) --
Provides the virtual private cloud (VPC) ID of the subnet group.
SubnetGroupStatus (string) --
Provides the status of the subnet group.
Subnets (list) --
Detailed information about one or more subnets within a subnet group.
(dict) --
Detailed information about a subnet.
SubnetIdentifier (string) --
Specifies the identifier of the subnet.
SubnetAvailabilityZone (dict) --
Specifies the Availability Zone for the subnet.
Name (string) --
The name of the Availability Zone.
SubnetStatus (string) --
Specifies the status of the subnet.
DBSubnetGroupArn (string) --
The Amazon Resource Name (ARN) for the DB subnet group.
SupportedNetworkTypes (list) --
The network type of the DB subnet group.
Valid Values: IPV4 | DUAL
A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
(string) --
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
PendingModifiedValues (dict) --
Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.
DBInstanceClass (string) --
Contains the new DBInstanceClass for the instance that will be applied or is currently being applied.
AllocatedStorage (integer) --
Contains the new AllocatedStorage size for then instance that will be applied or is currently being applied.
MasterUserPassword (string) --
Contains the pending or currently in-progress change of the master credentials for the instance.
Port (integer) --
Specifies the pending port for the instance.
BackupRetentionPeriod (integer) --
Specifies the pending number of days for which automated backups are retained.
MultiAZ (boolean) --
Indicates that the Single-AZ instance is to change to a Multi-AZ deployment.
EngineVersion (string) --
Indicates the database engine version.
LicenseModel (string) --
The license model for the instance.
Valid values: license-included, bring-your-own-license, general-public-license
Iops (integer) --
Specifies the new Provisioned IOPS value for the instance that will be applied or is currently being applied.
DBInstanceIdentifier (string) --
Contains the new DBInstanceIdentifier for the instance that will be applied or is currently being applied.
StorageType (string) --
Specifies the storage type to be associated with the instance.
CACertificateIdentifier (string) --
Specifies the identifier of the certificate authority (CA) certificate for the DB instance.
DBSubnetGroupName (string) --
The new subnet group for the instance.
PendingCloudwatchLogsExports (dict) --
A list of the log types whose configuration is still pending. These log types are in the process of being activated or deactivated.
LogTypesToEnable (list) --
Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.
(string) --
LogTypesToDisable (list) --
Log types that are in the process of being enabled. After they are enabled, these log types are exported to Amazon CloudWatch Logs.
(string) --
LatestRestorableTime (datetime) --
Specifies the latest time to which a database can be restored with point-in-time restore.
EngineVersion (string) --
Indicates the database engine version.
AutoMinorVersionUpgrade (boolean) --
Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.
PubliclyAccessible (boolean) --
Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false.
StatusInfos (list) --
The status of a read replica. If the instance is not a read replica, this is blank.
(dict) --
Provides a list of status information for an instance.
StatusType (string) --
This value is currently " read replication."
Normal (boolean) --
A Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.
Status (string) --
Status of the instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.
Message (string) --
Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.
DBClusterIdentifier (string) --
Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.
StorageEncrypted (boolean) --
Specifies whether or not the instance is encrypted.
KmsKeyId (string) --
If StorageEncrypted is true, the KMS key identifier for the encrypted instance.
DbiResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the instance. This identifier is found in CloudTrail log entries whenever the KMS key for the instance is accessed.
CACertificateIdentifier (string) --
The identifier of the CA certificate for this DB instance.
CopyTagsToSnapshot (boolean) --
A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
PromotionTier (integer) --
A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
DBInstanceArn (string) --
The Amazon Resource Name (ARN) for the instance.
EnabledCloudwatchLogsExports (list) --
A list of log types that this instance is configured to export to CloudWatch Logs.
(string) --
CertificateDetails (dict) --
The details of the DB instance's server certificate.
CAIdentifier (string) --
The CA identifier of the CA certificate used for the DB instance's server certificate.
ValidTill (datetime) --
The expiration date of the DB instance’s server certificate.
PerformanceInsightsEnabled (boolean) --
Set to true if Amazon RDS Performance Insights is enabled for the DB instance, and otherwise false.
PerformanceInsightsKMSKeyId (string) --
The KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
{'DBSubnetGroup': {'SupportedNetworkTypes': ['string']}}
Creates a new subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Amazon Web Services Region.
See also: AWS API Documentation
Request Syntax
client.create_db_subnet_group(
DBSubnetGroupName='string',
DBSubnetGroupDescription='string',
SubnetIds=[
'string',
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The name for the subnet group. This value is stored as a lowercase string.
Constraints: Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. Must not be default.
Example: mySubnetgroup
string
[REQUIRED]
The description for the subnet group.
list
[REQUIRED]
The Amazon EC2 subnet IDs for the subnet group.
(string) --
list
The tags to be assigned to the subnet group.
(dict) --
Metadata assigned to an Amazon DocumentDB resource consisting of a key-value pair.
Key (string) --
The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with " aws:" or " rds:". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
Value (string) --
The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with " aws:" or " rds:". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
dict
Response Syntax
{
'DBSubnetGroup': {
'DBSubnetGroupName': 'string',
'DBSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetStatus': 'string'
},
],
'DBSubnetGroupArn': 'string',
'SupportedNetworkTypes': [
'string',
]
}
}
Response Structure
(dict) --
DBSubnetGroup (dict) --
Detailed information about a subnet group.
DBSubnetGroupName (string) --
The name of the subnet group.
DBSubnetGroupDescription (string) --
Provides the description of the subnet group.
VpcId (string) --
Provides the virtual private cloud (VPC) ID of the subnet group.
SubnetGroupStatus (string) --
Provides the status of the subnet group.
Subnets (list) --
Detailed information about one or more subnets within a subnet group.
(dict) --
Detailed information about a subnet.
SubnetIdentifier (string) --
Specifies the identifier of the subnet.
SubnetAvailabilityZone (dict) --
Specifies the Availability Zone for the subnet.
Name (string) --
The name of the Availability Zone.
SubnetStatus (string) --
Specifies the status of the subnet.
DBSubnetGroupArn (string) --
The Amazon Resource Name (ARN) for the DB subnet group.
SupportedNetworkTypes (list) --
The network type of the DB subnet group.
Valid Values: IPV4 | DUAL
A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
(string) --
{'DBCluster': {'IOOptimizedNextAllowedModificationTime': 'timestamp',
'NetworkType': 'string'}}
Deletes a previously provisioned cluster. When you delete a cluster, all automated backups for that cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified cluster are not deleted.
See also: AWS API Documentation
Request Syntax
client.delete_db_cluster(
DBClusterIdentifier='string',
SkipFinalSnapshot=True|False,
FinalDBSnapshotIdentifier='string'
)
string
[REQUIRED]
The cluster identifier for the cluster to be deleted. This parameter isn't case sensitive.
Constraints:
Must match an existing DBClusterIdentifier.
boolean
Determines whether a final cluster snapshot is created before the cluster is deleted. If true is specified, no cluster snapshot is created. If false is specified, a cluster snapshot is created before the DB cluster is deleted.
Default: false
string
The cluster snapshot identifier of the new cluster snapshot created when SkipFinalSnapshot is set to false.
Constraints:
Must be from 1 to 255 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
dict
Response Syntax
{
'DBCluster': {
'AvailabilityZones': [
'string',
],
'BackupRetentionPeriod': 123,
'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',
'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'
},
],
'CloneGroupId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'EnabledCloudwatchLogsExports': [
'string',
],
'DeletionProtection': True|False,
'IOOptimizedNextAllowedModificationTime': datetime(2015, 1, 1),
'StorageType': 'string',
'ServerlessV2ScalingConfiguration': {
'MinCapacity': 123.0,
'MaxCapacity': 123.0
},
'MasterUserSecret': {
'SecretArn': 'string',
'SecretStatus': 'string',
'KmsKeyId': 'string'
},
'NetworkType': 'string'
}
}
Response Structure
(dict) --
DBCluster (dict) --
Detailed information about a cluster.
AvailabilityZones (list) --
Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
(string) --
BackupRetentionPeriod (integer) --
Specifies the number of days for which automatic snapshots are retained.
DBClusterIdentifier (string) --
Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.
DBClusterParameterGroup (string) --
Specifies the name of the cluster parameter group for the cluster.
DBSubnetGroup (string) --
Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.
Status (string) --
Specifies the current state of this cluster.
PercentProgress (string) --
Specifies the progress of the operation as a percentage.
EarliestRestorableTime (datetime) --
The earliest time to which a database can be restored with point-in-time restore.
Endpoint (string) --
Specifies the connection endpoint for the primary instance of the cluster.
ReaderEndpoint (string) --
The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.
If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.
MultiAZ (boolean) --
Specifies whether the cluster has instances in multiple Availability Zones.
Engine (string) --
Provides the name of the database engine to be used for this 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 user name for the cluster.
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 cluster if this cluster is a secondary cluster.
ReadReplicaIdentifiers (list) --
Contains one or more identifiers of the secondary clusters that are associated with this cluster.
(string) --
DBClusterMembers (list) --
Provides the list of instances that make up the cluster.
(dict) --
Contains information about an instance that is part of a cluster.
DBInstanceIdentifier (string) --
Specifies the instance identifier for this member of the cluster.
IsClusterWriter (boolean) --
A value that is true if the cluster member is the primary instance for the cluster and false otherwise.
DBClusterParameterGroupStatus (string) --
Specifies the status of the cluster parameter group for this member of the DB cluster.
PromotionTier (integer) --
A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
VpcSecurityGroups (list) --
Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.
(dict) --
Used as a response element for queries on virtual private cloud (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 cluster is encrypted.
KmsKeyId (string) --
If StorageEncrypted is true, the KMS key identifier for the encrypted cluster.
DbClusterResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the cluster. This identifier is found in CloudTrail log entries whenever the KMS key for the cluster is accessed.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for the cluster.
AssociatedRoles (list) --
Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.
(dict) --
Describes an Identity and Access Management (IAM) role that is associated with a cluster.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAMrole that is associated with the DB cluster.
Status (string) --
Describes the state of association between the IAMrole and the cluster. The Status property returns one of the following values:
ACTIVE - The IAMrole ARN is associated with the cluster and can be used to access other Amazon Web Services services on your behalf.
PENDING - The IAMrole ARN is being associated with the cluster.
INVALID - The IAMrole ARN is associated with the cluster, but the cluster cannot assume the IAMrole to access other Amazon Web Services services on your behalf.
CloneGroupId (string) --
Identifies the clone group to which the DB cluster is associated.
ClusterCreateTime (datetime) --
Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
EnabledCloudwatchLogsExports (list) --
A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.
(string) --
DeletionProtection (boolean) --
Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.
IOOptimizedNextAllowedModificationTime (datetime) --
The next time you can modify the Amazon DocumentDB cluster to use the iopt1 storage type.
StorageType (string) --
Storage type associated with your cluster
For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.
Valid values for storage type - standard | iopt1
Default value is standard
ServerlessV2ScalingConfiguration (dict) --
The scaling configuration of an Amazon DocumentDB Serverless cluster.
MinCapacity (float) --
The minimum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster. You can specify DCU values in half-step increments, such as 8, 8.5, 9, and so on.
MaxCapacity (float) --
The maximum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster. You can specify DCU values in half-step increments, such as 32, 32.5, 33, and so on.
MasterUserSecret (dict) --
The secret managed by Amazon DocumentDB in Amazon Web Services Secrets Manager for the master user password.
SecretArn (string) --
The Amazon Resource Name (ARN) of the secret.
SecretStatus (string) --
The status of the secret.
The possible status values include the following:
creating - The secret is being created.
active - The secret is available for normal use and rotation.
rotating - The secret is being rotated.
impaired - The secret can be used to access database credentials, but it can't be rotated. A secret might have this status if, for example, permissions are changed so that Amazon DocumentDB can no longer access either the secret or the KMS key for the secret. When a secret has this status, you can correct the condition that caused the status. Alternatively, modify the instance to turn off automatic management of database credentials, and then modify the instance again to turn on automatic management of database credentials.
KmsKeyId (string) --
The Amazon Web Services KMS key identifier that is used to encrypt the secret.
NetworkType (string) --
The network type of the cluster.
The network type is determined by the DBSubnetGroup specified for the cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols ( DUAL).
For more information, see DocumentDB clusters in a VPC in the Amazon DocumentDB Developer Guide.
Valid Values: IPV4 | DUAL
{'DBInstance': {'DBSubnetGroup': {'SupportedNetworkTypes': ['string']}}}
Deletes a previously provisioned instance.
See also: AWS API Documentation
Request Syntax
client.delete_db_instance(
DBInstanceIdentifier='string'
)
string
[REQUIRED]
The instance identifier for the instance to be deleted. This parameter isn't case sensitive.
Constraints:
Must match the name of an existing instance.
dict
Response Syntax
{
'DBInstance': {
'DBInstanceIdentifier': 'string',
'DBInstanceClass': 'string',
'Engine': 'string',
'DBInstanceStatus': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123,
'HostedZoneId': 'string'
},
'InstanceCreateTime': datetime(2015, 1, 1),
'PreferredBackupWindow': 'string',
'BackupRetentionPeriod': 123,
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'AvailabilityZone': 'string',
'DBSubnetGroup': {
'DBSubnetGroupName': 'string',
'DBSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetStatus': 'string'
},
],
'DBSubnetGroupArn': 'string',
'SupportedNetworkTypes': [
'string',
]
},
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'DBInstanceClass': 'string',
'AllocatedStorage': 123,
'MasterUserPassword': 'string',
'Port': 123,
'BackupRetentionPeriod': 123,
'MultiAZ': True|False,
'EngineVersion': 'string',
'LicenseModel': 'string',
'Iops': 123,
'DBInstanceIdentifier': 'string',
'StorageType': 'string',
'CACertificateIdentifier': 'string',
'DBSubnetGroupName': 'string',
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
}
},
'LatestRestorableTime': datetime(2015, 1, 1),
'EngineVersion': 'string',
'AutoMinorVersionUpgrade': True|False,
'PubliclyAccessible': True|False,
'StatusInfos': [
{
'StatusType': 'string',
'Normal': True|False,
'Status': 'string',
'Message': 'string'
},
],
'DBClusterIdentifier': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbiResourceId': 'string',
'CACertificateIdentifier': 'string',
'CopyTagsToSnapshot': True|False,
'PromotionTier': 123,
'DBInstanceArn': 'string',
'EnabledCloudwatchLogsExports': [
'string',
],
'CertificateDetails': {
'CAIdentifier': 'string',
'ValidTill': datetime(2015, 1, 1)
},
'PerformanceInsightsEnabled': True|False,
'PerformanceInsightsKMSKeyId': 'string'
}
}
Response Structure
(dict) --
DBInstance (dict) --
Detailed information about an instance.
DBInstanceIdentifier (string) --
Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.
DBInstanceClass (string) --
Contains the name of the compute and memory capacity class of the instance.
Engine (string) --
Provides the name of the database engine to be used for this instance.
DBInstanceStatus (string) --
Specifies the current state of this database.
Endpoint (dict) --
Specifies the connection endpoint.
Address (string) --
Specifies the DNS address of the instance.
Port (integer) --
Specifies the port that the database engine is listening on.
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
InstanceCreateTime (datetime) --
Provides the date and time that the instance was created.
PreferredBackupWindow (string) --
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
BackupRetentionPeriod (integer) --
Specifies the number of days for which automatic snapshots are retained.
VpcSecurityGroups (list) --
Provides a list of VPC security group elements that the instance belongs to.
(dict) --
Used as a response element for queries on virtual private cloud (VPC) security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The status of the VPC security group.
AvailabilityZone (string) --
Specifies the name of the Availability Zone that the instance is located in.
DBSubnetGroup (dict) --
Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group.
DBSubnetGroupName (string) --
The name of the subnet group.
DBSubnetGroupDescription (string) --
Provides the description of the subnet group.
VpcId (string) --
Provides the virtual private cloud (VPC) ID of the subnet group.
SubnetGroupStatus (string) --
Provides the status of the subnet group.
Subnets (list) --
Detailed information about one or more subnets within a subnet group.
(dict) --
Detailed information about a subnet.
SubnetIdentifier (string) --
Specifies the identifier of the subnet.
SubnetAvailabilityZone (dict) --
Specifies the Availability Zone for the subnet.
Name (string) --
The name of the Availability Zone.
SubnetStatus (string) --
Specifies the status of the subnet.
DBSubnetGroupArn (string) --
The Amazon Resource Name (ARN) for the DB subnet group.
SupportedNetworkTypes (list) --
The network type of the DB subnet group.
Valid Values: IPV4 | DUAL
A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
(string) --
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
PendingModifiedValues (dict) --
Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.
DBInstanceClass (string) --
Contains the new DBInstanceClass for the instance that will be applied or is currently being applied.
AllocatedStorage (integer) --
Contains the new AllocatedStorage size for then instance that will be applied or is currently being applied.
MasterUserPassword (string) --
Contains the pending or currently in-progress change of the master credentials for the instance.
Port (integer) --
Specifies the pending port for the instance.
BackupRetentionPeriod (integer) --
Specifies the pending number of days for which automated backups are retained.
MultiAZ (boolean) --
Indicates that the Single-AZ instance is to change to a Multi-AZ deployment.
EngineVersion (string) --
Indicates the database engine version.
LicenseModel (string) --
The license model for the instance.
Valid values: license-included, bring-your-own-license, general-public-license
Iops (integer) --
Specifies the new Provisioned IOPS value for the instance that will be applied or is currently being applied.
DBInstanceIdentifier (string) --
Contains the new DBInstanceIdentifier for the instance that will be applied or is currently being applied.
StorageType (string) --
Specifies the storage type to be associated with the instance.
CACertificateIdentifier (string) --
Specifies the identifier of the certificate authority (CA) certificate for the DB instance.
DBSubnetGroupName (string) --
The new subnet group for the instance.
PendingCloudwatchLogsExports (dict) --
A list of the log types whose configuration is still pending. These log types are in the process of being activated or deactivated.
LogTypesToEnable (list) --
Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.
(string) --
LogTypesToDisable (list) --
Log types that are in the process of being enabled. After they are enabled, these log types are exported to Amazon CloudWatch Logs.
(string) --
LatestRestorableTime (datetime) --
Specifies the latest time to which a database can be restored with point-in-time restore.
EngineVersion (string) --
Indicates the database engine version.
AutoMinorVersionUpgrade (boolean) --
Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.
PubliclyAccessible (boolean) --
Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false.
StatusInfos (list) --
The status of a read replica. If the instance is not a read replica, this is blank.
(dict) --
Provides a list of status information for an instance.
StatusType (string) --
This value is currently " read replication."
Normal (boolean) --
A Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.
Status (string) --
Status of the instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.
Message (string) --
Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.
DBClusterIdentifier (string) --
Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.
StorageEncrypted (boolean) --
Specifies whether or not the instance is encrypted.
KmsKeyId (string) --
If StorageEncrypted is true, the KMS key identifier for the encrypted instance.
DbiResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the instance. This identifier is found in CloudTrail log entries whenever the KMS key for the instance is accessed.
CACertificateIdentifier (string) --
The identifier of the CA certificate for this DB instance.
CopyTagsToSnapshot (boolean) --
A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
PromotionTier (integer) --
A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
DBInstanceArn (string) --
The Amazon Resource Name (ARN) for the instance.
EnabledCloudwatchLogsExports (list) --
A list of log types that this instance is configured to export to CloudWatch Logs.
(string) --
CertificateDetails (dict) --
The details of the DB instance's server certificate.
CAIdentifier (string) --
The CA identifier of the CA certificate used for the DB instance's server certificate.
ValidTill (datetime) --
The expiration date of the DB instance’s server certificate.
PerformanceInsightsEnabled (boolean) --
Set to true if Amazon RDS Performance Insights is enabled for the DB instance, and otherwise false.
PerformanceInsightsKMSKeyId (string) --
The KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
{'DBClusters': {'IOOptimizedNextAllowedModificationTime': 'timestamp',
'NetworkType': 'string'}}
Returns information about provisioned Amazon DocumentDB clusters. This API operation supports pagination. For certain management features such as cluster and instance lifecycle management, Amazon DocumentDB leverages operational technology that is shared with Amazon RDS and Amazon Neptune. Use the filterName=engine,Values=docdb filter parameter to return only Amazon DocumentDB clusters.
See also: AWS API Documentation
Request Syntax
client.describe_db_clusters(
DBClusterIdentifier='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
string
The user-provided cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case sensitive.
Constraints:
If provided, must match an existing DBClusterIdentifier.
list
A filter that specifies one or more clusters to describe.
Supported filters:
db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list only includes information about the clusters identified by these ARNs.
(dict) --
A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.
Wildcards are not supported in filters.
Name (string) -- [REQUIRED]
The name of the filter. Filter names are case sensitive.
Values (list) -- [REQUIRED]
One or more filter values. Filter values are case sensitive.
(string) --
integer
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
string
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
dict
Response Syntax
{
'Marker': 'string',
'DBClusters': [
{
'AvailabilityZones': [
'string',
],
'BackupRetentionPeriod': 123,
'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',
'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'
},
],
'CloneGroupId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'EnabledCloudwatchLogsExports': [
'string',
],
'DeletionProtection': True|False,
'IOOptimizedNextAllowedModificationTime': datetime(2015, 1, 1),
'StorageType': 'string',
'ServerlessV2ScalingConfiguration': {
'MinCapacity': 123.0,
'MaxCapacity': 123.0
},
'MasterUserSecret': {
'SecretArn': 'string',
'SecretStatus': 'string',
'KmsKeyId': 'string'
},
'NetworkType': 'string'
},
]
}
Response Structure
(dict) --
Represents the output of DescribeDBClusters.
Marker (string) --
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
DBClusters (list) --
A list of clusters.
(dict) --
Detailed information about a cluster.
AvailabilityZones (list) --
Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
(string) --
BackupRetentionPeriod (integer) --
Specifies the number of days for which automatic snapshots are retained.
DBClusterIdentifier (string) --
Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.
DBClusterParameterGroup (string) --
Specifies the name of the cluster parameter group for the cluster.
DBSubnetGroup (string) --
Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.
Status (string) --
Specifies the current state of this cluster.
PercentProgress (string) --
Specifies the progress of the operation as a percentage.
EarliestRestorableTime (datetime) --
The earliest time to which a database can be restored with point-in-time restore.
Endpoint (string) --
Specifies the connection endpoint for the primary instance of the cluster.
ReaderEndpoint (string) --
The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.
If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.
MultiAZ (boolean) --
Specifies whether the cluster has instances in multiple Availability Zones.
Engine (string) --
Provides the name of the database engine to be used for this 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 user name for the cluster.
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 cluster if this cluster is a secondary cluster.
ReadReplicaIdentifiers (list) --
Contains one or more identifiers of the secondary clusters that are associated with this cluster.
(string) --
DBClusterMembers (list) --
Provides the list of instances that make up the cluster.
(dict) --
Contains information about an instance that is part of a cluster.
DBInstanceIdentifier (string) --
Specifies the instance identifier for this member of the cluster.
IsClusterWriter (boolean) --
A value that is true if the cluster member is the primary instance for the cluster and false otherwise.
DBClusterParameterGroupStatus (string) --
Specifies the status of the cluster parameter group for this member of the DB cluster.
PromotionTier (integer) --
A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
VpcSecurityGroups (list) --
Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.
(dict) --
Used as a response element for queries on virtual private cloud (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 cluster is encrypted.
KmsKeyId (string) --
If StorageEncrypted is true, the KMS key identifier for the encrypted cluster.
DbClusterResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the cluster. This identifier is found in CloudTrail log entries whenever the KMS key for the cluster is accessed.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for the cluster.
AssociatedRoles (list) --
Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.
(dict) --
Describes an Identity and Access Management (IAM) role that is associated with a cluster.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAMrole that is associated with the DB cluster.
Status (string) --
Describes the state of association between the IAMrole and the cluster. The Status property returns one of the following values:
ACTIVE - The IAMrole ARN is associated with the cluster and can be used to access other Amazon Web Services services on your behalf.
PENDING - The IAMrole ARN is being associated with the cluster.
INVALID - The IAMrole ARN is associated with the cluster, but the cluster cannot assume the IAMrole to access other Amazon Web Services services on your behalf.
CloneGroupId (string) --
Identifies the clone group to which the DB cluster is associated.
ClusterCreateTime (datetime) --
Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
EnabledCloudwatchLogsExports (list) --
A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.
(string) --
DeletionProtection (boolean) --
Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.
IOOptimizedNextAllowedModificationTime (datetime) --
The next time you can modify the Amazon DocumentDB cluster to use the iopt1 storage type.
StorageType (string) --
Storage type associated with your cluster
For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.
Valid values for storage type - standard | iopt1
Default value is standard
ServerlessV2ScalingConfiguration (dict) --
The scaling configuration of an Amazon DocumentDB Serverless cluster.
MinCapacity (float) --
The minimum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster. You can specify DCU values in half-step increments, such as 8, 8.5, 9, and so on.
MaxCapacity (float) --
The maximum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster. You can specify DCU values in half-step increments, such as 32, 32.5, 33, and so on.
MasterUserSecret (dict) --
The secret managed by Amazon DocumentDB in Amazon Web Services Secrets Manager for the master user password.
SecretArn (string) --
The Amazon Resource Name (ARN) of the secret.
SecretStatus (string) --
The status of the secret.
The possible status values include the following:
creating - The secret is being created.
active - The secret is available for normal use and rotation.
rotating - The secret is being rotated.
impaired - The secret can be used to access database credentials, but it can't be rotated. A secret might have this status if, for example, permissions are changed so that Amazon DocumentDB can no longer access either the secret or the KMS key for the secret. When a secret has this status, you can correct the condition that caused the status. Alternatively, modify the instance to turn off automatic management of database credentials, and then modify the instance again to turn on automatic management of database credentials.
KmsKeyId (string) --
The Amazon Web Services KMS key identifier that is used to encrypt the secret.
NetworkType (string) --
The network type of the cluster.
The network type is determined by the DBSubnetGroup specified for the cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols ( DUAL).
For more information, see DocumentDB clusters in a VPC in the Amazon DocumentDB Developer Guide.
Valid Values: IPV4 | DUAL
{'DBInstances': {'DBSubnetGroup': {'SupportedNetworkTypes': ['string']}}}
Returns information about provisioned Amazon DocumentDB instances. This API supports pagination.
See also: AWS API Documentation
Request Syntax
client.describe_db_instances(
DBInstanceIdentifier='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
string
The user-provided instance identifier. If this parameter is specified, information from only the specific instance is returned. This parameter isn't case sensitive.
Constraints:
If provided, must match the identifier of an existing DBInstance.
list
A filter that specifies one or more instances to describe.
Supported filters:
db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list includes only the information about the instances that are associated with the clusters that are identified by these ARNs.
db-instance-id - Accepts instance identifiers and instance ARNs. The results list includes only the information about the instances that are identified by these ARNs.
(dict) --
A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.
Wildcards are not supported in filters.
Name (string) -- [REQUIRED]
The name of the filter. Filter names are case sensitive.
Values (list) -- [REQUIRED]
One or more filter values. Filter values are case sensitive.
(string) --
integer
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
string
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
dict
Response Syntax
{
'Marker': 'string',
'DBInstances': [
{
'DBInstanceIdentifier': 'string',
'DBInstanceClass': 'string',
'Engine': 'string',
'DBInstanceStatus': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123,
'HostedZoneId': 'string'
},
'InstanceCreateTime': datetime(2015, 1, 1),
'PreferredBackupWindow': 'string',
'BackupRetentionPeriod': 123,
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'AvailabilityZone': 'string',
'DBSubnetGroup': {
'DBSubnetGroupName': 'string',
'DBSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetStatus': 'string'
},
],
'DBSubnetGroupArn': 'string',
'SupportedNetworkTypes': [
'string',
]
},
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'DBInstanceClass': 'string',
'AllocatedStorage': 123,
'MasterUserPassword': 'string',
'Port': 123,
'BackupRetentionPeriod': 123,
'MultiAZ': True|False,
'EngineVersion': 'string',
'LicenseModel': 'string',
'Iops': 123,
'DBInstanceIdentifier': 'string',
'StorageType': 'string',
'CACertificateIdentifier': 'string',
'DBSubnetGroupName': 'string',
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
}
},
'LatestRestorableTime': datetime(2015, 1, 1),
'EngineVersion': 'string',
'AutoMinorVersionUpgrade': True|False,
'PubliclyAccessible': True|False,
'StatusInfos': [
{
'StatusType': 'string',
'Normal': True|False,
'Status': 'string',
'Message': 'string'
},
],
'DBClusterIdentifier': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbiResourceId': 'string',
'CACertificateIdentifier': 'string',
'CopyTagsToSnapshot': True|False,
'PromotionTier': 123,
'DBInstanceArn': 'string',
'EnabledCloudwatchLogsExports': [
'string',
],
'CertificateDetails': {
'CAIdentifier': 'string',
'ValidTill': datetime(2015, 1, 1)
},
'PerformanceInsightsEnabled': True|False,
'PerformanceInsightsKMSKeyId': 'string'
},
]
}
Response Structure
(dict) --
Represents the output of DescribeDBInstances.
Marker (string) --
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
DBInstances (list) --
Detailed information about one or more instances.
(dict) --
Detailed information about an instance.
DBInstanceIdentifier (string) --
Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.
DBInstanceClass (string) --
Contains the name of the compute and memory capacity class of the instance.
Engine (string) --
Provides the name of the database engine to be used for this instance.
DBInstanceStatus (string) --
Specifies the current state of this database.
Endpoint (dict) --
Specifies the connection endpoint.
Address (string) --
Specifies the DNS address of the instance.
Port (integer) --
Specifies the port that the database engine is listening on.
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
InstanceCreateTime (datetime) --
Provides the date and time that the instance was created.
PreferredBackupWindow (string) --
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
BackupRetentionPeriod (integer) --
Specifies the number of days for which automatic snapshots are retained.
VpcSecurityGroups (list) --
Provides a list of VPC security group elements that the instance belongs to.
(dict) --
Used as a response element for queries on virtual private cloud (VPC) security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The status of the VPC security group.
AvailabilityZone (string) --
Specifies the name of the Availability Zone that the instance is located in.
DBSubnetGroup (dict) --
Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group.
DBSubnetGroupName (string) --
The name of the subnet group.
DBSubnetGroupDescription (string) --
Provides the description of the subnet group.
VpcId (string) --
Provides the virtual private cloud (VPC) ID of the subnet group.
SubnetGroupStatus (string) --
Provides the status of the subnet group.
Subnets (list) --
Detailed information about one or more subnets within a subnet group.
(dict) --
Detailed information about a subnet.
SubnetIdentifier (string) --
Specifies the identifier of the subnet.
SubnetAvailabilityZone (dict) --
Specifies the Availability Zone for the subnet.
Name (string) --
The name of the Availability Zone.
SubnetStatus (string) --
Specifies the status of the subnet.
DBSubnetGroupArn (string) --
The Amazon Resource Name (ARN) for the DB subnet group.
SupportedNetworkTypes (list) --
The network type of the DB subnet group.
Valid Values: IPV4 | DUAL
A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
(string) --
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
PendingModifiedValues (dict) --
Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.
DBInstanceClass (string) --
Contains the new DBInstanceClass for the instance that will be applied or is currently being applied.
AllocatedStorage (integer) --
Contains the new AllocatedStorage size for then instance that will be applied or is currently being applied.
MasterUserPassword (string) --
Contains the pending or currently in-progress change of the master credentials for the instance.
Port (integer) --
Specifies the pending port for the instance.
BackupRetentionPeriod (integer) --
Specifies the pending number of days for which automated backups are retained.
MultiAZ (boolean) --
Indicates that the Single-AZ instance is to change to a Multi-AZ deployment.
EngineVersion (string) --
Indicates the database engine version.
LicenseModel (string) --
The license model for the instance.
Valid values: license-included, bring-your-own-license, general-public-license
Iops (integer) --
Specifies the new Provisioned IOPS value for the instance that will be applied or is currently being applied.
DBInstanceIdentifier (string) --
Contains the new DBInstanceIdentifier for the instance that will be applied or is currently being applied.
StorageType (string) --
Specifies the storage type to be associated with the instance.
CACertificateIdentifier (string) --
Specifies the identifier of the certificate authority (CA) certificate for the DB instance.
DBSubnetGroupName (string) --
The new subnet group for the instance.
PendingCloudwatchLogsExports (dict) --
A list of the log types whose configuration is still pending. These log types are in the process of being activated or deactivated.
LogTypesToEnable (list) --
Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.
(string) --
LogTypesToDisable (list) --
Log types that are in the process of being enabled. After they are enabled, these log types are exported to Amazon CloudWatch Logs.
(string) --
LatestRestorableTime (datetime) --
Specifies the latest time to which a database can be restored with point-in-time restore.
EngineVersion (string) --
Indicates the database engine version.
AutoMinorVersionUpgrade (boolean) --
Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.
PubliclyAccessible (boolean) --
Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false.
StatusInfos (list) --
The status of a read replica. If the instance is not a read replica, this is blank.
(dict) --
Provides a list of status information for an instance.
StatusType (string) --
This value is currently " read replication."
Normal (boolean) --
A Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.
Status (string) --
Status of the instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.
Message (string) --
Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.
DBClusterIdentifier (string) --
Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.
StorageEncrypted (boolean) --
Specifies whether or not the instance is encrypted.
KmsKeyId (string) --
If StorageEncrypted is true, the KMS key identifier for the encrypted instance.
DbiResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the instance. This identifier is found in CloudTrail log entries whenever the KMS key for the instance is accessed.
CACertificateIdentifier (string) --
The identifier of the CA certificate for this DB instance.
CopyTagsToSnapshot (boolean) --
A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
PromotionTier (integer) --
A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
DBInstanceArn (string) --
The Amazon Resource Name (ARN) for the instance.
EnabledCloudwatchLogsExports (list) --
A list of log types that this instance is configured to export to CloudWatch Logs.
(string) --
CertificateDetails (dict) --
The details of the DB instance's server certificate.
CAIdentifier (string) --
The CA identifier of the CA certificate used for the DB instance's server certificate.
ValidTill (datetime) --
The expiration date of the DB instance’s server certificate.
PerformanceInsightsEnabled (boolean) --
Set to true if Amazon RDS Performance Insights is enabled for the DB instance, and otherwise false.
PerformanceInsightsKMSKeyId (string) --
The KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
{'DBSubnetGroups': {'SupportedNetworkTypes': ['string']}}
Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.
See also: AWS API Documentation
Request Syntax
client.describe_db_subnet_groups(
DBSubnetGroupName='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
string
The name of the subnet group to return details for.
list
This parameter is not currently supported.
(dict) --
A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.
Wildcards are not supported in filters.
Name (string) -- [REQUIRED]
The name of the filter. Filter names are case sensitive.
Values (list) -- [REQUIRED]
One or more filter values. Filter values are case sensitive.
(string) --
integer
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
string
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
dict
Response Syntax
{
'Marker': 'string',
'DBSubnetGroups': [
{
'DBSubnetGroupName': 'string',
'DBSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetStatus': 'string'
},
],
'DBSubnetGroupArn': 'string',
'SupportedNetworkTypes': [
'string',
]
},
]
}
Response Structure
(dict) --
Represents the output of DescribeDBSubnetGroups.
Marker (string) --
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
DBSubnetGroups (list) --
Detailed information about one or more subnet groups.
(dict) --
Detailed information about a subnet group.
DBSubnetGroupName (string) --
The name of the subnet group.
DBSubnetGroupDescription (string) --
Provides the description of the subnet group.
VpcId (string) --
Provides the virtual private cloud (VPC) ID of the subnet group.
SubnetGroupStatus (string) --
Provides the status of the subnet group.
Subnets (list) --
Detailed information about one or more subnets within a subnet group.
(dict) --
Detailed information about a subnet.
SubnetIdentifier (string) --
Specifies the identifier of the subnet.
SubnetAvailabilityZone (dict) --
Specifies the Availability Zone for the subnet.
Name (string) --
The name of the Availability Zone.
SubnetStatus (string) --
Specifies the status of the subnet.
DBSubnetGroupArn (string) --
The Amazon Resource Name (ARN) for the DB subnet group.
SupportedNetworkTypes (list) --
The network type of the DB subnet group.
Valid Values: IPV4 | DUAL
A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
(string) --
{'DBCluster': {'IOOptimizedNextAllowedModificationTime': 'timestamp',
'NetworkType': 'string'}}
Forces a failover for a cluster.
A failover for a cluster promotes one of the Amazon DocumentDB replicas (read-only instances) in the cluster to be the primary instance (the cluster writer).
If the primary instance fails, Amazon DocumentDB automatically fails over to an Amazon DocumentDB replica, if one exists. You can force a failover when you want to simulate a failure of a primary instance for testing.
See also: AWS API Documentation
Request Syntax
client.failover_db_cluster(
DBClusterIdentifier='string',
TargetDBInstanceIdentifier='string'
)
string
A cluster identifier to force a failover for. This parameter is not case sensitive.
Constraints:
Must match the identifier of an existing DBCluster.
string
The name of the instance to promote to the primary instance.
You must specify the instance identifier for an Amazon DocumentDB replica in the cluster. For example, mydbcluster-replica1.
dict
Response Syntax
{
'DBCluster': {
'AvailabilityZones': [
'string',
],
'BackupRetentionPeriod': 123,
'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',
'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'
},
],
'CloneGroupId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'EnabledCloudwatchLogsExports': [
'string',
],
'DeletionProtection': True|False,
'IOOptimizedNextAllowedModificationTime': datetime(2015, 1, 1),
'StorageType': 'string',
'ServerlessV2ScalingConfiguration': {
'MinCapacity': 123.0,
'MaxCapacity': 123.0
},
'MasterUserSecret': {
'SecretArn': 'string',
'SecretStatus': 'string',
'KmsKeyId': 'string'
},
'NetworkType': 'string'
}
}
Response Structure
(dict) --
DBCluster (dict) --
Detailed information about a cluster.
AvailabilityZones (list) --
Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
(string) --
BackupRetentionPeriod (integer) --
Specifies the number of days for which automatic snapshots are retained.
DBClusterIdentifier (string) --
Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.
DBClusterParameterGroup (string) --
Specifies the name of the cluster parameter group for the cluster.
DBSubnetGroup (string) --
Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.
Status (string) --
Specifies the current state of this cluster.
PercentProgress (string) --
Specifies the progress of the operation as a percentage.
EarliestRestorableTime (datetime) --
The earliest time to which a database can be restored with point-in-time restore.
Endpoint (string) --
Specifies the connection endpoint for the primary instance of the cluster.
ReaderEndpoint (string) --
The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.
If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.
MultiAZ (boolean) --
Specifies whether the cluster has instances in multiple Availability Zones.
Engine (string) --
Provides the name of the database engine to be used for this 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 user name for the cluster.
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 cluster if this cluster is a secondary cluster.
ReadReplicaIdentifiers (list) --
Contains one or more identifiers of the secondary clusters that are associated with this cluster.
(string) --
DBClusterMembers (list) --
Provides the list of instances that make up the cluster.
(dict) --
Contains information about an instance that is part of a cluster.
DBInstanceIdentifier (string) --
Specifies the instance identifier for this member of the cluster.
IsClusterWriter (boolean) --
A value that is true if the cluster member is the primary instance for the cluster and false otherwise.
DBClusterParameterGroupStatus (string) --
Specifies the status of the cluster parameter group for this member of the DB cluster.
PromotionTier (integer) --
A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
VpcSecurityGroups (list) --
Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.
(dict) --
Used as a response element for queries on virtual private cloud (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 cluster is encrypted.
KmsKeyId (string) --
If StorageEncrypted is true, the KMS key identifier for the encrypted cluster.
DbClusterResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the cluster. This identifier is found in CloudTrail log entries whenever the KMS key for the cluster is accessed.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for the cluster.
AssociatedRoles (list) --
Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.
(dict) --
Describes an Identity and Access Management (IAM) role that is associated with a cluster.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAMrole that is associated with the DB cluster.
Status (string) --
Describes the state of association between the IAMrole and the cluster. The Status property returns one of the following values:
ACTIVE - The IAMrole ARN is associated with the cluster and can be used to access other Amazon Web Services services on your behalf.
PENDING - The IAMrole ARN is being associated with the cluster.
INVALID - The IAMrole ARN is associated with the cluster, but the cluster cannot assume the IAMrole to access other Amazon Web Services services on your behalf.
CloneGroupId (string) --
Identifies the clone group to which the DB cluster is associated.
ClusterCreateTime (datetime) --
Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
EnabledCloudwatchLogsExports (list) --
A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.
(string) --
DeletionProtection (boolean) --
Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.
IOOptimizedNextAllowedModificationTime (datetime) --
The next time you can modify the Amazon DocumentDB cluster to use the iopt1 storage type.
StorageType (string) --
Storage type associated with your cluster
For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.
Valid values for storage type - standard | iopt1
Default value is standard
ServerlessV2ScalingConfiguration (dict) --
The scaling configuration of an Amazon DocumentDB Serverless cluster.
MinCapacity (float) --
The minimum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster. You can specify DCU values in half-step increments, such as 8, 8.5, 9, and so on.
MaxCapacity (float) --
The maximum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster. You can specify DCU values in half-step increments, such as 32, 32.5, 33, and so on.
MasterUserSecret (dict) --
The secret managed by Amazon DocumentDB in Amazon Web Services Secrets Manager for the master user password.
SecretArn (string) --
The Amazon Resource Name (ARN) of the secret.
SecretStatus (string) --
The status of the secret.
The possible status values include the following:
creating - The secret is being created.
active - The secret is available for normal use and rotation.
rotating - The secret is being rotated.
impaired - The secret can be used to access database credentials, but it can't be rotated. A secret might have this status if, for example, permissions are changed so that Amazon DocumentDB can no longer access either the secret or the KMS key for the secret. When a secret has this status, you can correct the condition that caused the status. Alternatively, modify the instance to turn off automatic management of database credentials, and then modify the instance again to turn on automatic management of database credentials.
KmsKeyId (string) --
The Amazon Web Services KMS key identifier that is used to encrypt the secret.
NetworkType (string) --
The network type of the cluster.
The network type is determined by the DBSubnetGroup specified for the cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols ( DUAL).
For more information, see DocumentDB clusters in a VPC in the Amazon DocumentDB Developer Guide.
Valid Values: IPV4 | DUAL
{'NetworkType': 'string'}
Response {'DBCluster': {'IOOptimizedNextAllowedModificationTime': 'timestamp',
'NetworkType': 'string'}}
Modifies a setting for an Amazon DocumentDB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.
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',
PreferredBackupWindow='string',
PreferredMaintenanceWindow='string',
CloudwatchLogsExportConfiguration={
'EnableLogTypes': [
'string',
],
'DisableLogTypes': [
'string',
]
},
EngineVersion='string',
AllowMajorVersionUpgrade=True|False,
DeletionProtection=True|False,
StorageType='string',
ServerlessV2ScalingConfiguration={
'MinCapacity': 123.0,
'MaxCapacity': 123.0
},
ManageMasterUserPassword=True|False,
MasterUserSecretKmsKeyId='string',
RotateMasterUserPassword=True|False,
NetworkType='string'
)
string
[REQUIRED]
The cluster identifier for the cluster that is being modified. This parameter is not case sensitive.
Constraints:
Must match the identifier of an existing DBCluster.
string
The new cluster identifier for the cluster when renaming a cluster. This value is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: my-cluster2
boolean
A value that specifies whether the changes in this request and any pending changes are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cluster. If this parameter is set to false, changes to the cluster are applied during the next maintenance window.
The ApplyImmediately parameter affects only the NewDBClusterIdentifier and MasterUserPassword values. If you set this parameter value to false, the 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
integer
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.
string
The name of the cluster parameter group to use for the cluster.
list
A list of virtual private cloud (VPC) security groups that the cluster will belong to.
(string) --
integer
The port number on which the cluster accepts connections.
Constraints: Must be a value from 1150 to 65535.
Default: The same port as the original cluster.
string
The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).
Constraints: Must contain from 8 to 100 characters.
string
The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region.
Constraints:
Must be in the format hh24:mi-hh24:mi.
Must be in Universal Coordinated Time (UTC).
Must not conflict with the preferred maintenance window.
Must be at least 30 minutes.
string
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
dict
The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific instance or cluster. The EnableLogTypes and DisableLogTypes arrays determine which logs are exported (or not exported) to CloudWatch Logs.
EnableLogTypes (list) --
The list of log types to enable.
(string) --
DisableLogTypes (list) --
The list of log types to disable.
(string) --
string
The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless ApplyImmediately is enabled.
To list all of the available engine versions for Amazon DocumentDB use the following command:
aws docdb describe-db-engine-versions --engine docdb --query "DBEngineVersions[].EngineVersion"
boolean
A value that indicates whether major version upgrades are allowed.
Constraints:
You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the cluster's current version.
Since some parameters are version specific, changing them requires executing a new ModifyDBCluster API call after the in-place MVU completes.
boolean
Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.
string
The storage type to associate with the DB cluster.
For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.
Valid values for storage type - standard | iopt1
Default value is standard
dict
Contains the scaling configuration of an Amazon DocumentDB Serverless cluster.
MinCapacity (float) --
The minimum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster. You can specify DCU values in half-step increments, such as 8, 8.5, 9, and so on.
MaxCapacity (float) --
The maximum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster. You can specify DCU values in half-step increments, such as 32, 32.5, 33, and so on.
boolean
Specifies whether to manage the master user password with Amazon Web Services Secrets Manager. If the cluster doesn't manage the master user password with Amazon Web Services Secrets Manager, you can turn on this management. In this case, you can't specify MasterUserPassword. If the cluster already manages the master user password with Amazon Web Services Secrets Manager, and you specify that the master user password is not managed with Amazon Web Services Secrets Manager, then you must specify MasterUserPassword. In this case, Amazon DocumentDB deletes the secret and uses the new password for the master user specified by MasterUserPassword.
string
The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
This setting is valid only if both of the following conditions are met:
The cluster doesn't manage the master user password in Amazon Web Services Secrets Manager. If the cluster already manages the master user password in Amazon Web Services Secrets Manager, you can't change the KMS key that is used to encrypt the secret.
You are enabling ManageMasterUserPassword to manage the master user password in Amazon Web Services Secrets Manager. If you are turning on ManageMasterUserPassword and don't specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
boolean
Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.
This setting is valid only if the master user password is managed by Amazon DocumentDB in Amazon Web Services Secrets Manager for the cluster. The secret value contains the updated password.
Constraint: You must apply the change immediately when rotating the master user password.
string
The network type of the cluster.
The network type is determined by the DBSubnetGroup specified for the cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols ( DUAL).
For more information, see DocumentDB clusters in a VPC in the Amazon DocumentDB Developer Guide.
Valid Values: IPV4 | DUAL
dict
Response Syntax
{
'DBCluster': {
'AvailabilityZones': [
'string',
],
'BackupRetentionPeriod': 123,
'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',
'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'
},
],
'CloneGroupId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'EnabledCloudwatchLogsExports': [
'string',
],
'DeletionProtection': True|False,
'IOOptimizedNextAllowedModificationTime': datetime(2015, 1, 1),
'StorageType': 'string',
'ServerlessV2ScalingConfiguration': {
'MinCapacity': 123.0,
'MaxCapacity': 123.0
},
'MasterUserSecret': {
'SecretArn': 'string',
'SecretStatus': 'string',
'KmsKeyId': 'string'
},
'NetworkType': 'string'
}
}
Response Structure
(dict) --
DBCluster (dict) --
Detailed information about a cluster.
AvailabilityZones (list) --
Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
(string) --
BackupRetentionPeriod (integer) --
Specifies the number of days for which automatic snapshots are retained.
DBClusterIdentifier (string) --
Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.
DBClusterParameterGroup (string) --
Specifies the name of the cluster parameter group for the cluster.
DBSubnetGroup (string) --
Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.
Status (string) --
Specifies the current state of this cluster.
PercentProgress (string) --
Specifies the progress of the operation as a percentage.
EarliestRestorableTime (datetime) --
The earliest time to which a database can be restored with point-in-time restore.
Endpoint (string) --
Specifies the connection endpoint for the primary instance of the cluster.
ReaderEndpoint (string) --
The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.
If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.
MultiAZ (boolean) --
Specifies whether the cluster has instances in multiple Availability Zones.
Engine (string) --
Provides the name of the database engine to be used for this 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 user name for the cluster.
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 cluster if this cluster is a secondary cluster.
ReadReplicaIdentifiers (list) --
Contains one or more identifiers of the secondary clusters that are associated with this cluster.
(string) --
DBClusterMembers (list) --
Provides the list of instances that make up the cluster.
(dict) --
Contains information about an instance that is part of a cluster.
DBInstanceIdentifier (string) --
Specifies the instance identifier for this member of the cluster.
IsClusterWriter (boolean) --
A value that is true if the cluster member is the primary instance for the cluster and false otherwise.
DBClusterParameterGroupStatus (string) --
Specifies the status of the cluster parameter group for this member of the DB cluster.
PromotionTier (integer) --
A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
VpcSecurityGroups (list) --
Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.
(dict) --
Used as a response element for queries on virtual private cloud (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 cluster is encrypted.
KmsKeyId (string) --
If StorageEncrypted is true, the KMS key identifier for the encrypted cluster.
DbClusterResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the cluster. This identifier is found in CloudTrail log entries whenever the KMS key for the cluster is accessed.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for the cluster.
AssociatedRoles (list) --
Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.
(dict) --
Describes an Identity and Access Management (IAM) role that is associated with a cluster.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAMrole that is associated with the DB cluster.
Status (string) --
Describes the state of association between the IAMrole and the cluster. The Status property returns one of the following values:
ACTIVE - The IAMrole ARN is associated with the cluster and can be used to access other Amazon Web Services services on your behalf.
PENDING - The IAMrole ARN is being associated with the cluster.
INVALID - The IAMrole ARN is associated with the cluster, but the cluster cannot assume the IAMrole to access other Amazon Web Services services on your behalf.
CloneGroupId (string) --
Identifies the clone group to which the DB cluster is associated.
ClusterCreateTime (datetime) --
Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
EnabledCloudwatchLogsExports (list) --
A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.
(string) --
DeletionProtection (boolean) --
Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.
IOOptimizedNextAllowedModificationTime (datetime) --
The next time you can modify the Amazon DocumentDB cluster to use the iopt1 storage type.
StorageType (string) --
Storage type associated with your cluster
For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.
Valid values for storage type - standard | iopt1
Default value is standard
ServerlessV2ScalingConfiguration (dict) --
The scaling configuration of an Amazon DocumentDB Serverless cluster.
MinCapacity (float) --
The minimum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster. You can specify DCU values in half-step increments, such as 8, 8.5, 9, and so on.
MaxCapacity (float) --
The maximum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster. You can specify DCU values in half-step increments, such as 32, 32.5, 33, and so on.
MasterUserSecret (dict) --
The secret managed by Amazon DocumentDB in Amazon Web Services Secrets Manager for the master user password.
SecretArn (string) --
The Amazon Resource Name (ARN) of the secret.
SecretStatus (string) --
The status of the secret.
The possible status values include the following:
creating - The secret is being created.
active - The secret is available for normal use and rotation.
rotating - The secret is being rotated.
impaired - The secret can be used to access database credentials, but it can't be rotated. A secret might have this status if, for example, permissions are changed so that Amazon DocumentDB can no longer access either the secret or the KMS key for the secret. When a secret has this status, you can correct the condition that caused the status. Alternatively, modify the instance to turn off automatic management of database credentials, and then modify the instance again to turn on automatic management of database credentials.
KmsKeyId (string) --
The Amazon Web Services KMS key identifier that is used to encrypt the secret.
NetworkType (string) --
The network type of the cluster.
The network type is determined by the DBSubnetGroup specified for the cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols ( DUAL).
For more information, see DocumentDB clusters in a VPC in the Amazon DocumentDB Developer Guide.
Valid Values: IPV4 | DUAL
{'DBInstance': {'DBSubnetGroup': {'SupportedNetworkTypes': ['string']}}}
Modifies settings for an instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.
See also: AWS API Documentation
Request Syntax
client.modify_db_instance(
DBInstanceIdentifier='string',
DBInstanceClass='string',
ApplyImmediately=True|False,
PreferredMaintenanceWindow='string',
AutoMinorVersionUpgrade=True|False,
NewDBInstanceIdentifier='string',
CACertificateIdentifier='string',
CopyTagsToSnapshot=True|False,
PromotionTier=123,
EnablePerformanceInsights=True|False,
PerformanceInsightsKMSKeyId='string',
CertificateRotationRestart=True|False
)
string
[REQUIRED]
The instance identifier. This value is stored as a lowercase string.
Constraints:
Must match the identifier of an existing DBInstance.
string
The new compute and memory capacity of the instance; for example, db.r5.large. Not all instance classes are available in all Amazon Web Services Regions.
If you modify the instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless ApplyImmediately is specified as true for this request.
Default: Uses existing setting.
boolean
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 instance.
If this parameter is set to false, changes to the instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next reboot.
Default: false
string
The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter doesn't result in an outage except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, changing this parameter causes a reboot of the instance. If you are moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure that pending changes are applied.
Default: Uses existing setting.
Format: ddd:hh24:mi-ddd:hh24:mi
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Must be at least 30 minutes.
boolean
This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.
string
The new instance identifier for the instance when renaming an instance. When you change the instance identifier, an instance reboot occurs immediately if you set Apply Immediately to true. It occurs during the next maintenance window if you set Apply Immediately to false. This value is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
string
Indicates the certificate that needs to be associated with the instance.
boolean
A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
integer
A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
Default: 1
Valid values: 0-15
boolean
A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights.
string
The KMS key identifier for encryption of Performance Insights data.
The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services region.
boolean
Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.
By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.
If you are using SSL/TLS to connect to the DB instance, see Updating Your Amazon DocumentDB TLS Certificates and Encrypting Data in Transit in the Amazon DocumentDB Developer Guide.
dict
Response Syntax
{
'DBInstance': {
'DBInstanceIdentifier': 'string',
'DBInstanceClass': 'string',
'Engine': 'string',
'DBInstanceStatus': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123,
'HostedZoneId': 'string'
},
'InstanceCreateTime': datetime(2015, 1, 1),
'PreferredBackupWindow': 'string',
'BackupRetentionPeriod': 123,
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'AvailabilityZone': 'string',
'DBSubnetGroup': {
'DBSubnetGroupName': 'string',
'DBSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetStatus': 'string'
},
],
'DBSubnetGroupArn': 'string',
'SupportedNetworkTypes': [
'string',
]
},
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'DBInstanceClass': 'string',
'AllocatedStorage': 123,
'MasterUserPassword': 'string',
'Port': 123,
'BackupRetentionPeriod': 123,
'MultiAZ': True|False,
'EngineVersion': 'string',
'LicenseModel': 'string',
'Iops': 123,
'DBInstanceIdentifier': 'string',
'StorageType': 'string',
'CACertificateIdentifier': 'string',
'DBSubnetGroupName': 'string',
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
}
},
'LatestRestorableTime': datetime(2015, 1, 1),
'EngineVersion': 'string',
'AutoMinorVersionUpgrade': True|False,
'PubliclyAccessible': True|False,
'StatusInfos': [
{
'StatusType': 'string',
'Normal': True|False,
'Status': 'string',
'Message': 'string'
},
],
'DBClusterIdentifier': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbiResourceId': 'string',
'CACertificateIdentifier': 'string',
'CopyTagsToSnapshot': True|False,
'PromotionTier': 123,
'DBInstanceArn': 'string',
'EnabledCloudwatchLogsExports': [
'string',
],
'CertificateDetails': {
'CAIdentifier': 'string',
'ValidTill': datetime(2015, 1, 1)
},
'PerformanceInsightsEnabled': True|False,
'PerformanceInsightsKMSKeyId': 'string'
}
}
Response Structure
(dict) --
DBInstance (dict) --
Detailed information about an instance.
DBInstanceIdentifier (string) --
Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.
DBInstanceClass (string) --
Contains the name of the compute and memory capacity class of the instance.
Engine (string) --
Provides the name of the database engine to be used for this instance.
DBInstanceStatus (string) --
Specifies the current state of this database.
Endpoint (dict) --
Specifies the connection endpoint.
Address (string) --
Specifies the DNS address of the instance.
Port (integer) --
Specifies the port that the database engine is listening on.
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
InstanceCreateTime (datetime) --
Provides the date and time that the instance was created.
PreferredBackupWindow (string) --
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
BackupRetentionPeriod (integer) --
Specifies the number of days for which automatic snapshots are retained.
VpcSecurityGroups (list) --
Provides a list of VPC security group elements that the instance belongs to.
(dict) --
Used as a response element for queries on virtual private cloud (VPC) security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The status of the VPC security group.
AvailabilityZone (string) --
Specifies the name of the Availability Zone that the instance is located in.
DBSubnetGroup (dict) --
Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group.
DBSubnetGroupName (string) --
The name of the subnet group.
DBSubnetGroupDescription (string) --
Provides the description of the subnet group.
VpcId (string) --
Provides the virtual private cloud (VPC) ID of the subnet group.
SubnetGroupStatus (string) --
Provides the status of the subnet group.
Subnets (list) --
Detailed information about one or more subnets within a subnet group.
(dict) --
Detailed information about a subnet.
SubnetIdentifier (string) --
Specifies the identifier of the subnet.
SubnetAvailabilityZone (dict) --
Specifies the Availability Zone for the subnet.
Name (string) --
The name of the Availability Zone.
SubnetStatus (string) --
Specifies the status of the subnet.
DBSubnetGroupArn (string) --
The Amazon Resource Name (ARN) for the DB subnet group.
SupportedNetworkTypes (list) --
The network type of the DB subnet group.
Valid Values: IPV4 | DUAL
A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
(string) --
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
PendingModifiedValues (dict) --
Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.
DBInstanceClass (string) --
Contains the new DBInstanceClass for the instance that will be applied or is currently being applied.
AllocatedStorage (integer) --
Contains the new AllocatedStorage size for then instance that will be applied or is currently being applied.
MasterUserPassword (string) --
Contains the pending or currently in-progress change of the master credentials for the instance.
Port (integer) --
Specifies the pending port for the instance.
BackupRetentionPeriod (integer) --
Specifies the pending number of days for which automated backups are retained.
MultiAZ (boolean) --
Indicates that the Single-AZ instance is to change to a Multi-AZ deployment.
EngineVersion (string) --
Indicates the database engine version.
LicenseModel (string) --
The license model for the instance.
Valid values: license-included, bring-your-own-license, general-public-license
Iops (integer) --
Specifies the new Provisioned IOPS value for the instance that will be applied or is currently being applied.
DBInstanceIdentifier (string) --
Contains the new DBInstanceIdentifier for the instance that will be applied or is currently being applied.
StorageType (string) --
Specifies the storage type to be associated with the instance.
CACertificateIdentifier (string) --
Specifies the identifier of the certificate authority (CA) certificate for the DB instance.
DBSubnetGroupName (string) --
The new subnet group for the instance.
PendingCloudwatchLogsExports (dict) --
A list of the log types whose configuration is still pending. These log types are in the process of being activated or deactivated.
LogTypesToEnable (list) --
Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.
(string) --
LogTypesToDisable (list) --
Log types that are in the process of being enabled. After they are enabled, these log types are exported to Amazon CloudWatch Logs.
(string) --
LatestRestorableTime (datetime) --
Specifies the latest time to which a database can be restored with point-in-time restore.
EngineVersion (string) --
Indicates the database engine version.
AutoMinorVersionUpgrade (boolean) --
Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.
PubliclyAccessible (boolean) --
Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false.
StatusInfos (list) --
The status of a read replica. If the instance is not a read replica, this is blank.
(dict) --
Provides a list of status information for an instance.
StatusType (string) --
This value is currently " read replication."
Normal (boolean) --
A Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.
Status (string) --
Status of the instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.
Message (string) --
Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.
DBClusterIdentifier (string) --
Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.
StorageEncrypted (boolean) --
Specifies whether or not the instance is encrypted.
KmsKeyId (string) --
If StorageEncrypted is true, the KMS key identifier for the encrypted instance.
DbiResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the instance. This identifier is found in CloudTrail log entries whenever the KMS key for the instance is accessed.
CACertificateIdentifier (string) --
The identifier of the CA certificate for this DB instance.
CopyTagsToSnapshot (boolean) --
A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
PromotionTier (integer) --
A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
DBInstanceArn (string) --
The Amazon Resource Name (ARN) for the instance.
EnabledCloudwatchLogsExports (list) --
A list of log types that this instance is configured to export to CloudWatch Logs.
(string) --
CertificateDetails (dict) --
The details of the DB instance's server certificate.
CAIdentifier (string) --
The CA identifier of the CA certificate used for the DB instance's server certificate.
ValidTill (datetime) --
The expiration date of the DB instance’s server certificate.
PerformanceInsightsEnabled (boolean) --
Set to true if Amazon RDS Performance Insights is enabled for the DB instance, and otherwise false.
PerformanceInsightsKMSKeyId (string) --
The KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
{'DBSubnetGroup': {'SupportedNetworkTypes': ['string']}}
Modifies an existing subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Amazon Web Services Region.
See also: AWS API Documentation
Request Syntax
client.modify_db_subnet_group(
DBSubnetGroupName='string',
DBSubnetGroupDescription='string',
SubnetIds=[
'string',
]
)
string
[REQUIRED]
The name for the subnet group. This value is stored as a lowercase string. You can't modify the default subnet group.
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example: mySubnetgroup
string
The description for the subnet group.
list
[REQUIRED]
The Amazon EC2 subnet IDs for the subnet group.
(string) --
dict
Response Syntax
{
'DBSubnetGroup': {
'DBSubnetGroupName': 'string',
'DBSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetStatus': 'string'
},
],
'DBSubnetGroupArn': 'string',
'SupportedNetworkTypes': [
'string',
]
}
}
Response Structure
(dict) --
DBSubnetGroup (dict) --
Detailed information about a subnet group.
DBSubnetGroupName (string) --
The name of the subnet group.
DBSubnetGroupDescription (string) --
Provides the description of the subnet group.
VpcId (string) --
Provides the virtual private cloud (VPC) ID of the subnet group.
SubnetGroupStatus (string) --
Provides the status of the subnet group.
Subnets (list) --
Detailed information about one or more subnets within a subnet group.
(dict) --
Detailed information about a subnet.
SubnetIdentifier (string) --
Specifies the identifier of the subnet.
SubnetAvailabilityZone (dict) --
Specifies the Availability Zone for the subnet.
Name (string) --
The name of the Availability Zone.
SubnetStatus (string) --
Specifies the status of the subnet.
DBSubnetGroupArn (string) --
The Amazon Resource Name (ARN) for the DB subnet group.
SupportedNetworkTypes (list) --
The network type of the DB subnet group.
Valid Values: IPV4 | DUAL
A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
(string) --
{'DBInstance': {'DBSubnetGroup': {'SupportedNetworkTypes': ['string']}}}
You might need to reboot your instance, usually for maintenance reasons. For example, if you make certain changes, or if you change the cluster parameter group that is associated with the instance, you must reboot the instance for the changes to take effect.
Rebooting an instance restarts the database engine service. Rebooting an instance results in a momentary outage, during which the instance status is set to rebooting.
See also: AWS API Documentation
Request Syntax
client.reboot_db_instance(
DBInstanceIdentifier='string',
ForceFailover=True|False
)
string
[REQUIRED]
The instance identifier. This parameter is stored as a lowercase string.
Constraints:
Must match the identifier of an existing DBInstance.
boolean
When true, the reboot is conducted through a Multi-AZ failover.
Constraint: You can't specify true if the instance is not configured for Multi-AZ.
dict
Response Syntax
{
'DBInstance': {
'DBInstanceIdentifier': 'string',
'DBInstanceClass': 'string',
'Engine': 'string',
'DBInstanceStatus': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123,
'HostedZoneId': 'string'
},
'InstanceCreateTime': datetime(2015, 1, 1),
'PreferredBackupWindow': 'string',
'BackupRetentionPeriod': 123,
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'AvailabilityZone': 'string',
'DBSubnetGroup': {
'DBSubnetGroupName': 'string',
'DBSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetStatus': 'string'
},
],
'DBSubnetGroupArn': 'string',
'SupportedNetworkTypes': [
'string',
]
},
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'DBInstanceClass': 'string',
'AllocatedStorage': 123,
'MasterUserPassword': 'string',
'Port': 123,
'BackupRetentionPeriod': 123,
'MultiAZ': True|False,
'EngineVersion': 'string',
'LicenseModel': 'string',
'Iops': 123,
'DBInstanceIdentifier': 'string',
'StorageType': 'string',
'CACertificateIdentifier': 'string',
'DBSubnetGroupName': 'string',
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
}
},
'LatestRestorableTime': datetime(2015, 1, 1),
'EngineVersion': 'string',
'AutoMinorVersionUpgrade': True|False,
'PubliclyAccessible': True|False,
'StatusInfos': [
{
'StatusType': 'string',
'Normal': True|False,
'Status': 'string',
'Message': 'string'
},
],
'DBClusterIdentifier': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbiResourceId': 'string',
'CACertificateIdentifier': 'string',
'CopyTagsToSnapshot': True|False,
'PromotionTier': 123,
'DBInstanceArn': 'string',
'EnabledCloudwatchLogsExports': [
'string',
],
'CertificateDetails': {
'CAIdentifier': 'string',
'ValidTill': datetime(2015, 1, 1)
},
'PerformanceInsightsEnabled': True|False,
'PerformanceInsightsKMSKeyId': 'string'
}
}
Response Structure
(dict) --
DBInstance (dict) --
Detailed information about an instance.
DBInstanceIdentifier (string) --
Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.
DBInstanceClass (string) --
Contains the name of the compute and memory capacity class of the instance.
Engine (string) --
Provides the name of the database engine to be used for this instance.
DBInstanceStatus (string) --
Specifies the current state of this database.
Endpoint (dict) --
Specifies the connection endpoint.
Address (string) --
Specifies the DNS address of the instance.
Port (integer) --
Specifies the port that the database engine is listening on.
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
InstanceCreateTime (datetime) --
Provides the date and time that the instance was created.
PreferredBackupWindow (string) --
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
BackupRetentionPeriod (integer) --
Specifies the number of days for which automatic snapshots are retained.
VpcSecurityGroups (list) --
Provides a list of VPC security group elements that the instance belongs to.
(dict) --
Used as a response element for queries on virtual private cloud (VPC) security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The status of the VPC security group.
AvailabilityZone (string) --
Specifies the name of the Availability Zone that the instance is located in.
DBSubnetGroup (dict) --
Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group.
DBSubnetGroupName (string) --
The name of the subnet group.
DBSubnetGroupDescription (string) --
Provides the description of the subnet group.
VpcId (string) --
Provides the virtual private cloud (VPC) ID of the subnet group.
SubnetGroupStatus (string) --
Provides the status of the subnet group.
Subnets (list) --
Detailed information about one or more subnets within a subnet group.
(dict) --
Detailed information about a subnet.
SubnetIdentifier (string) --
Specifies the identifier of the subnet.
SubnetAvailabilityZone (dict) --
Specifies the Availability Zone for the subnet.
Name (string) --
The name of the Availability Zone.
SubnetStatus (string) --
Specifies the status of the subnet.
DBSubnetGroupArn (string) --
The Amazon Resource Name (ARN) for the DB subnet group.
SupportedNetworkTypes (list) --
The network type of the DB subnet group.
Valid Values: IPV4 | DUAL
A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
(string) --
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
PendingModifiedValues (dict) --
Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.
DBInstanceClass (string) --
Contains the new DBInstanceClass for the instance that will be applied or is currently being applied.
AllocatedStorage (integer) --
Contains the new AllocatedStorage size for then instance that will be applied or is currently being applied.
MasterUserPassword (string) --
Contains the pending or currently in-progress change of the master credentials for the instance.
Port (integer) --
Specifies the pending port for the instance.
BackupRetentionPeriod (integer) --
Specifies the pending number of days for which automated backups are retained.
MultiAZ (boolean) --
Indicates that the Single-AZ instance is to change to a Multi-AZ deployment.
EngineVersion (string) --
Indicates the database engine version.
LicenseModel (string) --
The license model for the instance.
Valid values: license-included, bring-your-own-license, general-public-license
Iops (integer) --
Specifies the new Provisioned IOPS value for the instance that will be applied or is currently being applied.
DBInstanceIdentifier (string) --
Contains the new DBInstanceIdentifier for the instance that will be applied or is currently being applied.
StorageType (string) --
Specifies the storage type to be associated with the instance.
CACertificateIdentifier (string) --
Specifies the identifier of the certificate authority (CA) certificate for the DB instance.
DBSubnetGroupName (string) --
The new subnet group for the instance.
PendingCloudwatchLogsExports (dict) --
A list of the log types whose configuration is still pending. These log types are in the process of being activated or deactivated.
LogTypesToEnable (list) --
Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.
(string) --
LogTypesToDisable (list) --
Log types that are in the process of being enabled. After they are enabled, these log types are exported to Amazon CloudWatch Logs.
(string) --
LatestRestorableTime (datetime) --
Specifies the latest time to which a database can be restored with point-in-time restore.
EngineVersion (string) --
Indicates the database engine version.
AutoMinorVersionUpgrade (boolean) --
Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.
PubliclyAccessible (boolean) --
Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false.
StatusInfos (list) --
The status of a read replica. If the instance is not a read replica, this is blank.
(dict) --
Provides a list of status information for an instance.
StatusType (string) --
This value is currently " read replication."
Normal (boolean) --
A Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.
Status (string) --
Status of the instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.
Message (string) --
Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.
DBClusterIdentifier (string) --
Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.
StorageEncrypted (boolean) --
Specifies whether or not the instance is encrypted.
KmsKeyId (string) --
If StorageEncrypted is true, the KMS key identifier for the encrypted instance.
DbiResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the instance. This identifier is found in CloudTrail log entries whenever the KMS key for the instance is accessed.
CACertificateIdentifier (string) --
The identifier of the CA certificate for this DB instance.
CopyTagsToSnapshot (boolean) --
A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
PromotionTier (integer) --
A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
DBInstanceArn (string) --
The Amazon Resource Name (ARN) for the instance.
EnabledCloudwatchLogsExports (list) --
A list of log types that this instance is configured to export to CloudWatch Logs.
(string) --
CertificateDetails (dict) --
The details of the DB instance's server certificate.
CAIdentifier (string) --
The CA identifier of the CA certificate used for the DB instance's server certificate.
ValidTill (datetime) --
The expiration date of the DB instance’s server certificate.
PerformanceInsightsEnabled (boolean) --
Set to true if Amazon RDS Performance Insights is enabled for the DB instance, and otherwise false.
PerformanceInsightsKMSKeyId (string) --
The KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
{'NetworkType': 'string'}
Response {'DBCluster': {'IOOptimizedNextAllowedModificationTime': 'timestamp',
'NetworkType': 'string'}}
Creates a new cluster from a snapshot or cluster snapshot.
If a snapshot is specified, the target cluster is created from the source DB snapshot with a default configuration and default security group.
If a cluster snapshot is specified, the target cluster is created from the source cluster restore point with the same configuration as the original source DB cluster, except that the new cluster is created with the default security group.
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',
VpcSecurityGroupIds=[
'string',
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
KmsKeyId='string',
EnableCloudwatchLogsExports=[
'string',
],
DeletionProtection=True|False,
DBClusterParameterGroupName='string',
ServerlessV2ScalingConfiguration={
'MinCapacity': 123.0,
'MaxCapacity': 123.0
},
StorageType='string',
NetworkType='string'
)
list
Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.
(string) --
string
[REQUIRED]
The name of the cluster to create from the snapshot or cluster snapshot. This parameter isn't case sensitive.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: my-snapshot-id
string
[REQUIRED]
The identifier for the snapshot or cluster snapshot to restore from.
You can use either the name or the Amazon Resource Name (ARN) to specify a cluster snapshot. However, you can use only the ARN to specify a snapshot.
Constraints:
Must match the identifier of an existing snapshot.
string
[REQUIRED]
The database engine to use for the new cluster.
Default: The same as source.
Constraint: Must be compatible with the engine of the source.
string
The version of the database engine to use for the new cluster.
integer
The port number on which the new cluster accepts connections.
Constraints: Must be a value from 1150 to 65535.
Default: The same port as the original cluster.
string
The name of the subnet group to use for the new cluster.
Constraints: If provided, must match the name of an existing DBSubnetGroup.
Example: mySubnetgroup
list
A list of virtual private cloud (VPC) security groups that the new cluster will belong to.
(string) --
list
The tags to be assigned to the restored cluster.
(dict) --
Metadata assigned to an Amazon DocumentDB resource consisting of a key-value pair.
Key (string) --
The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with " aws:" or " rds:". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
Value (string) --
The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with " aws:" or " rds:". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
string
The KMS key identifier to use when restoring an encrypted cluster from a DB snapshot or cluster snapshot.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a cluster with the same Amazon Web Services account that owns the KMS encryption key used to encrypt the new 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 occurs:
If the snapshot or cluster snapshot in SnapshotIdentifier is encrypted, then the restored cluster is encrypted using the KMS key that was used to encrypt the snapshot or the cluster snapshot.
If the snapshot or the cluster snapshot in SnapshotIdentifier is not encrypted, then the restored DB cluster is not encrypted.
list
A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.
(string) --
boolean
Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.
string
The name of the DB cluster parameter group to associate with this DB cluster.
Type: String. Required: No.
If this argument is omitted, the default DB cluster parameter group is used. If supplied, must match the name of an existing default DB cluster parameter group. The string must consist of from 1 to 255 letters, numbers or hyphens. Its first character must be a letter, and it cannot end with a hyphen or contain two consecutive hyphens.
dict
Contains the scaling configuration of an Amazon DocumentDB Serverless cluster.
MinCapacity (float) --
The minimum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster. You can specify DCU values in half-step increments, such as 8, 8.5, 9, and so on.
MaxCapacity (float) --
The maximum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster. You can specify DCU values in half-step increments, such as 32, 32.5, 33, and so on.
string
The storage type to associate with the DB cluster.
For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.
Valid values for storage type - standard | iopt1
Default value is standard
string
The network type of the cluster.
The network type is determined by the DBSubnetGroup specified for the cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols ( DUAL).
For more information, see DocumentDB clusters in a VPC in the Amazon DocumentDB Developer Guide.
Valid Values: IPV4 | DUAL
dict
Response Syntax
{
'DBCluster': {
'AvailabilityZones': [
'string',
],
'BackupRetentionPeriod': 123,
'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',
'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'
},
],
'CloneGroupId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'EnabledCloudwatchLogsExports': [
'string',
],
'DeletionProtection': True|False,
'IOOptimizedNextAllowedModificationTime': datetime(2015, 1, 1),
'StorageType': 'string',
'ServerlessV2ScalingConfiguration': {
'MinCapacity': 123.0,
'MaxCapacity': 123.0
},
'MasterUserSecret': {
'SecretArn': 'string',
'SecretStatus': 'string',
'KmsKeyId': 'string'
},
'NetworkType': 'string'
}
}
Response Structure
(dict) --
DBCluster (dict) --
Detailed information about a cluster.
AvailabilityZones (list) --
Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
(string) --
BackupRetentionPeriod (integer) --
Specifies the number of days for which automatic snapshots are retained.
DBClusterIdentifier (string) --
Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.
DBClusterParameterGroup (string) --
Specifies the name of the cluster parameter group for the cluster.
DBSubnetGroup (string) --
Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.
Status (string) --
Specifies the current state of this cluster.
PercentProgress (string) --
Specifies the progress of the operation as a percentage.
EarliestRestorableTime (datetime) --
The earliest time to which a database can be restored with point-in-time restore.
Endpoint (string) --
Specifies the connection endpoint for the primary instance of the cluster.
ReaderEndpoint (string) --
The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.
If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.
MultiAZ (boolean) --
Specifies whether the cluster has instances in multiple Availability Zones.
Engine (string) --
Provides the name of the database engine to be used for this 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 user name for the cluster.
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 cluster if this cluster is a secondary cluster.
ReadReplicaIdentifiers (list) --
Contains one or more identifiers of the secondary clusters that are associated with this cluster.
(string) --
DBClusterMembers (list) --
Provides the list of instances that make up the cluster.
(dict) --
Contains information about an instance that is part of a cluster.
DBInstanceIdentifier (string) --
Specifies the instance identifier for this member of the cluster.
IsClusterWriter (boolean) --
A value that is true if the cluster member is the primary instance for the cluster and false otherwise.
DBClusterParameterGroupStatus (string) --
Specifies the status of the cluster parameter group for this member of the DB cluster.
PromotionTier (integer) --
A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
VpcSecurityGroups (list) --
Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.
(dict) --
Used as a response element for queries on virtual private cloud (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 cluster is encrypted.
KmsKeyId (string) --
If StorageEncrypted is true, the KMS key identifier for the encrypted cluster.
DbClusterResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the cluster. This identifier is found in CloudTrail log entries whenever the KMS key for the cluster is accessed.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for the cluster.
AssociatedRoles (list) --
Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.
(dict) --
Describes an Identity and Access Management (IAM) role that is associated with a cluster.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAMrole that is associated with the DB cluster.
Status (string) --
Describes the state of association between the IAMrole and the cluster. The Status property returns one of the following values:
ACTIVE - The IAMrole ARN is associated with the cluster and can be used to access other Amazon Web Services services on your behalf.
PENDING - The IAMrole ARN is being associated with the cluster.
INVALID - The IAMrole ARN is associated with the cluster, but the cluster cannot assume the IAMrole to access other Amazon Web Services services on your behalf.
CloneGroupId (string) --
Identifies the clone group to which the DB cluster is associated.
ClusterCreateTime (datetime) --
Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
EnabledCloudwatchLogsExports (list) --
A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.
(string) --
DeletionProtection (boolean) --
Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.
IOOptimizedNextAllowedModificationTime (datetime) --
The next time you can modify the Amazon DocumentDB cluster to use the iopt1 storage type.
StorageType (string) --
Storage type associated with your cluster
For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.
Valid values for storage type - standard | iopt1
Default value is standard
ServerlessV2ScalingConfiguration (dict) --
The scaling configuration of an Amazon DocumentDB Serverless cluster.
MinCapacity (float) --
The minimum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster. You can specify DCU values in half-step increments, such as 8, 8.5, 9, and so on.
MaxCapacity (float) --
The maximum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster. You can specify DCU values in half-step increments, such as 32, 32.5, 33, and so on.
MasterUserSecret (dict) --
The secret managed by Amazon DocumentDB in Amazon Web Services Secrets Manager for the master user password.
SecretArn (string) --
The Amazon Resource Name (ARN) of the secret.
SecretStatus (string) --
The status of the secret.
The possible status values include the following:
creating - The secret is being created.
active - The secret is available for normal use and rotation.
rotating - The secret is being rotated.
impaired - The secret can be used to access database credentials, but it can't be rotated. A secret might have this status if, for example, permissions are changed so that Amazon DocumentDB can no longer access either the secret or the KMS key for the secret. When a secret has this status, you can correct the condition that caused the status. Alternatively, modify the instance to turn off automatic management of database credentials, and then modify the instance again to turn on automatic management of database credentials.
KmsKeyId (string) --
The Amazon Web Services KMS key identifier that is used to encrypt the secret.
NetworkType (string) --
The network type of the cluster.
The network type is determined by the DBSubnetGroup specified for the cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols ( DUAL).
For more information, see DocumentDB clusters in a VPC in the Amazon DocumentDB Developer Guide.
Valid Values: IPV4 | DUAL
{'NetworkType': 'string'}
Response {'DBCluster': {'IOOptimizedNextAllowedModificationTime': 'timestamp',
'NetworkType': 'string'}}
Restores a cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target cluster is created from the source cluster with the same configuration as the original cluster, except that the new cluster is created with the default security group.
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',
VpcSecurityGroupIds=[
'string',
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
KmsKeyId='string',
EnableCloudwatchLogsExports=[
'string',
],
DeletionProtection=True|False,
ServerlessV2ScalingConfiguration={
'MinCapacity': 123.0,
'MaxCapacity': 123.0
},
StorageType='string',
NetworkType='string'
)
string
[REQUIRED]
The name of the new cluster to be created.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
string
The type of restore to be performed. You can specify one of the following values:
full-copy - The new DB cluster is restored as a full copy of the source DB cluster.
copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.
Constraints: You can't specify copy-on-write if the engine version of the source DB cluster is earlier than 1.11.
If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.
string
[REQUIRED]
The identifier of the source cluster from which to restore.
Constraints:
Must match the identifier of an existing DBCluster.
datetime
The date and time to restore the cluster to.
Valid values: A time in Universal Coordinated Time (UTC) format.
Constraints:
Must be before the latest restorable time for the instance.
Must be specified if the UseLatestRestorableTime parameter is not provided.
Cannot be specified if the UseLatestRestorableTime parameter is true.
Cannot be specified if the RestoreType parameter is copy-on-write.
Example: 2015-03-07T23:45:00Z
boolean
A value that is set to true to restore the cluster to the latest restorable backup time, and false otherwise.
Default: false
Constraints: Cannot be specified if the RestoreToTime parameter is provided.
integer
The port number on which the new cluster accepts connections.
Constraints: Must be a value from 1150 to 65535.
Default: The default port for the engine.
string
The subnet group name to use for the new cluster.
Constraints: If provided, must match the name of an existing DBSubnetGroup.
Example: mySubnetgroup
list
A list of VPC security groups that the new cluster belongs to.
(string) --
list
The tags to be assigned to the restored cluster.
(dict) --
Metadata assigned to an Amazon DocumentDB resource consisting of a key-value pair.
Key (string) --
The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with " aws:" or " rds:". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
Value (string) --
The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with " aws:" or " rds:". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
string
The KMS key identifier to use when restoring an encrypted cluster from an encrypted cluster.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a cluster with the same Amazon Web Services account that owns the KMS encryption key used to encrypt the new cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
You can restore to a new cluster and encrypt the new cluster with an KMS key that is different from the KMS key used to encrypt the source cluster. The new DB cluster is encrypted with the KMS key identified by the KmsKeyId parameter.
If you do not specify a value for the KmsKeyId parameter, then the following occurs:
If the cluster is encrypted, then the restored cluster is encrypted using the KMS key that was used to encrypt the source cluster.
If the cluster is not encrypted, then the restored cluster is not encrypted.
If DBClusterIdentifier refers to a cluster that is not encrypted, then the restore request is rejected.
list
A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.
(string) --
boolean
Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.
dict
Contains the scaling configuration of an Amazon DocumentDB Serverless cluster.
MinCapacity (float) --
The minimum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster. You can specify DCU values in half-step increments, such as 8, 8.5, 9, and so on.
MaxCapacity (float) --
The maximum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster. You can specify DCU values in half-step increments, such as 32, 32.5, 33, and so on.
string
The storage type to associate with the DB cluster.
For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.
Valid values for storage type - standard | iopt1
Default value is standard
string
The network type of the cluster.
The network type is determined by the DBSubnetGroup specified for the cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols ( DUAL).
For more information, see DocumentDB clusters in a VPC in the Amazon DocumentDB Developer Guide.
Valid Values: IPV4 | DUAL
dict
Response Syntax
{
'DBCluster': {
'AvailabilityZones': [
'string',
],
'BackupRetentionPeriod': 123,
'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',
'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'
},
],
'CloneGroupId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'EnabledCloudwatchLogsExports': [
'string',
],
'DeletionProtection': True|False,
'IOOptimizedNextAllowedModificationTime': datetime(2015, 1, 1),
'StorageType': 'string',
'ServerlessV2ScalingConfiguration': {
'MinCapacity': 123.0,
'MaxCapacity': 123.0
},
'MasterUserSecret': {
'SecretArn': 'string',
'SecretStatus': 'string',
'KmsKeyId': 'string'
},
'NetworkType': 'string'
}
}
Response Structure
(dict) --
DBCluster (dict) --
Detailed information about a cluster.
AvailabilityZones (list) --
Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
(string) --
BackupRetentionPeriod (integer) --
Specifies the number of days for which automatic snapshots are retained.
DBClusterIdentifier (string) --
Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.
DBClusterParameterGroup (string) --
Specifies the name of the cluster parameter group for the cluster.
DBSubnetGroup (string) --
Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.
Status (string) --
Specifies the current state of this cluster.
PercentProgress (string) --
Specifies the progress of the operation as a percentage.
EarliestRestorableTime (datetime) --
The earliest time to which a database can be restored with point-in-time restore.
Endpoint (string) --
Specifies the connection endpoint for the primary instance of the cluster.
ReaderEndpoint (string) --
The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.
If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.
MultiAZ (boolean) --
Specifies whether the cluster has instances in multiple Availability Zones.
Engine (string) --
Provides the name of the database engine to be used for this 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 user name for the cluster.
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 cluster if this cluster is a secondary cluster.
ReadReplicaIdentifiers (list) --
Contains one or more identifiers of the secondary clusters that are associated with this cluster.
(string) --
DBClusterMembers (list) --
Provides the list of instances that make up the cluster.
(dict) --
Contains information about an instance that is part of a cluster.
DBInstanceIdentifier (string) --
Specifies the instance identifier for this member of the cluster.
IsClusterWriter (boolean) --
A value that is true if the cluster member is the primary instance for the cluster and false otherwise.
DBClusterParameterGroupStatus (string) --
Specifies the status of the cluster parameter group for this member of the DB cluster.
PromotionTier (integer) --
A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
VpcSecurityGroups (list) --
Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.
(dict) --
Used as a response element for queries on virtual private cloud (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 cluster is encrypted.
KmsKeyId (string) --
If StorageEncrypted is true, the KMS key identifier for the encrypted cluster.
DbClusterResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the cluster. This identifier is found in CloudTrail log entries whenever the KMS key for the cluster is accessed.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for the cluster.
AssociatedRoles (list) --
Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.
(dict) --
Describes an Identity and Access Management (IAM) role that is associated with a cluster.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAMrole that is associated with the DB cluster.
Status (string) --
Describes the state of association between the IAMrole and the cluster. The Status property returns one of the following values:
ACTIVE - The IAMrole ARN is associated with the cluster and can be used to access other Amazon Web Services services on your behalf.
PENDING - The IAMrole ARN is being associated with the cluster.
INVALID - The IAMrole ARN is associated with the cluster, but the cluster cannot assume the IAMrole to access other Amazon Web Services services on your behalf.
CloneGroupId (string) --
Identifies the clone group to which the DB cluster is associated.
ClusterCreateTime (datetime) --
Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
EnabledCloudwatchLogsExports (list) --
A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.
(string) --
DeletionProtection (boolean) --
Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.
IOOptimizedNextAllowedModificationTime (datetime) --
The next time you can modify the Amazon DocumentDB cluster to use the iopt1 storage type.
StorageType (string) --
Storage type associated with your cluster
For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.
Valid values for storage type - standard | iopt1
Default value is standard
ServerlessV2ScalingConfiguration (dict) --
The scaling configuration of an Amazon DocumentDB Serverless cluster.
MinCapacity (float) --
The minimum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster. You can specify DCU values in half-step increments, such as 8, 8.5, 9, and so on.
MaxCapacity (float) --
The maximum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster. You can specify DCU values in half-step increments, such as 32, 32.5, 33, and so on.
MasterUserSecret (dict) --
The secret managed by Amazon DocumentDB in Amazon Web Services Secrets Manager for the master user password.
SecretArn (string) --
The Amazon Resource Name (ARN) of the secret.
SecretStatus (string) --
The status of the secret.
The possible status values include the following:
creating - The secret is being created.
active - The secret is available for normal use and rotation.
rotating - The secret is being rotated.
impaired - The secret can be used to access database credentials, but it can't be rotated. A secret might have this status if, for example, permissions are changed so that Amazon DocumentDB can no longer access either the secret or the KMS key for the secret. When a secret has this status, you can correct the condition that caused the status. Alternatively, modify the instance to turn off automatic management of database credentials, and then modify the instance again to turn on automatic management of database credentials.
KmsKeyId (string) --
The Amazon Web Services KMS key identifier that is used to encrypt the secret.
NetworkType (string) --
The network type of the cluster.
The network type is determined by the DBSubnetGroup specified for the cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols ( DUAL).
For more information, see DocumentDB clusters in a VPC in the Amazon DocumentDB Developer Guide.
Valid Values: IPV4 | DUAL
{'DBCluster': {'IOOptimizedNextAllowedModificationTime': 'timestamp',
'NetworkType': 'string'}}
Restarts the stopped cluster that is specified by DBClusterIdentifier. For more information, see Stopping and Starting an Amazon DocumentDB Cluster.
See also: AWS API Documentation
Request Syntax
client.start_db_cluster(
DBClusterIdentifier='string'
)
string
[REQUIRED]
The identifier of the cluster to restart. Example: docdb-2019-05-28-15-24-52
dict
Response Syntax
{
'DBCluster': {
'AvailabilityZones': [
'string',
],
'BackupRetentionPeriod': 123,
'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',
'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'
},
],
'CloneGroupId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'EnabledCloudwatchLogsExports': [
'string',
],
'DeletionProtection': True|False,
'IOOptimizedNextAllowedModificationTime': datetime(2015, 1, 1),
'StorageType': 'string',
'ServerlessV2ScalingConfiguration': {
'MinCapacity': 123.0,
'MaxCapacity': 123.0
},
'MasterUserSecret': {
'SecretArn': 'string',
'SecretStatus': 'string',
'KmsKeyId': 'string'
},
'NetworkType': 'string'
}
}
Response Structure
(dict) --
DBCluster (dict) --
Detailed information about a cluster.
AvailabilityZones (list) --
Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
(string) --
BackupRetentionPeriod (integer) --
Specifies the number of days for which automatic snapshots are retained.
DBClusterIdentifier (string) --
Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.
DBClusterParameterGroup (string) --
Specifies the name of the cluster parameter group for the cluster.
DBSubnetGroup (string) --
Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.
Status (string) --
Specifies the current state of this cluster.
PercentProgress (string) --
Specifies the progress of the operation as a percentage.
EarliestRestorableTime (datetime) --
The earliest time to which a database can be restored with point-in-time restore.
Endpoint (string) --
Specifies the connection endpoint for the primary instance of the cluster.
ReaderEndpoint (string) --
The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.
If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.
MultiAZ (boolean) --
Specifies whether the cluster has instances in multiple Availability Zones.
Engine (string) --
Provides the name of the database engine to be used for this 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 user name for the cluster.
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 cluster if this cluster is a secondary cluster.
ReadReplicaIdentifiers (list) --
Contains one or more identifiers of the secondary clusters that are associated with this cluster.
(string) --
DBClusterMembers (list) --
Provides the list of instances that make up the cluster.
(dict) --
Contains information about an instance that is part of a cluster.
DBInstanceIdentifier (string) --
Specifies the instance identifier for this member of the cluster.
IsClusterWriter (boolean) --
A value that is true if the cluster member is the primary instance for the cluster and false otherwise.
DBClusterParameterGroupStatus (string) --
Specifies the status of the cluster parameter group for this member of the DB cluster.
PromotionTier (integer) --
A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
VpcSecurityGroups (list) --
Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.
(dict) --
Used as a response element for queries on virtual private cloud (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 cluster is encrypted.
KmsKeyId (string) --
If StorageEncrypted is true, the KMS key identifier for the encrypted cluster.
DbClusterResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the cluster. This identifier is found in CloudTrail log entries whenever the KMS key for the cluster is accessed.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for the cluster.
AssociatedRoles (list) --
Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.
(dict) --
Describes an Identity and Access Management (IAM) role that is associated with a cluster.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAMrole that is associated with the DB cluster.
Status (string) --
Describes the state of association between the IAMrole and the cluster. The Status property returns one of the following values:
ACTIVE - The IAMrole ARN is associated with the cluster and can be used to access other Amazon Web Services services on your behalf.
PENDING - The IAMrole ARN is being associated with the cluster.
INVALID - The IAMrole ARN is associated with the cluster, but the cluster cannot assume the IAMrole to access other Amazon Web Services services on your behalf.
CloneGroupId (string) --
Identifies the clone group to which the DB cluster is associated.
ClusterCreateTime (datetime) --
Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
EnabledCloudwatchLogsExports (list) --
A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.
(string) --
DeletionProtection (boolean) --
Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.
IOOptimizedNextAllowedModificationTime (datetime) --
The next time you can modify the Amazon DocumentDB cluster to use the iopt1 storage type.
StorageType (string) --
Storage type associated with your cluster
For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.
Valid values for storage type - standard | iopt1
Default value is standard
ServerlessV2ScalingConfiguration (dict) --
The scaling configuration of an Amazon DocumentDB Serverless cluster.
MinCapacity (float) --
The minimum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster. You can specify DCU values in half-step increments, such as 8, 8.5, 9, and so on.
MaxCapacity (float) --
The maximum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster. You can specify DCU values in half-step increments, such as 32, 32.5, 33, and so on.
MasterUserSecret (dict) --
The secret managed by Amazon DocumentDB in Amazon Web Services Secrets Manager for the master user password.
SecretArn (string) --
The Amazon Resource Name (ARN) of the secret.
SecretStatus (string) --
The status of the secret.
The possible status values include the following:
creating - The secret is being created.
active - The secret is available for normal use and rotation.
rotating - The secret is being rotated.
impaired - The secret can be used to access database credentials, but it can't be rotated. A secret might have this status if, for example, permissions are changed so that Amazon DocumentDB can no longer access either the secret or the KMS key for the secret. When a secret has this status, you can correct the condition that caused the status. Alternatively, modify the instance to turn off automatic management of database credentials, and then modify the instance again to turn on automatic management of database credentials.
KmsKeyId (string) --
The Amazon Web Services KMS key identifier that is used to encrypt the secret.
NetworkType (string) --
The network type of the cluster.
The network type is determined by the DBSubnetGroup specified for the cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols ( DUAL).
For more information, see DocumentDB clusters in a VPC in the Amazon DocumentDB Developer Guide.
Valid Values: IPV4 | DUAL
{'DBCluster': {'IOOptimizedNextAllowedModificationTime': 'timestamp',
'NetworkType': 'string'}}
Stops the running cluster that is specified by DBClusterIdentifier. The cluster must be in the available state. For more information, see Stopping and Starting an Amazon DocumentDB Cluster.
See also: AWS API Documentation
Request Syntax
client.stop_db_cluster(
DBClusterIdentifier='string'
)
string
[REQUIRED]
The identifier of the cluster to stop. Example: docdb-2019-05-28-15-24-52
dict
Response Syntax
{
'DBCluster': {
'AvailabilityZones': [
'string',
],
'BackupRetentionPeriod': 123,
'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',
'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'
},
],
'CloneGroupId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'EnabledCloudwatchLogsExports': [
'string',
],
'DeletionProtection': True|False,
'IOOptimizedNextAllowedModificationTime': datetime(2015, 1, 1),
'StorageType': 'string',
'ServerlessV2ScalingConfiguration': {
'MinCapacity': 123.0,
'MaxCapacity': 123.0
},
'MasterUserSecret': {
'SecretArn': 'string',
'SecretStatus': 'string',
'KmsKeyId': 'string'
},
'NetworkType': 'string'
}
}
Response Structure
(dict) --
DBCluster (dict) --
Detailed information about a cluster.
AvailabilityZones (list) --
Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
(string) --
BackupRetentionPeriod (integer) --
Specifies the number of days for which automatic snapshots are retained.
DBClusterIdentifier (string) --
Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.
DBClusterParameterGroup (string) --
Specifies the name of the cluster parameter group for the cluster.
DBSubnetGroup (string) --
Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.
Status (string) --
Specifies the current state of this cluster.
PercentProgress (string) --
Specifies the progress of the operation as a percentage.
EarliestRestorableTime (datetime) --
The earliest time to which a database can be restored with point-in-time restore.
Endpoint (string) --
Specifies the connection endpoint for the primary instance of the cluster.
ReaderEndpoint (string) --
The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.
If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.
MultiAZ (boolean) --
Specifies whether the cluster has instances in multiple Availability Zones.
Engine (string) --
Provides the name of the database engine to be used for this 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 user name for the cluster.
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 cluster if this cluster is a secondary cluster.
ReadReplicaIdentifiers (list) --
Contains one or more identifiers of the secondary clusters that are associated with this cluster.
(string) --
DBClusterMembers (list) --
Provides the list of instances that make up the cluster.
(dict) --
Contains information about an instance that is part of a cluster.
DBInstanceIdentifier (string) --
Specifies the instance identifier for this member of the cluster.
IsClusterWriter (boolean) --
A value that is true if the cluster member is the primary instance for the cluster and false otherwise.
DBClusterParameterGroupStatus (string) --
Specifies the status of the cluster parameter group for this member of the DB cluster.
PromotionTier (integer) --
A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
VpcSecurityGroups (list) --
Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.
(dict) --
Used as a response element for queries on virtual private cloud (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 cluster is encrypted.
KmsKeyId (string) --
If StorageEncrypted is true, the KMS key identifier for the encrypted cluster.
DbClusterResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the cluster. This identifier is found in CloudTrail log entries whenever the KMS key for the cluster is accessed.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for the cluster.
AssociatedRoles (list) --
Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.
(dict) --
Describes an Identity and Access Management (IAM) role that is associated with a cluster.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAMrole that is associated with the DB cluster.
Status (string) --
Describes the state of association between the IAMrole and the cluster. The Status property returns one of the following values:
ACTIVE - The IAMrole ARN is associated with the cluster and can be used to access other Amazon Web Services services on your behalf.
PENDING - The IAMrole ARN is being associated with the cluster.
INVALID - The IAMrole ARN is associated with the cluster, but the cluster cannot assume the IAMrole to access other Amazon Web Services services on your behalf.
CloneGroupId (string) --
Identifies the clone group to which the DB cluster is associated.
ClusterCreateTime (datetime) --
Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
EnabledCloudwatchLogsExports (list) --
A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.
(string) --
DeletionProtection (boolean) --
Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.
IOOptimizedNextAllowedModificationTime (datetime) --
The next time you can modify the Amazon DocumentDB cluster to use the iopt1 storage type.
StorageType (string) --
Storage type associated with your cluster
For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.
Valid values for storage type - standard | iopt1
Default value is standard
ServerlessV2ScalingConfiguration (dict) --
The scaling configuration of an Amazon DocumentDB Serverless cluster.
MinCapacity (float) --
The minimum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster. You can specify DCU values in half-step increments, such as 8, 8.5, 9, and so on.
MaxCapacity (float) --
The maximum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster. You can specify DCU values in half-step increments, such as 32, 32.5, 33, and so on.
MasterUserSecret (dict) --
The secret managed by Amazon DocumentDB in Amazon Web Services Secrets Manager for the master user password.
SecretArn (string) --
The Amazon Resource Name (ARN) of the secret.
SecretStatus (string) --
The status of the secret.
The possible status values include the following:
creating - The secret is being created.
active - The secret is available for normal use and rotation.
rotating - The secret is being rotated.
impaired - The secret can be used to access database credentials, but it can't be rotated. A secret might have this status if, for example, permissions are changed so that Amazon DocumentDB can no longer access either the secret or the KMS key for the secret. When a secret has this status, you can correct the condition that caused the status. Alternatively, modify the instance to turn off automatic management of database credentials, and then modify the instance again to turn on automatic management of database credentials.
KmsKeyId (string) --
The Amazon Web Services KMS key identifier that is used to encrypt the secret.
NetworkType (string) --
The network type of the cluster.
The network type is determined by the DBSubnetGroup specified for the cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols ( DUAL).
For more information, see DocumentDB clusters in a VPC in the Amazon DocumentDB Developer Guide.
Valid Values: IPV4 | DUAL