2023/11/06 - Amazon DocumentDB with MongoDB compatibility - 6 updated api methods
Changes Update the input of CreateDBInstance and ModifyDBInstance to support setting CA Certificates. Update the output of DescribeDBInstance and DescribeDBEngineVersions to show current and supported CA certificates.
{'CACertificateIdentifier': 'string'}
Response {'DBInstance': {'CertificateDetails': {'CAIdentifier': 'string',
'ValidTill': 'timestamp'}}}
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'
},
'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)
}
}
}
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.
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.
{'DBInstance': {'CertificateDetails': {'CAIdentifier': 'string',
'ValidTill': 'timestamp'}}}
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'
},
'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)
}
}
}
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.
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.
{'DBEngineVersions': {'SupportedCACertificateIdentifiers': ['string'],
'SupportsCertificateRotationWithoutRestart': 'boolean'}}
Returns a list of the available engines.
See also: AWS API Documentation
Request Syntax
client.describe_db_engine_versions(
Engine='string',
EngineVersion='string',
DBParameterGroupFamily='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string',
DefaultOnly=True|False,
ListSupportedCharacterSets=True|False,
ListSupportedTimezones=True|False
)
string
The database engine to return.
string
The database engine version to return.
Example: 3.6.0
string
The name of a specific parameter group family to return details for.
Constraints:
If provided, must match an existing DBParameterGroupFamily.
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.
boolean
Indicates that only the default version of the specified engine or engine and major version combination is returned.
boolean
If this parameter is specified and the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.
boolean
If this parameter is specified and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version.
dict
Response Syntax
{
'Marker': 'string',
'DBEngineVersions': [
{
'Engine': 'string',
'EngineVersion': 'string',
'DBParameterGroupFamily': 'string',
'DBEngineDescription': 'string',
'DBEngineVersionDescription': 'string',
'ValidUpgradeTarget': [
{
'Engine': 'string',
'EngineVersion': 'string',
'Description': 'string',
'AutoUpgrade': True|False,
'IsMajorVersionUpgrade': True|False
},
],
'ExportableLogTypes': [
'string',
],
'SupportsLogExportsToCloudwatchLogs': True|False,
'SupportedCACertificateIdentifiers': [
'string',
],
'SupportsCertificateRotationWithoutRestart': True|False
},
]
}
Response Structure
(dict) --
Represents the output of DescribeDBEngineVersions.
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.
DBEngineVersions (list) --
Detailed information about one or more engine versions.
(dict) --
Detailed information about an engine version.
Engine (string) --
The name of the database engine.
EngineVersion (string) --
The version number of the database engine.
DBParameterGroupFamily (string) --
The name of the parameter group family for the database engine.
DBEngineDescription (string) --
The description of the database engine.
DBEngineVersionDescription (string) --
The description of the database engine version.
ValidUpgradeTarget (list) --
A list of engine versions that this database engine version can be upgraded to.
(dict) --
The version of the database engine that an instance can be upgraded to.
Engine (string) --
The name of the upgrade target database engine.
EngineVersion (string) --
The version number of the upgrade target database engine.
Description (string) --
The version of the database engine that an instance can be upgraded to.
AutoUpgrade (boolean) --
A value that indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.
IsMajorVersionUpgrade (boolean) --
A value that indicates whether a database engine is upgraded to a major version.
ExportableLogTypes (list) --
The types of logs that the database engine has available for export to Amazon CloudWatch Logs.
(string) --
SupportsLogExportsToCloudwatchLogs (boolean) --
A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.
SupportedCACertificateIdentifiers (list) --
A list of the supported CA certificate identifiers.
For more information, see Updating Your Amazon DocumentDB TLS Certificates and Encrypting Data in Transit in the Amazon DocumentDB Developer Guide.
(string) --
SupportsCertificateRotationWithoutRestart (boolean) --
Indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.
{'DBInstances': {'CertificateDetails': {'CAIdentifier': 'string',
'ValidTill': 'timestamp'}}}
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'
},
'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)
}
},
]
}
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.
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.
{'CertificateRotationRestart': 'boolean'}
Response {'DBInstance': {'CertificateDetails': {'CAIdentifier': 'string',
'ValidTill': 'timestamp'}}}
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'
},
'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)
}
}
}
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.
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.
{'DBInstance': {'CertificateDetails': {'CAIdentifier': 'string',
'ValidTill': 'timestamp'}}}
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'
},
'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)
}
}
}
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.
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.