Table of Contents
RDS.Client¶A low-level client representing Amazon Relational Database Service (RDS)
Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. It provides cost-efficient, resizeable capacity for an industry-standard relational database and manages common database administration tasks, freeing up developers to focus on what makes their applications and businesses unique.
Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, Oracle, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS is flexible: you can scale your DB instance's compute resources and storage capacity to meet your application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for the resources you use.
This interface reference for Amazon RDS contains documentation for a programming or command line interface you can use to manage Amazon RDS. Amazon RDS is asynchronous, which means that some interfaces might require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. The reference structure is as follows, and we list following some related topics from the user guide.
Amazon RDS API Reference
Amazon RDS User Guide
import boto3
client = boto3.client('rds')
These are the available methods:
add_role_to_db_cluster()add_role_to_db_instance()add_source_identifier_to_subscription()add_tags_to_resource()apply_pending_maintenance_action()authorize_db_security_group_ingress()backtrack_db_cluster()can_paginate()cancel_export_task()close()copy_db_cluster_parameter_group()copy_db_cluster_snapshot()copy_db_parameter_group()copy_db_snapshot()copy_option_group()create_custom_db_engine_version()create_db_cluster()create_db_cluster_endpoint()create_db_cluster_parameter_group()create_db_cluster_snapshot()create_db_instance()create_db_instance_read_replica()create_db_parameter_group()create_db_proxy()create_db_proxy_endpoint()create_db_security_group()create_db_snapshot()create_db_subnet_group()create_event_subscription()create_global_cluster()create_option_group()delete_custom_db_engine_version()delete_db_cluster()delete_db_cluster_endpoint()delete_db_cluster_parameter_group()delete_db_cluster_snapshot()delete_db_instance()delete_db_instance_automated_backup()delete_db_parameter_group()delete_db_proxy()delete_db_proxy_endpoint()delete_db_security_group()delete_db_snapshot()delete_db_subnet_group()delete_event_subscription()delete_global_cluster()delete_option_group()deregister_db_proxy_targets()describe_account_attributes()describe_certificates()describe_db_cluster_backtracks()describe_db_cluster_endpoints()describe_db_cluster_parameter_groups()describe_db_cluster_parameters()describe_db_cluster_snapshot_attributes()describe_db_cluster_snapshots()describe_db_clusters()describe_db_engine_versions()describe_db_instance_automated_backups()describe_db_instances()describe_db_log_files()describe_db_parameter_groups()describe_db_parameters()describe_db_proxies()describe_db_proxy_endpoints()describe_db_proxy_target_groups()describe_db_proxy_targets()describe_db_security_groups()describe_db_snapshot_attributes()describe_db_snapshots()describe_db_subnet_groups()describe_engine_default_cluster_parameters()describe_engine_default_parameters()describe_event_categories()describe_event_subscriptions()describe_events()describe_export_tasks()describe_global_clusters()describe_option_group_options()describe_option_groups()describe_orderable_db_instance_options()describe_pending_maintenance_actions()describe_reserved_db_instances()describe_reserved_db_instances_offerings()describe_source_regions()describe_valid_db_instance_modifications()download_db_log_file_portion()failover_db_cluster()failover_global_cluster()generate_db_auth_token()get_paginator()get_waiter()list_tags_for_resource()modify_activity_stream()modify_certificates()modify_current_db_cluster_capacity()modify_custom_db_engine_version()modify_db_cluster()modify_db_cluster_endpoint()modify_db_cluster_parameter_group()modify_db_cluster_snapshot_attribute()modify_db_instance()modify_db_parameter_group()modify_db_proxy()modify_db_proxy_endpoint()modify_db_proxy_target_group()modify_db_snapshot()modify_db_snapshot_attribute()modify_db_subnet_group()modify_event_subscription()modify_global_cluster()modify_option_group()promote_read_replica()promote_read_replica_db_cluster()purchase_reserved_db_instances_offering()reboot_db_cluster()reboot_db_instance()register_db_proxy_targets()remove_from_global_cluster()remove_role_from_db_cluster()remove_role_from_db_instance()remove_source_identifier_from_subscription()remove_tags_from_resource()reset_db_cluster_parameter_group()reset_db_parameter_group()restore_db_cluster_from_s3()restore_db_cluster_from_snapshot()restore_db_cluster_to_point_in_time()restore_db_instance_from_db_snapshot()restore_db_instance_from_s3()restore_db_instance_to_point_in_time()revoke_db_security_group_ingress()start_activity_stream()start_db_cluster()start_db_instance()start_db_instance_automated_backups_replication()start_export_task()stop_activity_stream()stop_db_cluster()stop_db_instance()stop_db_instance_automated_backups_replication()add_role_to_db_cluster(**kwargs)¶Associates an Identity and Access Management (IAM) role with a DB cluster.
See also: AWS API Documentation
Request Syntax
response = client.add_role_to_db_cluster(
DBClusterIdentifier='string',
RoleArn='string',
FeatureName='string'
)
[REQUIRED]
The name of the DB cluster to associate the IAM role with.
[REQUIRED]
The Amazon Resource Name (ARN) of the IAM role to associate with the Aurora DB cluster, for example arn:aws:iam::123456789012:role/AuroraAccessRole .
None
Exceptions
RDS.Client.exceptions.DBClusterNotFoundFaultRDS.Client.exceptions.DBClusterRoleAlreadyExistsFaultRDS.Client.exceptions.InvalidDBClusterStateFaultRDS.Client.exceptions.DBClusterRoleQuotaExceededFaultadd_role_to_db_instance(**kwargs)¶Associates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance.
Note
To add a role to a DB instance, the status of the DB instance must be available .
This command doesn't apply to RDS Custom.
See also: AWS API Documentation
Request Syntax
response = client.add_role_to_db_instance(
DBInstanceIdentifier='string',
RoleArn='string',
FeatureName='string'
)
[REQUIRED]
The name of the DB instance to associate the IAM role with.
[REQUIRED]
The Amazon Resource Name (ARN) of the IAM role to associate with the DB instance, for example arn:aws:iam::123456789012:role/AccessRole .
[REQUIRED]
The name of the feature for the DB instance that the IAM role is to be associated with. For information about supported feature names, see DBEngineVersion .
None
Exceptions
RDS.Client.exceptions.DBInstanceNotFoundFaultRDS.Client.exceptions.DBInstanceRoleAlreadyExistsFaultRDS.Client.exceptions.InvalidDBInstanceStateFaultRDS.Client.exceptions.DBInstanceRoleQuotaExceededFaultadd_source_identifier_to_subscription(**kwargs)¶Adds a source identifier to an existing RDS event notification subscription.
See also: AWS API Documentation
Request Syntax
response = client.add_source_identifier_to_subscription(
SubscriptionName='string',
SourceIdentifier='string'
)
[REQUIRED]
The name of the RDS event notification subscription you want to add a source identifier to.
[REQUIRED]
The identifier of the event source to be added.
Constraints:
DBInstanceIdentifier value must be supplied.DBClusterIdentifier value must be supplied.DBParameterGroupName value must be supplied.DBSecurityGroupName value must be supplied.DBSnapshotIdentifier value must be supplied.DBClusterSnapshotIdentifier value must be supplied.DBProxyName value must be supplied.dict
Response Syntax
{
'EventSubscription': {
'CustomerAwsId': 'string',
'CustSubscriptionId': 'string',
'SnsTopicArn': 'string',
'Status': 'string',
'SubscriptionCreationTime': 'string',
'SourceType': 'string',
'SourceIdsList': [
'string',
],
'EventCategoriesList': [
'string',
],
'Enabled': True|False,
'EventSubscriptionArn': 'string'
}
}
Response Structure
(dict) --
EventSubscription (dict) --
Contains the results of a successful invocation of the DescribeEventSubscriptions action.
CustomerAwsId (string) --
The Amazon Web Services customer account associated with the RDS event notification subscription.
CustSubscriptionId (string) --
The RDS event notification subscription Id.
SnsTopicArn (string) --
The topic ARN of the RDS event notification subscription.
Status (string) --
The status of the RDS event notification subscription.
Constraints:
Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist
The status "no-permission" indicates that RDS no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.
SubscriptionCreationTime (string) --
The time the RDS event notification subscription was created.
SourceType (string) --
The source type for the RDS event notification subscription.
SourceIdsList (list) --
A list of source IDs for the RDS event notification subscription.
EventCategoriesList (list) --
A list of event categories for the RDS event notification subscription.
Enabled (boolean) --
A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.
EventSubscriptionArn (string) --
The Amazon Resource Name (ARN) for the event subscription.
Exceptions
RDS.Client.exceptions.SubscriptionNotFoundFaultRDS.Client.exceptions.SourceNotFoundFaultExamples
This example add a source identifier to an event notification subscription.
response = client.add_source_identifier_to_subscription(
SourceIdentifier='mymysqlinstance',
SubscriptionName='mymysqleventsubscription',
)
print(response)
Expected Output:
{
'EventSubscription': {
},
'ResponseMetadata': {
'...': '...',
},
}
Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in a Condition statement in an IAM policy for Amazon RDS.
For an overview on tagging Amazon RDS resources, see Tagging Amazon RDS Resources .
See also: AWS API Documentation
Request Syntax
response = client.add_tags_to_resource(
ResourceName='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The Amazon RDS resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN) .
[REQUIRED]
The tags to be assigned to the Amazon RDS resource.
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
None
Exceptions
RDS.Client.exceptions.DBInstanceNotFoundFaultRDS.Client.exceptions.DBClusterNotFoundFaultRDS.Client.exceptions.DBSnapshotNotFoundFaultRDS.Client.exceptions.DBProxyNotFoundFaultRDS.Client.exceptions.DBProxyTargetGroupNotFoundFaultExamples
This example adds a tag to an option group.
response = client.add_tags_to_resource(
ResourceName='arn:aws:rds:us-east-1:992648334831:og:mymysqloptiongroup',
Tags=[
{
'Key': 'Staging',
'Value': 'LocationDB',
},
],
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
apply_pending_maintenance_action(**kwargs)¶Applies a pending maintenance action to a resource (for example, to a DB instance).
See also: AWS API Documentation
Request Syntax
response = client.apply_pending_maintenance_action(
ResourceIdentifier='string',
ApplyAction='string',
OptInType='string'
)
[REQUIRED]
The RDS Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to. For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN) .
[REQUIRED]
The pending maintenance action to apply to this resource.
Valid values: system-update , db-upgrade , hardware-maintenance , ca-certificate-rotation
[REQUIRED]
A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in request of type immediate can't be undone.
Valid values:
immediate - Apply the maintenance action immediately.next-maintenance - Apply the maintenance action during the next maintenance window for the resource.undo-opt-in - Cancel any existing next-maintenance opt-in requests.dict
Response Syntax
{
'ResourcePendingMaintenanceActions': {
'ResourceIdentifier': 'string',
'PendingMaintenanceActionDetails': [
{
'Action': 'string',
'AutoAppliedAfterDate': datetime(2015, 1, 1),
'ForcedApplyDate': datetime(2015, 1, 1),
'OptInStatus': 'string',
'CurrentApplyDate': datetime(2015, 1, 1),
'Description': 'string'
},
]
}
}
Response Structure
(dict) --
ResourcePendingMaintenanceActions (dict) --
Describes the pending maintenance actions for a resource.
ResourceIdentifier (string) --
The ARN of the resource that has pending maintenance actions.
PendingMaintenanceActionDetails (list) --
A list that provides details about the pending maintenance actions for the resource.
(dict) --
Provides information about a pending maintenance action for a resource.
Action (string) --
The type of pending maintenance action that is available for the resource. Valid actions are system-update , db-upgrade , hardware-maintenance , and ca-certificate-rotation .
AutoAppliedAfterDate (datetime) --
The date of the maintenance window when the action is applied. The maintenance action is applied to the resource during its first maintenance window after this date.
ForcedApplyDate (datetime) --
The date when the maintenance action is automatically applied.
On this date, the maintenance action is applied to the resource as soon as possible, regardless of the maintenance window for the resource. There might be a delay of one or more days from this date before the maintenance action is applied.
OptInStatus (string) --
Indicates the type of opt-in request that has been received for the resource.
CurrentApplyDate (datetime) --
The effective date when the pending maintenance action is applied to the resource. This date takes into account opt-in requests received from the ApplyPendingMaintenanceAction API, the AutoAppliedAfterDate , and the ForcedApplyDate . This value is blank if an opt-in request has not been received and nothing has been specified as AutoAppliedAfterDate or ForcedApplyDate .
Description (string) --
A description providing more detail about the maintenance action.
Exceptions
RDS.Client.exceptions.ResourceNotFoundFaultRDS.Client.exceptions.InvalidDBClusterStateFaultRDS.Client.exceptions.InvalidDBInstanceStateFaultExamples
This example immediately applies a pending system update to a DB instance.
response = client.apply_pending_maintenance_action(
ApplyAction='system-update',
OptInType='immediate',
ResourceIdentifier='arn:aws:rds:us-east-1:992648334831:db:mymysqlinstance',
)
print(response)
Expected Output:
{
'ResourcePendingMaintenanceActions': {
},
'ResponseMetadata': {
'...': '...',
},
}
Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).
Note
You can't authorize ingress from an EC2 security group in one Amazon Web Services Region to an Amazon RDS DB instance in another. You can't authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.
For an overview of CIDR ranges, go to the Wikipedia Tutorial .
See also: AWS API Documentation
Request Syntax
response = client.authorize_db_security_group_ingress(
DBSecurityGroupName='string',
CIDRIP='string',
EC2SecurityGroupName='string',
EC2SecurityGroupId='string',
EC2SecurityGroupOwnerId='string'
)
[REQUIRED]
The name of the DB security group to add authorization to.
EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.EC2SecurityGroupName parameter. The Amazon Web Services access key ID isn't an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.dict
Response Syntax
{
'DBSecurityGroup': {
'OwnerId': 'string',
'DBSecurityGroupName': 'string',
'DBSecurityGroupDescription': 'string',
'VpcId': 'string',
'EC2SecurityGroups': [
{
'Status': 'string',
'EC2SecurityGroupName': 'string',
'EC2SecurityGroupId': 'string',
'EC2SecurityGroupOwnerId': 'string'
},
],
'IPRanges': [
{
'Status': 'string',
'CIDRIP': 'string'
},
],
'DBSecurityGroupArn': 'string'
}
}
Response Structure
(dict) --
DBSecurityGroup (dict) --
Contains the details for an Amazon RDS DB security group.
This data type is used as a response element in the DescribeDBSecurityGroups action.
OwnerId (string) --
Provides the Amazon Web Services ID of the owner of a specific DB security group.
DBSecurityGroupName (string) --
Specifies the name of the DB security group.
DBSecurityGroupDescription (string) --
Provides the description of the DB security group.
VpcId (string) --
Provides the VpcId of the DB security group.
EC2SecurityGroups (list) --
Contains a list of EC2SecurityGroup elements.
(dict) --
This data type is used as a response element in the following actions:
AuthorizeDBSecurityGroupIngressDescribeDBSecurityGroupsRevokeDBSecurityGroupIngressStatus (string) --
Provides the status of the EC2 security group. Status can be "authorizing", "authorized", "revoking", and "revoked".
EC2SecurityGroupName (string) --
Specifies the name of the EC2 security group.
EC2SecurityGroupId (string) --
Specifies the id of the EC2 security group.
EC2SecurityGroupOwnerId (string) --
Specifies the Amazon Web Services ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.
IPRanges (list) --
Contains a list of IPRange elements.
(dict) --
This data type is used as a response element in the DescribeDBSecurityGroups action.
Status (string) --
Specifies the status of the IP range. Status can be "authorizing", "authorized", "revoking", and "revoked".
CIDRIP (string) --
Specifies the IP range.
DBSecurityGroupArn (string) --
The Amazon Resource Name (ARN) for the DB security group.
Exceptions
RDS.Client.exceptions.DBSecurityGroupNotFoundFaultRDS.Client.exceptions.InvalidDBSecurityGroupStateFaultRDS.Client.exceptions.AuthorizationAlreadyExistsFaultRDS.Client.exceptions.AuthorizationQuotaExceededFaultExamples
This example authorizes access to the specified security group by the specified CIDR block.
response = client.authorize_db_security_group_ingress(
CIDRIP='203.0.113.5/32',
DBSecurityGroupName='mydbsecuritygroup',
)
print(response)
Expected Output:
{
'DBSecurityGroup': {
},
'ResponseMetadata': {
'...': '...',
},
}
backtrack_db_cluster(**kwargs)¶Backtracks a DB cluster to a specific time, without creating a new DB cluster.
For more information on backtracking, see Backtracking an Aurora DB Cluster in the Amazon Aurora User Guide .
Note
This action applies only to Aurora MySQL DB clusters.
See also: AWS API Documentation
Request Syntax
response = client.backtrack_db_cluster(
DBClusterIdentifier='string',
BacktrackTo=datetime(2015, 1, 1),
Force=True|False,
UseEarliestTimeOnPointInTimeUnavailable=True|False
)
[REQUIRED]
The DB cluster identifier of the DB cluster to be backtracked. This parameter is stored as a lowercase string.
Constraints:
Example: my-cluster1
[REQUIRED]
The timestamp of the time to backtrack the DB cluster to, specified in ISO 8601 format. For more information about ISO 8601, see the ISO8601 Wikipedia page.
Note
If the specified time isn't a consistent time for the DB cluster, Aurora automatically chooses the nearest possible consistent time for the DB cluster.
Constraints:
Example: 2017-07-08T18:00Z
dict
Response Syntax
{
'DBClusterIdentifier': 'string',
'BacktrackIdentifier': 'string',
'BacktrackTo': datetime(2015, 1, 1),
'BacktrackedFrom': datetime(2015, 1, 1),
'BacktrackRequestCreationTime': datetime(2015, 1, 1),
'Status': 'string'
}
Response Structure
(dict) --
This data type is used as a response element in the DescribeDBClusterBacktracks action.
DBClusterIdentifier (string) --
Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
BacktrackIdentifier (string) --
Contains the backtrack identifier.
BacktrackTo (datetime) --
The timestamp of the time to which the DB cluster was backtracked.
BacktrackedFrom (datetime) --
The timestamp of the time from which the DB cluster was backtracked.
BacktrackRequestCreationTime (datetime) --
The timestamp of the time at which the backtrack was requested.
Status (string) --
The status of the backtrack. This property returns one of the following values:
applying - The backtrack is currently being applied to or rolled back from the DB cluster.completed - The backtrack has successfully been applied to or rolled back from the DB cluster.failed - An error occurred while the backtrack was applied to or rolled back from the DB cluster.pending - The backtrack is currently pending application to or rollback from the DB cluster.Exceptions
RDS.Client.exceptions.DBClusterNotFoundFaultRDS.Client.exceptions.InvalidDBClusterStateFaultcan_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.cancel_export_task(**kwargs)¶Cancels an export task in progress that is exporting a snapshot to Amazon S3. Any data that has already been written to the S3 bucket isn't removed.
See also: AWS API Documentation
Request Syntax
response = client.cancel_export_task(
ExportTaskIdentifier='string'
)
[REQUIRED]
The identifier of the snapshot export task to cancel.
{
'ExportTaskIdentifier': 'string',
'SourceArn': 'string',
'ExportOnly': [
'string',
],
'SnapshotTime': datetime(2015, 1, 1),
'TaskStartTime': datetime(2015, 1, 1),
'TaskEndTime': datetime(2015, 1, 1),
'S3Bucket': 'string',
'S3Prefix': 'string',
'IamRoleArn': 'string',
'KmsKeyId': 'string',
'Status': 'string',
'PercentProgress': 123,
'TotalExtractedDataInGB': 123,
'FailureCause': 'string',
'WarningMessage': 'string'
}
Response Structure
Contains the details of a snapshot export to Amazon S3.
This data type is used as a response element in the DescribeExportTasks action.
A unique identifier for the snapshot export task. This ID isn't an identifier for the Amazon S3 bucket where the snapshot is exported to.
The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.
The data exported from the snapshot. Valid values are the following:
database - Export all the data from a specified database.database.table table-name - Export a table of the snapshot. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.database.schema schema-name - Export a database schema of the snapshot. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.database.schema.table table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.The time that the snapshot was created.
The time that the snapshot export task started.
The time that the snapshot export task completed.
The Amazon S3 bucket that the snapshot is exported to.
The Amazon S3 bucket prefix that is the file name and path of the exported snapshot.
The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot.
The key identifier of the Amazon Web Services KMS key that is used to encrypt the snapshot when it's exported to Amazon S3. The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the snapshot export must have encryption and decryption permissions to use this KMS key.
The progress status of the export task.
The progress of the snapshot export task as a percentage.
The total amount of data exported, in gigabytes.
The reason the export failed, if it failed.
A warning about the snapshot export task.
Exceptions
RDS.Client.exceptions.ExportTaskNotFoundFaultRDS.Client.exceptions.InvalidExportTaskStateFaultclose()¶Closes underlying endpoint connections.
copy_db_cluster_parameter_group(**kwargs)¶Copies the specified DB cluster parameter group.
See also: AWS API Documentation
Request Syntax
response = client.copy_db_cluster_parameter_group(
SourceDBClusterParameterGroupIdentifier='string',
TargetDBClusterParameterGroupIdentifier='string',
TargetDBClusterParameterGroupDescription='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group. For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon Aurora User Guide .
Constraints:
[REQUIRED]
The identifier for the copied DB cluster parameter group.
Constraints:
Example: my-cluster-param-group1
[REQUIRED]
A description for the copied DB cluster parameter group.
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
dict
Response Syntax
{
'DBClusterParameterGroup': {
'DBClusterParameterGroupName': 'string',
'DBParameterGroupFamily': 'string',
'Description': 'string',
'DBClusterParameterGroupArn': 'string'
}
}
Response Structure
(dict) --
DBClusterParameterGroup (dict) --
Contains the details of an Amazon RDS DB cluster parameter group.
This data type is used as a response element in the DescribeDBClusterParameterGroups action.
DBClusterParameterGroupName (string) --
The name of the DB cluster parameter group.
DBParameterGroupFamily (string) --
The name of the DB parameter group family that this DB cluster parameter group is compatible with.
Description (string) --
Provides the customer-specified description for this DB cluster parameter group.
DBClusterParameterGroupArn (string) --
The Amazon Resource Name (ARN) for the DB cluster parameter group.
Exceptions
RDS.Client.exceptions.DBParameterGroupNotFoundFaultRDS.Client.exceptions.DBParameterGroupQuotaExceededFaultRDS.Client.exceptions.DBParameterGroupAlreadyExistsFaultExamples
This example copies a DB cluster parameter group.
response = client.copy_db_cluster_parameter_group(
SourceDBClusterParameterGroupIdentifier='mydbclusterparametergroup',
TargetDBClusterParameterGroupDescription='My DB cluster parameter group copy',
TargetDBClusterParameterGroupIdentifier='mydbclusterparametergroup-copy',
)
print(response)
Expected Output:
{
'DBClusterParameterGroup': {
},
'ResponseMetadata': {
'...': '...',
},
}
copy_db_cluster_snapshot(**kwargs)¶Copies a snapshot of a DB cluster.
To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.
You can copy an encrypted DB cluster snapshot from another Amazon Web Services Region. In that case, the Amazon Web Services Region where you call the CopyDBClusterSnapshot operation is the destination Amazon Web Services Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another Amazon Web Services Region, you must provide the following values:
KmsKeyId - The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region.TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination Amazon Web Services Region.SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the ARN format for the source Amazon Web Services Region and is the same value as the SourceDBClusterSnapshotIdentifier in the presigned URL.To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in "copying" status.
For more information on copying encrypted Amazon Aurora DB cluster snapshots from one Amazon Web Services Region to another, see Copying a Snapshot in the Amazon Aurora User Guide .
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide .
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide .
See also: AWS API Documentation
Request Syntax
response = client.copy_db_cluster_snapshot(
SourceDBClusterSnapshotIdentifier='string',
TargetDBClusterSnapshotIdentifier='string',
KmsKeyId='string',
CopyTags=True|False,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
SourceRegion='string'
)
[REQUIRED]
The identifier of the DB cluster snapshot to copy. This parameter isn't case-sensitive.
You can't copy an encrypted, shared DB cluster snapshot from one Amazon Web Services Region to another.
Constraints:
Example: my-cluster-snapshot1
[REQUIRED]
The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter isn't case-sensitive.
Constraints:
Example: my-cluster-snapshot2
The Amazon Web Services KMS key identifier for an encrypted DB cluster snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS key.
If you copy an encrypted DB cluster snapshot from your Amazon Web Services account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS key. If you don't specify a value for KmsKeyId , then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot.
If you copy an encrypted DB cluster snapshot that is shared from another Amazon Web Services account, then you must specify a value for KmsKeyId .
To copy an encrypted DB cluster snapshot to another Amazon Web Services Region, you must set KmsKeyId to the Amazon Web Services KMS key identifier you want to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region that they are created in, and you can't use KMS keys from one Amazon Web Services Region in another Amazon Web Services Region.
If you copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.
When you are copying a DB cluster snapshot from one Amazon Web Services GovCloud (US) Region to another, the URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API operation in the Amazon Web Services Region that contains the source DB cluster snapshot to copy. Use the PreSignedUrl parameter when copying an encrypted DB cluster snapshot from another Amazon Web Services Region. Don't specify PreSignedUrl when copying an encrypted DB cluster snapshot in the same Amazon Web Services Region.
This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other Amazon Web Services Regions.
The presigned URL must be a valid request for the CopyDBClusterSnapshot API operation that can run in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to copy. The presigned URL request must contain the following parameter values:
KmsKeyId - The KMS key identifier for the KMS key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. This is the same identifier for both the CopyDBClusterSnapshot operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL.DestinationRegion - The name of the Amazon Web Services Region that the DB cluster snapshot is to be created in.SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115 .To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process .
Note
If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.
Please note that this parameter is automatically populated if it is not provided. Including this parameter is not required
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
dict
Response Syntax
{
'DBClusterSnapshot': {
'AvailabilityZones': [
'string',
],
'DBClusterSnapshotIdentifier': 'string',
'DBClusterIdentifier': 'string',
'SnapshotCreateTime': datetime(2015, 1, 1),
'Engine': 'string',
'EngineMode': 'string',
'AllocatedStorage': 123,
'Status': 'string',
'Port': 123,
'VpcId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'EngineVersion': 'string',
'LicenseModel': 'string',
'SnapshotType': 'string',
'PercentProgress': 123,
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DBClusterSnapshotArn': 'string',
'SourceDBClusterSnapshotArn': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
DBClusterSnapshot (dict) --
Contains the details for an Amazon RDS DB cluster snapshot
This data type is used as a response element in the DescribeDBClusterSnapshots action.
AvailabilityZones (list) --
Provides the list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
DBClusterSnapshotIdentifier (string) --
Specifies the identifier for the DB cluster snapshot.
DBClusterIdentifier (string) --
Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
SnapshotCreateTime (datetime) --
Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
Engine (string) --
Specifies the name of the database engine for this DB cluster snapshot.
EngineMode (string) --
Provides the engine mode of the database engine for this DB cluster snapshot.
AllocatedStorage (integer) --
Specifies the allocated storage size in gibibytes (GiB).
Status (string) --
Specifies the status of this DB cluster snapshot. Valid statuses are the following:
availablecopyingcreatingPort (integer) --
Specifies the port that the DB cluster was listening on at the time of the snapshot.
VpcId (string) --
Provides the VPC ID associated with the DB cluster snapshot.
ClusterCreateTime (datetime) --
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
MasterUsername (string) --
Provides the master username for this DB cluster snapshot.
EngineVersion (string) --
Provides the version of the database engine for this DB cluster snapshot.
LicenseModel (string) --
Provides the license model information for this DB cluster snapshot.
SnapshotType (string) --
Provides the type of the DB cluster snapshot.
PercentProgress (integer) --
Specifies the percentage of the estimated data that has been transferred.
StorageEncrypted (boolean) --
Specifies whether the DB cluster snapshot is encrypted.
KmsKeyId (string) --
If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
DBClusterSnapshotArn (string) --
The Amazon Resource Name (ARN) for the DB cluster snapshot.
SourceDBClusterSnapshotArn (string) --
If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.
IAMDatabaseAuthenticationEnabled (boolean) --
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
TagList (list) --
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Exceptions
RDS.Client.exceptions.DBClusterSnapshotAlreadyExistsFaultRDS.Client.exceptions.DBClusterSnapshotNotFoundFaultRDS.Client.exceptions.InvalidDBClusterStateFaultRDS.Client.exceptions.InvalidDBClusterSnapshotStateFaultRDS.Client.exceptions.SnapshotQuotaExceededFaultRDS.Client.exceptions.KMSKeyNotAccessibleFaultExamples
The following example copies an automated snapshot of a DB cluster to a new DB cluster snapshot.
response = client.copy_db_cluster_snapshot(
SourceDBClusterSnapshotIdentifier='rds:sample-cluster-2016-09-14-10-38',
TargetDBClusterSnapshotIdentifier='cluster-snapshot-copy-1',
)
print(response)
Expected Output:
{
'DBClusterSnapshot': {
},
'ResponseMetadata': {
'...': '...',
},
}
copy_db_parameter_group(**kwargs)¶Copies the specified DB parameter group.
See also: AWS API Documentation
Request Syntax
response = client.copy_db_parameter_group(
SourceDBParameterGroupIdentifier='string',
TargetDBParameterGroupIdentifier='string',
TargetDBParameterGroupDescription='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The identifier or ARN for the source DB parameter group. For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide .
Constraints:
[REQUIRED]
The identifier for the copied DB parameter group.
Constraints:
Example: my-db-parameter-group
[REQUIRED]
A description for the copied DB parameter group.
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
dict
Response Syntax
{
'DBParameterGroup': {
'DBParameterGroupName': 'string',
'DBParameterGroupFamily': 'string',
'Description': 'string',
'DBParameterGroupArn': 'string'
}
}
Response Structure
(dict) --
DBParameterGroup (dict) --
Contains the details of an Amazon RDS DB parameter group.
This data type is used as a response element in the DescribeDBParameterGroups action.
DBParameterGroupName (string) --
The name of the DB parameter group.
DBParameterGroupFamily (string) --
The name of the DB parameter group family that this DB parameter group is compatible with.
Description (string) --
Provides the customer-specified description for this DB parameter group.
DBParameterGroupArn (string) --
The Amazon Resource Name (ARN) for the DB parameter group.
Exceptions
RDS.Client.exceptions.DBParameterGroupNotFoundFaultRDS.Client.exceptions.DBParameterGroupAlreadyExistsFaultRDS.Client.exceptions.DBParameterGroupQuotaExceededFaultExamples
This example copies a DB parameter group.
response = client.copy_db_parameter_group(
SourceDBParameterGroupIdentifier='mymysqlparametergroup',
TargetDBParameterGroupDescription='My MySQL parameter group copy',
TargetDBParameterGroupIdentifier='mymysqlparametergroup-copy',
)
print(response)
Expected Output:
{
'DBParameterGroup': {
},
'ResponseMetadata': {
'...': '...',
},
}
copy_db_snapshot(**kwargs)¶Copies the specified DB snapshot. The source DB snapshot must be in the available state.
You can copy a snapshot from one Amazon Web Services Region to another. In that case, the Amazon Web Services Region where you call the CopyDBSnapshot operation is the destination Amazon Web Services Region for the DB snapshot copy.
This command doesn't apply to RDS Custom.
For more information about copying snapshots, see Copying a DB Snapshot in the Amazon RDS User Guide .
See also: AWS API Documentation
Request Syntax
response = client.copy_db_snapshot(
SourceDBSnapshotIdentifier='string',
TargetDBSnapshotIdentifier='string',
KmsKeyId='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
CopyTags=True|False,
OptionGroupName='string',
TargetCustomAvailabilityZone='string',
SourceRegion='string'
)
[REQUIRED]
The identifier for the source DB snapshot.
If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB snapshot identifier. For example, you might specify rds:mysql-instance1-snapshot-20130805 .
If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB snapshot ARN. For example, you might specify arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805 .
If you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot.
If you are copying an encrypted snapshot this parameter must be in the ARN format for the source Amazon Web Services Region.
Constraints:
Example: rds:mydb-2012-04-02-00-01
Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805
[REQUIRED]
The identifier for the copy of the snapshot.
Constraints:
Example: my-db-snapshot
The Amazon Web Services KMS key identifier for an encrypted DB snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you copy an encrypted DB snapshot from your Amazon Web Services account, you can specify a value for this parameter to encrypt the copy with a new KMS key. If you don't specify a value for this parameter, then the copy of the DB snapshot is encrypted with the same Amazon Web Services KMS key as the source DB snapshot.
If you copy an encrypted DB snapshot that is shared from another Amazon Web Services account, then you must specify a value for this parameter.
If you specify this parameter when you copy an unencrypted snapshot, the copy is encrypted.
If you copy an encrypted snapshot to a different Amazon Web Services Region, then you must specify an Amazon Web Services KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region that they are created in, and you can't use KMS keys from one Amazon Web Services Region in another Amazon Web Services Region.
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
When you are copying a snapshot from one Amazon Web Services GovCloud (US) Region to another, the URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API operation in the source Amazon Web Services Region that contains the source DB snapshot to copy.
This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other Amazon Web Services Regions.
You must specify this parameter when you copy an encrypted DB snapshot from another Amazon Web Services Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are copying an encrypted DB snapshot in the same Amazon Web Services Region.
The presigned URL must be a valid request for the CopyDBClusterSnapshot API operation that can run in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to copy. The presigned URL request must contain the following parameter values:
DestinationRegion - The Amazon Web Services Region that the encrypted DB snapshot is copied to. This Amazon Web Services Region is the same one where the CopyDBSnapshot operation is called that contains this presigned URL. For example, if you copy an encrypted DB snapshot from the us-west-2 Amazon Web Services Region to the us-east-1 Amazon Web Services Region, then you call the CopyDBSnapshot operation in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the CopyDBSnapshot operation in the us-west-2 Amazon Web Services Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 Amazon Web Services Region.KmsKeyId - The KMS key identifier for the KMS key to use to encrypt the copy of the DB snapshot in the destination Amazon Web Services Region. This is the same identifier for both the CopyDBSnapshot operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL.SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted DB snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115 .To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process .
Note
If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.
Please note that this parameter is automatically populated if it is not provided. Including this parameter is not required
The name of an option group to associate with the copy of the snapshot.
Specify this option if you are copying a snapshot from one Amazon Web Services Region to another, and your DB instance uses a nondefault option group. If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, you must specify this option when copying across Amazon Web Services Regions. For more information, see Option group considerations in the Amazon RDS User Guide .
The external custom Availability Zone (CAZ) identifier for the target CAZ.
Example: rds-caz-aiqhTgQv .
dict
Response Syntax
{
'DBSnapshot': {
'DBSnapshotIdentifier': 'string',
'DBInstanceIdentifier': 'string',
'SnapshotCreateTime': datetime(2015, 1, 1),
'Engine': 'string',
'AllocatedStorage': 123,
'Status': 'string',
'Port': 123,
'AvailabilityZone': 'string',
'VpcId': 'string',
'InstanceCreateTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'EngineVersion': 'string',
'LicenseModel': 'string',
'SnapshotType': 'string',
'Iops': 123,
'OptionGroupName': 'string',
'PercentProgress': 123,
'SourceRegion': 'string',
'SourceDBSnapshotIdentifier': 'string',
'StorageType': 'string',
'TdeCredentialArn': 'string',
'Encrypted': True|False,
'KmsKeyId': 'string',
'DBSnapshotArn': 'string',
'Timezone': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
],
'DbiResourceId': 'string',
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'OriginalSnapshotCreateTime': datetime(2015, 1, 1),
'SnapshotTarget': 'string'
}
}
Response Structure
(dict) --
DBSnapshot (dict) --
Contains the details of an Amazon RDS DB snapshot.
This data type is used as a response element in the DescribeDBSnapshots action.
DBSnapshotIdentifier (string) --
Specifies the identifier for the DB snapshot.
DBInstanceIdentifier (string) --
Specifies the DB instance identifier of the DB instance this DB snapshot was created from.
SnapshotCreateTime (datetime) --
Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied.
Engine (string) --
Specifies the name of the database engine.
AllocatedStorage (integer) --
Specifies the allocated storage size in gibibytes (GiB).
Status (string) --
Specifies the status of this DB snapshot.
Port (integer) --
Specifies the port that the database engine was listening on at the time of the snapshot.
AvailabilityZone (string) --
Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
VpcId (string) --
Provides the VPC ID associated with the DB snapshot.
InstanceCreateTime (datetime) --
Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.
MasterUsername (string) --
Provides the master username for the DB snapshot.
EngineVersion (string) --
Specifies the version of the database engine.
LicenseModel (string) --
License model information for the restored DB instance.
SnapshotType (string) --
Provides the type of the DB snapshot.
Iops (integer) --
Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
OptionGroupName (string) --
Provides the option group name for the DB snapshot.
PercentProgress (integer) --
The percentage of the estimated data that has been transferred.
SourceRegion (string) --
The Amazon Web Services Region that the DB snapshot was created in or copied from.
SourceDBSnapshotIdentifier (string) --
The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has a value in the case of a cross-account or cross-Region copy.
StorageType (string) --
Specifies the storage type associated with DB snapshot.
TdeCredentialArn (string) --
The ARN from the key store with which to associate the instance for TDE encryption.
Encrypted (boolean) --
Specifies whether the DB snapshot is encrypted.
KmsKeyId (string) --
If Encrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
DBSnapshotArn (string) --
The Amazon Resource Name (ARN) for the DB snapshot.
Timezone (string) --
The time zone of the DB snapshot. In most cases, the Timezone element is empty. Timezone content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.
IAMDatabaseAuthenticationEnabled (boolean) --
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
ProcessorFeatures (list) --
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.
(dict) --
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstanceModifyDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceFromS3RestoreDBInstanceToPointInTimeYou can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstancesDescribeDBSnapshotsDescribeValidDBInstanceModificationsIf you call DescribeDBInstances , ProcessorFeature returns non-null values only if the following conditions are met:
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
Name (string) --
The name of the processor feature. Valid names are coreCount and threadsPerCore .
Value (string) --
The value of a processor feature name.
DbiResourceId (string) --
The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
TagList (list) --
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
OriginalSnapshotCreateTime (datetime) --
Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied.
SnapshotTarget (string) --
Specifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
Exceptions
RDS.Client.exceptions.DBSnapshotAlreadyExistsFaultRDS.Client.exceptions.DBSnapshotNotFoundFaultRDS.Client.exceptions.InvalidDBSnapshotStateFaultRDS.Client.exceptions.SnapshotQuotaExceededFaultRDS.Client.exceptions.KMSKeyNotAccessibleFaultRDS.Client.exceptions.CustomAvailabilityZoneNotFoundFaultExamples
This example copies a DB snapshot.
response = client.copy_db_snapshot(
SourceDBSnapshotIdentifier='mydbsnapshot',
TargetDBSnapshotIdentifier='mydbsnapshot-copy',
)
print(response)
Expected Output:
{
'DBSnapshot': {
},
'ResponseMetadata': {
'...': '...',
},
}
copy_option_group(**kwargs)¶Copies the specified option group.
See also: AWS API Documentation
Request Syntax
response = client.copy_option_group(
SourceOptionGroupIdentifier='string',
TargetOptionGroupIdentifier='string',
TargetOptionGroupDescription='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The identifier for the source option group.
Constraints:
[REQUIRED]
The identifier for the copied option group.
Constraints:
Example: my-option-group
[REQUIRED]
The description for the copied option group.
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
dict
Response Syntax
{
'OptionGroup': {
'OptionGroupName': 'string',
'OptionGroupDescription': 'string',
'EngineName': 'string',
'MajorEngineVersion': 'string',
'Options': [
{
'OptionName': 'string',
'OptionDescription': 'string',
'Persistent': True|False,
'Permanent': True|False,
'Port': 123,
'OptionVersion': 'string',
'OptionSettings': [
{
'Name': 'string',
'Value': 'string',
'DefaultValue': 'string',
'Description': 'string',
'ApplyType': 'string',
'DataType': 'string',
'AllowedValues': 'string',
'IsModifiable': True|False,
'IsCollection': True|False
},
],
'DBSecurityGroupMemberships': [
{
'DBSecurityGroupName': 'string',
'Status': 'string'
},
],
'VpcSecurityGroupMemberships': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
]
},
],
'AllowsVpcAndNonVpcInstanceMemberships': True|False,
'VpcId': 'string',
'OptionGroupArn': 'string'
}
}
Response Structure
(dict) --
OptionGroup (dict) --
OptionGroupName (string) --
Specifies the name of the option group.
OptionGroupDescription (string) --
Provides a description of the option group.
EngineName (string) --
Indicates the name of the engine that this option group can be applied to.
MajorEngineVersion (string) --
Indicates the major engine version associated with this option group.
Options (list) --
Indicates what options are available in the option group.
(dict) --
Option details.
OptionName (string) --
The name of the option.
OptionDescription (string) --
The description of the option.
Persistent (boolean) --
Indicate if this option is persistent.
Permanent (boolean) --
Indicate if this option is permanent.
Port (integer) --
If required, the port configured for this option to use.
OptionVersion (string) --
The version of the option.
OptionSettings (list) --
The option settings for this option.
(dict) --
Option settings are the actual settings being applied or configured for that option. It is used when you modify an option group or describe option groups. For example, the NATIVE_NETWORK_ENCRYPTION option has a setting called SQLNET.ENCRYPTION_SERVER that can have several different values.
Name (string) --
The name of the option that has settings that you can set.
Value (string) --
The current value of the option setting.
DefaultValue (string) --
The default value of the option setting.
Description (string) --
The description of the option setting.
ApplyType (string) --
The DB engine specific parameter type.
DataType (string) --
The data type of the option setting.
AllowedValues (string) --
The allowed values of the option setting.
IsModifiable (boolean) --
A Boolean value that, when true, indicates the option setting can be modified from the default.
IsCollection (boolean) --
Indicates if the option setting is part of a collection.
DBSecurityGroupMemberships (list) --
If the option requires access to a port, then this DB security group allows access to the port.
(dict) --
This data type is used as a response element in the following actions:
ModifyDBInstanceRebootDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceToPointInTimeDBSecurityGroupName (string) --
The name of the DB security group.
Status (string) --
The status of the DB security group.
VpcSecurityGroupMemberships (list) --
If the option requires access to a port, then this VPC security group allows access to the port.
(dict) --
This data type is used as a response element for queries on VPC security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The membership status of the VPC security group.
Currently, the only valid status is active .
AllowsVpcAndNonVpcInstanceMemberships (boolean) --
Indicates whether this option group can be applied to both VPC and non-VPC instances. The value true indicates the option group can be applied to both VPC and non-VPC instances.
VpcId (string) --
If AllowsVpcAndNonVpcInstanceMemberships is false , this field is blank. If AllowsVpcAndNonVpcInstanceMemberships is true and this field is blank, then this option group can be applied to both VPC and non-VPC instances. If this field contains a value, then this option group can only be applied to instances that are in the VPC indicated by this field.
OptionGroupArn (string) --
The Amazon Resource Name (ARN) for the option group.
Exceptions
RDS.Client.exceptions.OptionGroupAlreadyExistsFaultRDS.Client.exceptions.OptionGroupNotFoundFaultRDS.Client.exceptions.OptionGroupQuotaExceededFaultExamples
This example copies an option group.
response = client.copy_option_group(
SourceOptionGroupIdentifier='mymysqloptiongroup',
TargetOptionGroupDescription='My MySQL option group copy',
TargetOptionGroupIdentifier='mymysqloptiongroup-copy',
)
print(response)
Expected Output:
{
'OptionGroup': {
},
'ResponseMetadata': {
'...': '...',
},
}
create_custom_db_engine_version(**kwargs)¶Creates a custom DB engine version (CEV). A CEV is a binary volume snapshot of a database engine and specific AMI. The supported engines are the following:
Amazon RDS, which is a fully managed service, supplies the Amazon Machine Image (AMI) and database software. The Amazon RDS database software is preinstalled, so you need only select a DB engine and version, and create your database. With Amazon RDS Custom for Oracle, you upload your database installation files in Amazon S3.
When you create a custom engine version, you specify the files in a JSON document called a CEV manifest. This document describes installation .zip files stored in Amazon S3. RDS Custom creates your CEV from the installation files that you provided. This service model is called Bring Your Own Media (BYOM).
Creation takes approximately two hours. If creation fails, RDS Custom issues RDS-EVENT-0196 with the message Creation failed for custom engine version , and includes details about the failure. For example, the event prints missing files.
After you create the CEV, it is available for use. You can create multiple CEVs, and create multiple RDS Custom instances from any CEV. You can also change the status of a CEV to make it available or inactive.
Note
The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the CreateCustomDbEngineVersion event aren't logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the CreateCustomDbEngineVersion event.
For more information, see Creating a CEV in the Amazon RDS User Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_custom_db_engine_version(
Engine='string',
EngineVersion='string',
DatabaseInstallationFilesS3BucketName='string',
DatabaseInstallationFilesS3Prefix='string',
KMSKeyId='string',
Description='string',
Manifest='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The database engine to use for your custom engine version (CEV). The only supported value is custom-oracle-ee .
[REQUIRED]
The name of your CEV. The name format is 19.*customized_string* `` . For example, a valid name is ``19.my_cev1 . This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Region.
[REQUIRED]
The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is my-custom-installation-files .
123456789012/cev1 . If this setting isn't specified, no prefix is assumed.[REQUIRED]
The Amazon Web Services KMS key identifier for an encrypted CEV. A symmetric KMS key is required for RDS Custom, but optional for Amazon RDS.
If you have an existing symmetric KMS key in your account, you can use it with RDS Custom. No further action is necessary. If you don't already have a symmetric KMS key in your account, follow the instructions in Creating symmetric KMS keys in the Amazon Web Services Key Management Service Developer Guide .
You can choose the same symmetric key when you create a CEV and a DB instance, or choose different keys.
[REQUIRED]
The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed.
The following JSON fields are valid:
MediaImportTemplateVersion
Version of the CEV manifest. The date is in the format YYYY-MM-DD .
databaseInstallationFileNames
Ordered list of installation files for the CEV.
opatchFileNames
Ordered list of OPatch installers used for the Oracle DB engine.
psuRuPatchFileNames
The PSU and RU patches for this CEV.
OtherPatchFileNames
The patches that are not in the list of PSU and RU patches. Amazon RDS applies these patches after applying the PSU and RU patches.
For more information, see Creating the CEV manifest in the Amazon RDS User Guide .
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
dict
Response Syntax
{
'Engine': 'string',
'EngineVersion': 'string',
'DBParameterGroupFamily': 'string',
'DBEngineDescription': 'string',
'DBEngineVersionDescription': 'string',
'DefaultCharacterSet': {
'CharacterSetName': 'string',
'CharacterSetDescription': 'string'
},
'SupportedCharacterSets': [
{
'CharacterSetName': 'string',
'CharacterSetDescription': 'string'
},
],
'SupportedNcharCharacterSets': [
{
'CharacterSetName': 'string',
'CharacterSetDescription': 'string'
},
],
'ValidUpgradeTarget': [
{
'Engine': 'string',
'EngineVersion': 'string',
'Description': 'string',
'AutoUpgrade': True|False,
'IsMajorVersionUpgrade': True|False,
'SupportedEngineModes': [
'string',
],
'SupportsParallelQuery': True|False,
'SupportsGlobalDatabases': True|False,
'SupportsBabelfish': True|False
},
],
'SupportedTimezones': [
{
'TimezoneName': 'string'
},
],
'ExportableLogTypes': [
'string',
],
'SupportsLogExportsToCloudwatchLogs': True|False,
'SupportsReadReplica': True|False,
'SupportedEngineModes': [
'string',
],
'SupportedFeatureNames': [
'string',
],
'Status': 'string',
'SupportsParallelQuery': True|False,
'SupportsGlobalDatabases': True|False,
'MajorEngineVersion': 'string',
'DatabaseInstallationFilesS3BucketName': 'string',
'DatabaseInstallationFilesS3Prefix': 'string',
'DBEngineVersionArn': 'string',
'KMSKeyId': 'string',
'CreateTime': datetime(2015, 1, 1),
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'SupportsBabelfish': True|False
}
Response Structure
(dict) --
This data type is used as a response element in the action DescribeDBEngineVersions .
Engine (string) --
The name of the database engine.
EngineVersion (string) --
The version number of the database engine.
DBParameterGroupFamily (string) --
The name of the DB parameter group family for the database engine.
DBEngineDescription (string) --
The description of the database engine.
DBEngineVersionDescription (string) --
The description of the database engine version.
DefaultCharacterSet (dict) --
The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API isn't specified.
CharacterSetName (string) --
The name of the character set.
CharacterSetDescription (string) --
The description of the character set.
SupportedCharacterSets (list) --
A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance operation.
(dict) --
This data type is used as a response element in the action DescribeDBEngineVersions .
CharacterSetName (string) --
The name of the character set.
CharacterSetDescription (string) --
The description of the character set.
SupportedNcharCharacterSets (list) --
A list of the character sets supported by the Oracle DB engine for the NcharCharacterSetName parameter of the CreateDBInstance operation.
(dict) --
This data type is used as a response element in the action DescribeDBEngineVersions .
CharacterSetName (string) --
The name of the character set.
CharacterSetDescription (string) --
The description of the character set.
ValidUpgradeTarget (list) --
A list of engine versions that this database engine version can be upgraded to.
(dict) --
The version of the database engine that a DB 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 a DB 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 upgrading to the target version requires upgrading the major version of the database engine.
SupportedEngineModes (list) --
A list of the supported DB engine modes for the target engine version.
SupportsParallelQuery (boolean) --
A value that indicates whether you can use Aurora parallel query with the target engine version.
SupportsGlobalDatabases (boolean) --
A value that indicates whether you can use Aurora global databases with the target engine version.
SupportsBabelfish (boolean) --
A value that indicates whether you can use Babelfish for Aurora PostgreSQL with the target engine version.
SupportedTimezones (list) --
A list of the time zones supported by this engine for the Timezone parameter of the CreateDBInstance action.
(dict) --
A time zone associated with a DBInstance or a DBSnapshot . This data type is an element in the response to the DescribeDBInstances , the DescribeDBSnapshots , and the DescribeDBEngineVersions actions.
TimezoneName (string) --
The name of the time zone.
ExportableLogTypes (list) --
The types of logs that the database engine has available for export to CloudWatch Logs.
SupportsLogExportsToCloudwatchLogs (boolean) --
A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.
SupportsReadReplica (boolean) --
Indicates whether the database engine version supports read replicas.
SupportedEngineModes (list) --
A list of the supported DB engine modes.
SupportedFeatureNames (list) --
A list of features supported by the DB engine.
The supported features vary by DB engine and DB engine version.
To determine the supported features for a specific DB engine and DB engine version using the CLI, use the following command:
aws rds describe-db-engine-versions --engine <engine_name> --engine-version <engine_version>
For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, use the following command:
aws rds describe-db-engine-versions --engine postgres --engine-version 13.3
The supported features are listed under SupportedFeatureNames in the output.
Status (string) --
The status of the DB engine version, either available or deprecated .
SupportsParallelQuery (boolean) --
A value that indicates whether you can use Aurora parallel query with a specific DB engine version.
SupportsGlobalDatabases (boolean) --
A value that indicates whether you can use Aurora global databases with a specific DB engine version.
MajorEngineVersion (string) --
The major engine version of the CEV.
DatabaseInstallationFilesS3BucketName (string) --
The name of the Amazon S3 bucket that contains your database installation files.
DatabaseInstallationFilesS3Prefix (string) --
The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.
DBEngineVersionArn (string) --
The ARN of the custom engine version.
KMSKeyId (string) --
The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.
CreateTime (datetime) --
The creation time of the DB engine version.
TagList (list) --
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
SupportsBabelfish (boolean) --
A value that indicates whether the engine version supports Babelfish for Aurora PostgreSQL.
Exceptions
RDS.Client.exceptions.CustomDBEngineVersionAlreadyExistsFaultRDS.Client.exceptions.CustomDBEngineVersionQuotaExceededFaultRDS.Client.exceptions.KMSKeyNotAccessibleFaultcreate_db_cluster(**kwargs)¶Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.
You can use the ReplicationSourceIdentifier parameter to create an Amazon Aurora DB cluster as a read replica of another DB cluster or Amazon RDS MySQL or PostgreSQL DB instance.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide .
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_db_cluster(
AvailabilityZones=[
'string',
],
BackupRetentionPeriod=123,
CharacterSetName='string',
DatabaseName='string',
DBClusterIdentifier='string',
DBClusterParameterGroupName='string',
VpcSecurityGroupIds=[
'string',
],
DBSubnetGroupName='string',
Engine='string',
EngineVersion='string',
Port=123,
MasterUsername='string',
MasterUserPassword='string',
OptionGroupName='string',
PreferredBackupWindow='string',
PreferredMaintenanceWindow='string',
ReplicationSourceIdentifier='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
StorageEncrypted=True|False,
KmsKeyId='string',
EnableIAMDatabaseAuthentication=True|False,
BacktrackWindow=123,
EnableCloudwatchLogsExports=[
'string',
],
EngineMode='string',
ScalingConfiguration={
'MinCapacity': 123,
'MaxCapacity': 123,
'AutoPause': True|False,
'SecondsUntilAutoPause': 123,
'TimeoutAction': 'string',
'SecondsBeforeTimeout': 123
},
DeletionProtection=True|False,
GlobalClusterIdentifier='string',
EnableHttpEndpoint=True|False,
CopyTagsToSnapshot=True|False,
Domain='string',
DomainIAMRoleName='string',
EnableGlobalWriteForwarding=True|False,
DBClusterInstanceClass='string',
AllocatedStorage=123,
StorageType='string',
Iops=123,
PubliclyAccessible=True|False,
AutoMinorVersionUpgrade=True|False,
MonitoringInterval=123,
MonitoringRoleArn='string',
EnablePerformanceInsights=True|False,
PerformanceInsightsKMSKeyId='string',
PerformanceInsightsRetentionPeriod=123,
ServerlessV2ScalingConfiguration={
'MinCapacity': 123.0,
'MaxCapacity': 123.0
},
SourceRegion='string'
)
A list of Availability Zones (AZs) where DB instances in the DB cluster can be created.
For information on Amazon Web Services Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide .
Valid for: Aurora DB clusters only
The number of days for which automated backups are retained.
Default: 1
Constraints:
Valid for: Aurora DB clusters and Multi-AZ DB clusters
A value that indicates that the DB cluster should be associated with the specified CharacterSet.
Valid for: Aurora DB clusters only
The name for your database of up to 64 alphanumeric characters. If you do not provide a name, Amazon RDS doesn't create a database in the DB cluster you are creating.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
[REQUIRED]
The DB cluster identifier. This parameter is stored as a lowercase string.
Constraints:
Example: my-cluster1
Valid for: Aurora DB clusters and Multi-AZ DB clusters
The name of the DB cluster parameter group to associate with this DB cluster. If you do not specify a value, then the default DB cluster parameter group for the specified DB engine and version is used.
Constraints:
Valid for: Aurora DB clusters and Multi-AZ DB clusters
A list of EC2 VPC security groups to associate with this DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
A DB subnet group to associate with this DB cluster.
This setting is required to create a Multi-AZ DB cluster.
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example: mydbsubnetgroup
Valid for: Aurora DB clusters and Multi-AZ DB clusters
[REQUIRED]
The name of the database engine to be used for this DB cluster.
Valid Values:
aurora (for MySQL 5.6-compatible Aurora)aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)aurora-postgresqlmysqlpostgresValid for: Aurora DB clusters and Multi-AZ DB clusters
The version number of the database engine to use.
To list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command:
aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora, use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for Aurora PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for MySQL, use the following command:
aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"Aurora MySQL
For information, see MySQL on Amazon RDS Versions in the Amazon Aurora User Guide .
Aurora PostgreSQL
For information, see Amazon Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide .
MySQL
For information, see MySQL on Amazon RDS Versions in the Amazon RDS User Guide .
PostgreSQL
For information, see Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide .
Valid for: Aurora DB clusters and Multi-AZ DB clusters
The port number on which the instances in the DB cluster accept connections.
RDS for MySQL and Aurora MySQL
Default: 3306
Valid values: 1150-65535
RDS for PostgreSQL and Aurora PostgreSQL
Default: 5432
Valid values: 1150-65535
Valid for: Aurora DB clusters and Multi-AZ DB clusters
The name of the master user for the DB cluster.
Constraints:
Valid for: Aurora DB clusters and Multi-AZ DB clusters
The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".
Constraints: Must contain from 8 to 41 characters.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
A value that indicates that the DB cluster should be associated with the specified option group.
DB clusters are associated with a default option group that can't be modified.
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. To view the time blocks available, see Backup window in the Amazon Aurora User Guide .
Constraints:
hh24:mi-hh24:mi .Valid for: Aurora DB clusters and Multi-AZ DB clusters
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide .
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.
Valid for: Aurora DB clusters only
Tags to assign to the DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
A value that indicates whether the DB cluster is encrypted.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
The Amazon Web Services KMS key identifier for an encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
When a KMS key isn't specified in KmsKeyId :
ReplicationSourceIdentifier identifies an encrypted source, then Amazon RDS will use the KMS key used to encrypt the source. Otherwise, Amazon RDS will use your default KMS key.StorageEncrypted parameter is enabled and ReplicationSourceIdentifier isn't specified, then Amazon RDS will use your default KMS key.There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
If you create a read replica of an encrypted DB cluster in another Amazon Web Services Region, you must set KmsKeyId to a KMS key identifier that is valid in the destination Amazon Web Services Region. This KMS key is used to encrypt the read replica in that Amazon Web Services Region.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
When you are replicating a DB cluster from one Amazon Web Services GovCloud (US) Region to another, an URL that contains a Signature Version 4 signed request for the CreateDBCluster operation to be called in the source Amazon Web Services Region where the DB cluster is replicated from. Specify PreSignedUrl only when you are performing cross-Region replication from an encrypted DB cluster.
The presigned URL must be a valid request for the CreateDBCluster API operation that can run in the source Amazon Web Services Region that contains the encrypted DB cluster to copy.
The presigned URL request must contain the following parameter values:
KmsKeyId - The KMS key identifier for the KMS key to use to encrypt the copy of the DB cluster in the destination Amazon Web Services Region. This should refer to the same KMS key for both the CreateDBCluster operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL.DestinationRegion - The name of the Amazon Web Services Region that Aurora read replica will be created in.ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted DB cluster from the us-west-2 Amazon Web Services Region, then your ReplicationSourceIdentifier would look like Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1 .To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process .
Note
If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.
Valid for: Aurora DB clusters only
Please note that this parameter is automatically populated if it is not provided. Including this parameter is not required
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide .
Valid for: Aurora DB clusters only
The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Default: 0
Constraints:
Valid for: Aurora MySQL DB clusters only
The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used.
RDS for MySQL
Possible values are error , general , and slowquery .
RDS for PostgreSQL
Possible values are postgresql and upgrade .
Aurora MySQL
Possible values are audit , error , general , and slowquery .
Aurora PostgreSQL
Possible value is postgresql .
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide .
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide .
Valid for: Aurora DB clusters and Multi-AZ DB clusters
The DB engine mode of the DB cluster, either provisioned , serverless , parallelquery , global , or multimaster .
The parallelquery engine mode isn't required for Aurora MySQL version 1.23 and higher 1.x versions, and version 2.09 and higher 2.x versions.
The global engine mode isn't required for Aurora MySQL version 1.22 and higher 1.x versions, and global engine mode isn't required for any 2.x versions.
The multimaster engine mode only applies for DB clusters created with Aurora MySQL version 5.6.10a.
The serverless engine mode only applies for Aurora Serverless v1 DB clusters.
For Aurora PostgreSQL, the global engine mode isn't required, and both the parallelquery and the multimaster engine modes currently aren't supported.
Limitations and requirements apply to some DB engine modes. For more information, see the following sections in the Amazon Aurora User Guide :
Valid for: Aurora DB clusters only
For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
Valid for: Aurora DB clusters only
The minimum capacity for an Aurora DB cluster in serverless DB engine mode.
For Aurora MySQL, valid capacity values are 1 , 2 , 4 , 8 , 16 , 32 , 64 , 128 , and 256 .
For Aurora PostgreSQL, valid capacity values are 2 , 4 , 8 , 16 , 32 , 64 , 192 , and 384 .
The minimum capacity must be less than or equal to the maximum capacity.
The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
For Aurora MySQL, valid capacity values are 1 , 2 , 4 , 8 , 16 , 32 , 64 , 128 , and 256 .
For Aurora PostgreSQL, valid capacity values are 2 , 4 , 8 , 16 , 32 , 64 , 192 , and 384 .
The maximum capacity must be greater than or equal to the minimum capacity.
A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections).
Note
If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.
The time, in seconds, before an Aurora DB cluster in serverless mode is paused.
Specify a value between 300 and 86,400 seconds.
The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange .
ForceApplyCapacityChangesets the capacity to the specified value as soon as possible.
RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period.
Warning
If you specify ForceApplyCapacityChange , connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped.
For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide .
The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.
Specify a value between 60 and 600 seconds.
A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.
Valid for: Aurora DB clusters only
A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint is disabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide .
Valid for: Aurora DB clusters only
A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
The Active Directory directory ID to create the DB cluster in.
For Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster.
For more information, see Kerberos authentication in the Amazon Aurora User Guide .
Valid for: Aurora DB clusters only
Specify the name of the IAM role to be used when making API calls to the Directory Service.
Valid for: Aurora DB clusters only
A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an Aurora global database ( GlobalCluster ). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.
You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by the FailoverGlobalCluster API operation, but it does nothing until then.
Valid for: Aurora DB clusters only
The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
For the full list of DB instance classes and availability for your engine, see DB instance class in the Amazon RDS User Guide .
This setting is required to create a Multi-AZ DB cluster.
Valid for: Multi-AZ DB clusters only
The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
This setting is required to create a Multi-AZ DB cluster.
Valid for: Multi-AZ DB clusters only
Specifies the storage type to be associated with the DB cluster.
This setting is required to create a Multi-AZ DB cluster.
Valid values: io1
When specified, a value for the Iops parameter is required.
Default: io1
Valid for: Multi-AZ DB clusters only
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
For information about valid Iops values, see Amazon RDS Provisioned IOPS storage to improve performance in the Amazon RDS User Guide .
This setting is required to create a Multi-AZ DB cluster.
Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
Valid for: Multi-AZ DB clusters only
A value that indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
Valid for: Multi-AZ DB clusters only
A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.
Valid for: Multi-AZ DB clusters only
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0.
If MonitoringRoleArn is specified, also set MonitoringInterval to a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
Valid for: Multi-AZ DB clusters only
The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is arn:aws:iam:123456789012:role/emaccess . For information on creating a monitoring role, see Setting up and enabling Enhanced Monitoring in the Amazon RDS User Guide .
If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.
Valid for: Multi-AZ DB clusters only
A value that indicates whether to turn on Performance Insights for the DB cluster.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide .
Valid for: Multi-AZ DB clusters only
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you don't specify a value for PerformanceInsightsKMSKeyId , then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
Valid for: Multi-AZ DB clusters only
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
For example, the following values are valid:
If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
Valid for: Multi-AZ DB clusters only
Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide .
The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.
The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128.
dict
Response Syntax
{
'DBCluster': {
'AllocatedStorage': 123,
'AvailabilityZones': [
'string',
],
'BackupRetentionPeriod': 123,
'CharacterSetName': 'string',
'DatabaseName': 'string',
'DBClusterIdentifier': 'string',
'DBClusterParameterGroup': 'string',
'DBSubnetGroup': 'string',
'Status': 'string',
'AutomaticRestartTime': datetime(2015, 1, 1),
'PercentProgress': 'string',
'EarliestRestorableTime': datetime(2015, 1, 1),
'Endpoint': 'string',
'ReaderEndpoint': 'string',
'CustomEndpoints': [
'string',
],
'MultiAZ': True|False,
'Engine': 'string',
'EngineVersion': 'string',
'LatestRestorableTime': datetime(2015, 1, 1),
'Port': 123,
'MasterUsername': 'string',
'DBClusterOptionGroupMemberships': [
{
'DBClusterOptionGroupName': 'string',
'Status': 'string'
},
],
'PreferredBackupWindow': 'string',
'PreferredMaintenanceWindow': 'string',
'ReplicationSourceIdentifier': 'string',
'ReadReplicaIdentifiers': [
'string',
],
'DBClusterMembers': [
{
'DBInstanceIdentifier': 'string',
'IsClusterWriter': True|False,
'DBClusterParameterGroupStatus': 'string',
'PromotionTier': 123
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'HostedZoneId': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbClusterResourceId': 'string',
'DBClusterArn': 'string',
'AssociatedRoles': [
{
'RoleArn': 'string',
'Status': 'string',
'FeatureName': 'string'
},
],
'IAMDatabaseAuthenticationEnabled': True|False,
'CloneGroupId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'EarliestBacktrackTime': datetime(2015, 1, 1),
'BacktrackWindow': 123,
'BacktrackConsumedChangeRecords': 123,
'EnabledCloudwatchLogsExports': [
'string',
],
'Capacity': 123,
'EngineMode': 'string',
'ScalingConfigurationInfo': {
'MinCapacity': 123,
'MaxCapacity': 123,
'AutoPause': True|False,
'SecondsUntilAutoPause': 123,
'TimeoutAction': 'string',
'SecondsBeforeTimeout': 123
},
'DeletionProtection': True|False,
'HttpEndpointEnabled': True|False,
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'CopyTagsToSnapshot': True|False,
'CrossAccountClone': True|False,
'DomainMemberships': [
{
'Domain': 'string',
'Status': 'string',
'FQDN': 'string',
'IAMRoleName': 'string'
},
],
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'GlobalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'unknown',
'GlobalWriteForwardingRequested': True|False,
'PendingModifiedValues': {
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
},
'DBClusterIdentifier': 'string',
'MasterUserPassword': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'EngineVersion': 'string'
},
'DBClusterInstanceClass': 'string',
'StorageType': 'string',
'Iops': 123,
'PubliclyAccessible': True|False,
'AutoMinorVersionUpgrade': True|False,
'MonitoringInterval': 123,
'MonitoringRoleArn': 'string',
'PerformanceInsightsEnabled': True|False,
'PerformanceInsightsKMSKeyId': 'string',
'PerformanceInsightsRetentionPeriod': 123,
'ServerlessV2ScalingConfiguration': {
'MinCapacity': 123.0,
'MaxCapacity': 123.0
}
}
}
Response Structure
(dict) --
DBCluster (dict) --
Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
For an Amazon Aurora DB cluster, this data type is used as a response element in the operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , FailoverDBCluster , ModifyDBCluster , PromoteReadReplicaDBCluster , RestoreDBClusterFromS3 , RestoreDBClusterFromSnapshot , RestoreDBClusterToPointInTime , StartDBCluster , and StopDBCluster .
For a Multi-AZ DB cluster, this data type is used as a response element in the operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , FailoverDBCluster , ModifyDBCluster , RebootDBCluster , RestoreDBClusterFromSnapshot , and RestoreDBClusterToPointInTime .
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
AllocatedStorage (integer) --
For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
AvailabilityZones (list) --
Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.
BackupRetentionPeriod (integer) --
Specifies the number of days for which automatic DB snapshots are retained.
CharacterSetName (string) --
If present, specifies the name of the character set that this cluster is associated with.
DatabaseName (string) --
Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.
DBClusterIdentifier (string) --
Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
DBClusterParameterGroup (string) --
Specifies the name of the DB cluster parameter group for the DB cluster.
DBSubnetGroup (string) --
Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
Status (string) --
Specifies the current state of this DB cluster.
AutomaticRestartTime (datetime) --
The time when a stopped DB cluster is restarted automatically.
PercentProgress (string) --
Specifies the progress of the operation as a percentage.
EarliestRestorableTime (datetime) --
The earliest time to which a database can be restored with point-in-time restore.
Endpoint (string) --
Specifies the connection endpoint for the primary instance of the DB cluster.
ReaderEndpoint (string) --
The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.
If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
CustomEndpoints (list) --
Identifies all custom endpoints associated with the cluster.
MultiAZ (boolean) --
Specifies whether the DB cluster has instances in multiple Availability Zones.
Engine (string) --
The name of the database engine to be used for this DB cluster.
EngineVersion (string) --
Indicates the database engine version.
LatestRestorableTime (datetime) --
Specifies the latest time to which a database can be restored with point-in-time restore.
Port (integer) --
Specifies the port that the database engine is listening on.
MasterUsername (string) --
Contains the master username for the DB cluster.
DBClusterOptionGroupMemberships (list) --
Provides the list of option group memberships for this DB cluster.
(dict) --
Contains status information for a DB cluster option group.
DBClusterOptionGroupName (string) --
Specifies the name of the DB cluster option group.
Status (string) --
Specifies the status of the DB cluster option group.
PreferredBackupWindow (string) --
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
ReplicationSourceIdentifier (string) --
Contains the identifier of the source DB cluster if this DB cluster is a read replica.
ReadReplicaIdentifiers (list) --
Contains one or more identifiers of the read replicas associated with this DB cluster.
DBClusterMembers (list) --
Provides the list of instances that make up the DB cluster.
(dict) --
Contains information about an instance that is part of a DB cluster.
DBInstanceIdentifier (string) --
Specifies the instance identifier for this member of the DB cluster.
IsClusterWriter (boolean) --
Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
DBClusterParameterGroupStatus (string) --
Specifies the status of the DB cluster parameter group for this member of the DB cluster.
PromotionTier (integer) --
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .
VpcSecurityGroups (list) --
Provides a list of VPC security groups that the DB cluster belongs to.
(dict) --
This data type is used as a response element for queries on VPC security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The membership status of the VPC security group.
Currently, the only valid status is active .
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
StorageEncrypted (boolean) --
Specifies whether the DB cluster is encrypted.
KmsKeyId (string) --
If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
DbClusterResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for the DB cluster.
AssociatedRoles (list) --
Provides a list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.
(dict) --
Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB cluster.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
Status (string) --
Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other Amazon Web Services on your behalf.PENDING - the IAM role ARN is being associated with the DB cluster.INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other Amazon Web Services on your behalf.FeatureName (string) --
The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion .
IAMDatabaseAuthenticationEnabled (boolean) --
A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
CloneGroupId (string) --
Identifies the clone group to which the DB cluster is associated.
ClusterCreateTime (datetime) --
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
EarliestBacktrackTime (datetime) --
The earliest time to which a DB cluster can be backtracked.
BacktrackWindow (integer) --
The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.
BacktrackConsumedChangeRecords (integer) --
The number of change records stored for Backtrack.
EnabledCloudwatchLogsExports (list) --
A list of log types that this DB cluster is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.
Capacity (integer) --
The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 (zero) when the cluster is paused.
For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide .
EngineMode (string) --
The DB engine mode of the DB cluster, either provisioned , serverless , parallelquery , global , or multimaster .
For more information, see CreateDBCluster .
ScalingConfigurationInfo (dict) --
Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.
For more information, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide .
MinCapacity (integer) --
The minimum capacity for an Aurora DB cluster in serverless DB engine mode.
MaxCapacity (integer) --
The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
AutoPause (boolean) --
A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.
When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.
SecondsUntilAutoPause (integer) --
The remaining amount of time, in seconds, before the Aurora DB cluster in serverless mode is paused. A DB cluster can be paused only when it's idle (it has no connections).
TimeoutAction (string) --
The action that occurs when Aurora times out while attempting to change the capacity of an Aurora Serverless v1 cluster. The value is either ForceApplyCapacityChange or RollbackCapacityChange .
ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.
RollbackCapacityChangeignores the capacity change if a scaling point isn't found in the timeout period.
SecondsBeforeTimeout (integer) --
The number of seconds before scaling times out. What happens when an attempted scaling action times out is determined by the TimeoutAction setting.
DeletionProtection (boolean) --
Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
HttpEndpointEnabled (boolean) --
A value that indicates whether the HTTP endpoint for an Aurora Serverless v1 DB cluster is enabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide .
ActivityStreamMode (string) --
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.
ActivityStreamStatus (string) --
The status of the database activity stream.
ActivityStreamKmsKeyId (string) --
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
ActivityStreamKinesisStreamName (string) --
The name of the Amazon Kinesis data stream used for the database activity stream.
CopyTagsToSnapshot (boolean) --
Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.
CrossAccountClone (boolean) --
Specifies whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
DomainMemberships (list) --
The Active Directory Domain membership records associated with the DB cluster.
(dict) --
An Active Directory Domain membership record associated with the DB instance or cluster.
Domain (string) --
The identifier of the Active Directory Domain.
Status (string) --
The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.
FQDN (string) --
The fully qualified domain name of the Active Directory Domain.
IAMRoleName (string) --
The name of the IAM role to be used when making API calls to the Directory Service.
TagList (list) --
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
GlobalWriteForwardingStatus (string) --
Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.
GlobalWriteForwardingRequested (boolean) --
Specifies whether you have requested to enable write forwarding for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.
PendingModifiedValues (dict) --
A value that specifies that changes to the DB cluster are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
PendingCloudwatchLogsExports (dict) --
A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.
LogTypesToEnable (list) --
Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.
LogTypesToDisable (list) --
Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.
DBClusterIdentifier (string) --
The DBClusterIdentifier value for the DB cluster.
MasterUserPassword (string) --
The master credentials for the DB cluster.
IAMDatabaseAuthenticationEnabled (boolean) --
A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
EngineVersion (string) --
The database engine version.
DBClusterInstanceClass (string) --
The name of the compute and memory capacity class of the DB instance.
This setting is only for non-Aurora Multi-AZ DB clusters.
StorageType (string) --
The storage type associated with the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
Iops (integer) --
The Provisioned IOPS (I/O operations per second) value.
This setting is only for non-Aurora Multi-AZ DB clusters.
PubliclyAccessible (boolean) --
Specifies the accessibility options for the DB instance.
When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance .
This setting is only for non-Aurora Multi-AZ DB clusters.
AutoMinorVersionUpgrade (boolean) --
A value that indicates that minor version patches are applied automatically.
This setting is only for non-Aurora Multi-AZ DB clusters.
MonitoringInterval (integer) --
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
MonitoringRoleArn (string) --
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
This setting is only for non-Aurora Multi-AZ DB clusters.
PerformanceInsightsEnabled (boolean) --
True if Performance Insights is enabled for the DB cluster, and otherwise false.
This setting is only for non-Aurora Multi-AZ DB clusters.
PerformanceInsightsKMSKeyId (string) --
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
This setting is only for non-Aurora Multi-AZ DB clusters.
PerformanceInsightsRetentionPeriod (integer) --
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
For example, the following values are valid:
This setting is only for non-Aurora Multi-AZ DB clusters.
ServerlessV2ScalingConfiguration (dict) --
Shows the scaling configuration for an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide .
MinCapacity (float) --
The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.
MaxCapacity (float) --
The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128.
Exceptions
RDS.Client.exceptions.DBClusterAlreadyExistsFaultRDS.Client.exceptions.InsufficientStorageClusterCapacityFaultRDS.Client.exceptions.DBClusterQuotaExceededFaultRDS.Client.exceptions.StorageQuotaExceededFaultRDS.Client.exceptions.DBSubnetGroupNotFoundFaultRDS.Client.exceptions.InvalidVPCNetworkStateFaultRDS.Client.exceptions.InvalidDBClusterStateFaultRDS.Client.exceptions.InvalidDBSubnetGroupStateFaultRDS.Client.exceptions.InvalidSubnetRDS.Client.exceptions.InvalidDBInstanceStateFaultRDS.Client.exceptions.DBClusterParameterGroupNotFoundFaultRDS.Client.exceptions.KMSKeyNotAccessibleFaultRDS.Client.exceptions.DBClusterNotFoundFaultRDS.Client.exceptions.DBInstanceNotFoundFaultRDS.Client.exceptions.DBSubnetGroupDoesNotCoverEnoughAZsRDS.Client.exceptions.GlobalClusterNotFoundFaultRDS.Client.exceptions.InvalidGlobalClusterStateFaultRDS.Client.exceptions.DomainNotFoundFaultExamples
This example creates a DB cluster.
response = client.create_db_cluster(
AvailabilityZones=[
'us-east-1a',
],
BackupRetentionPeriod=1,
DBClusterIdentifier='mydbcluster',
DBClusterParameterGroupName='mydbclusterparametergroup',
DatabaseName='myauroradb',
Engine='aurora',
EngineVersion='5.6.10a',
MasterUserPassword='mypassword',
MasterUsername='myuser',
Port=3306,
StorageEncrypted=True,
)
print(response)
Expected Output:
{
'DBCluster': {
},
'ResponseMetadata': {
'...': '...',
},
}
create_db_cluster_endpoint(**kwargs)¶Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.
Note
This action applies only to Aurora DB clusters.
See also: AWS API Documentation
Request Syntax
response = client.create_db_cluster_endpoint(
DBClusterIdentifier='string',
DBClusterEndpointIdentifier='string',
EndpointType='string',
StaticMembers=[
'string',
],
ExcludedMembers=[
'string',
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
[REQUIRED]
The identifier to use for the new endpoint. This parameter is stored as a lowercase string.
[REQUIRED]
The type of the endpoint, one of: READER , WRITER , ANY .
List of DB instance identifiers that are part of the custom endpoint group.
List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. This parameter is relevant only if the list of static members is empty.
The tags to be assigned to the Amazon RDS resource.
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
dict
Response Syntax
{
'DBClusterEndpointIdentifier': 'string',
'DBClusterIdentifier': 'string',
'DBClusterEndpointResourceIdentifier': 'string',
'Endpoint': 'string',
'Status': 'string',
'EndpointType': 'string',
'CustomEndpointType': 'string',
'StaticMembers': [
'string',
],
'ExcludedMembers': [
'string',
],
'DBClusterEndpointArn': 'string'
}
Response Structure
(dict) --
This data type represents the information you need to connect to an Amazon Aurora DB cluster. This data type is used as a response element in the following actions:
CreateDBClusterEndpointDescribeDBClusterEndpointsModifyDBClusterEndpointDeleteDBClusterEndpointFor the data structure that represents Amazon RDS DB instance endpoints, see Endpoint .
DBClusterEndpointIdentifier (string) --
The identifier associated with the endpoint. This parameter is stored as a lowercase string.
DBClusterIdentifier (string) --
The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
DBClusterEndpointResourceIdentifier (string) --
A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.
Endpoint (string) --
The DNS address of the endpoint.
Status (string) --
The current status of the endpoint. One of: creating , available , deleting , inactive , modifying . The inactive state applies to an endpoint that can't be used for a certain kind of cluster, such as a writer endpoint for a read-only secondary cluster in a global database.
EndpointType (string) --
The type of the endpoint. One of: READER , WRITER , CUSTOM .
CustomEndpointType (string) --
The type associated with a custom endpoint. One of: READER , WRITER , ANY .
StaticMembers (list) --
List of DB instance identifiers that are part of the custom endpoint group.
ExcludedMembers (list) --
List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.
DBClusterEndpointArn (string) --
The Amazon Resource Name (ARN) for the endpoint.
Exceptions
RDS.Client.exceptions.DBClusterEndpointQuotaExceededFaultRDS.Client.exceptions.DBClusterEndpointAlreadyExistsFaultRDS.Client.exceptions.DBClusterNotFoundFaultRDS.Client.exceptions.InvalidDBClusterStateFaultRDS.Client.exceptions.DBInstanceNotFoundFaultRDS.Client.exceptions.InvalidDBInstanceStateFaultcreate_db_cluster_parameter_group(**kwargs)¶Creates a new DB cluster parameter group.
Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.
A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup . Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster .
When you associate a new DB cluster parameter group with a running Aurora DB cluster, reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.
When you associate a new DB cluster parameter group with a running Multi-AZ DB cluster, reboot the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.
Warning
After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters operation to verify that your DB cluster parameter group has been created or modified.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide .
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_db_cluster_parameter_group(
DBClusterParameterGroupName='string',
DBParameterGroupFamily='string',
Description='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The name of the DB cluster parameter group.
Constraints:
Note
This value is stored as a lowercase string.
[REQUIRED]
The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.
Aurora MySQL
Example: aurora5.6 , aurora-mysql5.7 , aurora-mysql8.0
Aurora PostgreSQL
Example: aurora-postgresql9.6
RDS for MySQL
Example: mysql8.0
RDS for PostgreSQL
Example: postgres12
To list all of the available parameter group families for a DB engine, use the following command:
aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>
For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command:
aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine aurora-postgresql
Note
The output contains duplicates.
The following are the valid DB engine values:
aurora (for MySQL 5.6-compatible Aurora)aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)aurora-postgresqlmysqlpostgres[REQUIRED]
The description for the DB cluster parameter group.
Tags to assign to the DB cluster parameter group.
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
dict
Response Syntax
{
'DBClusterParameterGroup': {
'DBClusterParameterGroupName': 'string',
'DBParameterGroupFamily': 'string',
'Description': 'string',
'DBClusterParameterGroupArn': 'string'
}
}
Response Structure
(dict) --
DBClusterParameterGroup (dict) --
Contains the details of an Amazon RDS DB cluster parameter group.
This data type is used as a response element in the DescribeDBClusterParameterGroups action.
DBClusterParameterGroupName (string) --
The name of the DB cluster parameter group.
DBParameterGroupFamily (string) --
The name of the DB parameter group family that this DB cluster parameter group is compatible with.
Description (string) --
Provides the customer-specified description for this DB cluster parameter group.
DBClusterParameterGroupArn (string) --
The Amazon Resource Name (ARN) for the DB cluster parameter group.
Exceptions
RDS.Client.exceptions.DBParameterGroupQuotaExceededFaultRDS.Client.exceptions.DBParameterGroupAlreadyExistsFaultExamples
This example creates a DB cluster parameter group.
response = client.create_db_cluster_parameter_group(
DBClusterParameterGroupName='mydbclusterparametergroup',
DBParameterGroupFamily='aurora5.6',
Description='My DB cluster parameter group',
)
print(response)
Expected Output:
{
'DBClusterParameterGroup': {
},
'ResponseMetadata': {
'...': '...',
},
}
create_db_cluster_snapshot(**kwargs)¶Creates a snapshot of a DB cluster.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide .
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_db_cluster_snapshot(
DBClusterSnapshotIdentifier='string',
DBClusterIdentifier='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The identifier of the DB cluster snapshot. This parameter is stored as a lowercase string.
Constraints:
Example: my-cluster1-snapshot1
[REQUIRED]
The identifier of the DB cluster to create a snapshot for. This parameter isn't case-sensitive.
Constraints:
Example: my-cluster1
The tags to be assigned to the DB cluster snapshot.
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
dict
Response Syntax
{
'DBClusterSnapshot': {
'AvailabilityZones': [
'string',
],
'DBClusterSnapshotIdentifier': 'string',
'DBClusterIdentifier': 'string',
'SnapshotCreateTime': datetime(2015, 1, 1),
'Engine': 'string',
'EngineMode': 'string',
'AllocatedStorage': 123,
'Status': 'string',
'Port': 123,
'VpcId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'EngineVersion': 'string',
'LicenseModel': 'string',
'SnapshotType': 'string',
'PercentProgress': 123,
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DBClusterSnapshotArn': 'string',
'SourceDBClusterSnapshotArn': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
DBClusterSnapshot (dict) --
Contains the details for an Amazon RDS DB cluster snapshot
This data type is used as a response element in the DescribeDBClusterSnapshots action.
AvailabilityZones (list) --
Provides the list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
DBClusterSnapshotIdentifier (string) --
Specifies the identifier for the DB cluster snapshot.
DBClusterIdentifier (string) --
Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
SnapshotCreateTime (datetime) --
Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
Engine (string) --
Specifies the name of the database engine for this DB cluster snapshot.
EngineMode (string) --
Provides the engine mode of the database engine for this DB cluster snapshot.
AllocatedStorage (integer) --
Specifies the allocated storage size in gibibytes (GiB).
Status (string) --
Specifies the status of this DB cluster snapshot. Valid statuses are the following:
availablecopyingcreatingPort (integer) --
Specifies the port that the DB cluster was listening on at the time of the snapshot.
VpcId (string) --
Provides the VPC ID associated with the DB cluster snapshot.
ClusterCreateTime (datetime) --
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
MasterUsername (string) --
Provides the master username for this DB cluster snapshot.
EngineVersion (string) --
Provides the version of the database engine for this DB cluster snapshot.
LicenseModel (string) --
Provides the license model information for this DB cluster snapshot.
SnapshotType (string) --
Provides the type of the DB cluster snapshot.
PercentProgress (integer) --
Specifies the percentage of the estimated data that has been transferred.
StorageEncrypted (boolean) --
Specifies whether the DB cluster snapshot is encrypted.
KmsKeyId (string) --
If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
DBClusterSnapshotArn (string) --
The Amazon Resource Name (ARN) for the DB cluster snapshot.
SourceDBClusterSnapshotArn (string) --
If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.
IAMDatabaseAuthenticationEnabled (boolean) --
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
TagList (list) --
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Exceptions
RDS.Client.exceptions.DBClusterSnapshotAlreadyExistsFaultRDS.Client.exceptions.InvalidDBClusterStateFaultRDS.Client.exceptions.DBClusterNotFoundFaultRDS.Client.exceptions.SnapshotQuotaExceededFaultRDS.Client.exceptions.InvalidDBClusterSnapshotStateFaultExamples
This example creates a DB cluster snapshot.
response = client.create_db_cluster_snapshot(
DBClusterIdentifier='mydbcluster',
DBClusterSnapshotIdentifier='mydbclustersnapshot',
)
print(response)
Expected Output:
{
'DBClusterSnapshot': {
},
'ResponseMetadata': {
'...': '...',
},
}
create_db_instance(**kwargs)¶Creates a new DB instance.
The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster. For an Aurora DB cluster, you can call this operation multiple times to add more than one DB instance to the cluster.
For more information about creating an RDS DB instance, see Creating an Amazon RDS DB instance in the Amazon RDS User Guide .
For more information about creating a DB instance in an Aurora DB cluster, see Creating an Amazon Aurora DB cluster in the Amazon Aurora User Guide .
See also: AWS API Documentation
Request Syntax
response = client.create_db_instance(
DBName='string',
DBInstanceIdentifier='string',
AllocatedStorage=123,
DBInstanceClass='string',
Engine='string',
MasterUsername='string',
MasterUserPassword='string',
DBSecurityGroups=[
'string',
],
VpcSecurityGroupIds=[
'string',
],
AvailabilityZone='string',
DBSubnetGroupName='string',
PreferredMaintenanceWindow='string',
DBParameterGroupName='string',
BackupRetentionPeriod=123,
PreferredBackupWindow='string',
Port=123,
MultiAZ=True|False,
EngineVersion='string',
AutoMinorVersionUpgrade=True|False,
LicenseModel='string',
Iops=123,
OptionGroupName='string',
CharacterSetName='string',
NcharCharacterSetName='string',
PubliclyAccessible=True|False,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
DBClusterIdentifier='string',
StorageType='string',
TdeCredentialArn='string',
TdeCredentialPassword='string',
StorageEncrypted=True|False,
KmsKeyId='string',
Domain='string',
CopyTagsToSnapshot=True|False,
MonitoringInterval=123,
MonitoringRoleArn='string',
DomainIAMRoleName='string',
PromotionTier=123,
Timezone='string',
EnableIAMDatabaseAuthentication=True|False,
EnablePerformanceInsights=True|False,
PerformanceInsightsKMSKeyId='string',
PerformanceInsightsRetentionPeriod=123,
EnableCloudwatchLogsExports=[
'string',
],
ProcessorFeatures=[
{
'Name': 'string',
'Value': 'string'
},
],
DeletionProtection=True|False,
MaxAllocatedStorage=123,
EnableCustomerOwnedIp=True|False,
CustomIamInstanceProfile='string',
BackupTarget='string',
NetworkType='string'
)
The meaning of this parameter differs according to the database engine you use.
MySQL
The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
Constraints:
MariaDB
The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
Constraints:
PostgreSQL
The name of the database to create when the DB instance is created. If this parameter isn't specified, a database named postgres is created in the DB instance.
Constraints:
Oracle
The Oracle System ID (SID) of the created DB instance. If you specify null , the default value ORCL is used. You can't specify the string NULL, or any other reserved word, for DBName .
Default: ORCL
Constraints:
Amazon RDS Custom for Oracle
The Oracle System ID (SID) of the created RDS Custom DB instance. If you don't specify a value, the default value is ORCL .
Default: ORCL
Constraints:
Amazon RDS Custom for SQL Server
Not applicable. Must be null.
SQL Server
Not applicable. Must be null.
Amazon Aurora MySQL
The name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is created. If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created in the DB cluster.
Constraints:
Amazon Aurora PostgreSQL
The name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is created. If this parameter isn't specified for an Aurora PostgreSQL DB cluster, a database named postgres is created in the DB cluster.
Constraints:
[REQUIRED]
The DB instance identifier. This parameter is stored as a lowercase string.
Constraints:
Example: mydbinstance
The amount of storage in gibibytes (GiB) to allocate for the DB instance.
Type: Integer
Amazon Aurora
Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.
Amazon RDS Custom
Constraints to the amount of storage for each storage type are the following:
MySQL
Constraints to the amount of storage for each storage type are the following:
MariaDB
Constraints to the amount of storage for each storage type are the following:
PostgreSQL
Constraints to the amount of storage for each storage type are the following:
Oracle
Constraints to the amount of storage for each storage type are the following:
SQL Server
Constraints to the amount of storage for each storage type are the following:
[REQUIRED]
The compute and memory capacity of the DB instance, for example db.m5.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB instance classes in the Amazon RDS User Guide or Aurora DB instance classes in the Amazon Aurora User Guide .
[REQUIRED]
The name of the database engine to be used for this instance.
Not every database engine is available for every Amazon Web Services Region.
Valid Values:
aurora (for MySQL 5.6-compatible Aurora)aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)aurora-postgresqlcustom-oracle-ee (for RDS Custom for Oracle instances)custom-sqlserver-ee (for RDS Custom for SQL Server instances)custom-sqlserver-se (for RDS Custom for SQL Server instances)custom-sqlserver-web (for RDS Custom for SQL Server instances)mariadbmysqloracle-eeoracle-ee-cdboracle-se2oracle-se2-cdbpostgressqlserver-eesqlserver-sesqlserver-exsqlserver-webThe name for the master user.
Amazon Aurora
Not applicable. The name for the master user is managed by the DB cluster.
Amazon RDS
Constraints:
The password for the master user. The password can include any printable ASCII character except "/", """, or "@".
Amazon Aurora
Not applicable. The password for the master user is managed by the DB cluster.
MariaDB
Constraints: Must contain from 8 to 41 characters.
Microsoft SQL Server
Constraints: Must contain from 8 to 128 characters.
MySQL
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
PostgreSQL
Constraints: Must contain from 8 to 128 characters.
A list of DB security groups to associate with this DB instance.
This setting applies to the legacy EC2-Classic platform, which is no longer used to create new DB instances. Use the VpcSecurityGroupIds setting instead.
A list of Amazon EC2 VPC security groups to associate with this DB instance.
Amazon Aurora
Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
The Availability Zone (AZ) where the database will be created. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones .
Amazon Aurora
Each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one.
Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.
Example: us-east-1d
Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.
A DB subnet group to associate with this DB instance.
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example: mydbsubnetgroup
The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window .
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.
The name of the DB parameter group to associate with this DB instance. If you do not specify a value, then the default DB parameter group for the specified DB engine and version is used.
This setting doesn't apply to RDS Custom.
Constraints:
The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Amazon Aurora
Not applicable. The retention period for automated backups is managed by the DB cluster.
Default: 1
Constraints:
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. For more information, see Backup window in the Amazon RDS User Guide .
Amazon Aurora
Not applicable. The daily time range for creating automated backups is managed by the DB cluster.
Constraints:
hh24:mi-hh24:mi .The port number on which the database accepts connections.
MySQL
Default: 3306
Valid values: 1150-65535
Type: Integer
MariaDB
Default: 3306
Valid values: 1150-65535
Type: Integer
PostgreSQL
Default: 5432
Valid values: 1150-65535
Type: Integer
Oracle
Default: 1521
Valid values: 1150-65535
SQL Server
Default: 1433
Valid values: 1150-65535 except 1234 , 1434 , 3260 , 3343 , 3389 , 47001 , and 49152-49156 .
Amazon Aurora
Default: 3306
Valid values: 1150-65535
Type: Integer
A value that indicates whether the DB instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
This setting doesn't apply to RDS Custom.
Amazon Aurora
Not applicable. DB instance Availability Zones (AZs) are managed by the DB cluster.
The version number of the database engine to use.
For a list of valid engine versions, use the DescribeDBEngineVersions operation.
The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every Amazon Web Services Region.
Amazon Aurora
Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster.
Amazon RDS Custom for Oracle
A custom engine version (CEV) that you have previously created. This setting is required for RDS Custom for Oracle. The CEV name has the following format: 19.*customized_string* `` . An example identifier is ``19.my_cev1 . For more information, see Creating an RDS Custom for Oracle DB instance in the Amazon RDS User Guide .
Amazon RDS Custom for SQL Server
See RDS Custom for SQL Server general requirements in the Amazon RDS User Guide .
MariaDB
For information, see MariaDB on Amazon RDS Versions in the Amazon RDS User Guide .
Microsoft SQL Server
For information, see Microsoft SQL Server Versions on Amazon RDS in the Amazon RDS User Guide .
MySQL
For information, see MySQL on Amazon RDS Versions in the Amazon RDS User Guide .
Oracle
For information, see Oracle Database Engine Release Notes in the Amazon RDS User Guide .
PostgreSQL
For information, see Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide .
A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.
If you create an RDS Custom DB instance, you must set AutoMinorVersionUpgrade to false .
License model information for this DB instance.
Valid values: license-included | bring-your-own-license | general-public-license
This setting doesn't apply to RDS Custom.
Amazon Aurora
Not applicable.
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. For information about valid Iops values, see Amazon RDS Provisioned IOPS storage to improve performance in the Amazon RDS User Guide .
Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, must be a multiple between .5 and 50 of the storage amount for the DB instance. For SQL Server DB instances, must be a multiple between 1 and 50 of the storage amount for the DB instance.
Amazon Aurora
Not applicable. Storage is managed by the DB cluster.
A value that indicates that the DB instance should be associated with the specified option group.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance after it is associated with a DB instance.
This setting doesn't apply to RDS Custom.
Amazon Aurora
Not applicable.
For supported engines, this value indicates that the DB instance should be associated with the specified CharacterSet .
This setting doesn't apply to RDS Custom. However, if you need to change the character set, you can change it on the database itself.
Amazon Aurora
Not applicable. The character set is managed by the DB cluster. For more information, see CreateDBCluster .
The name of the NCHAR character set for the Oracle DB instance.
This parameter doesn't apply to RDS Custom.
A value that indicates whether the DB instance is publicly accessible.
When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
Tags to assign to the DB instance.
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
The identifier of the DB cluster that the instance will belong to.
This setting doesn't apply to RDS Custom.
Specifies the storage type to be associated with the DB instance.
Valid values: standard | gp2 | io1
If you specify io1 , you must also include a value for the Iops parameter.
Default: io1 if the Iops parameter is specified, otherwise gp2
Amazon Aurora
Not applicable. Storage is managed by the DB cluster.
The ARN from the key store with which to associate the instance for TDE encryption.
This setting doesn't apply to RDS Custom.
Amazon Aurora
Not applicable.
The password for the given ARN from the key store in order to access the device.
This setting doesn't apply to RDS Custom.
A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.
For RDS Custom instances, either set this parameter to true or leave it unset. If you set this parameter to false , RDS reports an error.
Amazon Aurora
Not applicable. The encryption for DB instances is managed by the DB cluster.
The Amazon Web Services KMS key identifier for an encrypted DB instance.
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.
Amazon Aurora
Not applicable. The Amazon Web Services KMS key identifier is managed by the DB cluster. For more information, see CreateDBCluster .
If StorageEncrypted is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
Amazon RDS Custom
A KMS key is required for RDS Custom instances. For most RDS engines, if you leave this parameter empty while enabling StorageEncrypted , the engine uses the default KMS key. However, RDS Custom doesn't use the default key when this parameter is empty. You must explicitly specify a key.
The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide .
This setting doesn't apply to RDS Custom.
Amazon Aurora
Not applicable. The domain is managed by the DB cluster.
A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0.
If MonitoringRoleArn is specified, then you must set MonitoringInterval to a value other than 0.
This setting doesn't apply to RDS Custom.
Valid Values: 0, 1, 5, 10, 15, 30, 60
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess . For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide .
If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
This setting doesn't apply to RDS Custom.
Specify the name of the IAM role to be used when making API calls to the Directory Service.
This setting doesn't apply to RDS Custom.
Amazon Aurora
Not applicable. The domain is managed by the DB cluster.
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .
This setting doesn't apply to RDS Custom.
Default: 1
Valid Values: 0 - 15
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide .
This setting doesn't apply to RDS Custom.
Amazon Aurora
Not applicable. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.
A value that indicates whether to enable Performance Insights for the DB instance. For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide .
This setting doesn't apply to RDS Custom.
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for PerformanceInsightsKMSKeyId , then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
This setting doesn't apply to RDS Custom.
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
For example, the following values are valid:
If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
This setting doesn't apply to RDS Custom.
The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide .
Amazon Aurora
Not applicable. CloudWatch Logs exports are managed by the DB cluster.
RDS Custom
Not applicable.
MariaDB
Possible values are audit , error , general , and slowquery .
Microsoft SQL Server
Possible values are agent and error .
MySQL
Possible values are audit , error , general , and slowquery .
Oracle
Possible values are alert , audit , listener , trace , and oemagent .
PostgreSQL
Possible values are postgresql and upgrade .
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
This setting doesn't apply to RDS Custom.
Amazon Aurora
Not applicable.
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstanceModifyDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceFromS3RestoreDBInstanceToPointInTimeYou can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstancesDescribeDBSnapshotsDescribeValidDBInstanceModificationsIf you call DescribeDBInstances , ProcessorFeature returns non-null values only if the following conditions are met:
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
The name of the processor feature. Valid names are coreCount and threadsPerCore .
The value of a processor feature name.
A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance .
Amazon Aurora
Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see CreateDBCluster . DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster.
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide .
This setting doesn't apply to RDS Custom.
Amazon Aurora
Not applicable. Storage is managed by the DB cluster.
A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide .
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide .
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
AWSRDSCustom .For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide .
This setting is required for RDS Custom.
Specifies where automated backups and manual snapshots are stored.
Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region .
For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide .
The network type of the DB instance.
Valid values:
IPV4DUALThe network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
dict
Response Syntax
{
'DBInstance': {
'DBInstanceIdentifier': 'string',
'DBInstanceClass': 'string',
'Engine': 'string',
'DBInstanceStatus': 'string',
'AutomaticRestartTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'DBName': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123,
'HostedZoneId': 'string'
},
'AllocatedStorage': 123,
'InstanceCreateTime': datetime(2015, 1, 1),
'PreferredBackupWindow': 'string',
'BackupRetentionPeriod': 123,
'DBSecurityGroups': [
{
'DBSecurityGroupName': 'string',
'Status': 'string'
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'DBParameterGroups': [
{
'DBParameterGroupName': 'string',
'ParameterApplyStatus': 'string'
},
],
'AvailabilityZone': 'string',
'DBSubnetGroup': {
'DBSubnetGroupName': 'string',
'DBSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetOutpost': {
'Arn': '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',
]
},
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
],
'IAMDatabaseAuthenticationEnabled': True|False,
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1)
},
'LatestRestorableTime': datetime(2015, 1, 1),
'MultiAZ': True|False,
'EngineVersion': 'string',
'AutoMinorVersionUpgrade': True|False,
'ReadReplicaSourceDBInstanceIdentifier': 'string',
'ReadReplicaDBInstanceIdentifiers': [
'string',
],
'ReadReplicaDBClusterIdentifiers': [
'string',
],
'ReplicaMode': 'open-read-only'|'mounted',
'LicenseModel': 'string',
'Iops': 123,
'OptionGroupMemberships': [
{
'OptionGroupName': 'string',
'Status': 'string'
},
],
'CharacterSetName': 'string',
'NcharCharacterSetName': 'string',
'SecondaryAvailabilityZone': 'string',
'PubliclyAccessible': True|False,
'StatusInfos': [
{
'StatusType': 'string',
'Normal': True|False,
'Status': 'string',
'Message': 'string'
},
],
'StorageType': 'string',
'TdeCredentialArn': 'string',
'DbInstancePort': 123,
'DBClusterIdentifier': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbiResourceId': 'string',
'CACertificateIdentifier': 'string',
'DomainMemberships': [
{
'Domain': 'string',
'Status': 'string',
'FQDN': 'string',
'IAMRoleName': 'string'
},
],
'CopyTagsToSnapshot': True|False,
'MonitoringInterval': 123,
'EnhancedMonitoringResourceArn': 'string',
'MonitoringRoleArn': 'string',
'PromotionTier': 123,
'DBInstanceArn': 'string',
'Timezone': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'PerformanceInsightsEnabled': True|False,
'PerformanceInsightsKMSKeyId': 'string',
'PerformanceInsightsRetentionPeriod': 123,
'EnabledCloudwatchLogsExports': [
'string',
],
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
],
'DeletionProtection': True|False,
'AssociatedRoles': [
{
'RoleArn': 'string',
'FeatureName': 'string',
'Status': 'string'
},
],
'ListenerEndpoint': {
'Address': 'string',
'Port': 123,
'HostedZoneId': 'string'
},
'MaxAllocatedStorage': 123,
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'DBInstanceAutomatedBackupsReplications': [
{
'DBInstanceAutomatedBackupsArn': 'string'
},
],
'CustomerOwnedIpEnabled': True|False,
'AwsBackupRecoveryPointArn': 'string',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamEngineNativeAuditFieldsIncluded': True|False,
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1),
'CustomIamInstanceProfile': 'string',
'BackupTarget': 'string',
'NetworkType': 'string',
'ActivityStreamPolicyStatus': 'locked'|'unlocked'|'locking-policy'|'unlocking-policy'
}
}
Response Structure
(dict) --
DBInstance (dict) --
Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations CreateDBInstance , CreateDBInstanceReadReplica , DeleteDBInstance , DescribeDBInstances , ModifyDBInstance , PromoteReadReplica , RebootDBInstance , RestoreDBInstanceFromDBSnapshot , RestoreDBInstanceFromS3 , RestoreDBInstanceToPointInTime , StartDBInstance , and StopDBInstance .
DBInstanceIdentifier (string) --
Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
DBInstanceClass (string) --
Contains the name of the compute and memory capacity class of the DB instance.
Engine (string) --
The name of the database engine to be used for this DB instance.
DBInstanceStatus (string) --
Specifies the current state of this database.
For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.
AutomaticRestartTime (datetime) --
The time when a stopped DB instance is restarted automatically.
MasterUsername (string) --
Contains the master username for the DB instance.
DBName (string) --
The meaning of this parameter differs according to the database engine you use.
MySQL, MariaDB, SQL Server, PostgreSQL
Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
Type: String
Oracle
Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
Endpoint (dict) --
Specifies the connection endpoint.
Note
The endpoint might not be shown for instances whose status is creating .
Address (string) --
Specifies the DNS address of the DB 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.
AllocatedStorage (integer) --
Specifies the allocated storage size specified in gibibytes (GiB).
InstanceCreateTime (datetime) --
Provides the date and time the DB 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 DB snapshots are retained.
DBSecurityGroups (list) --
A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
(dict) --
This data type is used as a response element in the following actions:
ModifyDBInstanceRebootDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceToPointInTimeDBSecurityGroupName (string) --
The name of the DB security group.
Status (string) --
The status of the DB security group.
VpcSecurityGroups (list) --
Provides a list of VPC security group elements that the DB instance belongs to.
(dict) --
This data type is used as a response element for queries on VPC security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The membership status of the VPC security group.
Currently, the only valid status is active .
DBParameterGroups (list) --
Provides the list of DB parameter groups applied to this DB instance.
(dict) --
The status of the DB parameter group.
This data type is used as a response element in the following actions:
CreateDBInstanceCreateDBInstanceReadReplicaDeleteDBInstanceModifyDBInstanceRebootDBInstanceRestoreDBInstanceFromDBSnapshotDBParameterGroupName (string) --
The name of the DB parameter group.
ParameterApplyStatus (string) --
The status of parameter updates.
AvailabilityZone (string) --
Specifies the name of the Availability Zone the DB instance is located in.
DBSubnetGroup (dict) --
Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
DBSubnetGroupName (string) --
The name of the DB subnet group.
DBSubnetGroupDescription (string) --
Provides the description of the DB subnet group.
VpcId (string) --
Provides the VpcId of the DB subnet group.
SubnetGroupStatus (string) --
Provides the status of the DB subnet group.
Subnets (list) --
Contains a list of Subnet elements.
(dict) --
This data type is used as a response element for the DescribeDBSubnetGroups operation.
SubnetIdentifier (string) --
The identifier of the subnet.
SubnetAvailabilityZone (dict) --
Contains Availability Zone information.
This data type is used as an element in the OrderableDBInstanceOption data type.
Name (string) --
The name of the Availability Zone.
SubnetOutpost (dict) --
If the subnet is associated with an Outpost, this value specifies the Outpost.
For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
Arn (string) --
The Amazon Resource Name (ARN) of the Outpost.
SubnetStatus (string) --
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:
IPV4DUALA DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
PendingModifiedValues (dict) --
A value that specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
DBInstanceClass (string) --
The name of the compute and memory capacity class for the DB instance.
AllocatedStorage (integer) --
The allocated storage size for the DB instance specified in gibibytes (GiB).
MasterUserPassword (string) --
The master credentials for the DB instance.
Port (integer) --
The port for the DB instance.
BackupRetentionPeriod (integer) --
The number of days for which automated backups are retained.
MultiAZ (boolean) --
A value that indicates that the Single-AZ DB instance will change to a Multi-AZ deployment.
EngineVersion (string) --
The database engine version.
LicenseModel (string) --
The license model for the DB instance.
Valid values: license-included | bring-your-own-license | general-public-license
Iops (integer) --
The Provisioned IOPS value for the DB instance.
DBInstanceIdentifier (string) --
The database identifier for the DB instance.
StorageType (string) --
The storage type of the DB instance.
CACertificateIdentifier (string) --
The identifier of the CA certificate for the DB instance.
DBSubnetGroupName (string) --
The DB subnet group for the DB instance.
PendingCloudwatchLogsExports (dict) --
A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.
LogTypesToEnable (list) --
Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.
LogTypesToDisable (list) --
Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.
ProcessorFeatures (list) --
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
(dict) --
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstanceModifyDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceFromS3RestoreDBInstanceToPointInTimeYou can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstancesDescribeDBSnapshotsDescribeValidDBInstanceModificationsIf you call DescribeDBInstances , ProcessorFeature returns non-null values only if the following conditions are met:
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
Name (string) --
The name of the processor feature. Valid names are coreCount and threadsPerCore .
Value (string) --
The value of a processor feature name.
IAMDatabaseAuthenticationEnabled (boolean) --
Whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
AutomationMode (string) --
The automation mode of the RDS Custom DB instance: full or all-paused . If full , the DB instance automates monitoring and instance recovery. If all-paused , the instance pauses automation for the duration set by --resume-full-automation-mode-minutes .
ResumeFullAutomationModeTime (datetime) --
The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
LatestRestorableTime (datetime) --
Specifies the latest time to which a database can be restored with point-in-time restore.
MultiAZ (boolean) --
Specifies if the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom.
EngineVersion (string) --
Indicates the database engine version.
AutoMinorVersionUpgrade (boolean) --
A value that indicates that minor version patches are applied automatically.
ReadReplicaSourceDBInstanceIdentifier (string) --
Contains the identifier of the source DB instance if this DB instance is a read replica.
ReadReplicaDBInstanceIdentifiers (list) --
Contains one or more identifiers of the read replicas associated with this DB instance.
ReadReplicaDBClusterIdentifiers (list) --
Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn't contain information about cross-Region Aurora read replicas.
Note
Currently, each RDS DB instance can have only one Aurora read replica.
ReplicaMode (string) --
The open mode of an Oracle read replica. The default is open-read-only . For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide .
Note
This attribute is only supported in RDS for Oracle.
LicenseModel (string) --
License model information for this DB instance. This setting doesn't apply to RDS Custom.
Iops (integer) --
Specifies the Provisioned IOPS (I/O operations per second) value.
OptionGroupMemberships (list) --
Provides the list of option group memberships for this DB instance.
(dict) --
Provides information on the option groups the DB instance is a member of.
OptionGroupName (string) --
The name of the option group that the instance belongs to.
Status (string) --
The status of the DB instance's option group membership. Valid values are: in-sync , pending-apply , pending-removal , pending-maintenance-apply , pending-maintenance-removal , applying , removing , and failed .
CharacterSetName (string) --
If present, specifies the name of the character set that this instance is associated with.
NcharCharacterSetName (string) --
The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.
SecondaryAvailabilityZone (string) --
If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
PubliclyAccessible (boolean) --
Specifies the accessibility options for the DB instance.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance .
StatusInfos (list) --
The status of a read replica. If the instance isn't a read replica, this is blank.
(dict) --
Provides a list of status information for a DB instance.
StatusType (string) --
This value is currently "read replication."
Normal (boolean) --
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 DB instance. For a StatusType of read replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.
Message (string) --
Details of the error if there is an error for the instance. If the instance isn't in an error state, this value is blank.
StorageType (string) --
Specifies the storage type associated with DB instance.
TdeCredentialArn (string) --
The ARN from the key store with which the instance is associated for TDE encryption.
DbInstancePort (integer) --
Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.
DBClusterIdentifier (string) --
If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.
StorageEncrypted (boolean) --
Specifies whether the DB instance is encrypted.
KmsKeyId (string) --
If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
DbiResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB instance is accessed.
CACertificateIdentifier (string) --
The identifier of the CA certificate for this DB instance.
DomainMemberships (list) --
The Active Directory Domain membership records associated with the DB instance.
(dict) --
An Active Directory Domain membership record associated with the DB instance or cluster.
Domain (string) --
The identifier of the Active Directory Domain.
Status (string) --
The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.
FQDN (string) --
The fully qualified domain name of the Active Directory Domain.
IAMRoleName (string) --
The name of the IAM role to be used when making API calls to the Directory Service.
CopyTagsToSnapshot (boolean) --
Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see DBCluster .
MonitoringInterval (integer) --
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
EnhancedMonitoringResourceArn (string) --
The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
MonitoringRoleArn (string) --
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
PromotionTier (integer) --
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .
DBInstanceArn (string) --
The Amazon Resource Name (ARN) for the DB instance.
Timezone (string) --
The time zone of the DB instance. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.
IAMDatabaseAuthenticationEnabled (boolean) --
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
IAM database authentication can be enabled for the following database engines
PerformanceInsightsEnabled (boolean) --
True if Performance Insights is enabled for the DB instance, and otherwise false.
PerformanceInsightsKMSKeyId (string) --
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
PerformanceInsightsRetentionPeriod (integer) --
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
For example, the following values are valid:
EnabledCloudwatchLogsExports (list) --
A list of log types that this DB instance is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon RDS User Guide.
ProcessorFeatures (list) --
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
(dict) --
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstanceModifyDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceFromS3RestoreDBInstanceToPointInTimeYou can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstancesDescribeDBSnapshotsDescribeValidDBInstanceModificationsIf you call DescribeDBInstances , ProcessorFeature returns non-null values only if the following conditions are met:
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
Name (string) --
The name of the processor feature. Valid names are coreCount and threadsPerCore .
Value (string) --
The value of a processor feature name.
DeletionProtection (boolean) --
Indicates if the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance .
AssociatedRoles (list) --
The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
(dict) --
Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.
FeatureName (string) --
The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion .
Status (string) --
Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf.PENDING - the IAM role ARN is being associated with the DB instance.INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf.ListenerEndpoint (dict) --
Specifies the listener connection endpoint for SQL Server Always On.
Address (string) --
Specifies the DNS address of the DB 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.
MaxAllocatedStorage (integer) --
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
TagList (list) --
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
DBInstanceAutomatedBackupsReplications (list) --
The list of replicated automated backups associated with the DB instance.
(dict) --
Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties.
DBInstanceAutomatedBackupsArn (string) --
The Amazon Resource Name (ARN) of the replicated automated backups.
CustomerOwnedIpEnabled (boolean) --
Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide .
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide .
AwsBackupRecoveryPointArn (string) --
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
ActivityStreamStatus (string) --
The status of the database activity stream.
ActivityStreamKmsKeyId (string) --
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
ActivityStreamKinesisStreamName (string) --
The name of the Amazon Kinesis data stream used for the database activity stream.
ActivityStreamMode (string) --
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. RDS for Oracle always handles these events asynchronously.
ActivityStreamEngineNativeAuditFieldsIncluded (boolean) --
Indicates whether engine-native audit fields are included in the database activity stream.
AutomationMode (string) --
The automation mode of the RDS Custom DB instance: full or all paused . If full , the DB instance automates monitoring and instance recovery. If all paused , the instance pauses automation for the duration set by --resume-full-automation-mode-minutes .
ResumeFullAutomationModeTime (datetime) --
The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
CustomIamInstanceProfile (string) --
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
AWSRDSCustom .For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide .
BackupTarget (string) --
Specifies where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
NetworkType (string) --
The network type of the DB instance.
Valid values:
IPV4DUALThe network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide and Working with a DB instance in a VPC in the Amazon Aurora User Guide.
ActivityStreamPolicyStatus (string) --
The status of the policy state of the activity stream.
Exceptions
RDS.Client.exceptions.DBInstanceAlreadyExistsFaultRDS.Client.exceptions.InsufficientDBInstanceCapacityFaultRDS.Client.exceptions.DBParameterGroupNotFoundFaultRDS.Client.exceptions.DBSecurityGroupNotFoundFaultRDS.Client.exceptions.InstanceQuotaExceededFaultRDS.Client.exceptions.StorageQuotaExceededFaultRDS.Client.exceptions.DBSubnetGroupNotFoundFaultRDS.Client.exceptions.DBSubnetGroupDoesNotCoverEnoughAZsRDS.Client.exceptions.InvalidDBClusterStateFaultRDS.Client.exceptions.InvalidSubnetRDS.Client.exceptions.InvalidVPCNetworkStateFaultRDS.Client.exceptions.ProvisionedIopsNotAvailableInAZFaultRDS.Client.exceptions.OptionGroupNotFoundFaultRDS.Client.exceptions.DBClusterNotFoundFaultRDS.Client.exceptions.StorageTypeNotSupportedFaultRDS.Client.exceptions.AuthorizationNotFoundFaultRDS.Client.exceptions.KMSKeyNotAccessibleFaultRDS.Client.exceptions.DomainNotFoundFaultRDS.Client.exceptions.BackupPolicyNotFoundFaultRDS.Client.exceptions.NetworkTypeNotSupportedExamples
This example creates a DB instance.
response = client.create_db_instance(
AllocatedStorage=5,
DBInstanceClass='db.t2.micro',
DBInstanceIdentifier='mymysqlinstance',
Engine='MySQL',
MasterUserPassword='MyPassword',
MasterUsername='MyUser',
)
print(response)
Expected Output:
{
'DBInstance': {
},
'ResponseMetadata': {
'...': '...',
},
}
create_db_instance_read_replica(**kwargs)¶Creates a new DB instance that acts as a read replica for an existing source DB instance. You can create a read replica for a DB instance running MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server. For more information, see Working with Read Replicas in the Amazon RDS User Guide .
Amazon Aurora doesn't support this operation. Call the CreateDBInstance operation to create a DB instance for an Aurora DB cluster.
All read replica DB instances are created with backups disabled. All other DB instance attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance, except as specified.
Warning
Your source DB instance must have backup retention enabled.
See also: AWS API Documentation
Request Syntax
response = client.create_db_instance_read_replica(
DBInstanceIdentifier='string',
SourceDBInstanceIdentifier='string',
DBInstanceClass='string',
AvailabilityZone='string',
Port=123,
MultiAZ=True|False,
AutoMinorVersionUpgrade=True|False,
Iops=123,
OptionGroupName='string',
DBParameterGroupName='string',
PubliclyAccessible=True|False,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
DBSubnetGroupName='string',
VpcSecurityGroupIds=[
'string',
],
StorageType='string',
CopyTagsToSnapshot=True|False,
MonitoringInterval=123,
MonitoringRoleArn='string',
KmsKeyId='string',
EnableIAMDatabaseAuthentication=True|False,
EnablePerformanceInsights=True|False,
PerformanceInsightsKMSKeyId='string',
PerformanceInsightsRetentionPeriod=123,
EnableCloudwatchLogsExports=[
'string',
],
ProcessorFeatures=[
{
'Name': 'string',
'Value': 'string'
},
],
UseDefaultProcessorFeatures=True|False,
DeletionProtection=True|False,
Domain='string',
DomainIAMRoleName='string',
ReplicaMode='open-read-only'|'mounted',
MaxAllocatedStorage=123,
CustomIamInstanceProfile='string',
NetworkType='string',
SourceRegion='string'
)
[REQUIRED]
The DB instance identifier of the read replica. This identifier is the unique key that identifies a DB instance. This parameter is stored as a lowercase string.
[REQUIRED]
The identifier of the DB instance that will act as the source for the read replica. Each DB instance can have up to five read replicas.
Constraints:
The compute and memory capacity of the read replica, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide .
Default: Inherits from the source DB instance.
The Availability Zone (AZ) where the read replica will be created.
Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.
Example: us-east-1d
The port number that the DB instance uses for connections.
Default: Inherits from the source DB instance
Valid Values: 1150-65535
A value that indicates whether the read replica is in a Multi-AZ deployment.
You can create a read replica as a Multi-AZ DB instance. RDS creates a standby of your replica in another Availability Zone for failover support for the replica. Creating your read replica as a Multi-AZ DB instance is independent of whether the source database is a Multi-AZ DB instance.
This setting doesn't apply to RDS Custom.
A value that indicates whether minor engine upgrades are applied automatically to the read replica during the maintenance window.
This setting doesn't apply to RDS Custom.
Default: Inherits from the source DB instance
The option group the DB instance is associated with. If omitted, the option group associated with the source instance is used.
Note
For SQL Server, you must use the option group associated with the source instance.
This setting doesn't apply to RDS Custom.
The name of the DB parameter group to associate with this DB instance.
If you do not specify a value for DBParameterGroupName , then Amazon RDS uses the DBParameterGroup of source DB instance for a same Region read replica, or the default DBParameterGroup for the specified DB engine for a cross-Region read replica.
Specifying a parameter group for this operation is only supported for MySQL and Oracle DB instances. It isn't supported for RDS Custom.
Constraints:
A value that indicates whether the DB instance is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance .
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Specifies a DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance isn't created in a VPC.
Constraints:
Example: mydbsubnetgroup
A list of Amazon EC2 VPC security groups to associate with the read replica.
This setting doesn't apply to RDS Custom.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
Specifies the storage type to be associated with the read replica.
Valid values: standard | gp2 | io1
If you specify io1 , you must also include a value for the Iops parameter.
Default: io1 if the Iops parameter is specified, otherwise gp2
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the read replica. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.
If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.
This setting doesn't apply to RDS Custom.
Valid Values: 0, 1, 5, 10, 15, 30, 60
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess . For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide .
If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
This setting doesn't apply to RDS Custom.
The Amazon Web Services KMS key identifier for an encrypted read replica.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you create an encrypted read replica in the same Amazon Web Services Region as the source DB instance, then do not specify a value for this parameter. A read replica in the same Amazon Web Services Region is always encrypted with the same KMS key as the source DB instance.
If you create an encrypted read replica in a different Amazon Web Services Region, then you must specify a KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region that they are created in, and you can't use KMS keys from one Amazon Web Services Region in another Amazon Web Services Region.
You can't create an encrypted read replica from an unencrypted DB instance.
This setting doesn't apply to RDS Custom, which uses the same KMS key as the primary replica.
When you are creating a read replica from one Amazon Web Services GovCloud (US) Region to another or from one China Amazon Web Services Region to another, the URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API operation in the source Amazon Web Services Region that contains the source DB instance.
This setting applies only to Amazon Web Services GovCloud (US) Regions and China Amazon Web Services Regions. It's ignored in other Amazon Web Services Regions.
You must specify this parameter when you create an encrypted read replica from another Amazon Web Services Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are creating an encrypted read replica in the same Amazon Web Services Region.
The presigned URL must be a valid request for the CreateDBInstanceReadReplica API operation that can run in the source Amazon Web Services Region that contains the encrypted source DB instance. The presigned URL request must contain the following parameter values:
DestinationRegion - The Amazon Web Services Region that the encrypted read replica is created in. This Amazon Web Services Region is the same one where the CreateDBInstanceReadReplica operation is called that contains this presigned URL. For example, if you create an encrypted DB instance in the us-west-1 Amazon Web Services Region, from a source DB instance in the us-east-2 Amazon Web Services Region, then you call the CreateDBInstanceReadReplica operation in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the CreateDBInstanceReadReplica operation in the us-west-2 Amazon Web Services Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 Amazon Web Services Region.KmsKeyId - The KMS key identifier for the key to use to encrypt the read replica in the destination Amazon Web Services Region. This is the same identifier for both the CreateDBInstanceReadReplica operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL.SourceDBInstanceIdentifier - The DB instance identifier for the encrypted DB instance to be replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are creating an encrypted read replica from a DB instance in the us-west-2 Amazon Web Services Region, then your SourceDBInstanceIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115 .To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process .
Note
If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.
SourceRegionisn't supported for SQL Server, because Amazon RDS for SQL Server doesn't support cross-Region read replicas.
This setting doesn't apply to RDS Custom.
Please note that this parameter is automatically populated if it is not provided. Including this parameter is not required
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide .
This setting doesn't apply to RDS Custom.
A value that indicates whether to enable Performance Insights for the read replica.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide .
This setting doesn't apply to RDS Custom.
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for PerformanceInsightsKMSKeyId , then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
This setting doesn't apply to RDS Custom.
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
For example, the following values are valid:
If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
This setting doesn't apply to RDS Custom.
The list of logs that the new DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide .
This setting doesn't apply to RDS Custom.
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
This setting doesn't apply to RDS Custom.
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstanceModifyDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceFromS3RestoreDBInstanceToPointInTimeYou can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstancesDescribeDBSnapshotsDescribeValidDBInstanceModificationsIf you call DescribeDBInstances , ProcessorFeature returns non-null values only if the following conditions are met:
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
The name of the processor feature. Valid names are coreCount and threadsPerCore .
The value of a processor feature name.
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
This setting doesn't apply to RDS Custom.
The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide .
This setting doesn't apply to RDS Custom.
Specify the name of the IAM role to be used when making API calls to the Directory Service.
This setting doesn't apply to RDS Custom.
The open mode of the replica database: mounted or read-only.
Note
This parameter is only supported for Oracle DB instances.
Mounted DB replicas are included in Oracle Database Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload.
You can create a combination of mounted and read-only DB replicas for the same primary DB instance. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide .
For RDS Custom, you must specify this parameter and set it to mounted . The value won't be set by default. After replica creation, you can manage the open mode manually.
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide .
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
AWSRDSCustom .For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide .
This setting is required for RDS Custom.
The network type of the DB instance.
Valid values:
IPV4DUALThe network type is determined by the DBSubnetGroup specified for read replica. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
dict
Response Syntax
{
'DBInstance': {
'DBInstanceIdentifier': 'string',
'DBInstanceClass': 'string',
'Engine': 'string',
'DBInstanceStatus': 'string',
'AutomaticRestartTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'DBName': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123,
'HostedZoneId': 'string'
},
'AllocatedStorage': 123,
'InstanceCreateTime': datetime(2015, 1, 1),
'PreferredBackupWindow': 'string',
'BackupRetentionPeriod': 123,
'DBSecurityGroups': [
{
'DBSecurityGroupName': 'string',
'Status': 'string'
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'DBParameterGroups': [
{
'DBParameterGroupName': 'string',
'ParameterApplyStatus': 'string'
},
],
'AvailabilityZone': 'string',
'DBSubnetGroup': {
'DBSubnetGroupName': 'string',
'DBSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetOutpost': {
'Arn': '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',
]
},
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
],
'IAMDatabaseAuthenticationEnabled': True|False,
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1)
},
'LatestRestorableTime': datetime(2015, 1, 1),
'MultiAZ': True|False,
'EngineVersion': 'string',
'AutoMinorVersionUpgrade': True|False,
'ReadReplicaSourceDBInstanceIdentifier': 'string',
'ReadReplicaDBInstanceIdentifiers': [
'string',
],
'ReadReplicaDBClusterIdentifiers': [
'string',
],
'ReplicaMode': 'open-read-only'|'mounted',
'LicenseModel': 'string',
'Iops': 123,
'OptionGroupMemberships': [
{
'OptionGroupName': 'string',
'Status': 'string'
},
],
'CharacterSetName': 'string',
'NcharCharacterSetName': 'string',
'SecondaryAvailabilityZone': 'string',
'PubliclyAccessible': True|False,
'StatusInfos': [
{
'StatusType': 'string',
'Normal': True|False,
'Status': 'string',
'Message': 'string'
},
],
'StorageType': 'string',
'TdeCredentialArn': 'string',
'DbInstancePort': 123,
'DBClusterIdentifier': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbiResourceId': 'string',
'CACertificateIdentifier': 'string',
'DomainMemberships': [
{
'Domain': 'string',
'Status': 'string',
'FQDN': 'string',
'IAMRoleName': 'string'
},
],
'CopyTagsToSnapshot': True|False,
'MonitoringInterval': 123,
'EnhancedMonitoringResourceArn': 'string',
'MonitoringRoleArn': 'string',
'PromotionTier': 123,
'DBInstanceArn': 'string',
'Timezone': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'PerformanceInsightsEnabled': True|False,
'PerformanceInsightsKMSKeyId': 'string',
'PerformanceInsightsRetentionPeriod': 123,
'EnabledCloudwatchLogsExports': [
'string',
],
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
],
'DeletionProtection': True|False,
'AssociatedRoles': [
{
'RoleArn': 'string',
'FeatureName': 'string',
'Status': 'string'
},
],
'ListenerEndpoint': {
'Address': 'string',
'Port': 123,
'HostedZoneId': 'string'
},
'MaxAllocatedStorage': 123,
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'DBInstanceAutomatedBackupsReplications': [
{
'DBInstanceAutomatedBackupsArn': 'string'
},
],
'CustomerOwnedIpEnabled': True|False,
'AwsBackupRecoveryPointArn': 'string',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamEngineNativeAuditFieldsIncluded': True|False,
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1),
'CustomIamInstanceProfile': 'string',
'BackupTarget': 'string',
'NetworkType': 'string',
'ActivityStreamPolicyStatus': 'locked'|'unlocked'|'locking-policy'|'unlocking-policy'
}
}
Response Structure
(dict) --
DBInstance (dict) --
Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations CreateDBInstance , CreateDBInstanceReadReplica , DeleteDBInstance , DescribeDBInstances , ModifyDBInstance , PromoteReadReplica , RebootDBInstance , RestoreDBInstanceFromDBSnapshot , RestoreDBInstanceFromS3 , RestoreDBInstanceToPointInTime , StartDBInstance , and StopDBInstance .
DBInstanceIdentifier (string) --
Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
DBInstanceClass (string) --
Contains the name of the compute and memory capacity class of the DB instance.
Engine (string) --
The name of the database engine to be used for this DB instance.
DBInstanceStatus (string) --
Specifies the current state of this database.
For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.
AutomaticRestartTime (datetime) --
The time when a stopped DB instance is restarted automatically.
MasterUsername (string) --
Contains the master username for the DB instance.
DBName (string) --
The meaning of this parameter differs according to the database engine you use.
MySQL, MariaDB, SQL Server, PostgreSQL
Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
Type: String
Oracle
Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
Endpoint (dict) --
Specifies the connection endpoint.
Note
The endpoint might not be shown for instances whose status is creating .
Address (string) --
Specifies the DNS address of the DB 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.
AllocatedStorage (integer) --
Specifies the allocated storage size specified in gibibytes (GiB).
InstanceCreateTime (datetime) --
Provides the date and time the DB 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 DB snapshots are retained.
DBSecurityGroups (list) --
A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
(dict) --
This data type is used as a response element in the following actions:
ModifyDBInstanceRebootDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceToPointInTimeDBSecurityGroupName (string) --
The name of the DB security group.
Status (string) --
The status of the DB security group.
VpcSecurityGroups (list) --
Provides a list of VPC security group elements that the DB instance belongs to.
(dict) --
This data type is used as a response element for queries on VPC security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The membership status of the VPC security group.
Currently, the only valid status is active .
DBParameterGroups (list) --
Provides the list of DB parameter groups applied to this DB instance.
(dict) --
The status of the DB parameter group.
This data type is used as a response element in the following actions:
CreateDBInstanceCreateDBInstanceReadReplicaDeleteDBInstanceModifyDBInstanceRebootDBInstanceRestoreDBInstanceFromDBSnapshotDBParameterGroupName (string) --
The name of the DB parameter group.
ParameterApplyStatus (string) --
The status of parameter updates.
AvailabilityZone (string) --
Specifies the name of the Availability Zone the DB instance is located in.
DBSubnetGroup (dict) --
Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
DBSubnetGroupName (string) --
The name of the DB subnet group.
DBSubnetGroupDescription (string) --
Provides the description of the DB subnet group.
VpcId (string) --
Provides the VpcId of the DB subnet group.
SubnetGroupStatus (string) --
Provides the status of the DB subnet group.
Subnets (list) --
Contains a list of Subnet elements.
(dict) --
This data type is used as a response element for the DescribeDBSubnetGroups operation.
SubnetIdentifier (string) --
The identifier of the subnet.
SubnetAvailabilityZone (dict) --
Contains Availability Zone information.
This data type is used as an element in the OrderableDBInstanceOption data type.
Name (string) --
The name of the Availability Zone.
SubnetOutpost (dict) --
If the subnet is associated with an Outpost, this value specifies the Outpost.
For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
Arn (string) --
The Amazon Resource Name (ARN) of the Outpost.
SubnetStatus (string) --
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:
IPV4DUALA DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
PendingModifiedValues (dict) --
A value that specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
DBInstanceClass (string) --
The name of the compute and memory capacity class for the DB instance.
AllocatedStorage (integer) --
The allocated storage size for the DB instance specified in gibibytes (GiB).
MasterUserPassword (string) --
The master credentials for the DB instance.
Port (integer) --
The port for the DB instance.
BackupRetentionPeriod (integer) --
The number of days for which automated backups are retained.
MultiAZ (boolean) --
A value that indicates that the Single-AZ DB instance will change to a Multi-AZ deployment.
EngineVersion (string) --
The database engine version.
LicenseModel (string) --
The license model for the DB instance.
Valid values: license-included | bring-your-own-license | general-public-license
Iops (integer) --
The Provisioned IOPS value for the DB instance.
DBInstanceIdentifier (string) --
The database identifier for the DB instance.
StorageType (string) --
The storage type of the DB instance.
CACertificateIdentifier (string) --
The identifier of the CA certificate for the DB instance.
DBSubnetGroupName (string) --
The DB subnet group for the DB instance.
PendingCloudwatchLogsExports (dict) --
A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.
LogTypesToEnable (list) --
Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.
LogTypesToDisable (list) --
Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.
ProcessorFeatures (list) --
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
(dict) --
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstanceModifyDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceFromS3RestoreDBInstanceToPointInTimeYou can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstancesDescribeDBSnapshotsDescribeValidDBInstanceModificationsIf you call DescribeDBInstances , ProcessorFeature returns non-null values only if the following conditions are met:
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
Name (string) --
The name of the processor feature. Valid names are coreCount and threadsPerCore .
Value (string) --
The value of a processor feature name.
IAMDatabaseAuthenticationEnabled (boolean) --
Whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
AutomationMode (string) --
The automation mode of the RDS Custom DB instance: full or all-paused . If full , the DB instance automates monitoring and instance recovery. If all-paused , the instance pauses automation for the duration set by --resume-full-automation-mode-minutes .
ResumeFullAutomationModeTime (datetime) --
The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
LatestRestorableTime (datetime) --
Specifies the latest time to which a database can be restored with point-in-time restore.
MultiAZ (boolean) --
Specifies if the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom.
EngineVersion (string) --
Indicates the database engine version.
AutoMinorVersionUpgrade (boolean) --
A value that indicates that minor version patches are applied automatically.
ReadReplicaSourceDBInstanceIdentifier (string) --
Contains the identifier of the source DB instance if this DB instance is a read replica.
ReadReplicaDBInstanceIdentifiers (list) --
Contains one or more identifiers of the read replicas associated with this DB instance.
ReadReplicaDBClusterIdentifiers (list) --
Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn't contain information about cross-Region Aurora read replicas.
Note
Currently, each RDS DB instance can have only one Aurora read replica.
ReplicaMode (string) --
The open mode of an Oracle read replica. The default is open-read-only . For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide .
Note
This attribute is only supported in RDS for Oracle.
LicenseModel (string) --
License model information for this DB instance. This setting doesn't apply to RDS Custom.
Iops (integer) --
Specifies the Provisioned IOPS (I/O operations per second) value.
OptionGroupMemberships (list) --
Provides the list of option group memberships for this DB instance.
(dict) --
Provides information on the option groups the DB instance is a member of.
OptionGroupName (string) --
The name of the option group that the instance belongs to.
Status (string) --
The status of the DB instance's option group membership. Valid values are: in-sync , pending-apply , pending-removal , pending-maintenance-apply , pending-maintenance-removal , applying , removing , and failed .
CharacterSetName (string) --
If present, specifies the name of the character set that this instance is associated with.
NcharCharacterSetName (string) --
The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.
SecondaryAvailabilityZone (string) --
If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
PubliclyAccessible (boolean) --
Specifies the accessibility options for the DB instance.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance .
StatusInfos (list) --
The status of a read replica. If the instance isn't a read replica, this is blank.
(dict) --
Provides a list of status information for a DB instance.
StatusType (string) --
This value is currently "read replication."
Normal (boolean) --
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 DB instance. For a StatusType of read replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.
Message (string) --
Details of the error if there is an error for the instance. If the instance isn't in an error state, this value is blank.
StorageType (string) --
Specifies the storage type associated with DB instance.
TdeCredentialArn (string) --
The ARN from the key store with which the instance is associated for TDE encryption.
DbInstancePort (integer) --
Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.
DBClusterIdentifier (string) --
If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.
StorageEncrypted (boolean) --
Specifies whether the DB instance is encrypted.
KmsKeyId (string) --
If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
DbiResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB instance is accessed.
CACertificateIdentifier (string) --
The identifier of the CA certificate for this DB instance.
DomainMemberships (list) --
The Active Directory Domain membership records associated with the DB instance.
(dict) --
An Active Directory Domain membership record associated with the DB instance or cluster.
Domain (string) --
The identifier of the Active Directory Domain.
Status (string) --
The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.
FQDN (string) --
The fully qualified domain name of the Active Directory Domain.
IAMRoleName (string) --
The name of the IAM role to be used when making API calls to the Directory Service.
CopyTagsToSnapshot (boolean) --
Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see DBCluster .
MonitoringInterval (integer) --
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
EnhancedMonitoringResourceArn (string) --
The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
MonitoringRoleArn (string) --
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
PromotionTier (integer) --
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .
DBInstanceArn (string) --
The Amazon Resource Name (ARN) for the DB instance.
Timezone (string) --
The time zone of the DB instance. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.
IAMDatabaseAuthenticationEnabled (boolean) --
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
IAM database authentication can be enabled for the following database engines
PerformanceInsightsEnabled (boolean) --
True if Performance Insights is enabled for the DB instance, and otherwise false.
PerformanceInsightsKMSKeyId (string) --
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
PerformanceInsightsRetentionPeriod (integer) --
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
For example, the following values are valid:
EnabledCloudwatchLogsExports (list) --
A list of log types that this DB instance is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon RDS User Guide.
ProcessorFeatures (list) --
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
(dict) --
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstanceModifyDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceFromS3RestoreDBInstanceToPointInTimeYou can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstancesDescribeDBSnapshotsDescribeValidDBInstanceModificationsIf you call DescribeDBInstances , ProcessorFeature returns non-null values only if the following conditions are met:
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
Name (string) --
The name of the processor feature. Valid names are coreCount and threadsPerCore .
Value (string) --
The value of a processor feature name.
DeletionProtection (boolean) --
Indicates if the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance .
AssociatedRoles (list) --
The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
(dict) --
Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.
FeatureName (string) --
The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion .
Status (string) --
Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf.PENDING - the IAM role ARN is being associated with the DB instance.INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf.ListenerEndpoint (dict) --
Specifies the listener connection endpoint for SQL Server Always On.
Address (string) --
Specifies the DNS address of the DB 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.
MaxAllocatedStorage (integer) --
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
TagList (list) --
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
DBInstanceAutomatedBackupsReplications (list) --
The list of replicated automated backups associated with the DB instance.
(dict) --
Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties.
DBInstanceAutomatedBackupsArn (string) --
The Amazon Resource Name (ARN) of the replicated automated backups.
CustomerOwnedIpEnabled (boolean) --
Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide .
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide .
AwsBackupRecoveryPointArn (string) --
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
ActivityStreamStatus (string) --
The status of the database activity stream.
ActivityStreamKmsKeyId (string) --
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
ActivityStreamKinesisStreamName (string) --
The name of the Amazon Kinesis data stream used for the database activity stream.
ActivityStreamMode (string) --
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. RDS for Oracle always handles these events asynchronously.
ActivityStreamEngineNativeAuditFieldsIncluded (boolean) --
Indicates whether engine-native audit fields are included in the database activity stream.
AutomationMode (string) --
The automation mode of the RDS Custom DB instance: full or all paused . If full , the DB instance automates monitoring and instance recovery. If all paused , the instance pauses automation for the duration set by --resume-full-automation-mode-minutes .
ResumeFullAutomationModeTime (datetime) --
The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
CustomIamInstanceProfile (string) --
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
AWSRDSCustom .For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide .
BackupTarget (string) --
Specifies where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
NetworkType (string) --
The network type of the DB instance.
Valid values:
IPV4DUALThe network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide and Working with a DB instance in a VPC in the Amazon Aurora User Guide.
ActivityStreamPolicyStatus (string) --
The status of the policy state of the activity stream.
Exceptions
RDS.Client.exceptions.DBInstanceAlreadyExistsFaultRDS.Client.exceptions.InsufficientDBInstanceCapacityFaultRDS.Client.exceptions.DBParameterGroupNotFoundFaultRDS.Client.exceptions.DBSecurityGroupNotFoundFaultRDS.Client.exceptions.InstanceQuotaExceededFaultRDS.Client.exceptions.StorageQuotaExceededFaultRDS.Client.exceptions.DBInstanceNotFoundFaultRDS.Client.exceptions.InvalidDBInstanceStateFaultRDS.Client.exceptions.DBSubnetGroupNotFoundFaultRDS.Client.exceptions.DBSubnetGroupDoesNotCoverEnoughAZsRDS.Client.exceptions.InvalidSubnetRDS.Client.exceptions.InvalidVPCNetworkStateFaultRDS.Client.exceptions.ProvisionedIopsNotAvailableInAZFaultRDS.Client.exceptions.OptionGroupNotFoundFaultRDS.Client.exceptions.DBSubnetGroupNotAllowedFaultRDS.Client.exceptions.InvalidDBSubnetGroupFaultRDS.Client.exceptions.StorageTypeNotSupportedFaultRDS.Client.exceptions.KMSKeyNotAccessibleFaultRDS.Client.exceptions.DomainNotFoundFaultRDS.Client.exceptions.NetworkTypeNotSupportedExamples
This example creates a DB instance read replica.
response = client.create_db_instance_read_replica(
AvailabilityZone='us-east-1a',
CopyTagsToSnapshot=True,
DBInstanceClass='db.t2.micro',
DBInstanceIdentifier='mydbreadreplica',
PubliclyAccessible=True,
SourceDBInstanceIdentifier='mymysqlinstance',
StorageType='gp2',
Tags=[
{
'Key': 'mydbreadreplicakey',
'Value': 'mydbreadreplicavalue',
},
],
)
print(response)
Expected Output:
{
'DBInstance': {
},
'ResponseMetadata': {
'...': '...',
},
}
create_db_parameter_group(**kwargs)¶Creates a new DB parameter group.
A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup . Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance . When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.
This command doesn't apply to RDS Custom.
Warning
After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.
See also: AWS API Documentation
Request Syntax
response = client.create_db_parameter_group(
DBParameterGroupName='string',
DBParameterGroupFamily='string',
Description='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The name of the DB parameter group.
Constraints:
Note
This value is stored as a lowercase string.
[REQUIRED]
The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.
To list all of the available parameter group families for a DB engine, use the following command:
aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>
For example, to list all of the available parameter group families for the MySQL DB engine, use the following command:
aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine mysql
Note
The output contains duplicates.
The following are the valid DB engine values:
aurora (for MySQL 5.6-compatible Aurora)aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)aurora-postgresqlmariadbmysqloracle-eeoracle-ee-cdboracle-se2oracle-se2-cdbpostgressqlserver-eesqlserver-sesqlserver-exsqlserver-web[REQUIRED]
The description for the DB parameter group.
Tags to assign to the DB parameter group.
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
dict
Response Syntax
{
'DBParameterGroup': {
'DBParameterGroupName': 'string',
'DBParameterGroupFamily': 'string',
'Description': 'string',
'DBParameterGroupArn': 'string'
}
}
Response Structure
(dict) --
DBParameterGroup (dict) --
Contains the details of an Amazon RDS DB parameter group.
This data type is used as a response element in the DescribeDBParameterGroups action.
DBParameterGroupName (string) --
The name of the DB parameter group.
DBParameterGroupFamily (string) --
The name of the DB parameter group family that this DB parameter group is compatible with.
Description (string) --
Provides the customer-specified description for this DB parameter group.
DBParameterGroupArn (string) --
The Amazon Resource Name (ARN) for the DB parameter group.
Exceptions
RDS.Client.exceptions.DBParameterGroupQuotaExceededFaultRDS.Client.exceptions.DBParameterGroupAlreadyExistsFaultExamples
This example creates a DB parameter group.
response = client.create_db_parameter_group(
DBParameterGroupFamily='mysql5.6',
DBParameterGroupName='mymysqlparametergroup',
Description='My MySQL parameter group',
)
print(response)
Expected Output:
{
'DBParameterGroup': {
},
'ResponseMetadata': {
'...': '...',
},
}
create_db_proxy(**kwargs)¶Creates a new DB proxy.
See also: AWS API Documentation
Request Syntax
response = client.create_db_proxy(
DBProxyName='string',
EngineFamily='MYSQL'|'POSTGRESQL',
Auth=[
{
'Description': 'string',
'UserName': 'string',
'AuthScheme': 'SECRETS',
'SecretArn': 'string',
'IAMAuth': 'DISABLED'|'REQUIRED'
},
],
RoleArn='string',
VpcSubnetIds=[
'string',
],
VpcSecurityGroupIds=[
'string',
],
RequireTLS=True|False,
IdleClientTimeout=123,
DebugLogging=True|False,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.
[REQUIRED]
The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. For Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases, specify MYSQL . For Aurora PostgreSQL and RDS for PostgreSQL databases, specify POSTGRESQL .
[REQUIRED]
The authorization mechanism that the proxy uses.
Specifies the details of authentication used by a proxy to log in as a specific database user.
A user-specified description about the authentication used by a proxy to log in as a specific database user.
The name of the database user to which the proxy connects.
The type of authentication that the proxy uses for connections from the proxy to the underlying database.
The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.
Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy.
[REQUIRED]
The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.
[REQUIRED]
One or more VPC subnet IDs to associate with the new proxy.
One or more VPC security group IDs to associate with the new proxy.
An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
dict
Response Syntax
{
'DBProxy': {
'DBProxyName': 'string',
'DBProxyArn': 'string',
'Status': 'available'|'modifying'|'incompatible-network'|'insufficient-resource-limits'|'creating'|'deleting'|'suspended'|'suspending'|'reactivating',
'EngineFamily': 'string',
'VpcId': 'string',
'VpcSecurityGroupIds': [
'string',
],
'VpcSubnetIds': [
'string',
],
'Auth': [
{
'Description': 'string',
'UserName': 'string',
'AuthScheme': 'SECRETS',
'SecretArn': 'string',
'IAMAuth': 'DISABLED'|'REQUIRED'
},
],
'RoleArn': 'string',
'Endpoint': 'string',
'RequireTLS': True|False,
'IdleClientTimeout': 123,
'DebugLogging': True|False,
'CreatedDate': datetime(2015, 1, 1),
'UpdatedDate': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
DBProxy (dict) --
The DBProxy structure corresponding to the new proxy.
DBProxyName (string) --
The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.
DBProxyArn (string) --
The Amazon Resource Name (ARN) for the proxy.
Status (string) --
The current status of this proxy. A status of available means the proxy is ready to handle requests. Other values indicate that you must wait for the proxy to be ready, or take some action to resolve an issue.
EngineFamily (string) --
The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. MYSQL supports Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases. POSTGRESQL supports Aurora PostgreSQL and RDS for PostgreSQL databases.
VpcId (string) --
Provides the VPC ID of the DB proxy.
VpcSecurityGroupIds (list) --
Provides a list of VPC security groups that the proxy belongs to.
VpcSubnetIds (list) --
The EC2 subnet IDs for the proxy.
Auth (list) --
One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.
(dict) --
Returns the details of authentication used by a proxy to log in as a specific database user.
Description (string) --
A user-specified description about the authentication used by a proxy to log in as a specific database user.
UserName (string) --
The name of the database user to which the proxy connects.
AuthScheme (string) --
The type of authentication that the proxy uses for connections from the proxy to the underlying database.
SecretArn (string) --
The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.
IAMAuth (string) --
Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy.
RoleArn (string) --
The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.
Endpoint (string) --
The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.
RequireTLS (boolean) --
Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
IdleClientTimeout (integer) --
The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection. The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by later connection requests.
Default: 1800 (30 minutes)
Constraints: 1 to 28,800
DebugLogging (boolean) --
Whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.
CreatedDate (datetime) --
The date and time when the proxy was first created.
UpdatedDate (datetime) --
The date and time when the proxy was last updated.
Exceptions
RDS.Client.exceptions.InvalidSubnetRDS.Client.exceptions.DBProxyAlreadyExistsFaultRDS.Client.exceptions.DBProxyQuotaExceededFaultcreate_db_proxy_endpoint(**kwargs)¶Creates a DBProxyEndpoint . Only applies to proxies that are associated with Aurora DB clusters. You can use DB proxy endpoints to specify read/write or read-only access to the DB cluster. You can also use DB proxy endpoints to access a DB proxy through a different VPC than the proxy's default VPC.
See also: AWS API Documentation
Request Syntax
response = client.create_db_proxy_endpoint(
DBProxyName='string',
DBProxyEndpointName='string',
VpcSubnetIds=[
'string',
],
VpcSecurityGroupIds=[
'string',
],
TargetRole='READ_WRITE'|'READ_ONLY',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The name of the DB proxy associated with the DB proxy endpoint that you create.
[REQUIRED]
The name of the DB proxy endpoint to create.
[REQUIRED]
The VPC subnet IDs for the DB proxy endpoint that you create. You can specify a different set of subnet IDs than for the original DB proxy.
The VPC security group IDs for the DB proxy endpoint that you create. You can specify a different set of security group IDs than for the original DB proxy. The default is the default security group for the VPC.
READ_WRITE .A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
dict
Response Syntax
{
'DBProxyEndpoint': {
'DBProxyEndpointName': 'string',
'DBProxyEndpointArn': 'string',
'DBProxyName': 'string',
'Status': 'available'|'modifying'|'incompatible-network'|'insufficient-resource-limits'|'creating'|'deleting',
'VpcId': 'string',
'VpcSecurityGroupIds': [
'string',
],
'VpcSubnetIds': [
'string',
],
'Endpoint': 'string',
'CreatedDate': datetime(2015, 1, 1),
'TargetRole': 'READ_WRITE'|'READ_ONLY',
'IsDefault': True|False
}
}
Response Structure
(dict) --
DBProxyEndpoint (dict) --
The DBProxyEndpoint object that is created by the API operation. The DB proxy endpoint that you create might provide capabilities such as read/write or read-only operations, or using a different VPC than the proxy's default VPC.
DBProxyEndpointName (string) --
The name for the DB proxy endpoint. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.
DBProxyEndpointArn (string) --
The Amazon Resource Name (ARN) for the DB proxy endpoint.
DBProxyName (string) --
The identifier for the DB proxy that is associated with this DB proxy endpoint.
Status (string) --
The current status of this DB proxy endpoint. A status of available means the endpoint is ready to handle requests. Other values indicate that you must wait for the endpoint to be ready, or take some action to resolve an issue.
VpcId (string) --
Provides the VPC ID of the DB proxy endpoint.
VpcSecurityGroupIds (list) --
Provides a list of VPC security groups that the DB proxy endpoint belongs to.
VpcSubnetIds (list) --
The EC2 subnet IDs for the DB proxy endpoint.
Endpoint (string) --
The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.
CreatedDate (datetime) --
The date and time when the DB proxy endpoint was first created.
TargetRole (string) --
A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
IsDefault (boolean) --
A value that indicates whether this endpoint is the default endpoint for the associated DB proxy. Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be either read/write or read-only.
Exceptions
RDS.Client.exceptions.InvalidSubnetRDS.Client.exceptions.DBProxyNotFoundFaultRDS.Client.exceptions.DBProxyEndpointAlreadyExistsFaultRDS.Client.exceptions.DBProxyEndpointQuotaExceededFaultRDS.Client.exceptions.InvalidDBProxyStateFaultcreate_db_security_group(**kwargs)¶Creates a new DB security group. DB security groups control access to a DB instance.
Note
A DB security group controls access to EC2-Classic DB instances that are not in a VPC.
See also: AWS API Documentation
Request Syntax
response = client.create_db_security_group(
DBSecurityGroupName='string',
DBSecurityGroupDescription='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The name for the DB security group. This value is stored as a lowercase string.
Constraints:
Example: mysecuritygroup
[REQUIRED]
The description for the DB security group.
Tags to assign to the DB security group.
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
dict
Response Syntax
{
'DBSecurityGroup': {
'OwnerId': 'string',
'DBSecurityGroupName': 'string',
'DBSecurityGroupDescription': 'string',
'VpcId': 'string',
'EC2SecurityGroups': [
{
'Status': 'string',
'EC2SecurityGroupName': 'string',
'EC2SecurityGroupId': 'string',
'EC2SecurityGroupOwnerId': 'string'
},
],
'IPRanges': [
{
'Status': 'string',
'CIDRIP': 'string'
},
],
'DBSecurityGroupArn': 'string'
}
}
Response Structure
(dict) --
DBSecurityGroup (dict) --
Contains the details for an Amazon RDS DB security group.
This data type is used as a response element in the DescribeDBSecurityGroups action.
OwnerId (string) --
Provides the Amazon Web Services ID of the owner of a specific DB security group.
DBSecurityGroupName (string) --
Specifies the name of the DB security group.
DBSecurityGroupDescription (string) --
Provides the description of the DB security group.
VpcId (string) --
Provides the VpcId of the DB security group.
EC2SecurityGroups (list) --
Contains a list of EC2SecurityGroup elements.
(dict) --
This data type is used as a response element in the following actions:
AuthorizeDBSecurityGroupIngressDescribeDBSecurityGroupsRevokeDBSecurityGroupIngressStatus (string) --
Provides the status of the EC2 security group. Status can be "authorizing", "authorized", "revoking", and "revoked".
EC2SecurityGroupName (string) --
Specifies the name of the EC2 security group.
EC2SecurityGroupId (string) --
Specifies the id of the EC2 security group.
EC2SecurityGroupOwnerId (string) --
Specifies the Amazon Web Services ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.
IPRanges (list) --
Contains a list of IPRange elements.
(dict) --
This data type is used as a response element in the DescribeDBSecurityGroups action.
Status (string) --
Specifies the status of the IP range. Status can be "authorizing", "authorized", "revoking", and "revoked".
CIDRIP (string) --
Specifies the IP range.
DBSecurityGroupArn (string) --
The Amazon Resource Name (ARN) for the DB security group.
Exceptions
RDS.Client.exceptions.DBSecurityGroupAlreadyExistsFaultRDS.Client.exceptions.DBSecurityGroupQuotaExceededFaultRDS.Client.exceptions.DBSecurityGroupNotSupportedFaultExamples
This example creates a DB security group.
response = client.create_db_security_group(
DBSecurityGroupDescription='My DB security group',
DBSecurityGroupName='mydbsecuritygroup',
)
print(response)
Expected Output:
{
'DBSecurityGroup': {
},
'ResponseMetadata': {
'...': '...',
},
}
create_db_snapshot(**kwargs)¶Creates a snapshot of a DB instance. The source DB instance must be in the available or storage-optimization state.
See also: AWS API Documentation
Request Syntax
response = client.create_db_snapshot(
DBSnapshotIdentifier='string',
DBInstanceIdentifier='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The identifier for the DB snapshot.
Constraints:
Example: my-snapshot-id
[REQUIRED]
The identifier of the DB instance that you want to create the snapshot of.
Constraints:
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
dict
Response Syntax
{
'DBSnapshot': {
'DBSnapshotIdentifier': 'string',
'DBInstanceIdentifier': 'string',
'SnapshotCreateTime': datetime(2015, 1, 1),
'Engine': 'string',
'AllocatedStorage': 123,
'Status': 'string',
'Port': 123,
'AvailabilityZone': 'string',
'VpcId': 'string',
'InstanceCreateTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'EngineVersion': 'string',
'LicenseModel': 'string',
'SnapshotType': 'string',
'Iops': 123,
'OptionGroupName': 'string',
'PercentProgress': 123,
'SourceRegion': 'string',
'SourceDBSnapshotIdentifier': 'string',
'StorageType': 'string',
'TdeCredentialArn': 'string',
'Encrypted': True|False,
'KmsKeyId': 'string',
'DBSnapshotArn': 'string',
'Timezone': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
],
'DbiResourceId': 'string',
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'OriginalSnapshotCreateTime': datetime(2015, 1, 1),
'SnapshotTarget': 'string'
}
}
Response Structure
(dict) --
DBSnapshot (dict) --
Contains the details of an Amazon RDS DB snapshot.
This data type is used as a response element in the DescribeDBSnapshots action.
DBSnapshotIdentifier (string) --
Specifies the identifier for the DB snapshot.
DBInstanceIdentifier (string) --
Specifies the DB instance identifier of the DB instance this DB snapshot was created from.
SnapshotCreateTime (datetime) --
Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied.
Engine (string) --
Specifies the name of the database engine.
AllocatedStorage (integer) --
Specifies the allocated storage size in gibibytes (GiB).
Status (string) --
Specifies the status of this DB snapshot.
Port (integer) --
Specifies the port that the database engine was listening on at the time of the snapshot.
AvailabilityZone (string) --
Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
VpcId (string) --
Provides the VPC ID associated with the DB snapshot.
InstanceCreateTime (datetime) --
Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.
MasterUsername (string) --
Provides the master username for the DB snapshot.
EngineVersion (string) --
Specifies the version of the database engine.
LicenseModel (string) --
License model information for the restored DB instance.
SnapshotType (string) --
Provides the type of the DB snapshot.
Iops (integer) --
Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
OptionGroupName (string) --
Provides the option group name for the DB snapshot.
PercentProgress (integer) --
The percentage of the estimated data that has been transferred.
SourceRegion (string) --
The Amazon Web Services Region that the DB snapshot was created in or copied from.
SourceDBSnapshotIdentifier (string) --
The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has a value in the case of a cross-account or cross-Region copy.
StorageType (string) --
Specifies the storage type associated with DB snapshot.
TdeCredentialArn (string) --
The ARN from the key store with which to associate the instance for TDE encryption.
Encrypted (boolean) --
Specifies whether the DB snapshot is encrypted.
KmsKeyId (string) --
If Encrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
DBSnapshotArn (string) --
The Amazon Resource Name (ARN) for the DB snapshot.
Timezone (string) --
The time zone of the DB snapshot. In most cases, the Timezone element is empty. Timezone content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.
IAMDatabaseAuthenticationEnabled (boolean) --
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
ProcessorFeatures (list) --
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.
(dict) --
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstanceModifyDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceFromS3RestoreDBInstanceToPointInTimeYou can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstancesDescribeDBSnapshotsDescribeValidDBInstanceModificationsIf you call DescribeDBInstances , ProcessorFeature returns non-null values only if the following conditions are met:
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
Name (string) --
The name of the processor feature. Valid names are coreCount and threadsPerCore .
Value (string) --
The value of a processor feature name.
DbiResourceId (string) --
The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
TagList (list) --
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
OriginalSnapshotCreateTime (datetime) --
Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied.
SnapshotTarget (string) --
Specifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
Exceptions
RDS.Client.exceptions.DBSnapshotAlreadyExistsFaultRDS.Client.exceptions.InvalidDBInstanceStateFaultRDS.Client.exceptions.DBInstanceNotFoundFaultRDS.Client.exceptions.SnapshotQuotaExceededFaultExamples
This example creates a DB snapshot.
response = client.create_db_snapshot(
DBInstanceIdentifier='mymysqlinstance',
DBSnapshotIdentifier='mydbsnapshot',
)
print(response)
Expected Output:
{
'DBSnapshot': {
},
'ResponseMetadata': {
'...': '...',
},
}
create_db_subnet_group(**kwargs)¶Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region.
See also: AWS API Documentation
Request Syntax
response = client.create_db_subnet_group(
DBSubnetGroupName='string',
DBSubnetGroupDescription='string',
SubnetIds=[
'string',
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The name for the DB subnet group. This value is stored as a lowercase string.
Constraints:
Example: mydbsubnetgroup
[REQUIRED]
The description for the DB subnet group.
[REQUIRED]
The EC2 Subnet IDs for the DB subnet group.
Tags to assign to the DB subnet group.
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
dict
Response Syntax
{
'DBSubnetGroup': {
'DBSubnetGroupName': 'string',
'DBSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetOutpost': {
'Arn': 'string'
},
'SubnetStatus': 'string'
},
],
'DBSubnetGroupArn': 'string',
'SupportedNetworkTypes': [
'string',
]
}
}
Response Structure
(dict) --
DBSubnetGroup (dict) --
Contains the details of an Amazon RDS DB subnet group.
This data type is used as a response element in the DescribeDBSubnetGroups action.
DBSubnetGroupName (string) --
The name of the DB subnet group.
DBSubnetGroupDescription (string) --
Provides the description of the DB subnet group.
VpcId (string) --
Provides the VpcId of the DB subnet group.
SubnetGroupStatus (string) --
Provides the status of the DB subnet group.
Subnets (list) --
Contains a list of Subnet elements.
(dict) --
This data type is used as a response element for the DescribeDBSubnetGroups operation.
SubnetIdentifier (string) --
The identifier of the subnet.
SubnetAvailabilityZone (dict) --
Contains Availability Zone information.
This data type is used as an element in the OrderableDBInstanceOption data type.
Name (string) --
The name of the Availability Zone.
SubnetOutpost (dict) --
If the subnet is associated with an Outpost, this value specifies the Outpost.
For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
Arn (string) --
The Amazon Resource Name (ARN) of the Outpost.
SubnetStatus (string) --
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:
IPV4DUALA DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
Exceptions
RDS.Client.exceptions.DBSubnetGroupAlreadyExistsFaultRDS.Client.exceptions.DBSubnetGroupQuotaExceededFaultRDS.Client.exceptions.DBSubnetQuotaExceededFaultRDS.Client.exceptions.DBSubnetGroupDoesNotCoverEnoughAZsRDS.Client.exceptions.InvalidSubnetExamples
This example creates a DB subnet group.
response = client.create_db_subnet_group(
DBSubnetGroupDescription='My DB subnet group',
DBSubnetGroupName='mydbsubnetgroup',
SubnetIds=[
'subnet-1fab8a69',
'subnet-d43a468c',
],
)
print(response)
Expected Output:
{
'DBSubnetGroup': {
},
'ResponseMetadata': {
'...': '...',
},
}
create_event_subscription(**kwargs)¶Creates an RDS event notification subscription. This operation requires a topic Amazon Resource Name (ARN) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.
You can specify the type of source (SourceType ) that you want to be notified of and provide a list of RDS sources (SourceIds ) that triggers the events. You can also provide a list of event categories (EventCategories ) for events that you want to be notified of. For example, you can specify SourceType = db-instance , SourceIds = mydbinstance1 , mydbinstance2 and EventCategories = Availability , Backup .
If you specify both the SourceType and SourceIds , such as SourceType = db-instance and SourceIds = myDBInstance1 , you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify SourceIds , you receive notice of the events for that source type for all your RDS sources. If you don't specify either the SourceType or the SourceIds , you are notified of events generated from all RDS sources belonging to your customer account.
Note
RDS event notification is only available for unencrypted SNS topics. If you specify an encrypted SNS topic, event notifications aren't sent for the topic.
See also: AWS API Documentation
Request Syntax
response = client.create_event_subscription(
SubscriptionName='string',
SnsTopicArn='string',
SourceType='string',
EventCategories=[
'string',
],
SourceIds=[
'string',
],
Enabled=True|False,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The name of the subscription.
Constraints: The name must be less than 255 characters.
[REQUIRED]
The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you set this parameter to db-instance . For RDS Proxy events, specify db-proxy . If this value isn't specified, all events are returned.
Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy
A list of event categories for a particular source type (SourceType ) that you want to subscribe to. You can see a list of the categories for a given source type in the "Amazon RDS event categories and event messages" section of the ` Amazon RDS User Guide https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.Messages.html`__ or the ` Amazon Aurora User Guide https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Events.Messages.html`__ . You can also see this list by using the DescribeEventCategories operation.
The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It can't end with a hyphen or contain two consecutive hyphens.
Constraints:
SourceIds are supplied, SourceType must also be provided.DBInstanceIdentifier value must be supplied.DBClusterIdentifier value must be supplied.DBParameterGroupName value must be supplied.DBSecurityGroupName value must be supplied.DBSnapshotIdentifier value must be supplied.DBClusterSnapshotIdentifier value must be supplied.DBProxyName value must be supplied.A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
dict
Response Syntax
{
'EventSubscription': {
'CustomerAwsId': 'string',
'CustSubscriptionId': 'string',
'SnsTopicArn': 'string',
'Status': 'string',
'SubscriptionCreationTime': 'string',
'SourceType': 'string',
'SourceIdsList': [
'string',
],
'EventCategoriesList': [
'string',
],
'Enabled': True|False,
'EventSubscriptionArn': 'string'
}
}
Response Structure
(dict) --
EventSubscription (dict) --
Contains the results of a successful invocation of the DescribeEventSubscriptions action.
CustomerAwsId (string) --
The Amazon Web Services customer account associated with the RDS event notification subscription.
CustSubscriptionId (string) --
The RDS event notification subscription Id.
SnsTopicArn (string) --
The topic ARN of the RDS event notification subscription.
Status (string) --
The status of the RDS event notification subscription.
Constraints:
Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist
The status "no-permission" indicates that RDS no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.
SubscriptionCreationTime (string) --
The time the RDS event notification subscription was created.
SourceType (string) --
The source type for the RDS event notification subscription.
SourceIdsList (list) --
A list of source IDs for the RDS event notification subscription.
EventCategoriesList (list) --
A list of event categories for the RDS event notification subscription.
Enabled (boolean) --
A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.
EventSubscriptionArn (string) --
The Amazon Resource Name (ARN) for the event subscription.
Exceptions
RDS.Client.exceptions.EventSubscriptionQuotaExceededFaultRDS.Client.exceptions.SubscriptionAlreadyExistFaultRDS.Client.exceptions.SNSInvalidTopicFaultRDS.Client.exceptions.SNSNoAuthorizationFaultRDS.Client.exceptions.SNSTopicArnNotFoundFaultRDS.Client.exceptions.SubscriptionCategoryNotFoundFaultRDS.Client.exceptions.SourceNotFoundFaultExamples
This example creates an event notification subscription.
response = client.create_event_subscription(
Enabled=True,
EventCategories=[
'availability',
],
SnsTopicArn='arn:aws:sns:us-east-1:992648334831:MyDemoSNSTopic',
SourceIds=[
'mymysqlinstance',
],
SourceType='db-instance',
SubscriptionName='mymysqleventsubscription',
)
print(response)
Expected Output:
{
'EventSubscription': {
},
'ResponseMetadata': {
'...': '...',
},
}
create_global_cluster(**kwargs)¶Creates an Aurora global database spread across multiple Amazon Web Services Regions. The global database contains a single primary cluster with read-write capability, and a read-only secondary cluster that receives data from the primary cluster through high-speed replication performed by the Aurora storage subsystem.
You can create a global database that is initially empty, and then add a primary cluster and a secondary cluster to it. Or you can specify an existing Aurora cluster during the create operation, and this cluster becomes the primary cluster of the global database.
Note
This action applies only to Aurora DB clusters.
See also: AWS API Documentation
Request Syntax
response = client.create_global_cluster(
GlobalClusterIdentifier='string',
SourceDBClusterIdentifier='string',
Engine='string',
EngineVersion='string',
DeletionProtection=True|False,
DatabaseName='string',
StorageEncrypted=True|False
)
dict
Response Syntax
{
'GlobalCluster': {
'GlobalClusterIdentifier': 'string',
'GlobalClusterResourceId': 'string',
'GlobalClusterArn': 'string',
'Status': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'DatabaseName': 'string',
'StorageEncrypted': True|False,
'DeletionProtection': True|False,
'GlobalClusterMembers': [
{
'DBClusterArn': 'string',
'Readers': [
'string',
],
'IsWriter': True|False,
'GlobalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'unknown'
},
],
'FailoverState': {
'Status': 'pending'|'failing-over'|'cancelling',
'FromDbClusterArn': 'string',
'ToDbClusterArn': 'string'
}
}
}
Response Structure
(dict) --
GlobalCluster (dict) --
A data type representing an Aurora global database.
GlobalClusterIdentifier (string) --
Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster.
GlobalClusterResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB cluster is accessed.
GlobalClusterArn (string) --
The Amazon Resource Name (ARN) for the global database cluster.
Status (string) --
Specifies the current state of this global database cluster.
Engine (string) --
The Aurora database engine used by the global database cluster.
EngineVersion (string) --
Indicates the database engine version.
DatabaseName (string) --
The default database name within the new global database cluster.
StorageEncrypted (boolean) --
The storage encryption setting for the global database cluster.
DeletionProtection (boolean) --
The deletion protection setting for the new global database cluster.
GlobalClusterMembers (list) --
The list of cluster IDs for secondary clusters within the global database cluster. Currently limited to 1 item.
(dict) --
A data structure with information about any primary and secondary clusters associated with an Aurora global database.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for each Aurora cluster.
Readers (list) --
The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global database.
IsWriter (boolean) --
Specifies whether the Aurora cluster is the primary cluster (that is, has read-write capability) for the Aurora global database with which it is associated.
GlobalWriteForwardingStatus (string) --
Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.
FailoverState (dict) --
A data object containing all properties for the current state of an in-process or pending failover process for this Aurora global database. This object is empty unless the FailoverGlobalCluster API operation has been called on this Aurora global database ( GlobalCluster ).
Status (string) --
The current status of the Aurora global database ( GlobalCluster ). Possible values are as follows:
GlobalCluster 's primary DB cluster and the specified secondary DB cluster are being verified before the failover process can start.FromDbClusterArn (string) --
The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being demoted, and which is associated with this state.
ToDbClusterArn (string) --
The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being promoted, and which is associated with this state.
Exceptions
RDS.Client.exceptions.GlobalClusterAlreadyExistsFaultRDS.Client.exceptions.GlobalClusterQuotaExceededFaultRDS.Client.exceptions.InvalidDBClusterStateFaultRDS.Client.exceptions.DBClusterNotFoundFaultcreate_option_group(**kwargs)¶Creates a new option group. You can create up to 20 option groups.
This command doesn't apply to RDS Custom.
See also: AWS API Documentation
Request Syntax
response = client.create_option_group(
OptionGroupName='string',
EngineName='string',
MajorEngineVersion='string',
OptionGroupDescription='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
Specifies the name of the option group to be created.
Constraints:
Example: myoptiongroup
[REQUIRED]
Specifies the name of the engine that this option group should be associated with.
Valid Values:
mariadbmysqloracle-eeoracle-ee-cdboracle-se2oracle-se2-cdbpostgressqlserver-eesqlserver-sesqlserver-exsqlserver-web[REQUIRED]
Specifies the major version of the engine that this option group should be associated with.
[REQUIRED]
The description of the option group.
Tags to assign to the option group.
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
dict
Response Syntax
{
'OptionGroup': {
'OptionGroupName': 'string',
'OptionGroupDescription': 'string',
'EngineName': 'string',
'MajorEngineVersion': 'string',
'Options': [
{
'OptionName': 'string',
'OptionDescription': 'string',
'Persistent': True|False,
'Permanent': True|False,
'Port': 123,
'OptionVersion': 'string',
'OptionSettings': [
{
'Name': 'string',
'Value': 'string',
'DefaultValue': 'string',
'Description': 'string',
'ApplyType': 'string',
'DataType': 'string',
'AllowedValues': 'string',
'IsModifiable': True|False,
'IsCollection': True|False
},
],
'DBSecurityGroupMemberships': [
{
'DBSecurityGroupName': 'string',
'Status': 'string'
},
],
'VpcSecurityGroupMemberships': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
]
},
],
'AllowsVpcAndNonVpcInstanceMemberships': True|False,
'VpcId': 'string',
'OptionGroupArn': 'string'
}
}
Response Structure
(dict) --
OptionGroup (dict) --
OptionGroupName (string) --
Specifies the name of the option group.
OptionGroupDescription (string) --
Provides a description of the option group.
EngineName (string) --
Indicates the name of the engine that this option group can be applied to.
MajorEngineVersion (string) --
Indicates the major engine version associated with this option group.
Options (list) --
Indicates what options are available in the option group.
(dict) --
Option details.
OptionName (string) --
The name of the option.
OptionDescription (string) --
The description of the option.
Persistent (boolean) --
Indicate if this option is persistent.
Permanent (boolean) --
Indicate if this option is permanent.
Port (integer) --
If required, the port configured for this option to use.
OptionVersion (string) --
The version of the option.
OptionSettings (list) --
The option settings for this option.
(dict) --
Option settings are the actual settings being applied or configured for that option. It is used when you modify an option group or describe option groups. For example, the NATIVE_NETWORK_ENCRYPTION option has a setting called SQLNET.ENCRYPTION_SERVER that can have several different values.
Name (string) --
The name of the option that has settings that you can set.
Value (string) --
The current value of the option setting.
DefaultValue (string) --
The default value of the option setting.
Description (string) --
The description of the option setting.
ApplyType (string) --
The DB engine specific parameter type.
DataType (string) --
The data type of the option setting.
AllowedValues (string) --
The allowed values of the option setting.
IsModifiable (boolean) --
A Boolean value that, when true, indicates the option setting can be modified from the default.
IsCollection (boolean) --
Indicates if the option setting is part of a collection.
DBSecurityGroupMemberships (list) --
If the option requires access to a port, then this DB security group allows access to the port.
(dict) --
This data type is used as a response element in the following actions:
ModifyDBInstanceRebootDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceToPointInTimeDBSecurityGroupName (string) --
The name of the DB security group.
Status (string) --
The status of the DB security group.
VpcSecurityGroupMemberships (list) --
If the option requires access to a port, then this VPC security group allows access to the port.
(dict) --
This data type is used as a response element for queries on VPC security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The membership status of the VPC security group.
Currently, the only valid status is active .
AllowsVpcAndNonVpcInstanceMemberships (boolean) --
Indicates whether this option group can be applied to both VPC and non-VPC instances. The value true indicates the option group can be applied to both VPC and non-VPC instances.
VpcId (string) --
If AllowsVpcAndNonVpcInstanceMemberships is false , this field is blank. If AllowsVpcAndNonVpcInstanceMemberships is true and this field is blank, then this option group can be applied to both VPC and non-VPC instances. If this field contains a value, then this option group can only be applied to instances that are in the VPC indicated by this field.
OptionGroupArn (string) --
The Amazon Resource Name (ARN) for the option group.
Exceptions
RDS.Client.exceptions.OptionGroupAlreadyExistsFaultRDS.Client.exceptions.OptionGroupQuotaExceededFaultExamples
This example creates an option group.
response = client.create_option_group(
EngineName='MySQL',
MajorEngineVersion='5.6',
OptionGroupDescription='My MySQL 5.6 option group',
OptionGroupName='mymysqloptiongroup',
)
print(response)
Expected Output:
{
'OptionGroup': {
},
'ResponseMetadata': {
'...': '...',
},
}
delete_custom_db_engine_version(**kwargs)¶Deletes a custom engine version. To run this command, make sure you meet the following prerequisites:
Typically, deletion takes a few minutes.
Note
The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the DeleteCustomDbEngineVersion event aren't logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the DeleteCustomDbEngineVersion event.
For more information, see Deleting a CEV in the Amazon RDS User Guide .
See also: AWS API Documentation
Request Syntax
response = client.delete_custom_db_engine_version(
Engine='string',
EngineVersion='string'
)
[REQUIRED]
The database engine. The only supported engine is custom-oracle-ee .
[REQUIRED]
The custom engine version (CEV) for your DB instance. This option is required for RDS Custom, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Amazon Web Services Region.
dict
Response Syntax
{
'Engine': 'string',
'EngineVersion': 'string',
'DBParameterGroupFamily': 'string',
'DBEngineDescription': 'string',
'DBEngineVersionDescription': 'string',
'DefaultCharacterSet': {
'CharacterSetName': 'string',
'CharacterSetDescription': 'string'
},
'SupportedCharacterSets': [
{
'CharacterSetName': 'string',
'CharacterSetDescription': 'string'
},
],
'SupportedNcharCharacterSets': [
{
'CharacterSetName': 'string',
'CharacterSetDescription': 'string'
},
],
'ValidUpgradeTarget': [
{
'Engine': 'string',
'EngineVersion': 'string',
'Description': 'string',
'AutoUpgrade': True|False,
'IsMajorVersionUpgrade': True|False,
'SupportedEngineModes': [
'string',
],
'SupportsParallelQuery': True|False,
'SupportsGlobalDatabases': True|False,
'SupportsBabelfish': True|False
},
],
'SupportedTimezones': [
{
'TimezoneName': 'string'
},
],
'ExportableLogTypes': [
'string',
],
'SupportsLogExportsToCloudwatchLogs': True|False,
'SupportsReadReplica': True|False,
'SupportedEngineModes': [
'string',
],
'SupportedFeatureNames': [
'string',
],
'Status': 'string',
'SupportsParallelQuery': True|False,
'SupportsGlobalDatabases': True|False,
'MajorEngineVersion': 'string',
'DatabaseInstallationFilesS3BucketName': 'string',
'DatabaseInstallationFilesS3Prefix': 'string',
'DBEngineVersionArn': 'string',
'KMSKeyId': 'string',
'CreateTime': datetime(2015, 1, 1),
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'SupportsBabelfish': True|False
}
Response Structure
(dict) --
This data type is used as a response element in the action DescribeDBEngineVersions .
Engine (string) --
The name of the database engine.
EngineVersion (string) --
The version number of the database engine.
DBParameterGroupFamily (string) --
The name of the DB parameter group family for the database engine.
DBEngineDescription (string) --
The description of the database engine.
DBEngineVersionDescription (string) --
The description of the database engine version.
DefaultCharacterSet (dict) --
The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API isn't specified.
CharacterSetName (string) --
The name of the character set.
CharacterSetDescription (string) --
The description of the character set.
SupportedCharacterSets (list) --
A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance operation.
(dict) --
This data type is used as a response element in the action DescribeDBEngineVersions .
CharacterSetName (string) --
The name of the character set.
CharacterSetDescription (string) --
The description of the character set.
SupportedNcharCharacterSets (list) --
A list of the character sets supported by the Oracle DB engine for the NcharCharacterSetName parameter of the CreateDBInstance operation.
(dict) --
This data type is used as a response element in the action DescribeDBEngineVersions .
CharacterSetName (string) --
The name of the character set.
CharacterSetDescription (string) --
The description of the character set.
ValidUpgradeTarget (list) --
A list of engine versions that this database engine version can be upgraded to.
(dict) --
The version of the database engine that a DB 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 a DB 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 upgrading to the target version requires upgrading the major version of the database engine.
SupportedEngineModes (list) --
A list of the supported DB engine modes for the target engine version.
SupportsParallelQuery (boolean) --
A value that indicates whether you can use Aurora parallel query with the target engine version.
SupportsGlobalDatabases (boolean) --
A value that indicates whether you can use Aurora global databases with the target engine version.
SupportsBabelfish (boolean) --
A value that indicates whether you can use Babelfish for Aurora PostgreSQL with the target engine version.
SupportedTimezones (list) --
A list of the time zones supported by this engine for the Timezone parameter of the CreateDBInstance action.
(dict) --
A time zone associated with a DBInstance or a DBSnapshot . This data type is an element in the response to the DescribeDBInstances , the DescribeDBSnapshots , and the DescribeDBEngineVersions actions.
TimezoneName (string) --
The name of the time zone.
ExportableLogTypes (list) --
The types of logs that the database engine has available for export to CloudWatch Logs.
SupportsLogExportsToCloudwatchLogs (boolean) --
A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.
SupportsReadReplica (boolean) --
Indicates whether the database engine version supports read replicas.
SupportedEngineModes (list) --
A list of the supported DB engine modes.
SupportedFeatureNames (list) --
A list of features supported by the DB engine.
The supported features vary by DB engine and DB engine version.
To determine the supported features for a specific DB engine and DB engine version using the CLI, use the following command:
aws rds describe-db-engine-versions --engine <engine_name> --engine-version <engine_version>
For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, use the following command:
aws rds describe-db-engine-versions --engine postgres --engine-version 13.3
The supported features are listed under SupportedFeatureNames in the output.
Status (string) --
The status of the DB engine version, either available or deprecated .
SupportsParallelQuery (boolean) --
A value that indicates whether you can use Aurora parallel query with a specific DB engine version.
SupportsGlobalDatabases (boolean) --
A value that indicates whether you can use Aurora global databases with a specific DB engine version.
MajorEngineVersion (string) --
The major engine version of the CEV.
DatabaseInstallationFilesS3BucketName (string) --
The name of the Amazon S3 bucket that contains your database installation files.
DatabaseInstallationFilesS3Prefix (string) --
The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.
DBEngineVersionArn (string) --
The ARN of the custom engine version.
KMSKeyId (string) --
The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.
CreateTime (datetime) --
The creation time of the DB engine version.
TagList (list) --
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
SupportsBabelfish (boolean) --
A value that indicates whether the engine version supports Babelfish for Aurora PostgreSQL.
Exceptions
RDS.Client.exceptions.CustomDBEngineVersionNotFoundFaultRDS.Client.exceptions.InvalidCustomDBEngineVersionStateFaultdelete_db_cluster(**kwargs)¶The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide .
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide .
See also: AWS API Documentation
Request Syntax
response = client.delete_db_cluster(
DBClusterIdentifier='string',
SkipFinalSnapshot=True|False,
FinalDBSnapshotIdentifier='string'
)
[REQUIRED]
The DB cluster identifier for the DB cluster to be deleted. This parameter isn't case-sensitive.
Constraints:
A value that indicates whether to skip the creation of a final DB cluster snapshot before the DB cluster is deleted. If skip is specified, no DB cluster snapshot is created. If skip isn't specified, a DB cluster snapshot is created before the DB cluster is deleted. By default, skip isn't specified, and the DB cluster snapshot is created. By default, this parameter is disabled.
Note
You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is disabled.
The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is disabled.
Note
Specifying this parameter and also skipping the creation of a final DB cluster snapshot with the SkipFinalShapshot parameter results in an error.
Constraints:
dict
Response Syntax
{
'DBCluster': {
'AllocatedStorage': 123,
'AvailabilityZones': [
'string',
],
'BackupRetentionPeriod': 123,
'CharacterSetName': 'string',
'DatabaseName': 'string',
'DBClusterIdentifier': 'string',
'DBClusterParameterGroup': 'string',
'DBSubnetGroup': 'string',
'Status': 'string',
'AutomaticRestartTime': datetime(2015, 1, 1),
'PercentProgress': 'string',
'EarliestRestorableTime': datetime(2015, 1, 1),
'Endpoint': 'string',
'ReaderEndpoint': 'string',
'CustomEndpoints': [
'string',
],
'MultiAZ': True|False,
'Engine': 'string',
'EngineVersion': 'string',
'LatestRestorableTime': datetime(2015, 1, 1),
'Port': 123,
'MasterUsername': 'string',
'DBClusterOptionGroupMemberships': [
{
'DBClusterOptionGroupName': 'string',
'Status': 'string'
},
],
'PreferredBackupWindow': 'string',
'PreferredMaintenanceWindow': 'string',
'ReplicationSourceIdentifier': 'string',
'ReadReplicaIdentifiers': [
'string',
],
'DBClusterMembers': [
{
'DBInstanceIdentifier': 'string',
'IsClusterWriter': True|False,
'DBClusterParameterGroupStatus': 'string',
'PromotionTier': 123
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'HostedZoneId': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbClusterResourceId': 'string',
'DBClusterArn': 'string',
'AssociatedRoles': [
{
'RoleArn': 'string',
'Status': 'string',
'FeatureName': 'string'
},
],
'IAMDatabaseAuthenticationEnabled': True|False,
'CloneGroupId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'EarliestBacktrackTime': datetime(2015, 1, 1),
'BacktrackWindow': 123,
'BacktrackConsumedChangeRecords': 123,
'EnabledCloudwatchLogsExports': [
'string',
],
'Capacity': 123,
'EngineMode': 'string',
'ScalingConfigurationInfo': {
'MinCapacity': 123,
'MaxCapacity': 123,
'AutoPause': True|False,
'SecondsUntilAutoPause': 123,
'TimeoutAction': 'string',
'SecondsBeforeTimeout': 123
},
'DeletionProtection': True|False,
'HttpEndpointEnabled': True|False,
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'CopyTagsToSnapshot': True|False,
'CrossAccountClone': True|False,
'DomainMemberships': [
{
'Domain': 'string',
'Status': 'string',
'FQDN': 'string',
'IAMRoleName': 'string'
},
],
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'GlobalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'unknown',
'GlobalWriteForwardingRequested': True|False,
'PendingModifiedValues': {
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
},
'DBClusterIdentifier': 'string',
'MasterUserPassword': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'EngineVersion': 'string'
},
'DBClusterInstanceClass': 'string',
'StorageType': 'string',
'Iops': 123,
'PubliclyAccessible': True|False,
'AutoMinorVersionUpgrade': True|False,
'MonitoringInterval': 123,
'MonitoringRoleArn': 'string',
'PerformanceInsightsEnabled': True|False,
'PerformanceInsightsKMSKeyId': 'string',
'PerformanceInsightsRetentionPeriod': 123,
'ServerlessV2ScalingConfiguration': {
'MinCapacity': 123.0,
'MaxCapacity': 123.0
}
}
}
Response Structure
(dict) --
DBCluster (dict) --
Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
For an Amazon Aurora DB cluster, this data type is used as a response element in the operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , FailoverDBCluster , ModifyDBCluster , PromoteReadReplicaDBCluster , RestoreDBClusterFromS3 , RestoreDBClusterFromSnapshot , RestoreDBClusterToPointInTime , StartDBCluster , and StopDBCluster .
For a Multi-AZ DB cluster, this data type is used as a response element in the operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , FailoverDBCluster , ModifyDBCluster , RebootDBCluster , RestoreDBClusterFromSnapshot , and RestoreDBClusterToPointInTime .
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
AllocatedStorage (integer) --
For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
AvailabilityZones (list) --
Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.
BackupRetentionPeriod (integer) --
Specifies the number of days for which automatic DB snapshots are retained.
CharacterSetName (string) --
If present, specifies the name of the character set that this cluster is associated with.
DatabaseName (string) --
Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.
DBClusterIdentifier (string) --
Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
DBClusterParameterGroup (string) --
Specifies the name of the DB cluster parameter group for the DB cluster.
DBSubnetGroup (string) --
Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
Status (string) --
Specifies the current state of this DB cluster.
AutomaticRestartTime (datetime) --
The time when a stopped DB cluster is restarted automatically.
PercentProgress (string) --
Specifies the progress of the operation as a percentage.
EarliestRestorableTime (datetime) --
The earliest time to which a database can be restored with point-in-time restore.
Endpoint (string) --
Specifies the connection endpoint for the primary instance of the DB cluster.
ReaderEndpoint (string) --
The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.
If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
CustomEndpoints (list) --
Identifies all custom endpoints associated with the cluster.
MultiAZ (boolean) --
Specifies whether the DB cluster has instances in multiple Availability Zones.
Engine (string) --
The name of the database engine to be used for this DB cluster.
EngineVersion (string) --
Indicates the database engine version.
LatestRestorableTime (datetime) --
Specifies the latest time to which a database can be restored with point-in-time restore.
Port (integer) --
Specifies the port that the database engine is listening on.
MasterUsername (string) --
Contains the master username for the DB cluster.
DBClusterOptionGroupMemberships (list) --
Provides the list of option group memberships for this DB cluster.
(dict) --
Contains status information for a DB cluster option group.
DBClusterOptionGroupName (string) --
Specifies the name of the DB cluster option group.
Status (string) --
Specifies the status of the DB cluster option group.
PreferredBackupWindow (string) --
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
ReplicationSourceIdentifier (string) --
Contains the identifier of the source DB cluster if this DB cluster is a read replica.
ReadReplicaIdentifiers (list) --
Contains one or more identifiers of the read replicas associated with this DB cluster.
DBClusterMembers (list) --
Provides the list of instances that make up the DB cluster.
(dict) --
Contains information about an instance that is part of a DB cluster.
DBInstanceIdentifier (string) --
Specifies the instance identifier for this member of the DB cluster.
IsClusterWriter (boolean) --
Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
DBClusterParameterGroupStatus (string) --
Specifies the status of the DB cluster parameter group for this member of the DB cluster.
PromotionTier (integer) --
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .
VpcSecurityGroups (list) --
Provides a list of VPC security groups that the DB cluster belongs to.
(dict) --
This data type is used as a response element for queries on VPC security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The membership status of the VPC security group.
Currently, the only valid status is active .
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
StorageEncrypted (boolean) --
Specifies whether the DB cluster is encrypted.
KmsKeyId (string) --
If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
DbClusterResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for the DB cluster.
AssociatedRoles (list) --
Provides a list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.
(dict) --
Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB cluster.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
Status (string) --
Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other Amazon Web Services on your behalf.PENDING - the IAM role ARN is being associated with the DB cluster.INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other Amazon Web Services on your behalf.FeatureName (string) --
The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion .
IAMDatabaseAuthenticationEnabled (boolean) --
A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
CloneGroupId (string) --
Identifies the clone group to which the DB cluster is associated.
ClusterCreateTime (datetime) --
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
EarliestBacktrackTime (datetime) --
The earliest time to which a DB cluster can be backtracked.
BacktrackWindow (integer) --
The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.
BacktrackConsumedChangeRecords (integer) --
The number of change records stored for Backtrack.
EnabledCloudwatchLogsExports (list) --
A list of log types that this DB cluster is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.
Capacity (integer) --
The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 (zero) when the cluster is paused.
For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide .
EngineMode (string) --
The DB engine mode of the DB cluster, either provisioned , serverless , parallelquery , global , or multimaster .
For more information, see CreateDBCluster .
ScalingConfigurationInfo (dict) --
Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.
For more information, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide .
MinCapacity (integer) --
The minimum capacity for an Aurora DB cluster in serverless DB engine mode.
MaxCapacity (integer) --
The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
AutoPause (boolean) --
A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.
When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.
SecondsUntilAutoPause (integer) --
The remaining amount of time, in seconds, before the Aurora DB cluster in serverless mode is paused. A DB cluster can be paused only when it's idle (it has no connections).
TimeoutAction (string) --
The action that occurs when Aurora times out while attempting to change the capacity of an Aurora Serverless v1 cluster. The value is either ForceApplyCapacityChange or RollbackCapacityChange .
ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.
RollbackCapacityChangeignores the capacity change if a scaling point isn't found in the timeout period.
SecondsBeforeTimeout (integer) --
The number of seconds before scaling times out. What happens when an attempted scaling action times out is determined by the TimeoutAction setting.
DeletionProtection (boolean) --
Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
HttpEndpointEnabled (boolean) --
A value that indicates whether the HTTP endpoint for an Aurora Serverless v1 DB cluster is enabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide .
ActivityStreamMode (string) --
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.
ActivityStreamStatus (string) --
The status of the database activity stream.
ActivityStreamKmsKeyId (string) --
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
ActivityStreamKinesisStreamName (string) --
The name of the Amazon Kinesis data stream used for the database activity stream.
CopyTagsToSnapshot (boolean) --
Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.
CrossAccountClone (boolean) --
Specifies whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
DomainMemberships (list) --
The Active Directory Domain membership records associated with the DB cluster.
(dict) --
An Active Directory Domain membership record associated with the DB instance or cluster.
Domain (string) --
The identifier of the Active Directory Domain.
Status (string) --
The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.
FQDN (string) --
The fully qualified domain name of the Active Directory Domain.
IAMRoleName (string) --
The name of the IAM role to be used when making API calls to the Directory Service.
TagList (list) --
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
GlobalWriteForwardingStatus (string) --
Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.
GlobalWriteForwardingRequested (boolean) --
Specifies whether you have requested to enable write forwarding for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.
PendingModifiedValues (dict) --
A value that specifies that changes to the DB cluster are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
PendingCloudwatchLogsExports (dict) --
A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.
LogTypesToEnable (list) --
Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.
LogTypesToDisable (list) --
Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.
DBClusterIdentifier (string) --
The DBClusterIdentifier value for the DB cluster.
MasterUserPassword (string) --
The master credentials for the DB cluster.
IAMDatabaseAuthenticationEnabled (boolean) --
A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
EngineVersion (string) --
The database engine version.
DBClusterInstanceClass (string) --
The name of the compute and memory capacity class of the DB instance.
This setting is only for non-Aurora Multi-AZ DB clusters.
StorageType (string) --
The storage type associated with the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
Iops (integer) --
The Provisioned IOPS (I/O operations per second) value.
This setting is only for non-Aurora Multi-AZ DB clusters.
PubliclyAccessible (boolean) --
Specifies the accessibility options for the DB instance.
When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance .
This setting is only for non-Aurora Multi-AZ DB clusters.
AutoMinorVersionUpgrade (boolean) --
A value that indicates that minor version patches are applied automatically.
This setting is only for non-Aurora Multi-AZ DB clusters.
MonitoringInterval (integer) --
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
MonitoringRoleArn (string) --
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
This setting is only for non-Aurora Multi-AZ DB clusters.
PerformanceInsightsEnabled (boolean) --
True if Performance Insights is enabled for the DB cluster, and otherwise false.
This setting is only for non-Aurora Multi-AZ DB clusters.
PerformanceInsightsKMSKeyId (string) --
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
This setting is only for non-Aurora Multi-AZ DB clusters.
PerformanceInsightsRetentionPeriod (integer) --
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
For example, the following values are valid:
This setting is only for non-Aurora Multi-AZ DB clusters.
ServerlessV2ScalingConfiguration (dict) --
Shows the scaling configuration for an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide .
MinCapacity (float) --
The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.
MaxCapacity (float) --
The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128.
Exceptions
RDS.Client.exceptions.DBClusterNotFoundFaultRDS.Client.exceptions.InvalidDBClusterStateFaultRDS.Client.exceptions.DBClusterSnapshotAlreadyExistsFaultRDS.Client.exceptions.SnapshotQuotaExceededFaultRDS.Client.exceptions.InvalidDBClusterSnapshotStateFaultExamples
This example deletes the specified DB cluster.
response = client.delete_db_cluster(
DBClusterIdentifier='mydbcluster',
SkipFinalSnapshot=True,
)
print(response)
Expected Output:
{
'DBCluster': {
},
'ResponseMetadata': {
'...': '...',
},
}
delete_db_cluster_endpoint(**kwargs)¶Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster.
Note
This action only applies to Aurora DB clusters.
See also: AWS API Documentation
Request Syntax
response = client.delete_db_cluster_endpoint(
DBClusterEndpointIdentifier='string'
)
[REQUIRED]
The identifier associated with the custom endpoint. This parameter is stored as a lowercase string.
{
'DBClusterEndpointIdentifier': 'string',
'DBClusterIdentifier': 'string',
'DBClusterEndpointResourceIdentifier': 'string',
'Endpoint': 'string',
'Status': 'string',
'EndpointType': 'string',
'CustomEndpointType': 'string',
'StaticMembers': [
'string',
],
'ExcludedMembers': [
'string',
],
'DBClusterEndpointArn': 'string'
}
Response Structure
This data type represents the information you need to connect to an Amazon Aurora DB cluster. This data type is used as a response element in the following actions:
CreateDBClusterEndpointDescribeDBClusterEndpointsModifyDBClusterEndpointDeleteDBClusterEndpointFor the data structure that represents Amazon RDS DB instance endpoints, see Endpoint .
The identifier associated with the endpoint. This parameter is stored as a lowercase string.
The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.
The DNS address of the endpoint.
The current status of the endpoint. One of: creating , available , deleting , inactive , modifying . The inactive state applies to an endpoint that can't be used for a certain kind of cluster, such as a writer endpoint for a read-only secondary cluster in a global database.
The type of the endpoint. One of: READER , WRITER , CUSTOM .
The type associated with a custom endpoint. One of: READER , WRITER , ANY .
List of DB instance identifiers that are part of the custom endpoint group.
List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.
The Amazon Resource Name (ARN) for the endpoint.
Exceptions
RDS.Client.exceptions.InvalidDBClusterEndpointStateFaultRDS.Client.exceptions.DBClusterEndpointNotFoundFaultRDS.Client.exceptions.InvalidDBClusterStateFaultdelete_db_cluster_parameter_group(**kwargs)¶Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide .
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide .
See also: AWS API Documentation
Request Syntax
response = client.delete_db_cluster_parameter_group(
DBClusterParameterGroupName='string'
)
[REQUIRED]
The name of the DB cluster parameter group.
Constraints:
Exceptions
RDS.Client.exceptions.InvalidDBParameterGroupStateFaultRDS.Client.exceptions.DBParameterGroupNotFoundFaultExamples
This example deletes the specified DB cluster parameter group.
response = client.delete_db_cluster_parameter_group(
DBClusterParameterGroupName='mydbclusterparametergroup',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
delete_db_cluster_snapshot(**kwargs)¶Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.
Note
The DB cluster snapshot must be in the available state to be deleted.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide .
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide .
See also: AWS API Documentation
Request Syntax
response = client.delete_db_cluster_snapshot(
DBClusterSnapshotIdentifier='string'
)
[REQUIRED]
The identifier of the DB cluster snapshot to delete.
Constraints: Must be the name of an existing DB cluster snapshot in the available state.
{
'DBClusterSnapshot': {
'AvailabilityZones': [
'string',
],
'DBClusterSnapshotIdentifier': 'string',
'DBClusterIdentifier': 'string',
'SnapshotCreateTime': datetime(2015, 1, 1),
'Engine': 'string',
'EngineMode': 'string',
'AllocatedStorage': 123,
'Status': 'string',
'Port': 123,
'VpcId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'EngineVersion': 'string',
'LicenseModel': 'string',
'SnapshotType': 'string',
'PercentProgress': 123,
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DBClusterSnapshotArn': 'string',
'SourceDBClusterSnapshotArn': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
Contains the details for an Amazon RDS DB cluster snapshot
This data type is used as a response element in the DescribeDBClusterSnapshots action.
Provides the list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
Specifies the identifier for the DB cluster snapshot.
Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
Specifies the name of the database engine for this DB cluster snapshot.
Provides the engine mode of the database engine for this DB cluster snapshot.
Specifies the allocated storage size in gibibytes (GiB).
Specifies the status of this DB cluster snapshot. Valid statuses are the following:
availablecopyingcreatingSpecifies the port that the DB cluster was listening on at the time of the snapshot.
Provides the VPC ID associated with the DB cluster snapshot.
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
Provides the master username for this DB cluster snapshot.
Provides the version of the database engine for this DB cluster snapshot.
Provides the license model information for this DB cluster snapshot.
Provides the type of the DB cluster snapshot.
Specifies the percentage of the estimated data that has been transferred.
Specifies whether the DB cluster snapshot is encrypted.
If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
The Amazon Resource Name (ARN) for the DB cluster snapshot.
If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Exceptions
RDS.Client.exceptions.InvalidDBClusterSnapshotStateFaultRDS.Client.exceptions.DBClusterSnapshotNotFoundFaultExamples
This example deletes the specified DB cluster snapshot.
response = client.delete_db_cluster_snapshot(
DBClusterSnapshotIdentifier='mydbclustersnapshot',
)
print(response)
Expected Output:
{
'DBClusterSnapshot': {
},
'ResponseMetadata': {
'...': '...',
},
}
delete_db_instance(**kwargs)¶The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted.
If you request a final DB snapshot the status of the Amazon RDS DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this operation. The action can't be canceled or reverted once submitted.
When a DB instance is in a failure state and has a status of failed , incompatible-restore , or incompatible-network , you can only delete it when you skip creation of the final snapshot with the SkipFinalSnapshot parameter.
If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following conditions are true:
To delete a DB instance in this case, first call the PromoteReadReplicaDBCluster API action to promote the DB cluster so it's no longer a read replica. After the promotion completes, then call the DeleteDBInstance API action to delete the final instance in the DB cluster.
See also: AWS API Documentation
Request Syntax
response = client.delete_db_instance(
DBInstanceIdentifier='string',
SkipFinalSnapshot=True|False,
FinalDBSnapshotIdentifier='string',
DeleteAutomatedBackups=True|False
)
[REQUIRED]
The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive.
Constraints:
A value that indicates whether to skip the creation of a final DB snapshot before deleting the instance. If you enable this parameter, RDS doesn't create a DB snapshot. If you don't enable this parameter, RDS creates a DB snapshot before the DB instance is deleted. By default, skip isn't enabled, and the DB snapshot is created.
Note
If you don't enable this parameter, you must specify the FinalDBSnapshotIdentifier parameter.
When a DB instance is in a failure state and has a status of failed , incompatible-restore , or incompatible-network , RDS can delete the instance only if you enable this parameter.
If you delete a read replica or an RDS Custom instance, you must enable this setting.
This setting is required for RDS Custom.
The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot parameter is disabled.
Note
If you enable this parameter and also enable SkipFinalShapshot, the command results in an error.
This setting doesn't apply to RDS Custom.
Constraints:
dict
Response Syntax
{
'DBInstance': {
'DBInstanceIdentifier': 'string',
'DBInstanceClass': 'string',
'Engine': 'string',
'DBInstanceStatus': 'string',
'AutomaticRestartTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'DBName': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123,
'HostedZoneId': 'string'
},
'AllocatedStorage': 123,
'InstanceCreateTime': datetime(2015, 1, 1),
'PreferredBackupWindow': 'string',
'BackupRetentionPeriod': 123,
'DBSecurityGroups': [
{
'DBSecurityGroupName': 'string',
'Status': 'string'
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'DBParameterGroups': [
{
'DBParameterGroupName': 'string',
'ParameterApplyStatus': 'string'
},
],
'AvailabilityZone': 'string',
'DBSubnetGroup': {
'DBSubnetGroupName': 'string',
'DBSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetOutpost': {
'Arn': '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',
]
},
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
],
'IAMDatabaseAuthenticationEnabled': True|False,
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1)
},
'LatestRestorableTime': datetime(2015, 1, 1),
'MultiAZ': True|False,
'EngineVersion': 'string',
'AutoMinorVersionUpgrade': True|False,
'ReadReplicaSourceDBInstanceIdentifier': 'string',
'ReadReplicaDBInstanceIdentifiers': [
'string',
],
'ReadReplicaDBClusterIdentifiers': [
'string',
],
'ReplicaMode': 'open-read-only'|'mounted',
'LicenseModel': 'string',
'Iops': 123,
'OptionGroupMemberships': [
{
'OptionGroupName': 'string',
'Status': 'string'
},
],
'CharacterSetName': 'string',
'NcharCharacterSetName': 'string',
'SecondaryAvailabilityZone': 'string',
'PubliclyAccessible': True|False,
'StatusInfos': [
{
'StatusType': 'string',
'Normal': True|False,
'Status': 'string',
'Message': 'string'
},
],
'StorageType': 'string',
'TdeCredentialArn': 'string',
'DbInstancePort': 123,
'DBClusterIdentifier': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbiResourceId': 'string',
'CACertificateIdentifier': 'string',
'DomainMemberships': [
{
'Domain': 'string',
'Status': 'string',
'FQDN': 'string',
'IAMRoleName': 'string'
},
],
'CopyTagsToSnapshot': True|False,
'MonitoringInterval': 123,
'EnhancedMonitoringResourceArn': 'string',
'MonitoringRoleArn': 'string',
'PromotionTier': 123,
'DBInstanceArn': 'string',
'Timezone': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'PerformanceInsightsEnabled': True|False,
'PerformanceInsightsKMSKeyId': 'string',
'PerformanceInsightsRetentionPeriod': 123,
'EnabledCloudwatchLogsExports': [
'string',
],
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
],
'DeletionProtection': True|False,
'AssociatedRoles': [
{
'RoleArn': 'string',
'FeatureName': 'string',
'Status': 'string'
},
],
'ListenerEndpoint': {
'Address': 'string',
'Port': 123,
'HostedZoneId': 'string'
},
'MaxAllocatedStorage': 123,
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'DBInstanceAutomatedBackupsReplications': [
{
'DBInstanceAutomatedBackupsArn': 'string'
},
],
'CustomerOwnedIpEnabled': True|False,
'AwsBackupRecoveryPointArn': 'string',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamEngineNativeAuditFieldsIncluded': True|False,
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1),
'CustomIamInstanceProfile': 'string',
'BackupTarget': 'string',
'NetworkType': 'string',
'ActivityStreamPolicyStatus': 'locked'|'unlocked'|'locking-policy'|'unlocking-policy'
}
}
Response Structure
(dict) --
DBInstance (dict) --
Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations CreateDBInstance , CreateDBInstanceReadReplica , DeleteDBInstance , DescribeDBInstances , ModifyDBInstance , PromoteReadReplica , RebootDBInstance , RestoreDBInstanceFromDBSnapshot , RestoreDBInstanceFromS3 , RestoreDBInstanceToPointInTime , StartDBInstance , and StopDBInstance .
DBInstanceIdentifier (string) --
Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
DBInstanceClass (string) --
Contains the name of the compute and memory capacity class of the DB instance.
Engine (string) --
The name of the database engine to be used for this DB instance.
DBInstanceStatus (string) --
Specifies the current state of this database.
For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.
AutomaticRestartTime (datetime) --
The time when a stopped DB instance is restarted automatically.
MasterUsername (string) --
Contains the master username for the DB instance.
DBName (string) --
The meaning of this parameter differs according to the database engine you use.
MySQL, MariaDB, SQL Server, PostgreSQL
Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
Type: String
Oracle
Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
Endpoint (dict) --
Specifies the connection endpoint.
Note
The endpoint might not be shown for instances whose status is creating .
Address (string) --
Specifies the DNS address of the DB 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.
AllocatedStorage (integer) --
Specifies the allocated storage size specified in gibibytes (GiB).
InstanceCreateTime (datetime) --
Provides the date and time the DB 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 DB snapshots are retained.
DBSecurityGroups (list) --
A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
(dict) --
This data type is used as a response element in the following actions:
ModifyDBInstanceRebootDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceToPointInTimeDBSecurityGroupName (string) --
The name of the DB security group.
Status (string) --
The status of the DB security group.
VpcSecurityGroups (list) --
Provides a list of VPC security group elements that the DB instance belongs to.
(dict) --
This data type is used as a response element for queries on VPC security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The membership status of the VPC security group.
Currently, the only valid status is active .
DBParameterGroups (list) --
Provides the list of DB parameter groups applied to this DB instance.
(dict) --
The status of the DB parameter group.
This data type is used as a response element in the following actions:
CreateDBInstanceCreateDBInstanceReadReplicaDeleteDBInstanceModifyDBInstanceRebootDBInstanceRestoreDBInstanceFromDBSnapshotDBParameterGroupName (string) --
The name of the DB parameter group.
ParameterApplyStatus (string) --
The status of parameter updates.
AvailabilityZone (string) --
Specifies the name of the Availability Zone the DB instance is located in.
DBSubnetGroup (dict) --
Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
DBSubnetGroupName (string) --
The name of the DB subnet group.
DBSubnetGroupDescription (string) --
Provides the description of the DB subnet group.
VpcId (string) --
Provides the VpcId of the DB subnet group.
SubnetGroupStatus (string) --
Provides the status of the DB subnet group.
Subnets (list) --
Contains a list of Subnet elements.
(dict) --
This data type is used as a response element for the DescribeDBSubnetGroups operation.
SubnetIdentifier (string) --
The identifier of the subnet.
SubnetAvailabilityZone (dict) --
Contains Availability Zone information.
This data type is used as an element in the OrderableDBInstanceOption data type.
Name (string) --
The name of the Availability Zone.
SubnetOutpost (dict) --
If the subnet is associated with an Outpost, this value specifies the Outpost.
For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
Arn (string) --
The Amazon Resource Name (ARN) of the Outpost.
SubnetStatus (string) --
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:
IPV4DUALA DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
PendingModifiedValues (dict) --
A value that specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
DBInstanceClass (string) --
The name of the compute and memory capacity class for the DB instance.
AllocatedStorage (integer) --
The allocated storage size for the DB instance specified in gibibytes (GiB).
MasterUserPassword (string) --
The master credentials for the DB instance.
Port (integer) --
The port for the DB instance.
BackupRetentionPeriod (integer) --
The number of days for which automated backups are retained.
MultiAZ (boolean) --
A value that indicates that the Single-AZ DB instance will change to a Multi-AZ deployment.
EngineVersion (string) --
The database engine version.
LicenseModel (string) --
The license model for the DB instance.
Valid values: license-included | bring-your-own-license | general-public-license
Iops (integer) --
The Provisioned IOPS value for the DB instance.
DBInstanceIdentifier (string) --
The database identifier for the DB instance.
StorageType (string) --
The storage type of the DB instance.
CACertificateIdentifier (string) --
The identifier of the CA certificate for the DB instance.
DBSubnetGroupName (string) --
The DB subnet group for the DB instance.
PendingCloudwatchLogsExports (dict) --
A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.
LogTypesToEnable (list) --
Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.
LogTypesToDisable (list) --
Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.
ProcessorFeatures (list) --
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
(dict) --
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstanceModifyDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceFromS3RestoreDBInstanceToPointInTimeYou can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstancesDescribeDBSnapshotsDescribeValidDBInstanceModificationsIf you call DescribeDBInstances , ProcessorFeature returns non-null values only if the following conditions are met:
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
Name (string) --
The name of the processor feature. Valid names are coreCount and threadsPerCore .
Value (string) --
The value of a processor feature name.
IAMDatabaseAuthenticationEnabled (boolean) --
Whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
AutomationMode (string) --
The automation mode of the RDS Custom DB instance: full or all-paused . If full , the DB instance automates monitoring and instance recovery. If all-paused , the instance pauses automation for the duration set by --resume-full-automation-mode-minutes .
ResumeFullAutomationModeTime (datetime) --
The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
LatestRestorableTime (datetime) --
Specifies the latest time to which a database can be restored with point-in-time restore.
MultiAZ (boolean) --
Specifies if the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom.
EngineVersion (string) --
Indicates the database engine version.
AutoMinorVersionUpgrade (boolean) --
A value that indicates that minor version patches are applied automatically.
ReadReplicaSourceDBInstanceIdentifier (string) --
Contains the identifier of the source DB instance if this DB instance is a read replica.
ReadReplicaDBInstanceIdentifiers (list) --
Contains one or more identifiers of the read replicas associated with this DB instance.
ReadReplicaDBClusterIdentifiers (list) --
Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn't contain information about cross-Region Aurora read replicas.
Note
Currently, each RDS DB instance can have only one Aurora read replica.
ReplicaMode (string) --
The open mode of an Oracle read replica. The default is open-read-only . For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide .
Note
This attribute is only supported in RDS for Oracle.
LicenseModel (string) --
License model information for this DB instance. This setting doesn't apply to RDS Custom.
Iops (integer) --
Specifies the Provisioned IOPS (I/O operations per second) value.
OptionGroupMemberships (list) --
Provides the list of option group memberships for this DB instance.
(dict) --
Provides information on the option groups the DB instance is a member of.
OptionGroupName (string) --
The name of the option group that the instance belongs to.
Status (string) --
The status of the DB instance's option group membership. Valid values are: in-sync , pending-apply , pending-removal , pending-maintenance-apply , pending-maintenance-removal , applying , removing , and failed .
CharacterSetName (string) --
If present, specifies the name of the character set that this instance is associated with.
NcharCharacterSetName (string) --
The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.
SecondaryAvailabilityZone (string) --
If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
PubliclyAccessible (boolean) --
Specifies the accessibility options for the DB instance.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance .
StatusInfos (list) --
The status of a read replica. If the instance isn't a read replica, this is blank.
(dict) --
Provides a list of status information for a DB instance.
StatusType (string) --
This value is currently "read replication."
Normal (boolean) --
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 DB instance. For a StatusType of read replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.
Message (string) --
Details of the error if there is an error for the instance. If the instance isn't in an error state, this value is blank.
StorageType (string) --
Specifies the storage type associated with DB instance.
TdeCredentialArn (string) --
The ARN from the key store with which the instance is associated for TDE encryption.
DbInstancePort (integer) --
Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.
DBClusterIdentifier (string) --
If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.
StorageEncrypted (boolean) --
Specifies whether the DB instance is encrypted.
KmsKeyId (string) --
If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
DbiResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB instance is accessed.
CACertificateIdentifier (string) --
The identifier of the CA certificate for this DB instance.
DomainMemberships (list) --
The Active Directory Domain membership records associated with the DB instance.
(dict) --
An Active Directory Domain membership record associated with the DB instance or cluster.
Domain (string) --
The identifier of the Active Directory Domain.
Status (string) --
The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.
FQDN (string) --
The fully qualified domain name of the Active Directory Domain.
IAMRoleName (string) --
The name of the IAM role to be used when making API calls to the Directory Service.
CopyTagsToSnapshot (boolean) --
Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see DBCluster .
MonitoringInterval (integer) --
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
EnhancedMonitoringResourceArn (string) --
The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
MonitoringRoleArn (string) --
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
PromotionTier (integer) --
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .
DBInstanceArn (string) --
The Amazon Resource Name (ARN) for the DB instance.
Timezone (string) --
The time zone of the DB instance. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.
IAMDatabaseAuthenticationEnabled (boolean) --
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
IAM database authentication can be enabled for the following database engines
PerformanceInsightsEnabled (boolean) --
True if Performance Insights is enabled for the DB instance, and otherwise false.
PerformanceInsightsKMSKeyId (string) --
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
PerformanceInsightsRetentionPeriod (integer) --
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
For example, the following values are valid:
EnabledCloudwatchLogsExports (list) --
A list of log types that this DB instance is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon RDS User Guide.
ProcessorFeatures (list) --
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
(dict) --
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstanceModifyDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceFromS3RestoreDBInstanceToPointInTimeYou can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstancesDescribeDBSnapshotsDescribeValidDBInstanceModificationsIf you call DescribeDBInstances , ProcessorFeature returns non-null values only if the following conditions are met:
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
Name (string) --
The name of the processor feature. Valid names are coreCount and threadsPerCore .
Value (string) --
The value of a processor feature name.
DeletionProtection (boolean) --
Indicates if the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance .
AssociatedRoles (list) --
The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
(dict) --
Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.
FeatureName (string) --
The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion .
Status (string) --
Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf.PENDING - the IAM role ARN is being associated with the DB instance.INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf.ListenerEndpoint (dict) --
Specifies the listener connection endpoint for SQL Server Always On.
Address (string) --
Specifies the DNS address of the DB 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.
MaxAllocatedStorage (integer) --
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
TagList (list) --
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
DBInstanceAutomatedBackupsReplications (list) --
The list of replicated automated backups associated with the DB instance.
(dict) --
Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties.
DBInstanceAutomatedBackupsArn (string) --
The Amazon Resource Name (ARN) of the replicated automated backups.
CustomerOwnedIpEnabled (boolean) --
Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide .
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide .
AwsBackupRecoveryPointArn (string) --
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
ActivityStreamStatus (string) --
The status of the database activity stream.
ActivityStreamKmsKeyId (string) --
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
ActivityStreamKinesisStreamName (string) --
The name of the Amazon Kinesis data stream used for the database activity stream.
ActivityStreamMode (string) --
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. RDS for Oracle always handles these events asynchronously.
ActivityStreamEngineNativeAuditFieldsIncluded (boolean) --
Indicates whether engine-native audit fields are included in the database activity stream.
AutomationMode (string) --
The automation mode of the RDS Custom DB instance: full or all paused . If full , the DB instance automates monitoring and instance recovery. If all paused , the instance pauses automation for the duration set by --resume-full-automation-mode-minutes .
ResumeFullAutomationModeTime (datetime) --
The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
CustomIamInstanceProfile (string) --
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
AWSRDSCustom .For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide .
BackupTarget (string) --
Specifies where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
NetworkType (string) --
The network type of the DB instance.
Valid values:
IPV4DUALThe network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide and Working with a DB instance in a VPC in the Amazon Aurora User Guide.
ActivityStreamPolicyStatus (string) --
The status of the policy state of the activity stream.
Exceptions
RDS.Client.exceptions.DBInstanceNotFoundFaultRDS.Client.exceptions.InvalidDBInstanceStateFaultRDS.Client.exceptions.DBSnapshotAlreadyExistsFaultRDS.Client.exceptions.SnapshotQuotaExceededFaultRDS.Client.exceptions.InvalidDBClusterStateFaultRDS.Client.exceptions.DBInstanceAutomatedBackupQuotaExceededFaultExamples
This example deletes the specified DB instance.
response = client.delete_db_instance(
DBInstanceIdentifier='mymysqlinstance',
SkipFinalSnapshot=True,
)
print(response)
Expected Output:
{
'DBInstance': {
},
'ResponseMetadata': {
'...': '...',
},
}
delete_db_instance_automated_backup(**kwargs)¶Deletes automated backups using the DbiResourceId value of the source DB instance or the Amazon Resource Name (ARN) of the automated backups.
See also: AWS API Documentation
Request Syntax
response = client.delete_db_instance_automated_backup(
DbiResourceId='string',
DBInstanceAutomatedBackupsArn='string'
)
The Amazon Resource Name (ARN) of the automated backups to delete, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE .
This setting doesn't apply to RDS Custom.
dict
Response Syntax
{
'DBInstanceAutomatedBackup': {
'DBInstanceArn': 'string',
'DbiResourceId': 'string',
'Region': 'string',
'DBInstanceIdentifier': 'string',
'RestoreWindow': {
'EarliestTime': datetime(2015, 1, 1),
'LatestTime': datetime(2015, 1, 1)
},
'AllocatedStorage': 123,
'Status': 'string',
'Port': 123,
'AvailabilityZone': 'string',
'VpcId': 'string',
'InstanceCreateTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'LicenseModel': 'string',
'Iops': 123,
'OptionGroupName': 'string',
'TdeCredentialArn': 'string',
'Encrypted': True|False,
'StorageType': 'string',
'KmsKeyId': 'string',
'Timezone': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'BackupRetentionPeriod': 123,
'DBInstanceAutomatedBackupsArn': 'string',
'DBInstanceAutomatedBackupsReplications': [
{
'DBInstanceAutomatedBackupsArn': 'string'
},
],
'BackupTarget': 'string'
}
}
Response Structure
(dict) --
DBInstanceAutomatedBackup (dict) --
An automated backup of a DB instance. It consists of system backups, transaction logs, and the database instance properties that existed at the time you deleted the source instance.
DBInstanceArn (string) --
The Amazon Resource Name (ARN) for the automated backups.
DbiResourceId (string) --
The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
Region (string) --
The Amazon Web Services Region associated with the automated backup.
DBInstanceIdentifier (string) --
The customer id of the instance that is/was associated with the automated backup.
RestoreWindow (dict) --
Earliest and latest time an instance can be restored to.
EarliestTime (datetime) --
The earliest time you can restore an instance to.
LatestTime (datetime) --
The latest time you can restore an instance to.
AllocatedStorage (integer) --
Specifies the allocated storage size in gibibytes (GiB).
Status (string) --
Provides a list of status information for an automated backup:
active - automated backups for current instancesretained - automated backups for deleted instancescreating - automated backups that are waiting for the first automated snapshot to be available.Port (integer) --
The port number that the automated backup used for connections.
Default: Inherits from the source DB instance
Valid Values: 1150-65535
AvailabilityZone (string) --
The Availability Zone that the automated backup was created in. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones .
VpcId (string) --
Provides the VPC ID associated with the DB instance
InstanceCreateTime (datetime) --
Provides the date and time that the DB instance was created.
MasterUsername (string) --
The license model of an automated backup.
Engine (string) --
The name of the database engine for this automated backup.
EngineVersion (string) --
The version of the database engine for the automated backup.
LicenseModel (string) --
License model information for the automated backup.
Iops (integer) --
The IOPS (I/O operations per second) value for the automated backup.
OptionGroupName (string) --
The option group the automated backup is associated with. If omitted, the default option group for the engine specified is used.
TdeCredentialArn (string) --
The ARN from the key store with which the automated backup is associated for TDE encryption.
Encrypted (boolean) --
Specifies whether the automated backup is encrypted.
StorageType (string) --
Specifies the storage type associated with the automated backup.
KmsKeyId (string) --
The Amazon Web Services KMS key ID for an automated backup.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
Timezone (string) --
The time zone of the automated backup. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.
IAMDatabaseAuthenticationEnabled (boolean) --
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
BackupRetentionPeriod (integer) --
The retention period for the automated backups.
DBInstanceAutomatedBackupsArn (string) --
The Amazon Resource Name (ARN) for the replicated automated backups.
DBInstanceAutomatedBackupsReplications (list) --
The list of replications to different Amazon Web Services Regions associated with the automated backup.
(dict) --
Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties.
DBInstanceAutomatedBackupsArn (string) --
The Amazon Resource Name (ARN) of the replicated automated backups.
BackupTarget (string) --
Specifies where automated backups are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
Exceptions
RDS.Client.exceptions.InvalidDBInstanceAutomatedBackupStateFaultRDS.Client.exceptions.DBInstanceAutomatedBackupNotFoundFaultdelete_db_parameter_group(**kwargs)¶Deletes a specified DB parameter group. The DB parameter group to be deleted can't be associated with any DB instances.
See also: AWS API Documentation
Request Syntax
response = client.delete_db_parameter_group(
DBParameterGroupName='string'
)
[REQUIRED]
The name of the DB parameter group.
Constraints:
Exceptions
RDS.Client.exceptions.InvalidDBParameterGroupStateFaultRDS.Client.exceptions.DBParameterGroupNotFoundFaultExamples
The following example deletes a DB parameter group.
response = client.delete_db_parameter_group(
DBParameterGroupName='mydbparamgroup3',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
delete_db_proxy(**kwargs)¶Deletes an existing DB proxy.
See also: AWS API Documentation
Request Syntax
response = client.delete_db_proxy(
DBProxyName='string'
)
[REQUIRED]
The name of the DB proxy to delete.
{
'DBProxy': {
'DBProxyName': 'string',
'DBProxyArn': 'string',
'Status': 'available'|'modifying'|'incompatible-network'|'insufficient-resource-limits'|'creating'|'deleting'|'suspended'|'suspending'|'reactivating',
'EngineFamily': 'string',
'VpcId': 'string',
'VpcSecurityGroupIds': [
'string',
],
'VpcSubnetIds': [
'string',
],
'Auth': [
{
'Description': 'string',
'UserName': 'string',
'AuthScheme': 'SECRETS',
'SecretArn': 'string',
'IAMAuth': 'DISABLED'|'REQUIRED'
},
],
'RoleArn': 'string',
'Endpoint': 'string',
'RequireTLS': True|False,
'IdleClientTimeout': 123,
'DebugLogging': True|False,
'CreatedDate': datetime(2015, 1, 1),
'UpdatedDate': datetime(2015, 1, 1)
}
}
Response Structure
The data structure representing the details of the DB proxy that you delete.
The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.
The Amazon Resource Name (ARN) for the proxy.
The current status of this proxy. A status of available means the proxy is ready to handle requests. Other values indicate that you must wait for the proxy to be ready, or take some action to resolve an issue.
The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. MYSQL supports Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases. POSTGRESQL supports Aurora PostgreSQL and RDS for PostgreSQL databases.
Provides the VPC ID of the DB proxy.
Provides a list of VPC security groups that the proxy belongs to.
The EC2 subnet IDs for the proxy.
One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.
Returns the details of authentication used by a proxy to log in as a specific database user.
A user-specified description about the authentication used by a proxy to log in as a specific database user.
The name of the database user to which the proxy connects.
The type of authentication that the proxy uses for connections from the proxy to the underlying database.
The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.
Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy.
The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.
The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.
Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection. The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by later connection requests.
Default: 1800 (30 minutes)
Constraints: 1 to 28,800
Whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.
The date and time when the proxy was first created.
The date and time when the proxy was last updated.
Exceptions
RDS.Client.exceptions.DBProxyNotFoundFaultRDS.Client.exceptions.InvalidDBProxyStateFaultdelete_db_proxy_endpoint(**kwargs)¶Deletes a DBProxyEndpoint . Doing so removes the ability to access the DB proxy using the endpoint that you defined. The endpoint that you delete might have provided capabilities such as read/write or read-only operations, or using a different VPC than the DB proxy's default VPC.
See also: AWS API Documentation
Request Syntax
response = client.delete_db_proxy_endpoint(
DBProxyEndpointName='string'
)
[REQUIRED]
The name of the DB proxy endpoint to delete.
{
'DBProxyEndpoint': {
'DBProxyEndpointName': 'string',
'DBProxyEndpointArn': 'string',
'DBProxyName': 'string',
'Status': 'available'|'modifying'|'incompatible-network'|'insufficient-resource-limits'|'creating'|'deleting',
'VpcId': 'string',
'VpcSecurityGroupIds': [
'string',
],
'VpcSubnetIds': [
'string',
],
'Endpoint': 'string',
'CreatedDate': datetime(2015, 1, 1),
'TargetRole': 'READ_WRITE'|'READ_ONLY',
'IsDefault': True|False
}
}
Response Structure
The data structure representing the details of the DB proxy endpoint that you delete.
The name for the DB proxy endpoint. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.
The Amazon Resource Name (ARN) for the DB proxy endpoint.
The identifier for the DB proxy that is associated with this DB proxy endpoint.
The current status of this DB proxy endpoint. A status of available means the endpoint is ready to handle requests. Other values indicate that you must wait for the endpoint to be ready, or take some action to resolve an issue.
Provides the VPC ID of the DB proxy endpoint.
Provides a list of VPC security groups that the DB proxy endpoint belongs to.
The EC2 subnet IDs for the DB proxy endpoint.
The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.
The date and time when the DB proxy endpoint was first created.
A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
A value that indicates whether this endpoint is the default endpoint for the associated DB proxy. Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be either read/write or read-only.
Exceptions
RDS.Client.exceptions.DBProxyEndpointNotFoundFaultRDS.Client.exceptions.InvalidDBProxyEndpointStateFaultdelete_db_security_group(**kwargs)¶Deletes a DB security group.
Note
The specified DB security group must not be associated with any DB instances.
See also: AWS API Documentation
Request Syntax
response = client.delete_db_security_group(
DBSecurityGroupName='string'
)
[REQUIRED]
The name of the DB security group to delete.
Note
You can't delete the default DB security group.
Constraints:
Exceptions
RDS.Client.exceptions.InvalidDBSecurityGroupStateFaultRDS.Client.exceptions.DBSecurityGroupNotFoundFaultExamples
The following example deletes a DB security group.
response = client.delete_db_security_group(
DBSecurityGroupName='mysecgroup',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
delete_db_snapshot(**kwargs)¶Deletes a DB snapshot. If the snapshot is being copied, the copy operation is terminated.
Note
The DB snapshot must be in the available state to be deleted.
See also: AWS API Documentation
Request Syntax
response = client.delete_db_snapshot(
DBSnapshotIdentifier='string'
)
[REQUIRED]
The DB snapshot identifier.
Constraints: Must be the name of an existing DB snapshot in the available state.
{
'DBSnapshot': {
'DBSnapshotIdentifier': 'string',
'DBInstanceIdentifier': 'string',
'SnapshotCreateTime': datetime(2015, 1, 1),
'Engine': 'string',
'AllocatedStorage': 123,
'Status': 'string',
'Port': 123,
'AvailabilityZone': 'string',
'VpcId': 'string',
'InstanceCreateTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'EngineVersion': 'string',
'LicenseModel': 'string',
'SnapshotType': 'string',
'Iops': 123,
'OptionGroupName': 'string',
'PercentProgress': 123,
'SourceRegion': 'string',
'SourceDBSnapshotIdentifier': 'string',
'StorageType': 'string',
'TdeCredentialArn': 'string',
'Encrypted': True|False,
'KmsKeyId': 'string',
'DBSnapshotArn': 'string',
'Timezone': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
],
'DbiResourceId': 'string',
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'OriginalSnapshotCreateTime': datetime(2015, 1, 1),
'SnapshotTarget': 'string'
}
}
Response Structure
Contains the details of an Amazon RDS DB snapshot.
This data type is used as a response element in the DescribeDBSnapshots action.
Specifies the identifier for the DB snapshot.
Specifies the DB instance identifier of the DB instance this DB snapshot was created from.
Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied.
Specifies the name of the database engine.
Specifies the allocated storage size in gibibytes (GiB).
Specifies the status of this DB snapshot.
Specifies the port that the database engine was listening on at the time of the snapshot.
Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
Provides the VPC ID associated with the DB snapshot.
Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.
Provides the master username for the DB snapshot.
Specifies the version of the database engine.
License model information for the restored DB instance.
Provides the type of the DB snapshot.
Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
Provides the option group name for the DB snapshot.
The percentage of the estimated data that has been transferred.
The Amazon Web Services Region that the DB snapshot was created in or copied from.
The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has a value in the case of a cross-account or cross-Region copy.
Specifies the storage type associated with DB snapshot.
The ARN from the key store with which to associate the instance for TDE encryption.
Specifies whether the DB snapshot is encrypted.
If Encrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
The Amazon Resource Name (ARN) for the DB snapshot.
The time zone of the DB snapshot. In most cases, the Timezone element is empty. Timezone content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstanceModifyDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceFromS3RestoreDBInstanceToPointInTimeYou can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstancesDescribeDBSnapshotsDescribeValidDBInstanceModificationsIf you call DescribeDBInstances , ProcessorFeature returns non-null values only if the following conditions are met:
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
The name of the processor feature. Valid names are coreCount and threadsPerCore .
The value of a processor feature name.
The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied.
Specifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
Exceptions
RDS.Client.exceptions.InvalidDBSnapshotStateFaultRDS.Client.exceptions.DBSnapshotNotFoundFaultExamples
This example deletes the specified DB snapshot.
response = client.delete_db_snapshot(
DBSnapshotIdentifier='mydbsnapshot',
)
print(response)
Expected Output:
{
'DBSnapshot': {
},
'ResponseMetadata': {
'...': '...',
},
}
delete_db_subnet_group(**kwargs)¶Deletes a DB subnet group.
Note
The specified database subnet group must not be associated with any DB instances.
See also: AWS API Documentation
Request Syntax
response = client.delete_db_subnet_group(
DBSubnetGroupName='string'
)
[REQUIRED]
The name of the database subnet group to delete.
Note
You can't delete the default subnet group.
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example: mydbsubnetgroup
Exceptions
RDS.Client.exceptions.InvalidDBSubnetGroupStateFaultRDS.Client.exceptions.InvalidDBSubnetStateFaultRDS.Client.exceptions.DBSubnetGroupNotFoundFaultExamples
This example deletes the specified DB subnetgroup.
response = client.delete_db_subnet_group(
DBSubnetGroupName='mydbsubnetgroup',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
delete_event_subscription(**kwargs)¶Deletes an RDS event notification subscription.
See also: AWS API Documentation
Request Syntax
response = client.delete_event_subscription(
SubscriptionName='string'
)
[REQUIRED]
The name of the RDS event notification subscription you want to delete.
{
'EventSubscription': {
'CustomerAwsId': 'string',
'CustSubscriptionId': 'string',
'SnsTopicArn': 'string',
'Status': 'string',
'SubscriptionCreationTime': 'string',
'SourceType': 'string',
'SourceIdsList': [
'string',
],
'EventCategoriesList': [
'string',
],
'Enabled': True|False,
'EventSubscriptionArn': 'string'
}
}
Response Structure
Contains the results of a successful invocation of the DescribeEventSubscriptions action.
The Amazon Web Services customer account associated with the RDS event notification subscription.
The RDS event notification subscription Id.
The topic ARN of the RDS event notification subscription.
The status of the RDS event notification subscription.
Constraints:
Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist
The status "no-permission" indicates that RDS no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.
The time the RDS event notification subscription was created.
The source type for the RDS event notification subscription.
A list of source IDs for the RDS event notification subscription.
A list of event categories for the RDS event notification subscription.
A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.
The Amazon Resource Name (ARN) for the event subscription.
Exceptions
RDS.Client.exceptions.SubscriptionNotFoundFaultRDS.Client.exceptions.InvalidEventSubscriptionStateFaultExamples
This example deletes the specified DB event subscription.
response = client.delete_event_subscription(
SubscriptionName='myeventsubscription',
)
print(response)
Expected Output:
{
'EventSubscription': {
},
'ResponseMetadata': {
'...': '...',
},
}
delete_global_cluster(**kwargs)¶Deletes a global database cluster. The primary and secondary clusters must already be detached or destroyed first.
Note
This action only applies to Aurora DB clusters.
See also: AWS API Documentation
Request Syntax
response = client.delete_global_cluster(
GlobalClusterIdentifier='string'
)
[REQUIRED]
The cluster identifier of the global database cluster being deleted.
{
'GlobalCluster': {
'GlobalClusterIdentifier': 'string',
'GlobalClusterResourceId': 'string',
'GlobalClusterArn': 'string',
'Status': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'DatabaseName': 'string',
'StorageEncrypted': True|False,
'DeletionProtection': True|False,
'GlobalClusterMembers': [
{
'DBClusterArn': 'string',
'Readers': [
'string',
],
'IsWriter': True|False,
'GlobalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'unknown'
},
],
'FailoverState': {
'Status': 'pending'|'failing-over'|'cancelling',
'FromDbClusterArn': 'string',
'ToDbClusterArn': 'string'
}
}
}
Response Structure
A data type representing an Aurora global database.
Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster.
The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB cluster is accessed.
The Amazon Resource Name (ARN) for the global database cluster.
Specifies the current state of this global database cluster.
The Aurora database engine used by the global database cluster.
Indicates the database engine version.
The default database name within the new global database cluster.
The storage encryption setting for the global database cluster.
The deletion protection setting for the new global database cluster.
The list of cluster IDs for secondary clusters within the global database cluster. Currently limited to 1 item.
A data structure with information about any primary and secondary clusters associated with an Aurora global database.
The Amazon Resource Name (ARN) for each Aurora cluster.
The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global database.
Specifies whether the Aurora cluster is the primary cluster (that is, has read-write capability) for the Aurora global database with which it is associated.
Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.
A data object containing all properties for the current state of an in-process or pending failover process for this Aurora global database. This object is empty unless the FailoverGlobalCluster API operation has been called on this Aurora global database ( GlobalCluster ).
The current status of the Aurora global database ( GlobalCluster ). Possible values are as follows:
GlobalCluster 's primary DB cluster and the specified secondary DB cluster are being verified before the failover process can start.The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being demoted, and which is associated with this state.
The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being promoted, and which is associated with this state.
Exceptions
RDS.Client.exceptions.GlobalClusterNotFoundFaultRDS.Client.exceptions.InvalidGlobalClusterStateFaultdelete_option_group(**kwargs)¶Deletes an existing option group.
See also: AWS API Documentation
Request Syntax
response = client.delete_option_group(
OptionGroupName='string'
)
[REQUIRED]
The name of the option group to be deleted.
Note
You can't delete default option groups.
Exceptions
RDS.Client.exceptions.OptionGroupNotFoundFaultRDS.Client.exceptions.InvalidOptionGroupStateFaultExamples
This example deletes the specified option group.
response = client.delete_option_group(
OptionGroupName='mydboptiongroup',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
deregister_db_proxy_targets(**kwargs)¶Remove the association between one or more DBProxyTarget data structures and a DBProxyTargetGroup .
See also: AWS API Documentation
Request Syntax
response = client.deregister_db_proxy_targets(
DBProxyName='string',
TargetGroupName='string',
DBInstanceIdentifiers=[
'string',
],
DBClusterIdentifiers=[
'string',
]
)
[REQUIRED]
The identifier of the DBProxy that is associated with the DBProxyTargetGroup .
DBProxyTargetGroup .One or more DB instance identifiers.
One or more DB cluster identifiers.
dict
Response Syntax
{}
Response Structure
Exceptions
RDS.Client.exceptions.DBProxyTargetNotFoundFaultRDS.Client.exceptions.DBProxyTargetGroupNotFoundFaultRDS.Client.exceptions.DBProxyNotFoundFaultRDS.Client.exceptions.InvalidDBProxyStateFaultdescribe_account_attributes()¶Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.
This command doesn't take any parameters.
See also: AWS API Documentation
Request Syntax
response = client.describe_account_attributes()
{
'AccountQuotas': [
{
'AccountQuotaName': 'string',
'Used': 123,
'Max': 123
},
]
}
Response Structure
Data returned by the DescribeAccountAttributes action.
A list of AccountQuota objects. Within this list, each quota has a name, a count of usage toward the quota maximum, and a maximum value for the quota.
Describes a quota for an Amazon Web Services account.
The following are account quotas:
AllocatedStorage - The total allocated storage per account, in GiB. The used value is the total allocated storage in the account, in GiB.AuthorizationsPerDBSecurityGroup - The number of ingress rules per DB security group. The used value is the highest number of ingress rules in a DB security group in the account. Other DB security groups in the account might have a lower number of ingress rules.CustomEndpointsPerDBCluster - The number of custom endpoints per DB cluster. The used value is the highest number of custom endpoints in a DB clusters in the account. Other DB clusters in the account might have a lower number of custom endpoints.DBClusterParameterGroups - The number of DB cluster parameter groups per account, excluding default parameter groups. The used value is the count of nondefault DB cluster parameter groups in the account.DBClusterRoles - The number of associated Amazon Web Services Identity and Access Management (IAM) roles per DB cluster. The used value is the highest number of associated IAM roles for a DB cluster in the account. Other DB clusters in the account might have a lower number of associated IAM roles.DBClusters - The number of DB clusters per account. The used value is the count of DB clusters in the account.DBInstanceRoles - The number of associated IAM roles per DB instance. The used value is the highest number of associated IAM roles for a DB instance in the account. Other DB instances in the account might have a lower number of associated IAM roles.DBInstances - The number of DB instances per account. The used value is the count of the DB instances in the account. Amazon RDS DB instances, Amazon Aurora DB instances, Amazon Neptune instances, and Amazon DocumentDB instances apply to this quota.DBParameterGroups - The number of DB parameter groups per account, excluding default parameter groups. The used value is the count of nondefault DB parameter groups in the account.DBSecurityGroups - The number of DB security groups (not VPC security groups) per account, excluding the default security group. The used value is the count of nondefault DB security groups in the account.DBSubnetGroups - The number of DB subnet groups per account. The used value is the count of the DB subnet groups in the account.EventSubscriptions - The number of event subscriptions per account. The used value is the count of the event subscriptions in the account.ManualClusterSnapshots - The number of manual DB cluster snapshots per account. The used value is the count of the manual DB cluster snapshots in the account.ManualSnapshots - The number of manual DB instance snapshots per account. The used value is the count of the manual DB instance snapshots in the account.OptionGroups - The number of DB option groups per account, excluding default option groups. The used value is the count of nondefault DB option groups in the account.ReadReplicasPerMaster - The number of read replicas per DB instance. The used value is the highest number of read replicas for a DB instance in the account. Other DB instances in the account might have a lower number of read replicas.ReservedDBInstances - The number of reserved DB instances per account. The used value is the count of the active reserved DB instances in the account.SubnetsPerDBSubnetGroup - The number of subnets per DB subnet group. The used value is highest number of subnets for a DB subnet group in the account. Other DB subnet groups in the account might have a lower number of subnets.For more information, see Quotas for Amazon RDS in the Amazon RDS User Guide and Quotas for Amazon Aurora in the Amazon Aurora User Guide .
The name of the Amazon RDS quota for this Amazon Web Services account.
The amount currently used toward the quota maximum.
The maximum allowed value for the quota.
Examples
This example lists account attributes.
response = client.describe_account_attributes(
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
describe_certificates(**kwargs)¶Lists the set of CA certificates provided by Amazon RDS for this Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
response = client.describe_certificates(
CertificateIdentifier='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
The user-supplied certificate identifier. If this parameter is specified, information for only the identified certificate is returned. This parameter isn't case-sensitive.
Constraints:
This parameter isn't currently supported.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
DescribeCertificates request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .dict
Response Syntax
{
'Certificates': [
{
'CertificateIdentifier': 'string',
'CertificateType': 'string',
'Thumbprint': 'string',
'ValidFrom': datetime(2015, 1, 1),
'ValidTill': datetime(2015, 1, 1),
'CertificateArn': 'string',
'CustomerOverride': True|False,
'CustomerOverrideValidTill': datetime(2015, 1, 1)
},
],
'Marker': 'string'
}
Response Structure
(dict) --
Data returned by the DescribeCertificates action.
Certificates (list) --
The list of Certificate objects for the Amazon Web Services account.
(dict) --
A CA certificate for an Amazon Web Services account.
CertificateIdentifier (string) --
The unique key that identifies a certificate.
CertificateType (string) --
The type of the certificate.
Thumbprint (string) --
The thumbprint of the certificate.
ValidFrom (datetime) --
The starting date from which the certificate is valid.
ValidTill (datetime) --
The final date that the certificate continues to be valid.
CertificateArn (string) --
The Amazon Resource Name (ARN) for the certificate.
CustomerOverride (boolean) --
Whether there is an override for the default certificate identifier.
CustomerOverrideValidTill (datetime) --
If there is an override for the default certificate identifier, when the override expires.
Marker (string) --
An optional pagination token provided by a previous DescribeCertificates request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
Exceptions
RDS.Client.exceptions.CertificateNotFoundFaultExamples
This example lists up to 20 certificates for the specified certificate identifier.
response = client.describe_certificates(
CertificateIdentifier='rds-ca-2015',
MaxRecords=20,
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
describe_db_cluster_backtracks(**kwargs)¶Returns information about backtracks for a DB cluster.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide .
Note
This action only applies to Aurora MySQL DB clusters.
See also: AWS API Documentation
Request Syntax
response = client.describe_db_cluster_backtracks(
DBClusterIdentifier='string',
BacktrackIdentifier='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
[REQUIRED]
The DB cluster identifier of the DB cluster to be described. This parameter is stored as a lowercase string.
Constraints:
Example: my-cluster1
If specified, this value is the backtrack identifier of the backtrack to be described.
Constraints:
Example: 123e4567-e89b-12d3-a456-426655440000
A filter that specifies one or more DB clusters to describe. Supported filters include the following:
db-cluster-backtrack-id - Accepts backtrack identifiers. The results list includes information about only the backtracks identified by these identifiers.db-cluster-backtrack-status - Accepts any of the following backtrack status values:applyingcompletedfailedpendingThe results list includes information about only the backtracks identified by these values.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
DescribeDBClusterBacktracks 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',
'DBClusterBacktracks': [
{
'DBClusterIdentifier': 'string',
'BacktrackIdentifier': 'string',
'BacktrackTo': datetime(2015, 1, 1),
'BacktrackedFrom': datetime(2015, 1, 1),
'BacktrackRequestCreationTime': datetime(2015, 1, 1),
'Status': 'string'
},
]
}
Response Structure
(dict) --
Contains the result of a successful invocation of the DescribeDBClusterBacktracks action.
Marker (string) --
A pagination token that can be used in a later DescribeDBClusterBacktracks request.
DBClusterBacktracks (list) --
Contains a list of backtracks for the user.
(dict) --
This data type is used as a response element in the DescribeDBClusterBacktracks action.
DBClusterIdentifier (string) --
Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
BacktrackIdentifier (string) --
Contains the backtrack identifier.
BacktrackTo (datetime) --
The timestamp of the time to which the DB cluster was backtracked.
BacktrackedFrom (datetime) --
The timestamp of the time from which the DB cluster was backtracked.
BacktrackRequestCreationTime (datetime) --
The timestamp of the time at which the backtrack was requested.
Status (string) --
The status of the backtrack. This property returns one of the following values:
applying - The backtrack is currently being applied to or rolled back from the DB cluster.completed - The backtrack has successfully been applied to or rolled back from the DB cluster.failed - An error occurred while the backtrack was applied to or rolled back from the DB cluster.pending - The backtrack is currently pending application to or rollback from the DB cluster.Exceptions
RDS.Client.exceptions.DBClusterNotFoundFaultRDS.Client.exceptions.DBClusterBacktrackNotFoundFaultdescribe_db_cluster_endpoints(**kwargs)¶Returns information about endpoints for an Amazon Aurora DB cluster.
Note
This action only applies to Aurora DB clusters.
See also: AWS API Documentation
Request Syntax
response = client.describe_db_cluster_endpoints(
DBClusterIdentifier='string',
DBClusterEndpointIdentifier='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
A set of name-value pairs that define which endpoints to include in the output. The filters are specified as name-value pairs, in the format Name=*endpoint_type* ,Values=*endpoint_type1* ,*endpoint_type2* ,... . Name can be one of: db-cluster-endpoint-type , db-cluster-endpoint-custom-type , db-cluster-endpoint-id , db-cluster-endpoint-status . Values for the db-cluster-endpoint-type filter can be one or more of: reader , writer , custom . Values for the db-cluster-endpoint-custom-type filter can be one or more of: reader , any . Values for the db-cluster-endpoint-status filter can be one or more of: available , creating , deleting , inactive , modifying .
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
DescribeDBClusterEndpoints 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',
'DBClusterEndpoints': [
{
'DBClusterEndpointIdentifier': 'string',
'DBClusterIdentifier': 'string',
'DBClusterEndpointResourceIdentifier': 'string',
'Endpoint': 'string',
'Status': 'string',
'EndpointType': 'string',
'CustomEndpointType': 'string',
'StaticMembers': [
'string',
],
'ExcludedMembers': [
'string',
],
'DBClusterEndpointArn': 'string'
},
]
}
Response Structure
(dict) --
Marker (string) --
An optional pagination token provided by a previous DescribeDBClusterEndpoints request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
DBClusterEndpoints (list) --
Contains the details of the endpoints associated with the cluster and matching any filter conditions.
(dict) --
This data type represents the information you need to connect to an Amazon Aurora DB cluster. This data type is used as a response element in the following actions:
CreateDBClusterEndpointDescribeDBClusterEndpointsModifyDBClusterEndpointDeleteDBClusterEndpointFor the data structure that represents Amazon RDS DB instance endpoints, see Endpoint .
DBClusterEndpointIdentifier (string) --
The identifier associated with the endpoint. This parameter is stored as a lowercase string.
DBClusterIdentifier (string) --
The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
DBClusterEndpointResourceIdentifier (string) --
A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.
Endpoint (string) --
The DNS address of the endpoint.
Status (string) --
The current status of the endpoint. One of: creating , available , deleting , inactive , modifying . The inactive state applies to an endpoint that can't be used for a certain kind of cluster, such as a writer endpoint for a read-only secondary cluster in a global database.
EndpointType (string) --
The type of the endpoint. One of: READER , WRITER , CUSTOM .
CustomEndpointType (string) --
The type associated with a custom endpoint. One of: READER , WRITER , ANY .
StaticMembers (list) --
List of DB instance identifiers that are part of the custom endpoint group.
ExcludedMembers (list) --
List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.
DBClusterEndpointArn (string) --
The Amazon Resource Name (ARN) for the endpoint.
Exceptions
RDS.Client.exceptions.DBClusterNotFoundFaultdescribe_db_cluster_parameter_groups(**kwargs)¶Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list will contain only the description of the specified DB cluster parameter group.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide .
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide .
See also: AWS API Documentation
Request Syntax
response = client.describe_db_cluster_parameter_groups(
DBClusterParameterGroupName='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
The name of a specific DB cluster parameter group to return details for.
Constraints:
This parameter isn't currently supported.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
DescribeDBClusterParameterGroups 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',
'DBClusterParameterGroups': [
{
'DBClusterParameterGroupName': 'string',
'DBParameterGroupFamily': 'string',
'Description': 'string',
'DBClusterParameterGroupArn': 'string'
},
]
}
Response Structure
(dict) --
Marker (string) --
An optional pagination token provided by a previous DescribeDBClusterParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
DBClusterParameterGroups (list) --
A list of DB cluster parameter groups.
(dict) --
Contains the details of an Amazon RDS DB cluster parameter group.
This data type is used as a response element in the DescribeDBClusterParameterGroups action.
DBClusterParameterGroupName (string) --
The name of the DB cluster parameter group.
DBParameterGroupFamily (string) --
The name of the DB parameter group family that this DB cluster parameter group is compatible with.
Description (string) --
Provides the customer-specified description for this DB cluster parameter group.
DBClusterParameterGroupArn (string) --
The Amazon Resource Name (ARN) for the DB cluster parameter group.
Exceptions
RDS.Client.exceptions.DBParameterGroupNotFoundFaultExamples
This example lists settings for the specified DB cluster parameter group.
response = client.describe_db_cluster_parameter_groups(
DBClusterParameterGroupName='mydbclusterparametergroup',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
describe_db_cluster_parameters(**kwargs)¶Returns the detailed parameter list for a particular DB cluster parameter group.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide .
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide .
See also: AWS API Documentation
Request Syntax
response = client.describe_db_cluster_parameters(
DBClusterParameterGroupName='string',
Source='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
[REQUIRED]
The name of a specific DB cluster parameter group to return parameter details for.
Constraints:
engine , service , or customer .This parameter isn't currently supported.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
DescribeDBClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .dict
Response Syntax
{
'Parameters': [
{
'ParameterName': 'string',
'ParameterValue': 'string',
'Description': 'string',
'Source': 'string',
'ApplyType': 'string',
'DataType': 'string',
'AllowedValues': 'string',
'IsModifiable': True|False,
'MinimumEngineVersion': 'string',
'ApplyMethod': 'immediate'|'pending-reboot',
'SupportedEngineModes': [
'string',
]
},
],
'Marker': 'string'
}
Response Structure
(dict) --
Provides details about a DB cluster parameter group including the parameters in the DB cluster parameter group.
Parameters (list) --
Provides a list of parameters for the DB cluster parameter group.
(dict) --
This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions.
This data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions.
ParameterName (string) --
Specifies the name of the parameter.
ParameterValue (string) --
Specifies the value of the parameter.
Description (string) --
Provides a description of the parameter.
Source (string) --
Indicates the source of the parameter value.
ApplyType (string) --
Specifies the engine specific parameters type.
DataType (string) --
Specifies the valid data type for the parameter.
AllowedValues (string) --
Specifies the valid range of values for the parameter.
IsModifiable (boolean) --
Indicates whether (true ) or not (false ) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
MinimumEngineVersion (string) --
The earliest engine version to which the parameter can apply.
ApplyMethod (string) --
Indicates when to apply parameter updates.
SupportedEngineModes (list) --
The valid DB engine modes.
Marker (string) --
An optional pagination token provided by a previous DescribeDBClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
Exceptions
RDS.Client.exceptions.DBParameterGroupNotFoundFaultExamples
This example lists system parameters for the specified DB cluster parameter group.
response = client.describe_db_cluster_parameters(
DBClusterParameterGroupName='mydbclusterparametergroup',
Source='system',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
describe_db_cluster_snapshot_attributes(**kwargs)¶Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.
When sharing snapshots with other Amazon Web Services accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of values for the restore attribute, then the manual DB cluster snapshot is public and can be copied or restored by all Amazon Web Services accounts.
To add or remove access for an Amazon Web Services account to copy or restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.
See also: AWS API Documentation
Request Syntax
response = client.describe_db_cluster_snapshot_attributes(
DBClusterSnapshotIdentifier='string'
)
[REQUIRED]
The identifier for the DB cluster snapshot to describe the attributes for.
{
'DBClusterSnapshotAttributesResult': {
'DBClusterSnapshotIdentifier': 'string',
'DBClusterSnapshotAttributes': [
{
'AttributeName': 'string',
'AttributeValues': [
'string',
]
},
]
}
}
Response Structure
Contains the results of a successful call to the DescribeDBClusterSnapshotAttributes API action.
Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.
The identifier of the manual DB cluster snapshot that the attributes apply to.
The list of attributes and values for the manual DB cluster snapshot.
Contains the name and values of a manual DB cluster snapshot attribute.
Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts to restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.
The name of the manual DB cluster snapshot attribute.
The attribute named restore refers to the list of Amazon Web Services accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.
The value(s) for the manual DB cluster snapshot attribute.
If the AttributeName field is set to restore , then this element returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual DB cluster snapshot. If a value of all is in the list, then the manual DB cluster snapshot is public and available for any Amazon Web Services account to copy or restore.
Exceptions
RDS.Client.exceptions.DBClusterSnapshotNotFoundFaultExamples
This example lists attributes for the specified DB cluster snapshot.
response = client.describe_db_cluster_snapshot_attributes(
DBClusterSnapshotIdentifier='mydbclustersnapshot',
)
print(response)
Expected Output:
{
'DBClusterSnapshotAttributesResult': {
},
'ResponseMetadata': {
'...': '...',
},
}
describe_db_cluster_snapshots(**kwargs)¶Returns information about DB cluster snapshots. This API action supports pagination.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide .
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide .
See also: AWS API Documentation
Request Syntax
response = client.describe_db_cluster_snapshots(
DBClusterIdentifier='string',
DBClusterSnapshotIdentifier='string',
SnapshotType='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string',
IncludeShared=True|False,
IncludePublic=True|False
)
The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter isn't case-sensitive.
Constraints:
A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with the DBClusterIdentifier parameter. This value is stored as a lowercase string.
Constraints:
SnapshotType parameter must also be specified.The type of DB cluster snapshots to be returned. You can specify one of the following values:
automated - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.manual - Return all DB cluster snapshots that have been taken by my Amazon Web Services account.shared - Return all manual DB cluster snapshots that have been shared to my Amazon Web Services account.public - Return all DB cluster snapshots that have been marked as public.If you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by enabling the IncludeShared parameter. You can include public DB cluster snapshots with these results by enabling the IncludePublic parameter.
The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated . The IncludePublic parameter doesn't apply when SnapshotType is set to shared . The IncludeShared parameter doesn't apply when SnapshotType is set to public .
A filter that specifies one or more DB cluster snapshots to describe.
Supported filters:
db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs).db-cluster-snapshot-id - Accepts DB cluster snapshot identifiers.snapshot-type - Accepts types of DB cluster snapshots.engine - Accepts names of database engines.A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .A value that indicates whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.
You can give an Amazon Web Services account permission to restore a manual DB cluster snapshot from another Amazon Web Services account by the ModifyDBClusterSnapshotAttribute API action.
A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.
You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.
dict
Response Syntax
{
'Marker': 'string',
'DBClusterSnapshots': [
{
'AvailabilityZones': [
'string',
],
'DBClusterSnapshotIdentifier': 'string',
'DBClusterIdentifier': 'string',
'SnapshotCreateTime': datetime(2015, 1, 1),
'Engine': 'string',
'EngineMode': 'string',
'AllocatedStorage': 123,
'Status': 'string',
'Port': 123,
'VpcId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'EngineVersion': 'string',
'LicenseModel': 'string',
'SnapshotType': 'string',
'PercentProgress': 123,
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DBClusterSnapshotArn': 'string',
'SourceDBClusterSnapshotArn': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
}
Response Structure
(dict) --
Provides a list of DB cluster snapshots for the user as the result of a call to the DescribeDBClusterSnapshots action.
Marker (string) --
An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
DBClusterSnapshots (list) --
Provides a list of DB cluster snapshots for the user.
(dict) --
Contains the details for an Amazon RDS DB cluster snapshot
This data type is used as a response element in the DescribeDBClusterSnapshots action.
AvailabilityZones (list) --
Provides the list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
DBClusterSnapshotIdentifier (string) --
Specifies the identifier for the DB cluster snapshot.
DBClusterIdentifier (string) --
Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
SnapshotCreateTime (datetime) --
Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
Engine (string) --
Specifies the name of the database engine for this DB cluster snapshot.
EngineMode (string) --
Provides the engine mode of the database engine for this DB cluster snapshot.
AllocatedStorage (integer) --
Specifies the allocated storage size in gibibytes (GiB).
Status (string) --
Specifies the status of this DB cluster snapshot. Valid statuses are the following:
availablecopyingcreatingPort (integer) --
Specifies the port that the DB cluster was listening on at the time of the snapshot.
VpcId (string) --
Provides the VPC ID associated with the DB cluster snapshot.
ClusterCreateTime (datetime) --
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
MasterUsername (string) --
Provides the master username for this DB cluster snapshot.
EngineVersion (string) --
Provides the version of the database engine for this DB cluster snapshot.
LicenseModel (string) --
Provides the license model information for this DB cluster snapshot.
SnapshotType (string) --
Provides the type of the DB cluster snapshot.
PercentProgress (integer) --
Specifies the percentage of the estimated data that has been transferred.
StorageEncrypted (boolean) --
Specifies whether the DB cluster snapshot is encrypted.
KmsKeyId (string) --
If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
DBClusterSnapshotArn (string) --
The Amazon Resource Name (ARN) for the DB cluster snapshot.
SourceDBClusterSnapshotArn (string) --
If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.
IAMDatabaseAuthenticationEnabled (boolean) --
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
TagList (list) --
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Exceptions
RDS.Client.exceptions.DBClusterSnapshotNotFoundFaultExamples
This example lists settings for the specified, manually-created cluster snapshot.
response = client.describe_db_cluster_snapshots(
DBClusterSnapshotIdentifier='mydbclustersnapshot',
SnapshotType='manual',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
describe_db_clusters(**kwargs)¶Returns information about Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide .
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide .
This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
See also: AWS API Documentation
Request Syntax
response = client.describe_db_clusters(
DBClusterIdentifier='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string',
IncludeShared=True|False
)
The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.
Constraints:
A filter that specifies one or more DB clusters to describe.
Supported filters:
clone-group-id - Accepts clone group identifiers. The results list only includes information about the DB clusters associated with these clone groups.db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB clusters identified by these ARNs.domain - Accepts Active Directory directory IDs. The results list only includes information about the DB clusters associated with these domains.engine - Accepts engine names. The results list only includes information about the DB clusters for these engines.A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
DescribeDBClusters 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': [
{
'AllocatedStorage': 123,
'AvailabilityZones': [
'string',
],
'BackupRetentionPeriod': 123,
'CharacterSetName': 'string',
'DatabaseName': 'string',
'DBClusterIdentifier': 'string',
'DBClusterParameterGroup': 'string',
'DBSubnetGroup': 'string',
'Status': 'string',
'AutomaticRestartTime': datetime(2015, 1, 1),
'PercentProgress': 'string',
'EarliestRestorableTime': datetime(2015, 1, 1),
'Endpoint': 'string',
'ReaderEndpoint': 'string',
'CustomEndpoints': [
'string',
],
'MultiAZ': True|False,
'Engine': 'string',
'EngineVersion': 'string',
'LatestRestorableTime': datetime(2015, 1, 1),
'Port': 123,
'MasterUsername': 'string',
'DBClusterOptionGroupMemberships': [
{
'DBClusterOptionGroupName': 'string',
'Status': 'string'
},
],
'PreferredBackupWindow': 'string',
'PreferredMaintenanceWindow': 'string',
'ReplicationSourceIdentifier': 'string',
'ReadReplicaIdentifiers': [
'string',
],
'DBClusterMembers': [
{
'DBInstanceIdentifier': 'string',
'IsClusterWriter': True|False,
'DBClusterParameterGroupStatus': 'string',
'PromotionTier': 123
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'HostedZoneId': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbClusterResourceId': 'string',
'DBClusterArn': 'string',
'AssociatedRoles': [
{
'RoleArn': 'string',
'Status': 'string',
'FeatureName': 'string'
},
],
'IAMDatabaseAuthenticationEnabled': True|False,
'CloneGroupId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'EarliestBacktrackTime': datetime(2015, 1, 1),
'BacktrackWindow': 123,
'BacktrackConsumedChangeRecords': 123,
'EnabledCloudwatchLogsExports': [
'string',
],
'Capacity': 123,
'EngineMode': 'string',
'ScalingConfigurationInfo': {
'MinCapacity': 123,
'MaxCapacity': 123,
'AutoPause': True|False,
'SecondsUntilAutoPause': 123,
'TimeoutAction': 'string',
'SecondsBeforeTimeout': 123
},
'DeletionProtection': True|False,
'HttpEndpointEnabled': True|False,
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'CopyTagsToSnapshot': True|False,
'CrossAccountClone': True|False,
'DomainMemberships': [
{
'Domain': 'string',
'Status': 'string',
'FQDN': 'string',
'IAMRoleName': 'string'
},
],
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'GlobalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'unknown',
'GlobalWriteForwardingRequested': True|False,
'PendingModifiedValues': {
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
},
'DBClusterIdentifier': 'string',
'MasterUserPassword': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'EngineVersion': 'string'
},
'DBClusterInstanceClass': 'string',
'StorageType': 'string',
'Iops': 123,
'PubliclyAccessible': True|False,
'AutoMinorVersionUpgrade': True|False,
'MonitoringInterval': 123,
'MonitoringRoleArn': 'string',
'PerformanceInsightsEnabled': True|False,
'PerformanceInsightsKMSKeyId': 'string',
'PerformanceInsightsRetentionPeriod': 123,
'ServerlessV2ScalingConfiguration': {
'MinCapacity': 123.0,
'MaxCapacity': 123.0
}
},
]
}
Response Structure
(dict) --
Contains the result of a successful invocation of the DescribeDBClusters action.
Marker (string) --
A pagination token that can be used in a later DescribeDBClusters request.
DBClusters (list) --
Contains a list of DB clusters for the user.
(dict) --
Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
For an Amazon Aurora DB cluster, this data type is used as a response element in the operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , FailoverDBCluster , ModifyDBCluster , PromoteReadReplicaDBCluster , RestoreDBClusterFromS3 , RestoreDBClusterFromSnapshot , RestoreDBClusterToPointInTime , StartDBCluster , and StopDBCluster .
For a Multi-AZ DB cluster, this data type is used as a response element in the operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , FailoverDBCluster , ModifyDBCluster , RebootDBCluster , RestoreDBClusterFromSnapshot , and RestoreDBClusterToPointInTime .
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
AllocatedStorage (integer) --
For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
AvailabilityZones (list) --
Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.
BackupRetentionPeriod (integer) --
Specifies the number of days for which automatic DB snapshots are retained.
CharacterSetName (string) --
If present, specifies the name of the character set that this cluster is associated with.
DatabaseName (string) --
Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.
DBClusterIdentifier (string) --
Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
DBClusterParameterGroup (string) --
Specifies the name of the DB cluster parameter group for the DB cluster.
DBSubnetGroup (string) --
Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
Status (string) --
Specifies the current state of this DB cluster.
AutomaticRestartTime (datetime) --
The time when a stopped DB cluster is restarted automatically.
PercentProgress (string) --
Specifies the progress of the operation as a percentage.
EarliestRestorableTime (datetime) --
The earliest time to which a database can be restored with point-in-time restore.
Endpoint (string) --
Specifies the connection endpoint for the primary instance of the DB cluster.
ReaderEndpoint (string) --
The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.
If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
CustomEndpoints (list) --
Identifies all custom endpoints associated with the cluster.
MultiAZ (boolean) --
Specifies whether the DB cluster has instances in multiple Availability Zones.
Engine (string) --
The name of the database engine to be used for this DB cluster.
EngineVersion (string) --
Indicates the database engine version.
LatestRestorableTime (datetime) --
Specifies the latest time to which a database can be restored with point-in-time restore.
Port (integer) --
Specifies the port that the database engine is listening on.
MasterUsername (string) --
Contains the master username for the DB cluster.
DBClusterOptionGroupMemberships (list) --
Provides the list of option group memberships for this DB cluster.
(dict) --
Contains status information for a DB cluster option group.
DBClusterOptionGroupName (string) --
Specifies the name of the DB cluster option group.
Status (string) --
Specifies the status of the DB cluster option group.
PreferredBackupWindow (string) --
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
ReplicationSourceIdentifier (string) --
Contains the identifier of the source DB cluster if this DB cluster is a read replica.
ReadReplicaIdentifiers (list) --
Contains one or more identifiers of the read replicas associated with this DB cluster.
DBClusterMembers (list) --
Provides the list of instances that make up the DB cluster.
(dict) --
Contains information about an instance that is part of a DB cluster.
DBInstanceIdentifier (string) --
Specifies the instance identifier for this member of the DB cluster.
IsClusterWriter (boolean) --
Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
DBClusterParameterGroupStatus (string) --
Specifies the status of the DB cluster parameter group for this member of the DB cluster.
PromotionTier (integer) --
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .
VpcSecurityGroups (list) --
Provides a list of VPC security groups that the DB cluster belongs to.
(dict) --
This data type is used as a response element for queries on VPC security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The membership status of the VPC security group.
Currently, the only valid status is active .
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
StorageEncrypted (boolean) --
Specifies whether the DB cluster is encrypted.
KmsKeyId (string) --
If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
DbClusterResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for the DB cluster.
AssociatedRoles (list) --
Provides a list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.
(dict) --
Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB cluster.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
Status (string) --
Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other Amazon Web Services on your behalf.PENDING - the IAM role ARN is being associated with the DB cluster.INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other Amazon Web Services on your behalf.FeatureName (string) --
The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion .
IAMDatabaseAuthenticationEnabled (boolean) --
A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
CloneGroupId (string) --
Identifies the clone group to which the DB cluster is associated.
ClusterCreateTime (datetime) --
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
EarliestBacktrackTime (datetime) --
The earliest time to which a DB cluster can be backtracked.
BacktrackWindow (integer) --
The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.
BacktrackConsumedChangeRecords (integer) --
The number of change records stored for Backtrack.
EnabledCloudwatchLogsExports (list) --
A list of log types that this DB cluster is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.
Capacity (integer) --
The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 (zero) when the cluster is paused.
For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide .
EngineMode (string) --
The DB engine mode of the DB cluster, either provisioned , serverless , parallelquery , global , or multimaster .
For more information, see CreateDBCluster .
ScalingConfigurationInfo (dict) --
Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.
For more information, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide .
MinCapacity (integer) --
The minimum capacity for an Aurora DB cluster in serverless DB engine mode.
MaxCapacity (integer) --
The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
AutoPause (boolean) --
A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.
When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.
SecondsUntilAutoPause (integer) --
The remaining amount of time, in seconds, before the Aurora DB cluster in serverless mode is paused. A DB cluster can be paused only when it's idle (it has no connections).
TimeoutAction (string) --
The action that occurs when Aurora times out while attempting to change the capacity of an Aurora Serverless v1 cluster. The value is either ForceApplyCapacityChange or RollbackCapacityChange .
ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.
RollbackCapacityChangeignores the capacity change if a scaling point isn't found in the timeout period.
SecondsBeforeTimeout (integer) --
The number of seconds before scaling times out. What happens when an attempted scaling action times out is determined by the TimeoutAction setting.
DeletionProtection (boolean) --
Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
HttpEndpointEnabled (boolean) --
A value that indicates whether the HTTP endpoint for an Aurora Serverless v1 DB cluster is enabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide .
ActivityStreamMode (string) --
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.
ActivityStreamStatus (string) --
The status of the database activity stream.
ActivityStreamKmsKeyId (string) --
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
ActivityStreamKinesisStreamName (string) --
The name of the Amazon Kinesis data stream used for the database activity stream.
CopyTagsToSnapshot (boolean) --
Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.
CrossAccountClone (boolean) --
Specifies whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
DomainMemberships (list) --
The Active Directory Domain membership records associated with the DB cluster.
(dict) --
An Active Directory Domain membership record associated with the DB instance or cluster.
Domain (string) --
The identifier of the Active Directory Domain.
Status (string) --
The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.
FQDN (string) --
The fully qualified domain name of the Active Directory Domain.
IAMRoleName (string) --
The name of the IAM role to be used when making API calls to the Directory Service.
TagList (list) --
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
GlobalWriteForwardingStatus (string) --
Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.
GlobalWriteForwardingRequested (boolean) --
Specifies whether you have requested to enable write forwarding for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.
PendingModifiedValues (dict) --
A value that specifies that changes to the DB cluster are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
PendingCloudwatchLogsExports (dict) --
A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.
LogTypesToEnable (list) --
Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.
LogTypesToDisable (list) --
Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.
DBClusterIdentifier (string) --
The DBClusterIdentifier value for the DB cluster.
MasterUserPassword (string) --
The master credentials for the DB cluster.
IAMDatabaseAuthenticationEnabled (boolean) --
A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
EngineVersion (string) --
The database engine version.
DBClusterInstanceClass (string) --
The name of the compute and memory capacity class of the DB instance.
This setting is only for non-Aurora Multi-AZ DB clusters.
StorageType (string) --
The storage type associated with the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
Iops (integer) --
The Provisioned IOPS (I/O operations per second) value.
This setting is only for non-Aurora Multi-AZ DB clusters.
PubliclyAccessible (boolean) --
Specifies the accessibility options for the DB instance.
When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance .
This setting is only for non-Aurora Multi-AZ DB clusters.
AutoMinorVersionUpgrade (boolean) --
A value that indicates that minor version patches are applied automatically.
This setting is only for non-Aurora Multi-AZ DB clusters.
MonitoringInterval (integer) --
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
MonitoringRoleArn (string) --
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
This setting is only for non-Aurora Multi-AZ DB clusters.
PerformanceInsightsEnabled (boolean) --
True if Performance Insights is enabled for the DB cluster, and otherwise false.
This setting is only for non-Aurora Multi-AZ DB clusters.
PerformanceInsightsKMSKeyId (string) --
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
This setting is only for non-Aurora Multi-AZ DB clusters.
PerformanceInsightsRetentionPeriod (integer) --
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
For example, the following values are valid:
This setting is only for non-Aurora Multi-AZ DB clusters.
ServerlessV2ScalingConfiguration (dict) --
Shows the scaling configuration for an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide .
MinCapacity (float) --
The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.
MaxCapacity (float) --
The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128.
Exceptions
RDS.Client.exceptions.DBClusterNotFoundFaultExamples
This example lists settings for the specified DB cluster.
response = client.describe_db_clusters(
DBClusterIdentifier='mynewdbcluster',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
describe_db_engine_versions(**kwargs)¶Returns a list of the available DB engines.
See also: AWS API Documentation
Request Syntax
response = 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,
IncludeAll=True|False
)
The database engine to return.
Valid Values:
aurora (for MySQL 5.6-compatible Aurora)aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)aurora-postgresqlmariadbmysqloracle-eeoracle-ee-cdboracle-se2oracle-se2-cdbpostgressqlserver-eesqlserver-sesqlserver-exsqlserver-webThe database engine version to return.
Example: 5.1.49
The name of a specific DB parameter group family to return details for.
Constraints:
A filter that specifies one or more DB engine versions to describe.
Supported filters:
db-parameter-group-family - Accepts parameter groups family names. The results list only includes information about the DB engine versions for these parameter group families.engine - Accepts engine names. The results list only includes information about the DB engine versions for these engines.engine-mode - Accepts DB engine modes. The results list only includes information about the DB engine versions for these engine modes. Valid DB engine modes are the following:globalmultimasterparallelqueryprovisionedserverlessengine-version - Accepts engine versions. The results list only includes information about the DB engine versions for these engine versions.status - Accepts engine version statuses. The results list only includes information about the DB engine versions for these statuses. Valid statuses are the following:availabledeprecatedA filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
MaxRecords .A value that indicates whether to list the supported character sets for each engine version.
If this parameter is enabled and the requested engine supports the CharacterSetName parameter for CreateDBInstance , the response includes a list of supported character sets for each engine version.
For RDS Custom, the default is not to list supported character sets. If you set ListSupportedCharacterSets to true , RDS Custom returns no results.
A value that indicates whether to list the supported time zones for each engine version.
If this parameter is enabled and the requested engine supports the TimeZone parameter for CreateDBInstance , the response includes a list of supported time zones for each engine version.
For RDS Custom, the default is not to list supported time zones. If you set ListSupportedTimezones to true , RDS Custom returns no results.
dict
Response Syntax
{
'Marker': 'string',
'DBEngineVersions': [
{
'Engine': 'string',
'EngineVersion': 'string',
'DBParameterGroupFamily': 'string',
'DBEngineDescription': 'string',
'DBEngineVersionDescription': 'string',
'DefaultCharacterSet': {
'CharacterSetName': 'string',
'CharacterSetDescription': 'string'
},
'SupportedCharacterSets': [
{
'CharacterSetName': 'string',
'CharacterSetDescription': 'string'
},
],
'SupportedNcharCharacterSets': [
{
'CharacterSetName': 'string',
'CharacterSetDescription': 'string'
},
],
'ValidUpgradeTarget': [
{
'Engine': 'string',
'EngineVersion': 'string',
'Description': 'string',
'AutoUpgrade': True|False,
'IsMajorVersionUpgrade': True|False,
'SupportedEngineModes': [
'string',
],
'SupportsParallelQuery': True|False,
'SupportsGlobalDatabases': True|False,
'SupportsBabelfish': True|False
},
],
'SupportedTimezones': [
{
'TimezoneName': 'string'
},
],
'ExportableLogTypes': [
'string',
],
'SupportsLogExportsToCloudwatchLogs': True|False,
'SupportsReadReplica': True|False,
'SupportedEngineModes': [
'string',
],
'SupportedFeatureNames': [
'string',
],
'Status': 'string',
'SupportsParallelQuery': True|False,
'SupportsGlobalDatabases': True|False,
'MajorEngineVersion': 'string',
'DatabaseInstallationFilesS3BucketName': 'string',
'DatabaseInstallationFilesS3Prefix': 'string',
'DBEngineVersionArn': 'string',
'KMSKeyId': 'string',
'CreateTime': datetime(2015, 1, 1),
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'SupportsBabelfish': True|False
},
]
}
Response Structure
(dict) --
Contains the result of a successful invocation of the DescribeDBEngineVersions action.
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) --
A list of DBEngineVersion elements.
(dict) --
This data type is used as a response element in the action DescribeDBEngineVersions .
Engine (string) --
The name of the database engine.
EngineVersion (string) --
The version number of the database engine.
DBParameterGroupFamily (string) --
The name of the DB parameter group family for the database engine.
DBEngineDescription (string) --
The description of the database engine.
DBEngineVersionDescription (string) --
The description of the database engine version.
DefaultCharacterSet (dict) --
The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API isn't specified.
CharacterSetName (string) --
The name of the character set.
CharacterSetDescription (string) --
The description of the character set.
SupportedCharacterSets (list) --
A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance operation.
(dict) --
This data type is used as a response element in the action DescribeDBEngineVersions .
CharacterSetName (string) --
The name of the character set.
CharacterSetDescription (string) --
The description of the character set.
SupportedNcharCharacterSets (list) --
A list of the character sets supported by the Oracle DB engine for the NcharCharacterSetName parameter of the CreateDBInstance operation.
(dict) --
This data type is used as a response element in the action DescribeDBEngineVersions .
CharacterSetName (string) --
The name of the character set.
CharacterSetDescription (string) --
The description of the character set.
ValidUpgradeTarget (list) --
A list of engine versions that this database engine version can be upgraded to.
(dict) --
The version of the database engine that a DB 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 a DB 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 upgrading to the target version requires upgrading the major version of the database engine.
SupportedEngineModes (list) --
A list of the supported DB engine modes for the target engine version.
SupportsParallelQuery (boolean) --
A value that indicates whether you can use Aurora parallel query with the target engine version.
SupportsGlobalDatabases (boolean) --
A value that indicates whether you can use Aurora global databases with the target engine version.
SupportsBabelfish (boolean) --
A value that indicates whether you can use Babelfish for Aurora PostgreSQL with the target engine version.
SupportedTimezones (list) --
A list of the time zones supported by this engine for the Timezone parameter of the CreateDBInstance action.
(dict) --
A time zone associated with a DBInstance or a DBSnapshot . This data type is an element in the response to the DescribeDBInstances , the DescribeDBSnapshots , and the DescribeDBEngineVersions actions.
TimezoneName (string) --
The name of the time zone.
ExportableLogTypes (list) --
The types of logs that the database engine has available for export to CloudWatch Logs.
SupportsLogExportsToCloudwatchLogs (boolean) --
A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.
SupportsReadReplica (boolean) --
Indicates whether the database engine version supports read replicas.
SupportedEngineModes (list) --
A list of the supported DB engine modes.
SupportedFeatureNames (list) --
A list of features supported by the DB engine.
The supported features vary by DB engine and DB engine version.
To determine the supported features for a specific DB engine and DB engine version using the CLI, use the following command:
aws rds describe-db-engine-versions --engine <engine_name> --engine-version <engine_version>
For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, use the following command:
aws rds describe-db-engine-versions --engine postgres --engine-version 13.3
The supported features are listed under SupportedFeatureNames in the output.
Status (string) --
The status of the DB engine version, either available or deprecated .
SupportsParallelQuery (boolean) --
A value that indicates whether you can use Aurora parallel query with a specific DB engine version.
SupportsGlobalDatabases (boolean) --
A value that indicates whether you can use Aurora global databases with a specific DB engine version.
MajorEngineVersion (string) --
The major engine version of the CEV.
DatabaseInstallationFilesS3BucketName (string) --
The name of the Amazon S3 bucket that contains your database installation files.
DatabaseInstallationFilesS3Prefix (string) --
The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.
DBEngineVersionArn (string) --
The ARN of the custom engine version.
KMSKeyId (string) --
The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.
CreateTime (datetime) --
The creation time of the DB engine version.
TagList (list) --
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
SupportsBabelfish (boolean) --
A value that indicates whether the engine version supports Babelfish for Aurora PostgreSQL.
Examples
This example lists settings for the specified DB engine version.
response = client.describe_db_engine_versions(
DBParameterGroupFamily='mysql5.6',
DefaultOnly=True,
Engine='mysql',
EngineVersion='5.6',
ListSupportedCharacterSets=True,
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
describe_db_instance_automated_backups(**kwargs)¶Displays backups for both current and deleted instances. For example, use this operation to find details about automated backups for previously deleted instances. Current instances with retention periods greater than zero (0) are returned for both the DescribeDBInstanceAutomatedBackups and DescribeDBInstances operations.
All parameters are optional.
See also: AWS API Documentation
Request Syntax
response = client.describe_db_instance_automated_backups(
DbiResourceId='string',
DBInstanceIdentifier='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string',
DBInstanceAutomatedBackupsArn='string'
)
A filter that specifies which resources to return based on status.
Supported filters are the following:
statusactive - automated backups for current instancesretained - automated backups for deleted instances and after backup replication is stoppedcreating - automated backups that are waiting for the first automated snapshot to be availabledb-instance-id - Accepts DB instance identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance automated backups identified by these ARNs.dbi-resource-id - Accepts DB resource identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance resources identified by these ARNs.Returns all resources by default. The status for each resource is specified in the response.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.MaxRecords .The Amazon Resource Name (ARN) of the replicated automated backups, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE .
This setting doesn't apply to RDS Custom.
dict
Response Syntax
{
'Marker': 'string',
'DBInstanceAutomatedBackups': [
{
'DBInstanceArn': 'string',
'DbiResourceId': 'string',
'Region': 'string',
'DBInstanceIdentifier': 'string',
'RestoreWindow': {
'EarliestTime': datetime(2015, 1, 1),
'LatestTime': datetime(2015, 1, 1)
},
'AllocatedStorage': 123,
'Status': 'string',
'Port': 123,
'AvailabilityZone': 'string',
'VpcId': 'string',
'InstanceCreateTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'LicenseModel': 'string',
'Iops': 123,
'OptionGroupName': 'string',
'TdeCredentialArn': 'string',
'Encrypted': True|False,
'StorageType': 'string',
'KmsKeyId': 'string',
'Timezone': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'BackupRetentionPeriod': 123,
'DBInstanceAutomatedBackupsArn': 'string',
'DBInstanceAutomatedBackupsReplications': [
{
'DBInstanceAutomatedBackupsArn': 'string'
},
],
'BackupTarget': 'string'
},
]
}
Response Structure
(dict) --
Contains the result of a successful invocation of the DescribeDBInstanceAutomatedBackups action.
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 .
DBInstanceAutomatedBackups (list) --
A list of DBInstanceAutomatedBackup instances.
(dict) --
An automated backup of a DB instance. It consists of system backups, transaction logs, and the database instance properties that existed at the time you deleted the source instance.
DBInstanceArn (string) --
The Amazon Resource Name (ARN) for the automated backups.
DbiResourceId (string) --
The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
Region (string) --
The Amazon Web Services Region associated with the automated backup.
DBInstanceIdentifier (string) --
The customer id of the instance that is/was associated with the automated backup.
RestoreWindow (dict) --
Earliest and latest time an instance can be restored to.
EarliestTime (datetime) --
The earliest time you can restore an instance to.
LatestTime (datetime) --
The latest time you can restore an instance to.
AllocatedStorage (integer) --
Specifies the allocated storage size in gibibytes (GiB).
Status (string) --
Provides a list of status information for an automated backup:
active - automated backups for current instancesretained - automated backups for deleted instancescreating - automated backups that are waiting for the first automated snapshot to be available.Port (integer) --
The port number that the automated backup used for connections.
Default: Inherits from the source DB instance
Valid Values: 1150-65535
AvailabilityZone (string) --
The Availability Zone that the automated backup was created in. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones .
VpcId (string) --
Provides the VPC ID associated with the DB instance
InstanceCreateTime (datetime) --
Provides the date and time that the DB instance was created.
MasterUsername (string) --
The license model of an automated backup.
Engine (string) --
The name of the database engine for this automated backup.
EngineVersion (string) --
The version of the database engine for the automated backup.
LicenseModel (string) --
License model information for the automated backup.
Iops (integer) --
The IOPS (I/O operations per second) value for the automated backup.
OptionGroupName (string) --
The option group the automated backup is associated with. If omitted, the default option group for the engine specified is used.
TdeCredentialArn (string) --
The ARN from the key store with which the automated backup is associated for TDE encryption.
Encrypted (boolean) --
Specifies whether the automated backup is encrypted.
StorageType (string) --
Specifies the storage type associated with the automated backup.
KmsKeyId (string) --
The Amazon Web Services KMS key ID for an automated backup.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
Timezone (string) --
The time zone of the automated backup. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.
IAMDatabaseAuthenticationEnabled (boolean) --
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
BackupRetentionPeriod (integer) --
The retention period for the automated backups.
DBInstanceAutomatedBackupsArn (string) --
The Amazon Resource Name (ARN) for the replicated automated backups.
DBInstanceAutomatedBackupsReplications (list) --
The list of replications to different Amazon Web Services Regions associated with the automated backup.
(dict) --
Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties.
DBInstanceAutomatedBackupsArn (string) --
The Amazon Resource Name (ARN) of the replicated automated backups.
BackupTarget (string) --
Specifies where automated backups are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
Exceptions
RDS.Client.exceptions.DBInstanceAutomatedBackupNotFoundFaultdescribe_db_instances(**kwargs)¶Returns information about provisioned RDS instances. This API supports pagination.
Note
This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
See also: AWS API Documentation
Request Syntax
response = client.describe_db_instances(
DBInstanceIdentifier='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
The user-supplied instance identifier. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case-sensitive.
Constraints:
A filter that specifies one or more DB instances to describe.
Supported filters:
db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB instances associated with the DB clusters identified by these ARNs.db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list only includes information about the DB instances identified by these ARNs.dbi-resource-id - Accepts DB instance resource identifiers. The results list will only include information about the DB instances identified by these DB instance resource identifiers.domain - Accepts Active Directory directory IDs. The results list only includes information about the DB instances associated with these domains.engine - Accepts engine names. The results list only includes information about the DB instances for these engines.A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
DescribeDBInstances 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',
'AutomaticRestartTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'DBName': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123,
'HostedZoneId': 'string'
},
'AllocatedStorage': 123,
'InstanceCreateTime': datetime(2015, 1, 1),
'PreferredBackupWindow': 'string',
'BackupRetentionPeriod': 123,
'DBSecurityGroups': [
{
'DBSecurityGroupName': 'string',
'Status': 'string'
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'DBParameterGroups': [
{
'DBParameterGroupName': 'string',
'ParameterApplyStatus': 'string'
},
],
'AvailabilityZone': 'string',
'DBSubnetGroup': {
'DBSubnetGroupName': 'string',
'DBSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetOutpost': {
'Arn': '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',
]
},
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
],
'IAMDatabaseAuthenticationEnabled': True|False,
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1)
},
'LatestRestorableTime': datetime(2015, 1, 1),
'MultiAZ': True|False,
'EngineVersion': 'string',
'AutoMinorVersionUpgrade': True|False,
'ReadReplicaSourceDBInstanceIdentifier': 'string',
'ReadReplicaDBInstanceIdentifiers': [
'string',
],
'ReadReplicaDBClusterIdentifiers': [
'string',
],
'ReplicaMode': 'open-read-only'|'mounted',
'LicenseModel': 'string',
'Iops': 123,
'OptionGroupMemberships': [
{
'OptionGroupName': 'string',
'Status': 'string'
},
],
'CharacterSetName': 'string',
'NcharCharacterSetName': 'string',
'SecondaryAvailabilityZone': 'string',
'PubliclyAccessible': True|False,
'StatusInfos': [
{
'StatusType': 'string',
'Normal': True|False,
'Status': 'string',
'Message': 'string'
},
],
'StorageType': 'string',
'TdeCredentialArn': 'string',
'DbInstancePort': 123,
'DBClusterIdentifier': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbiResourceId': 'string',
'CACertificateIdentifier': 'string',
'DomainMemberships': [
{
'Domain': 'string',
'Status': 'string',
'FQDN': 'string',
'IAMRoleName': 'string'
},
],
'CopyTagsToSnapshot': True|False,
'MonitoringInterval': 123,
'EnhancedMonitoringResourceArn': 'string',
'MonitoringRoleArn': 'string',
'PromotionTier': 123,
'DBInstanceArn': 'string',
'Timezone': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'PerformanceInsightsEnabled': True|False,
'PerformanceInsightsKMSKeyId': 'string',
'PerformanceInsightsRetentionPeriod': 123,
'EnabledCloudwatchLogsExports': [
'string',
],
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
],
'DeletionProtection': True|False,
'AssociatedRoles': [
{
'RoleArn': 'string',
'FeatureName': 'string',
'Status': 'string'
},
],
'ListenerEndpoint': {
'Address': 'string',
'Port': 123,
'HostedZoneId': 'string'
},
'MaxAllocatedStorage': 123,
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'DBInstanceAutomatedBackupsReplications': [
{
'DBInstanceAutomatedBackupsArn': 'string'
},
],
'CustomerOwnedIpEnabled': True|False,
'AwsBackupRecoveryPointArn': 'string',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamEngineNativeAuditFieldsIncluded': True|False,
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1),
'CustomIamInstanceProfile': 'string',
'BackupTarget': 'string',
'NetworkType': 'string',
'ActivityStreamPolicyStatus': 'locked'|'unlocked'|'locking-policy'|'unlocking-policy'
},
]
}
Response Structure
(dict) --
Contains the result of a successful invocation of the DescribeDBInstances action.
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) --
A list of DBInstance instances.
(dict) --
Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations CreateDBInstance , CreateDBInstanceReadReplica , DeleteDBInstance , DescribeDBInstances , ModifyDBInstance , PromoteReadReplica , RebootDBInstance , RestoreDBInstanceFromDBSnapshot , RestoreDBInstanceFromS3 , RestoreDBInstanceToPointInTime , StartDBInstance , and StopDBInstance .
DBInstanceIdentifier (string) --
Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
DBInstanceClass (string) --
Contains the name of the compute and memory capacity class of the DB instance.
Engine (string) --
The name of the database engine to be used for this DB instance.
DBInstanceStatus (string) --
Specifies the current state of this database.
For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.
AutomaticRestartTime (datetime) --
The time when a stopped DB instance is restarted automatically.
MasterUsername (string) --
Contains the master username for the DB instance.
DBName (string) --
The meaning of this parameter differs according to the database engine you use.
MySQL, MariaDB, SQL Server, PostgreSQL
Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
Type: String
Oracle
Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
Endpoint (dict) --
Specifies the connection endpoint.
Note
The endpoint might not be shown for instances whose status is creating .
Address (string) --
Specifies the DNS address of the DB 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.
AllocatedStorage (integer) --
Specifies the allocated storage size specified in gibibytes (GiB).
InstanceCreateTime (datetime) --
Provides the date and time the DB 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 DB snapshots are retained.
DBSecurityGroups (list) --
A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
(dict) --
This data type is used as a response element in the following actions:
ModifyDBInstanceRebootDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceToPointInTimeDBSecurityGroupName (string) --
The name of the DB security group.
Status (string) --
The status of the DB security group.
VpcSecurityGroups (list) --
Provides a list of VPC security group elements that the DB instance belongs to.
(dict) --
This data type is used as a response element for queries on VPC security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The membership status of the VPC security group.
Currently, the only valid status is active .
DBParameterGroups (list) --
Provides the list of DB parameter groups applied to this DB instance.
(dict) --
The status of the DB parameter group.
This data type is used as a response element in the following actions:
CreateDBInstanceCreateDBInstanceReadReplicaDeleteDBInstanceModifyDBInstanceRebootDBInstanceRestoreDBInstanceFromDBSnapshotDBParameterGroupName (string) --
The name of the DB parameter group.
ParameterApplyStatus (string) --
The status of parameter updates.
AvailabilityZone (string) --
Specifies the name of the Availability Zone the DB instance is located in.
DBSubnetGroup (dict) --
Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
DBSubnetGroupName (string) --
The name of the DB subnet group.
DBSubnetGroupDescription (string) --
Provides the description of the DB subnet group.
VpcId (string) --
Provides the VpcId of the DB subnet group.
SubnetGroupStatus (string) --
Provides the status of the DB subnet group.
Subnets (list) --
Contains a list of Subnet elements.
(dict) --
This data type is used as a response element for the DescribeDBSubnetGroups operation.
SubnetIdentifier (string) --
The identifier of the subnet.
SubnetAvailabilityZone (dict) --
Contains Availability Zone information.
This data type is used as an element in the OrderableDBInstanceOption data type.
Name (string) --
The name of the Availability Zone.
SubnetOutpost (dict) --
If the subnet is associated with an Outpost, this value specifies the Outpost.
For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
Arn (string) --
The Amazon Resource Name (ARN) of the Outpost.
SubnetStatus (string) --
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:
IPV4DUALA DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
PendingModifiedValues (dict) --
A value that specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
DBInstanceClass (string) --
The name of the compute and memory capacity class for the DB instance.
AllocatedStorage (integer) --
The allocated storage size for the DB instance specified in gibibytes (GiB).
MasterUserPassword (string) --
The master credentials for the DB instance.
Port (integer) --
The port for the DB instance.
BackupRetentionPeriod (integer) --
The number of days for which automated backups are retained.
MultiAZ (boolean) --
A value that indicates that the Single-AZ DB instance will change to a Multi-AZ deployment.
EngineVersion (string) --
The database engine version.
LicenseModel (string) --
The license model for the DB instance.
Valid values: license-included | bring-your-own-license | general-public-license
Iops (integer) --
The Provisioned IOPS value for the DB instance.
DBInstanceIdentifier (string) --
The database identifier for the DB instance.
StorageType (string) --
The storage type of the DB instance.
CACertificateIdentifier (string) --
The identifier of the CA certificate for the DB instance.
DBSubnetGroupName (string) --
The DB subnet group for the DB instance.
PendingCloudwatchLogsExports (dict) --
A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.
LogTypesToEnable (list) --
Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.
LogTypesToDisable (list) --
Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.
ProcessorFeatures (list) --
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
(dict) --
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstanceModifyDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceFromS3RestoreDBInstanceToPointInTimeYou can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstancesDescribeDBSnapshotsDescribeValidDBInstanceModificationsIf you call DescribeDBInstances , ProcessorFeature returns non-null values only if the following conditions are met:
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
Name (string) --
The name of the processor feature. Valid names are coreCount and threadsPerCore .
Value (string) --
The value of a processor feature name.
IAMDatabaseAuthenticationEnabled (boolean) --
Whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
AutomationMode (string) --
The automation mode of the RDS Custom DB instance: full or all-paused . If full , the DB instance automates monitoring and instance recovery. If all-paused , the instance pauses automation for the duration set by --resume-full-automation-mode-minutes .
ResumeFullAutomationModeTime (datetime) --
The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
LatestRestorableTime (datetime) --
Specifies the latest time to which a database can be restored with point-in-time restore.
MultiAZ (boolean) --
Specifies if the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom.
EngineVersion (string) --
Indicates the database engine version.
AutoMinorVersionUpgrade (boolean) --
A value that indicates that minor version patches are applied automatically.
ReadReplicaSourceDBInstanceIdentifier (string) --
Contains the identifier of the source DB instance if this DB instance is a read replica.
ReadReplicaDBInstanceIdentifiers (list) --
Contains one or more identifiers of the read replicas associated with this DB instance.
ReadReplicaDBClusterIdentifiers (list) --
Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn't contain information about cross-Region Aurora read replicas.
Note
Currently, each RDS DB instance can have only one Aurora read replica.
ReplicaMode (string) --
The open mode of an Oracle read replica. The default is open-read-only . For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide .
Note
This attribute is only supported in RDS for Oracle.
LicenseModel (string) --
License model information for this DB instance. This setting doesn't apply to RDS Custom.
Iops (integer) --
Specifies the Provisioned IOPS (I/O operations per second) value.
OptionGroupMemberships (list) --
Provides the list of option group memberships for this DB instance.
(dict) --
Provides information on the option groups the DB instance is a member of.
OptionGroupName (string) --
The name of the option group that the instance belongs to.
Status (string) --
The status of the DB instance's option group membership. Valid values are: in-sync , pending-apply , pending-removal , pending-maintenance-apply , pending-maintenance-removal , applying , removing , and failed .
CharacterSetName (string) --
If present, specifies the name of the character set that this instance is associated with.
NcharCharacterSetName (string) --
The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.
SecondaryAvailabilityZone (string) --
If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
PubliclyAccessible (boolean) --
Specifies the accessibility options for the DB instance.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance .
StatusInfos (list) --
The status of a read replica. If the instance isn't a read replica, this is blank.
(dict) --
Provides a list of status information for a DB instance.
StatusType (string) --
This value is currently "read replication."
Normal (boolean) --
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 DB instance. For a StatusType of read replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.
Message (string) --
Details of the error if there is an error for the instance. If the instance isn't in an error state, this value is blank.
StorageType (string) --
Specifies the storage type associated with DB instance.
TdeCredentialArn (string) --
The ARN from the key store with which the instance is associated for TDE encryption.
DbInstancePort (integer) --
Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.
DBClusterIdentifier (string) --
If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.
StorageEncrypted (boolean) --
Specifies whether the DB instance is encrypted.
KmsKeyId (string) --
If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
DbiResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB instance is accessed.
CACertificateIdentifier (string) --
The identifier of the CA certificate for this DB instance.
DomainMemberships (list) --
The Active Directory Domain membership records associated with the DB instance.
(dict) --
An Active Directory Domain membership record associated with the DB instance or cluster.
Domain (string) --
The identifier of the Active Directory Domain.
Status (string) --
The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.
FQDN (string) --
The fully qualified domain name of the Active Directory Domain.
IAMRoleName (string) --
The name of the IAM role to be used when making API calls to the Directory Service.
CopyTagsToSnapshot (boolean) --
Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see DBCluster .
MonitoringInterval (integer) --
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
EnhancedMonitoringResourceArn (string) --
The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
MonitoringRoleArn (string) --
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
PromotionTier (integer) --
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .
DBInstanceArn (string) --
The Amazon Resource Name (ARN) for the DB instance.
Timezone (string) --
The time zone of the DB instance. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.
IAMDatabaseAuthenticationEnabled (boolean) --
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
IAM database authentication can be enabled for the following database engines
PerformanceInsightsEnabled (boolean) --
True if Performance Insights is enabled for the DB instance, and otherwise false.
PerformanceInsightsKMSKeyId (string) --
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
PerformanceInsightsRetentionPeriod (integer) --
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
For example, the following values are valid:
EnabledCloudwatchLogsExports (list) --
A list of log types that this DB instance is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon RDS User Guide.
ProcessorFeatures (list) --
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
(dict) --
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstanceModifyDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceFromS3RestoreDBInstanceToPointInTimeYou can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstancesDescribeDBSnapshotsDescribeValidDBInstanceModificationsIf you call DescribeDBInstances , ProcessorFeature returns non-null values only if the following conditions are met:
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
Name (string) --
The name of the processor feature. Valid names are coreCount and threadsPerCore .
Value (string) --
The value of a processor feature name.
DeletionProtection (boolean) --
Indicates if the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance .
AssociatedRoles (list) --
The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
(dict) --
Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.
FeatureName (string) --
The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion .
Status (string) --
Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf.PENDING - the IAM role ARN is being associated with the DB instance.INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf.ListenerEndpoint (dict) --
Specifies the listener connection endpoint for SQL Server Always On.
Address (string) --
Specifies the DNS address of the DB 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.
MaxAllocatedStorage (integer) --
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
TagList (list) --
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
DBInstanceAutomatedBackupsReplications (list) --
The list of replicated automated backups associated with the DB instance.
(dict) --
Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties.
DBInstanceAutomatedBackupsArn (string) --
The Amazon Resource Name (ARN) of the replicated automated backups.
CustomerOwnedIpEnabled (boolean) --
Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide .
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide .
AwsBackupRecoveryPointArn (string) --
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
ActivityStreamStatus (string) --
The status of the database activity stream.
ActivityStreamKmsKeyId (string) --
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
ActivityStreamKinesisStreamName (string) --
The name of the Amazon Kinesis data stream used for the database activity stream.
ActivityStreamMode (string) --
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. RDS for Oracle always handles these events asynchronously.
ActivityStreamEngineNativeAuditFieldsIncluded (boolean) --
Indicates whether engine-native audit fields are included in the database activity stream.
AutomationMode (string) --
The automation mode of the RDS Custom DB instance: full or all paused . If full , the DB instance automates monitoring and instance recovery. If all paused , the instance pauses automation for the duration set by --resume-full-automation-mode-minutes .
ResumeFullAutomationModeTime (datetime) --
The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
CustomIamInstanceProfile (string) --
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
AWSRDSCustom .For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide .
BackupTarget (string) --
Specifies where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
NetworkType (string) --
The network type of the DB instance.
Valid values:
IPV4DUALThe network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide and Working with a DB instance in a VPC in the Amazon Aurora User Guide.
ActivityStreamPolicyStatus (string) --
The status of the policy state of the activity stream.
Exceptions
RDS.Client.exceptions.DBInstanceNotFoundFaultExamples
This example lists settings for the specified DB instance.
response = client.describe_db_instances(
DBInstanceIdentifier='mymysqlinstance',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
describe_db_log_files(**kwargs)¶Returns a list of DB log files for the DB instance.
This command doesn't apply to RDS Custom.
See also: AWS API Documentation
Request Syntax
response = client.describe_db_log_files(
DBInstanceIdentifier='string',
FilenameContains='string',
FileLastWritten=123,
FileSize=123,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
[REQUIRED]
The customer-assigned name of the DB instance that contains the log files you want to list.
Constraints:
This parameter isn't currently supported.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'DescribeDBLogFiles': [
{
'LogFileName': 'string',
'LastWritten': 123,
'Size': 123
},
],
'Marker': 'string'
}
Response Structure
(dict) --
The response from a call to DescribeDBLogFiles .
DescribeDBLogFiles (list) --
The DB log files returned.
(dict) --
This data type is used as a response element to DescribeDBLogFiles .
LogFileName (string) --
The name of the log file for the specified DB instance.
LastWritten (integer) --
A POSIX timestamp when the last log entry was written.
Size (integer) --
The size, in bytes, of the log file for the specified DB instance.
Marker (string) --
A pagination token that can be used in a later DescribeDBLogFiles request.
Exceptions
RDS.Client.exceptions.DBInstanceNotFoundFaultExamples
This example lists matching log file names for the specified DB instance, file name pattern, last write date in POSIX time with milleseconds, and minimum file size.
response = client.describe_db_log_files(
DBInstanceIdentifier='mymysqlinstance',
FileLastWritten=1470873600000,
FileSize=0,
FilenameContains='error',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
describe_db_parameter_groups(**kwargs)¶Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group.
See also: AWS API Documentation
Request Syntax
response = client.describe_db_parameter_groups(
DBParameterGroupName='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
The name of a specific DB parameter group to return details for.
Constraints:
This parameter isn't currently supported.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
DescribeDBParameterGroups 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',
'DBParameterGroups': [
{
'DBParameterGroupName': 'string',
'DBParameterGroupFamily': 'string',
'Description': 'string',
'DBParameterGroupArn': 'string'
},
]
}
Response Structure
(dict) --
Contains the result of a successful invocation of the DescribeDBParameterGroups action.
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 .
DBParameterGroups (list) --
A list of DBParameterGroup instances.
(dict) --
Contains the details of an Amazon RDS DB parameter group.
This data type is used as a response element in the DescribeDBParameterGroups action.
DBParameterGroupName (string) --
The name of the DB parameter group.
DBParameterGroupFamily (string) --
The name of the DB parameter group family that this DB parameter group is compatible with.
Description (string) --
Provides the customer-specified description for this DB parameter group.
DBParameterGroupArn (string) --
The Amazon Resource Name (ARN) for the DB parameter group.
Exceptions
RDS.Client.exceptions.DBParameterGroupNotFoundFaultExamples
This example lists information about the specified DB parameter group.
response = client.describe_db_parameter_groups(
DBParameterGroupName='mymysqlparametergroup',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
describe_db_parameters(**kwargs)¶Returns the detailed parameter list for a particular DB parameter group.
See also: AWS API Documentation
Request Syntax
response = client.describe_db_parameters(
DBParameterGroupName='string',
Source='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
[REQUIRED]
The name of a specific DB parameter group to return details for.
Constraints:
The parameter types to return.
Default: All parameter types returned
Valid Values: user | system | engine-default
This parameter isn't currently supported.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
DescribeDBParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .dict
Response Syntax
{
'Parameters': [
{
'ParameterName': 'string',
'ParameterValue': 'string',
'Description': 'string',
'Source': 'string',
'ApplyType': 'string',
'DataType': 'string',
'AllowedValues': 'string',
'IsModifiable': True|False,
'MinimumEngineVersion': 'string',
'ApplyMethod': 'immediate'|'pending-reboot',
'SupportedEngineModes': [
'string',
]
},
],
'Marker': 'string'
}
Response Structure
(dict) --
Contains the result of a successful invocation of the DescribeDBParameters action.
Parameters (list) --
A list of Parameter values.
(dict) --
This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions.
This data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions.
ParameterName (string) --
Specifies the name of the parameter.
ParameterValue (string) --
Specifies the value of the parameter.
Description (string) --
Provides a description of the parameter.
Source (string) --
Indicates the source of the parameter value.
ApplyType (string) --
Specifies the engine specific parameters type.
DataType (string) --
Specifies the valid data type for the parameter.
AllowedValues (string) --
Specifies the valid range of values for the parameter.
IsModifiable (boolean) --
Indicates whether (true ) or not (false ) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
MinimumEngineVersion (string) --
The earliest engine version to which the parameter can apply.
ApplyMethod (string) --
Indicates when to apply parameter updates.
SupportedEngineModes (list) --
The valid DB engine modes.
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 .
Exceptions
RDS.Client.exceptions.DBParameterGroupNotFoundFaultExamples
This example lists information for up to the first 20 system parameters for the specified DB parameter group.
response = client.describe_db_parameters(
DBParameterGroupName='mymysqlparametergroup',
MaxRecords=20,
Source='system',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
describe_db_proxies(**kwargs)¶Returns information about DB proxies.
See also: AWS API Documentation
Request Syntax
response = client.describe_db_proxies(
DBProxyName='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
Marker='string',
MaxRecords=123
)
This parameter is not currently supported.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
MaxRecords .The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
dict
Response Syntax
{
'DBProxies': [
{
'DBProxyName': 'string',
'DBProxyArn': 'string',
'Status': 'available'|'modifying'|'incompatible-network'|'insufficient-resource-limits'|'creating'|'deleting'|'suspended'|'suspending'|'reactivating',
'EngineFamily': 'string',
'VpcId': 'string',
'VpcSecurityGroupIds': [
'string',
],
'VpcSubnetIds': [
'string',
],
'Auth': [
{
'Description': 'string',
'UserName': 'string',
'AuthScheme': 'SECRETS',
'SecretArn': 'string',
'IAMAuth': 'DISABLED'|'REQUIRED'
},
],
'RoleArn': 'string',
'Endpoint': 'string',
'RequireTLS': True|False,
'IdleClientTimeout': 123,
'DebugLogging': True|False,
'CreatedDate': datetime(2015, 1, 1),
'UpdatedDate': datetime(2015, 1, 1)
},
],
'Marker': 'string'
}
Response Structure
(dict) --
DBProxies (list) --
A return value representing an arbitrary number of DBProxy data structures.
(dict) --
The data structure representing a proxy managed by the RDS Proxy.
This data type is used as a response element in the DescribeDBProxies action.
DBProxyName (string) --
The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.
DBProxyArn (string) --
The Amazon Resource Name (ARN) for the proxy.
Status (string) --
The current status of this proxy. A status of available means the proxy is ready to handle requests. Other values indicate that you must wait for the proxy to be ready, or take some action to resolve an issue.
EngineFamily (string) --
The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. MYSQL supports Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases. POSTGRESQL supports Aurora PostgreSQL and RDS for PostgreSQL databases.
VpcId (string) --
Provides the VPC ID of the DB proxy.
VpcSecurityGroupIds (list) --
Provides a list of VPC security groups that the proxy belongs to.
VpcSubnetIds (list) --
The EC2 subnet IDs for the proxy.
Auth (list) --
One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.
(dict) --
Returns the details of authentication used by a proxy to log in as a specific database user.
Description (string) --
A user-specified description about the authentication used by a proxy to log in as a specific database user.
UserName (string) --
The name of the database user to which the proxy connects.
AuthScheme (string) --
The type of authentication that the proxy uses for connections from the proxy to the underlying database.
SecretArn (string) --
The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.
IAMAuth (string) --
Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy.
RoleArn (string) --
The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.
Endpoint (string) --
The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.
RequireTLS (boolean) --
Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
IdleClientTimeout (integer) --
The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection. The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by later connection requests.
Default: 1800 (30 minutes)
Constraints: 1 to 28,800
DebugLogging (boolean) --
Whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.
CreatedDate (datetime) --
The date and time when the proxy was first created.
UpdatedDate (datetime) --
The date and time when the proxy was last updated.
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 .
Exceptions
RDS.Client.exceptions.DBProxyNotFoundFaultdescribe_db_proxy_endpoints(**kwargs)¶Returns information about DB proxy endpoints.
See also: AWS API Documentation
Request Syntax
response = client.describe_db_proxy_endpoints(
DBProxyName='string',
DBProxyEndpointName='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
Marker='string',
MaxRecords=123
)
This parameter is not currently supported.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
MaxRecords .The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
dict
Response Syntax
{
'DBProxyEndpoints': [
{
'DBProxyEndpointName': 'string',
'DBProxyEndpointArn': 'string',
'DBProxyName': 'string',
'Status': 'available'|'modifying'|'incompatible-network'|'insufficient-resource-limits'|'creating'|'deleting',
'VpcId': 'string',
'VpcSecurityGroupIds': [
'string',
],
'VpcSubnetIds': [
'string',
],
'Endpoint': 'string',
'CreatedDate': datetime(2015, 1, 1),
'TargetRole': 'READ_WRITE'|'READ_ONLY',
'IsDefault': True|False
},
],
'Marker': 'string'
}
Response Structure
(dict) --
DBProxyEndpoints (list) --
The list of ProxyEndpoint objects returned by the API operation.
(dict) --
The data structure representing an endpoint associated with a DB proxy. RDS automatically creates one endpoint for each DB proxy. For Aurora DB clusters, you can associate additional endpoints with the same DB proxy. These endpoints can be read/write or read-only. They can also reside in different VPCs than the associated DB proxy.
This data type is used as a response element in the DescribeDBProxyEndpoints operation.
DBProxyEndpointName (string) --
The name for the DB proxy endpoint. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.
DBProxyEndpointArn (string) --
The Amazon Resource Name (ARN) for the DB proxy endpoint.
DBProxyName (string) --
The identifier for the DB proxy that is associated with this DB proxy endpoint.
Status (string) --
The current status of this DB proxy endpoint. A status of available means the endpoint is ready to handle requests. Other values indicate that you must wait for the endpoint to be ready, or take some action to resolve an issue.
VpcId (string) --
Provides the VPC ID of the DB proxy endpoint.
VpcSecurityGroupIds (list) --
Provides a list of VPC security groups that the DB proxy endpoint belongs to.
VpcSubnetIds (list) --
The EC2 subnet IDs for the DB proxy endpoint.
Endpoint (string) --
The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.
CreatedDate (datetime) --
The date and time when the DB proxy endpoint was first created.
TargetRole (string) --
A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
IsDefault (boolean) --
A value that indicates whether this endpoint is the default endpoint for the associated DB proxy. Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be either read/write or read-only.
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 .
Exceptions
RDS.Client.exceptions.DBProxyNotFoundFaultRDS.Client.exceptions.DBProxyEndpointNotFoundFaultdescribe_db_proxy_target_groups(**kwargs)¶Returns information about DB proxy target groups, represented by DBProxyTargetGroup data structures.
See also: AWS API Documentation
Request Syntax
response = client.describe_db_proxy_target_groups(
DBProxyName='string',
TargetGroupName='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
Marker='string',
MaxRecords=123
)
[REQUIRED]
The identifier of the DBProxy associated with the target group.
DBProxyTargetGroup to describe.This parameter is not currently supported.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
MaxRecords .The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
dict
Response Syntax
{
'TargetGroups': [
{
'DBProxyName': 'string',
'TargetGroupName': 'string',
'TargetGroupArn': 'string',
'IsDefault': True|False,
'Status': 'string',
'ConnectionPoolConfig': {
'MaxConnectionsPercent': 123,
'MaxIdleConnectionsPercent': 123,
'ConnectionBorrowTimeout': 123,
'SessionPinningFilters': [
'string',
],
'InitQuery': 'string'
},
'CreatedDate': datetime(2015, 1, 1),
'UpdatedDate': datetime(2015, 1, 1)
},
],
'Marker': 'string'
}
Response Structure
(dict) --
TargetGroups (list) --
An arbitrary number of DBProxyTargetGroup objects, containing details of the corresponding target groups.
(dict) --
Represents a set of RDS DB instances, Aurora DB clusters, or both that a proxy can connect to. Currently, each target group is associated with exactly one RDS DB instance or Aurora DB cluster.
This data type is used as a response element in the DescribeDBProxyTargetGroups action.
DBProxyName (string) --
The identifier for the RDS proxy associated with this target group.
TargetGroupName (string) --
The identifier for the target group. This name must be unique for all target groups owned by your Amazon Web Services account in the specified Amazon Web Services Region.
TargetGroupArn (string) --
The Amazon Resource Name (ARN) representing the target group.
IsDefault (boolean) --
Whether this target group is the first one used for connection requests by the associated proxy. Because each proxy is currently associated with a single target group, currently this setting is always true .
Status (string) --
The current status of this target group. A status of available means the target group is correctly associated with a database. Other values indicate that you must wait for the target group to be ready, or take some action to resolve an issue.
ConnectionPoolConfig (dict) --
The settings that determine the size and behavior of the connection pool for the target group.
MaxConnectionsPercent (integer) --
The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.
MaxIdleConnectionsPercent (integer) --
Controls how actively the proxy closes idle database connections in the connection pool. The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group. With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.
ConnectionBorrowTimeout (integer) --
The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the proxy has opened its maximum number of connections and all connections are busy with client sessions.
SessionPinningFilters (list) --
Each item in the list represents a class of SQL operations that normally cause all later statements in a session using a proxy to be pinned to the same underlying database connection. Including an item in the list exempts that class of SQL operations from the pinning behavior. Currently, the only allowed value is EXCLUDE_VARIABLE_SETS .
InitQuery (string) --
One or more SQL statements for the proxy to run when opening each new database connection. Typically used with SET statements to make sure that each connection has identical settings such as time zone and character set. This setting is empty by default. For multiple statements, use semicolons as the separator. You can also include multiple variables in a single SET statement, such as SET x=1, y=2 .
CreatedDate (datetime) --
The date and time when the target group was first created.
UpdatedDate (datetime) --
The date and time when the target group was last updated.
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 .
Exceptions
RDS.Client.exceptions.DBProxyNotFoundFaultRDS.Client.exceptions.DBProxyTargetGroupNotFoundFaultRDS.Client.exceptions.InvalidDBProxyStateFaultdescribe_db_proxy_targets(**kwargs)¶Returns information about DBProxyTarget objects. This API supports pagination.
See also: AWS API Documentation
Request Syntax
response = client.describe_db_proxy_targets(
DBProxyName='string',
TargetGroupName='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
Marker='string',
MaxRecords=123
)
[REQUIRED]
The identifier of the DBProxyTarget to describe.
DBProxyTargetGroup to describe.This parameter is not currently supported.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
MaxRecords .The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
dict
Response Syntax
{
'Targets': [
{
'TargetArn': 'string',
'Endpoint': 'string',
'TrackedClusterId': 'string',
'RdsResourceId': 'string',
'Port': 123,
'Type': 'RDS_INSTANCE'|'RDS_SERVERLESS_ENDPOINT'|'TRACKED_CLUSTER',
'Role': 'READ_WRITE'|'READ_ONLY'|'UNKNOWN',
'TargetHealth': {
'State': 'REGISTERING'|'AVAILABLE'|'UNAVAILABLE',
'Reason': 'UNREACHABLE'|'CONNECTION_FAILED'|'AUTH_FAILURE'|'PENDING_PROXY_CAPACITY'|'INVALID_REPLICATION_STATE',
'Description': 'string'
}
},
],
'Marker': 'string'
}
Response Structure
(dict) --
Targets (list) --
An arbitrary number of DBProxyTarget objects, containing details of the corresponding targets.
(dict) --
Contains the details for an RDS Proxy target. It represents an RDS DB instance or Aurora DB cluster that the proxy can connect to. One or more targets are associated with an RDS Proxy target group.
This data type is used as a response element in the DescribeDBProxyTargets action.
TargetArn (string) --
The Amazon Resource Name (ARN) for the RDS DB instance or Aurora DB cluster.
Endpoint (string) --
The writer endpoint for the RDS DB instance or Aurora DB cluster.
TrackedClusterId (string) --
The DB cluster identifier when the target represents an Aurora DB cluster. This field is blank when the target represents an RDS DB instance.
RdsResourceId (string) --
The identifier representing the target. It can be the instance identifier for an RDS DB instance, or the cluster identifier for an Aurora DB cluster.
Port (integer) --
The port that the RDS Proxy uses to connect to the target RDS DB instance or Aurora DB cluster.
Type (string) --
Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents.
Role (string) --
A value that indicates whether the target of the proxy can be used for read/write or read-only operations.
TargetHealth (dict) --
Information about the connection health of the RDS Proxy target.
State (string) --
The current state of the connection health lifecycle for the RDS Proxy target. The following is a typical lifecycle example for the states of an RDS Proxy target:
registering>unavailable>available>unavailable>available
Reason (string) --
The reason for the current health State of the RDS Proxy target.
Description (string) --
A description of the health of the RDS Proxy target. If the State is AVAILABLE , a description is not included.
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 .
Exceptions
RDS.Client.exceptions.DBProxyNotFoundFaultRDS.Client.exceptions.DBProxyTargetNotFoundFaultRDS.Client.exceptions.DBProxyTargetGroupNotFoundFaultRDS.Client.exceptions.InvalidDBProxyStateFaultdescribe_db_security_groups(**kwargs)¶Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of the specified DB security group.
See also: AWS API Documentation
Request Syntax
response = client.describe_db_security_groups(
DBSecurityGroupName='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
This parameter isn't currently supported.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
DescribeDBSecurityGroups 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',
'DBSecurityGroups': [
{
'OwnerId': 'string',
'DBSecurityGroupName': 'string',
'DBSecurityGroupDescription': 'string',
'VpcId': 'string',
'EC2SecurityGroups': [
{
'Status': 'string',
'EC2SecurityGroupName': 'string',
'EC2SecurityGroupId': 'string',
'EC2SecurityGroupOwnerId': 'string'
},
],
'IPRanges': [
{
'Status': 'string',
'CIDRIP': 'string'
},
],
'DBSecurityGroupArn': 'string'
},
]
}
Response Structure
(dict) --
Contains the result of a successful invocation of the DescribeDBSecurityGroups action.
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 .
DBSecurityGroups (list) --
A list of DBSecurityGroup instances.
(dict) --
Contains the details for an Amazon RDS DB security group.
This data type is used as a response element in the DescribeDBSecurityGroups action.
OwnerId (string) --
Provides the Amazon Web Services ID of the owner of a specific DB security group.
DBSecurityGroupName (string) --
Specifies the name of the DB security group.
DBSecurityGroupDescription (string) --
Provides the description of the DB security group.
VpcId (string) --
Provides the VpcId of the DB security group.
EC2SecurityGroups (list) --
Contains a list of EC2SecurityGroup elements.
(dict) --
This data type is used as a response element in the following actions:
AuthorizeDBSecurityGroupIngressDescribeDBSecurityGroupsRevokeDBSecurityGroupIngressStatus (string) --
Provides the status of the EC2 security group. Status can be "authorizing", "authorized", "revoking", and "revoked".
EC2SecurityGroupName (string) --
Specifies the name of the EC2 security group.
EC2SecurityGroupId (string) --
Specifies the id of the EC2 security group.
EC2SecurityGroupOwnerId (string) --
Specifies the Amazon Web Services ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.
IPRanges (list) --
Contains a list of IPRange elements.
(dict) --
This data type is used as a response element in the DescribeDBSecurityGroups action.
Status (string) --
Specifies the status of the IP range. Status can be "authorizing", "authorized", "revoking", and "revoked".
CIDRIP (string) --
Specifies the IP range.
DBSecurityGroupArn (string) --
The Amazon Resource Name (ARN) for the DB security group.
Exceptions
RDS.Client.exceptions.DBSecurityGroupNotFoundFaultExamples
This example lists settings for the specified security group.
response = client.describe_db_security_groups(
DBSecurityGroupName='mydbsecuritygroup',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
describe_db_snapshot_attributes(**kwargs)¶Returns a list of DB snapshot attribute names and values for a manual DB snapshot.
When sharing snapshots with other Amazon Web Services accounts, DescribeDBSnapshotAttributes returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore the manual DB snapshot. If all is included in the list of values for the restore attribute, then the manual DB snapshot is public and can be copied or restored by all Amazon Web Services accounts.
To add or remove access for an Amazon Web Services account to copy or restore a manual DB snapshot, or to make the manual DB snapshot public or private, use the ModifyDBSnapshotAttribute API action.
See also: AWS API Documentation
Request Syntax
response = client.describe_db_snapshot_attributes(
DBSnapshotIdentifier='string'
)
[REQUIRED]
The identifier for the DB snapshot to describe the attributes for.
{
'DBSnapshotAttributesResult': {
'DBSnapshotIdentifier': 'string',
'DBSnapshotAttributes': [
{
'AttributeName': 'string',
'AttributeValues': [
'string',
]
},
]
}
}
Response Structure
Contains the results of a successful call to the DescribeDBSnapshotAttributes API action.
Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts to copy or restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute API action.
The identifier of the manual DB snapshot that the attributes apply to.
The list of attributes and values for the manual DB snapshot.
Contains the name and values of a manual DB snapshot attribute
Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts to restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute API.
The name of the manual DB snapshot attribute.
The attribute named restore refers to the list of Amazon Web Services accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the ModifyDBSnapshotAttribute API action.
The value or values for the manual DB snapshot attribute.
If the AttributeName field is set to restore , then this element returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual DB snapshot. If a value of all is in the list, then the manual DB snapshot is public and available for any Amazon Web Services account to copy or restore.
Exceptions
RDS.Client.exceptions.DBSnapshotNotFoundFaultExamples
This example lists attributes for the specified DB snapshot.
response = client.describe_db_snapshot_attributes(
DBSnapshotIdentifier='mydbsnapshot',
)
print(response)
Expected Output:
{
'DBSnapshotAttributesResult': {
},
'ResponseMetadata': {
'...': '...',
},
}
describe_db_snapshots(**kwargs)¶Returns information about DB snapshots. This API action supports pagination.
See also: AWS API Documentation
Request Syntax
response = client.describe_db_snapshots(
DBInstanceIdentifier='string',
DBSnapshotIdentifier='string',
SnapshotType='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string',
IncludeShared=True|False,
IncludePublic=True|False,
DbiResourceId='string'
)
The ID of the DB instance to retrieve the list of DB snapshots for. This parameter isn't case-sensitive.
Constraints:
A specific DB snapshot identifier to describe. This value is stored as a lowercase string.
Constraints:
SnapshotType parameter must also be specified.The type of snapshots to be returned. You can specify one of the following values:
automated - Return all DB snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.manual - Return all DB snapshots that have been taken by my Amazon Web Services account.shared - Return all manual DB snapshots that have been shared to my Amazon Web Services account.public - Return all DB snapshots that have been marked as public.awsbackup - Return the DB snapshots managed by the Amazon Web Services Backup service. For information about Amazon Web Services Backup, see the ` Amazon Web Services Backup Developer Guide. https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html`__ The awsbackup type does not apply to Aurora.If you don't specify a SnapshotType value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by enabling the IncludeShared parameter. You can include public snapshots with these results by enabling the IncludePublic parameter.
The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated . The IncludePublic parameter doesn't apply when SnapshotType is set to shared . The IncludeShared parameter doesn't apply when SnapshotType is set to public .
A filter that specifies one or more DB snapshots to describe.
Supported filters:
db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).db-snapshot-id - Accepts DB snapshot identifiers.dbi-resource-id - Accepts identifiers of source DB instances.snapshot-type - Accepts types of DB snapshots.engine - Accepts names of database engines.A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
DescribeDBSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .A value that indicates whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.
You can give an Amazon Web Services account permission to restore a manual DB snapshot from another Amazon Web Services account by using the ModifyDBSnapshotAttribute API action.
This setting doesn't apply to RDS Custom.
A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.
You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.
This setting doesn't apply to RDS Custom.
dict
Response Syntax
{
'Marker': 'string',
'DBSnapshots': [
{
'DBSnapshotIdentifier': 'string',
'DBInstanceIdentifier': 'string',
'SnapshotCreateTime': datetime(2015, 1, 1),
'Engine': 'string',
'AllocatedStorage': 123,
'Status': 'string',
'Port': 123,
'AvailabilityZone': 'string',
'VpcId': 'string',
'InstanceCreateTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'EngineVersion': 'string',
'LicenseModel': 'string',
'SnapshotType': 'string',
'Iops': 123,
'OptionGroupName': 'string',
'PercentProgress': 123,
'SourceRegion': 'string',
'SourceDBSnapshotIdentifier': 'string',
'StorageType': 'string',
'TdeCredentialArn': 'string',
'Encrypted': True|False,
'KmsKeyId': 'string',
'DBSnapshotArn': 'string',
'Timezone': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
],
'DbiResourceId': 'string',
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'OriginalSnapshotCreateTime': datetime(2015, 1, 1),
'SnapshotTarget': 'string'
},
]
}
Response Structure
(dict) --
Contains the result of a successful invocation of the DescribeDBSnapshots action.
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 .
DBSnapshots (list) --
A list of DBSnapshot instances.
(dict) --
Contains the details of an Amazon RDS DB snapshot.
This data type is used as a response element in the DescribeDBSnapshots action.
DBSnapshotIdentifier (string) --
Specifies the identifier for the DB snapshot.
DBInstanceIdentifier (string) --
Specifies the DB instance identifier of the DB instance this DB snapshot was created from.
SnapshotCreateTime (datetime) --
Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied.
Engine (string) --
Specifies the name of the database engine.
AllocatedStorage (integer) --
Specifies the allocated storage size in gibibytes (GiB).
Status (string) --
Specifies the status of this DB snapshot.
Port (integer) --
Specifies the port that the database engine was listening on at the time of the snapshot.
AvailabilityZone (string) --
Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
VpcId (string) --
Provides the VPC ID associated with the DB snapshot.
InstanceCreateTime (datetime) --
Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.
MasterUsername (string) --
Provides the master username for the DB snapshot.
EngineVersion (string) --
Specifies the version of the database engine.
LicenseModel (string) --
License model information for the restored DB instance.
SnapshotType (string) --
Provides the type of the DB snapshot.
Iops (integer) --
Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
OptionGroupName (string) --
Provides the option group name for the DB snapshot.
PercentProgress (integer) --
The percentage of the estimated data that has been transferred.
SourceRegion (string) --
The Amazon Web Services Region that the DB snapshot was created in or copied from.
SourceDBSnapshotIdentifier (string) --
The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has a value in the case of a cross-account or cross-Region copy.
StorageType (string) --
Specifies the storage type associated with DB snapshot.
TdeCredentialArn (string) --
The ARN from the key store with which to associate the instance for TDE encryption.
Encrypted (boolean) --
Specifies whether the DB snapshot is encrypted.
KmsKeyId (string) --
If Encrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
DBSnapshotArn (string) --
The Amazon Resource Name (ARN) for the DB snapshot.
Timezone (string) --
The time zone of the DB snapshot. In most cases, the Timezone element is empty. Timezone content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.
IAMDatabaseAuthenticationEnabled (boolean) --
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
ProcessorFeatures (list) --
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.
(dict) --
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstanceModifyDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceFromS3RestoreDBInstanceToPointInTimeYou can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstancesDescribeDBSnapshotsDescribeValidDBInstanceModificationsIf you call DescribeDBInstances , ProcessorFeature returns non-null values only if the following conditions are met:
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
Name (string) --
The name of the processor feature. Valid names are coreCount and threadsPerCore .
Value (string) --
The value of a processor feature name.
DbiResourceId (string) --
The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
TagList (list) --
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
OriginalSnapshotCreateTime (datetime) --
Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied.
SnapshotTarget (string) --
Specifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
Exceptions
RDS.Client.exceptions.DBSnapshotNotFoundFaultExamples
This example lists all manually-created, shared snapshots for the specified DB instance.
response = client.describe_db_snapshots(
DBInstanceIdentifier='mymysqlinstance',
IncludePublic=False,
IncludeShared=True,
SnapshotType='manual',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
describe_db_subnet_groups(**kwargs)¶Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.
For an overview of CIDR ranges, go to the Wikipedia Tutorial .
See also: AWS API Documentation
Request Syntax
response = client.describe_db_subnet_groups(
DBSubnetGroupName='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
This parameter isn't currently supported.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
MaxRecords .dict
Response Syntax
{
'Marker': 'string',
'DBSubnetGroups': [
{
'DBSubnetGroupName': 'string',
'DBSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetOutpost': {
'Arn': 'string'
},
'SubnetStatus': 'string'
},
],
'DBSubnetGroupArn': 'string',
'SupportedNetworkTypes': [
'string',
]
},
]
}
Response Structure
(dict) --
Contains the result of a successful invocation of the DescribeDBSubnetGroups action.
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) --
A list of DBSubnetGroup instances.
(dict) --
Contains the details of an Amazon RDS DB subnet group.
This data type is used as a response element in the DescribeDBSubnetGroups action.
DBSubnetGroupName (string) --
The name of the DB subnet group.
DBSubnetGroupDescription (string) --
Provides the description of the DB subnet group.
VpcId (string) --
Provides the VpcId of the DB subnet group.
SubnetGroupStatus (string) --
Provides the status of the DB subnet group.
Subnets (list) --
Contains a list of Subnet elements.
(dict) --
This data type is used as a response element for the DescribeDBSubnetGroups operation.
SubnetIdentifier (string) --
The identifier of the subnet.
SubnetAvailabilityZone (dict) --
Contains Availability Zone information.
This data type is used as an element in the OrderableDBInstanceOption data type.
Name (string) --
The name of the Availability Zone.
SubnetOutpost (dict) --
If the subnet is associated with an Outpost, this value specifies the Outpost.
For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
Arn (string) --
The Amazon Resource Name (ARN) of the Outpost.
SubnetStatus (string) --
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:
IPV4DUALA DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
Exceptions
RDS.Client.exceptions.DBSubnetGroupNotFoundFaultExamples
This example lists information about the specified DB subnet group.
response = client.describe_db_subnet_groups(
DBSubnetGroupName='mydbsubnetgroup',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
describe_engine_default_cluster_parameters(**kwargs)¶Returns the default engine and system parameter information for the cluster database engine.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide .
See also: AWS API Documentation
Request Syntax
response = client.describe_engine_default_cluster_parameters(
DBParameterGroupFamily='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
[REQUIRED]
The name of the DB cluster parameter group family to return engine parameter information for.
This parameter isn't currently supported.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
DescribeEngineDefaultClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .dict
Response Syntax
{
'EngineDefaults': {
'DBParameterGroupFamily': 'string',
'Marker': 'string',
'Parameters': [
{
'ParameterName': 'string',
'ParameterValue': 'string',
'Description': 'string',
'Source': 'string',
'ApplyType': 'string',
'DataType': 'string',
'AllowedValues': 'string',
'IsModifiable': True|False,
'MinimumEngineVersion': 'string',
'ApplyMethod': 'immediate'|'pending-reboot',
'SupportedEngineModes': [
'string',
]
},
]
}
}
Response Structure
(dict) --
EngineDefaults (dict) --
Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.
DBParameterGroupFamily (string) --
Specifies the name of the DB parameter group family that the engine default parameters apply to.
Marker (string) --
An optional pagination token provided by a previous EngineDefaults request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
Parameters (list) --
Contains a list of engine default parameters.
(dict) --
This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions.
This data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions.
ParameterName (string) --
Specifies the name of the parameter.
ParameterValue (string) --
Specifies the value of the parameter.
Description (string) --
Provides a description of the parameter.
Source (string) --
Indicates the source of the parameter value.
ApplyType (string) --
Specifies the engine specific parameters type.
DataType (string) --
Specifies the valid data type for the parameter.
AllowedValues (string) --
Specifies the valid range of values for the parameter.
IsModifiable (boolean) --
Indicates whether (true ) or not (false ) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
MinimumEngineVersion (string) --
The earliest engine version to which the parameter can apply.
ApplyMethod (string) --
Indicates when to apply parameter updates.
SupportedEngineModes (list) --
The valid DB engine modes.
Examples
This example lists default parameters for the specified DB cluster engine.
response = client.describe_engine_default_cluster_parameters(
DBParameterGroupFamily='aurora5.6',
)
print(response)
Expected Output:
{
'EngineDefaults': {
},
'ResponseMetadata': {
'...': '...',
},
}
describe_engine_default_parameters(**kwargs)¶Returns the default engine and system parameter information for the specified database engine.
See also: AWS API Documentation
Request Syntax
response = client.describe_engine_default_parameters(
DBParameterGroupFamily='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
[REQUIRED]
The name of the DB parameter group family.
Valid Values:
aurora5.6aurora-mysql5.7aurora-mysql8.0aurora-postgresql10aurora-postgresql11aurora-postgresql12aurora-postgresql13mariadb10.2mariadb10.3mariadb10.4mariadb10.5mariadb10.6mysql5.7mysql8.0postgres10postgres11postgres12postgres13postgres14sqlserver-ee-11.0sqlserver-ee-12.0sqlserver-ee-13.0sqlserver-ee-14.0sqlserver-ee-15.0sqlserver-ex-11.0sqlserver-ex-12.0sqlserver-ex-13.0sqlserver-ex-14.0sqlserver-ex-15.0sqlserver-se-11.0sqlserver-se-12.0sqlserver-se-13.0sqlserver-se-14.0sqlserver-se-15.0sqlserver-web-11.0sqlserver-web-12.0sqlserver-web-13.0sqlserver-web-14.0sqlserver-web-15.0This parameter isn't currently supported.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
DescribeEngineDefaultParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .dict
Response Syntax
{
'EngineDefaults': {
'DBParameterGroupFamily': 'string',
'Marker': 'string',
'Parameters': [
{
'ParameterName': 'string',
'ParameterValue': 'string',
'Description': 'string',
'Source': 'string',
'ApplyType': 'string',
'DataType': 'string',
'AllowedValues': 'string',
'IsModifiable': True|False,
'MinimumEngineVersion': 'string',
'ApplyMethod': 'immediate'|'pending-reboot',
'SupportedEngineModes': [
'string',
]
},
]
}
}
Response Structure
(dict) --
EngineDefaults (dict) --
Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.
DBParameterGroupFamily (string) --
Specifies the name of the DB parameter group family that the engine default parameters apply to.
Marker (string) --
An optional pagination token provided by a previous EngineDefaults request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
Parameters (list) --
Contains a list of engine default parameters.
(dict) --
This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions.
This data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions.
ParameterName (string) --
Specifies the name of the parameter.
ParameterValue (string) --
Specifies the value of the parameter.
Description (string) --
Provides a description of the parameter.
Source (string) --
Indicates the source of the parameter value.
ApplyType (string) --
Specifies the engine specific parameters type.
DataType (string) --
Specifies the valid data type for the parameter.
AllowedValues (string) --
Specifies the valid range of values for the parameter.
IsModifiable (boolean) --
Indicates whether (true ) or not (false ) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
MinimumEngineVersion (string) --
The earliest engine version to which the parameter can apply.
ApplyMethod (string) --
Indicates when to apply parameter updates.
SupportedEngineModes (list) --
The valid DB engine modes.
Examples
This example lists default parameters for the specified DB engine.
response = client.describe_engine_default_parameters(
DBParameterGroupFamily='mysql5.6',
)
print(response)
Expected Output:
{
'EngineDefaults': {
},
'ResponseMetadata': {
'...': '...',
},
}
describe_event_categories(**kwargs)¶Displays a list of categories for all event source types, or, if specified, for a specified source type. You can also see this list in the "Amazon RDS event categories and event messages" section of the ` Amazon RDS User Guide https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.Messages.html`__ or the ` Amazon Aurora User Guide https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Events.Messages.html`__ .
See also: AWS API Documentation
Request Syntax
response = client.describe_event_categories(
SourceType='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
]
)
The type of source that is generating the events. For RDS Proxy events, specify db-proxy .
Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy
This parameter isn't currently supported.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'EventCategoriesMapList': [
{
'SourceType': 'string',
'EventCategories': [
'string',
]
},
]
}
Response Structure
(dict) --
Data returned from the DescribeEventCategories operation.
EventCategoriesMapList (list) --
A list of EventCategoriesMap data types.
(dict) --
Contains the results of a successful invocation of the DescribeEventCategories operation.
SourceType (string) --
The source type that the returned categories belong to
EventCategories (list) --
The event categories for the specified source type
Examples
This example lists all DB instance event categories.
response = client.describe_event_categories(
SourceType='db-instance',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
describe_event_subscriptions(**kwargs)¶Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName , SNSTopicARN , CustomerID , SourceType , SourceID , CreationTime , and Status .
If you specify a SubscriptionName , lists the description for that subscription.
See also: AWS API Documentation
Request Syntax
response = client.describe_event_subscriptions(
SubscriptionName='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
This parameter isn't currently supported.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
MaxRecords .dict
Response Syntax
{
'Marker': 'string',
'EventSubscriptionsList': [
{
'CustomerAwsId': 'string',
'CustSubscriptionId': 'string',
'SnsTopicArn': 'string',
'Status': 'string',
'SubscriptionCreationTime': 'string',
'SourceType': 'string',
'SourceIdsList': [
'string',
],
'EventCategoriesList': [
'string',
],
'Enabled': True|False,
'EventSubscriptionArn': 'string'
},
]
}
Response Structure
(dict) --
Data returned by the DescribeEventSubscriptions action.
Marker (string) --
An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
EventSubscriptionsList (list) --
A list of EventSubscriptions data types.
(dict) --
Contains the results of a successful invocation of the DescribeEventSubscriptions action.
CustomerAwsId (string) --
The Amazon Web Services customer account associated with the RDS event notification subscription.
CustSubscriptionId (string) --
The RDS event notification subscription Id.
SnsTopicArn (string) --
The topic ARN of the RDS event notification subscription.
Status (string) --
The status of the RDS event notification subscription.
Constraints:
Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist
The status "no-permission" indicates that RDS no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.
SubscriptionCreationTime (string) --
The time the RDS event notification subscription was created.
SourceType (string) --
The source type for the RDS event notification subscription.
SourceIdsList (list) --
A list of source IDs for the RDS event notification subscription.
EventCategoriesList (list) --
A list of event categories for the RDS event notification subscription.
Enabled (boolean) --
A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.
EventSubscriptionArn (string) --
The Amazon Resource Name (ARN) for the event subscription.
Exceptions
RDS.Client.exceptions.SubscriptionNotFoundFaultExamples
This example lists information for the specified DB event notification subscription.
response = client.describe_event_subscriptions(
SubscriptionName='mymysqleventsubscription',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
describe_events(**kwargs)¶Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days. Events specific to a particular DB instance, DB cluster, DB parameter group, DB security group, DB snapshot, DB cluster snapshot group, or RDS Proxy can be obtained by providing the name as a parameter.
For more information on working with events, see Monitoring Amazon RDS events in the Amazon RDS User Guide and Monitoring Amazon Aurora events in the Amazon Aurora User Guide .
Note
By default, RDS returns events that were generated in the past hour.
See also: AWS API Documentation
Request Syntax
response = client.describe_events(
SourceIdentifier='string',
SourceType='db-instance'|'db-parameter-group'|'db-security-group'|'db-snapshot'|'db-cluster'|'db-cluster-snapshot'|'custom-engine-version'|'db-proxy',
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
Duration=123,
EventCategories=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.
Constraints:
SourceIdentifier is supplied, SourceType must also be provided.DBInstanceIdentifier value must be supplied.DBClusterIdentifier value must be supplied.DBParameterGroupName value must be supplied.DBSecurityGroupName value must be supplied.DBSnapshotIdentifier value must be supplied.DBClusterSnapshotIdentifier value must be supplied.DBProxyName value must be supplied.The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z
The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z
The number of minutes to retrieve events for.
Default: 60
A list of event categories that trigger notifications for a event notification subscription.
This parameter isn't currently supported.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
MaxRecords .dict
Response Syntax
{
'Marker': 'string',
'Events': [
{
'SourceIdentifier': 'string',
'SourceType': 'db-instance'|'db-parameter-group'|'db-security-group'|'db-snapshot'|'db-cluster'|'db-cluster-snapshot'|'custom-engine-version'|'db-proxy',
'Message': 'string',
'EventCategories': [
'string',
],
'Date': datetime(2015, 1, 1),
'SourceArn': 'string'
},
]
}
Response Structure
(dict) --
Contains the result of a successful invocation of the DescribeEvents action.
Marker (string) --
An optional pagination token provided by a previous Events request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
Events (list) --
A list of Event instances.
(dict) --
This data type is used as a response element in the DescribeEvents action.
SourceIdentifier (string) --
Provides the identifier for the source of the event.
SourceType (string) --
Specifies the source type for this event.
Message (string) --
Provides the text of this event.
EventCategories (list) --
Specifies the category for the event.
Date (datetime) --
Specifies the date and time of the event.
SourceArn (string) --
The Amazon Resource Name (ARN) for the event.
Examples
This example lists information for all backup-related events for the specified DB instance for the past 7 days (7 days * 24 hours * 60 minutes = 10,080 minutes).
response = client.describe_events(
Duration=10080,
EventCategories=[
'backup',
],
SourceIdentifier='mymysqlinstance',
SourceType='db-instance',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
describe_export_tasks(**kwargs)¶Returns information about a snapshot export to Amazon S3. This API operation supports pagination.
See also: AWS API Documentation
Request Syntax
response = client.describe_export_tasks(
ExportTaskIdentifier='string',
SourceArn='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
Marker='string',
MaxRecords=123
)
Filters specify one or more snapshot exports to describe. The filters are specified as name-value pairs that define what to include in the output. Filter names and values are case-sensitive.
Supported filters include the following:
export-task-identifier - An identifier for the snapshot export task.s3-bucket - The Amazon S3 bucket the snapshot is exported to.source-arn - The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3status - The status of the export task. Must be lowercase. Valid statuses are the following:canceledcancelingcompletefailedin_progressstartingA filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
DescribeExportTasks request. If you specify this parameter, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.The maximum number of records to include in the response. If more records exist than the specified value, a pagination token called a marker is included in the response. You can use the marker in a later DescribeExportTasks request to retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
dict
Response Syntax
{
'Marker': 'string',
'ExportTasks': [
{
'ExportTaskIdentifier': 'string',
'SourceArn': 'string',
'ExportOnly': [
'string',
],
'SnapshotTime': datetime(2015, 1, 1),
'TaskStartTime': datetime(2015, 1, 1),
'TaskEndTime': datetime(2015, 1, 1),
'S3Bucket': 'string',
'S3Prefix': 'string',
'IamRoleArn': 'string',
'KmsKeyId': 'string',
'Status': 'string',
'PercentProgress': 123,
'TotalExtractedDataInGB': 123,
'FailureCause': 'string',
'WarningMessage': 'string'
},
]
}
Response Structure
(dict) --
Marker (string) --
A pagination token that can be used in a later DescribeExportTasks request. A marker is used for pagination to identify the location to begin output for the next response of DescribeExportTasks .
ExportTasks (list) --
Information about an export of a snapshot to Amazon S3.
(dict) --
Contains the details of a snapshot export to Amazon S3.
This data type is used as a response element in the DescribeExportTasks action.
ExportTaskIdentifier (string) --
A unique identifier for the snapshot export task. This ID isn't an identifier for the Amazon S3 bucket where the snapshot is exported to.
SourceArn (string) --
The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.
ExportOnly (list) --
The data exported from the snapshot. Valid values are the following:
database - Export all the data from a specified database.database.table table-name - Export a table of the snapshot. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.database.schema schema-name - Export a database schema of the snapshot. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.database.schema.table table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.SnapshotTime (datetime) --
The time that the snapshot was created.
TaskStartTime (datetime) --
The time that the snapshot export task started.
TaskEndTime (datetime) --
The time that the snapshot export task completed.
S3Bucket (string) --
The Amazon S3 bucket that the snapshot is exported to.
S3Prefix (string) --
The Amazon S3 bucket prefix that is the file name and path of the exported snapshot.
IamRoleArn (string) --
The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot.
KmsKeyId (string) --
The key identifier of the Amazon Web Services KMS key that is used to encrypt the snapshot when it's exported to Amazon S3. The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the snapshot export must have encryption and decryption permissions to use this KMS key.
Status (string) --
The progress status of the export task.
PercentProgress (integer) --
The progress of the snapshot export task as a percentage.
TotalExtractedDataInGB (integer) --
The total amount of data exported, in gigabytes.
FailureCause (string) --
The reason the export failed, if it failed.
WarningMessage (string) --
A warning about the snapshot export task.
Exceptions
RDS.Client.exceptions.ExportTaskNotFoundFaultdescribe_global_clusters(**kwargs)¶Returns information about Aurora global database clusters. This API supports pagination.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide .
Note
This action only applies to Aurora DB clusters.
See also: AWS API Documentation
Request Syntax
response = client.describe_global_clusters(
GlobalClusterIdentifier='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.
Constraints:
This parameter isn't currently supported.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
DescribeGlobalClusters 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',
'GlobalClusters': [
{
'GlobalClusterIdentifier': 'string',
'GlobalClusterResourceId': 'string',
'GlobalClusterArn': 'string',
'Status': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'DatabaseName': 'string',
'StorageEncrypted': True|False,
'DeletionProtection': True|False,
'GlobalClusterMembers': [
{
'DBClusterArn': 'string',
'Readers': [
'string',
],
'IsWriter': True|False,
'GlobalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'unknown'
},
],
'FailoverState': {
'Status': 'pending'|'failing-over'|'cancelling',
'FromDbClusterArn': 'string',
'ToDbClusterArn': 'string'
}
},
]
}
Response Structure
(dict) --
Marker (string) --
An optional pagination token provided by a previous DescribeGlobalClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
GlobalClusters (list) --
The list of global clusters returned by this request.
(dict) --
A data type representing an Aurora global database.
GlobalClusterIdentifier (string) --
Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster.
GlobalClusterResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB cluster is accessed.
GlobalClusterArn (string) --
The Amazon Resource Name (ARN) for the global database cluster.
Status (string) --
Specifies the current state of this global database cluster.
Engine (string) --
The Aurora database engine used by the global database cluster.
EngineVersion (string) --
Indicates the database engine version.
DatabaseName (string) --
The default database name within the new global database cluster.
StorageEncrypted (boolean) --
The storage encryption setting for the global database cluster.
DeletionProtection (boolean) --
The deletion protection setting for the new global database cluster.
GlobalClusterMembers (list) --
The list of cluster IDs for secondary clusters within the global database cluster. Currently limited to 1 item.
(dict) --
A data structure with information about any primary and secondary clusters associated with an Aurora global database.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for each Aurora cluster.
Readers (list) --
The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global database.
IsWriter (boolean) --
Specifies whether the Aurora cluster is the primary cluster (that is, has read-write capability) for the Aurora global database with which it is associated.
GlobalWriteForwardingStatus (string) --
Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.
FailoverState (dict) --
A data object containing all properties for the current state of an in-process or pending failover process for this Aurora global database. This object is empty unless the FailoverGlobalCluster API operation has been called on this Aurora global database ( GlobalCluster ).
Status (string) --
The current status of the Aurora global database ( GlobalCluster ). Possible values are as follows:
GlobalCluster 's primary DB cluster and the specified secondary DB cluster are being verified before the failover process can start.FromDbClusterArn (string) --
The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being demoted, and which is associated with this state.
ToDbClusterArn (string) --
The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being promoted, and which is associated with this state.
Exceptions
RDS.Client.exceptions.GlobalClusterNotFoundFaultdescribe_option_group_options(**kwargs)¶Describes all available options.
See also: AWS API Documentation
Request Syntax
response = client.describe_option_group_options(
EngineName='string',
MajorEngineVersion='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
[REQUIRED]
A required parameter. Options available for the given engine name are described.
Valid Values:
mariadbmysqloracle-eeoracle-ee-cdboracle-se2oracle-se2-cdbpostgressqlserver-eesqlserver-sesqlserver-exsqlserver-webThis parameter isn't currently supported.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
MaxRecords .dict
Response Syntax
{
'OptionGroupOptions': [
{
'Name': 'string',
'Description': 'string',
'EngineName': 'string',
'MajorEngineVersion': 'string',
'MinimumRequiredMinorEngineVersion': 'string',
'PortRequired': True|False,
'DefaultPort': 123,
'OptionsDependedOn': [
'string',
],
'OptionsConflictsWith': [
'string',
],
'Persistent': True|False,
'Permanent': True|False,
'RequiresAutoMinorEngineVersionUpgrade': True|False,
'VpcOnly': True|False,
'SupportsOptionVersionDowngrade': True|False,
'OptionGroupOptionSettings': [
{
'SettingName': 'string',
'SettingDescription': 'string',
'DefaultValue': 'string',
'ApplyType': 'string',
'AllowedValues': 'string',
'IsModifiable': True|False,
'IsRequired': True|False,
'MinimumEngineVersionPerAllowedValue': [
{
'AllowedValue': 'string',
'MinimumEngineVersion': 'string'
},
]
},
],
'OptionGroupOptionVersions': [
{
'Version': 'string',
'IsDefault': True|False
},
]
},
],
'Marker': 'string'
}
Response Structure
(dict) --
OptionGroupOptions (list) --
List of available option group options.
(dict) --
Available option.
Name (string) --
The name of the option.
Description (string) --
The description of the option.
EngineName (string) --
The name of the engine that this option can be applied to.
MajorEngineVersion (string) --
Indicates the major engine version that the option is available for.
MinimumRequiredMinorEngineVersion (string) --
The minimum required engine version for the option to be applied.
PortRequired (boolean) --
Specifies whether the option requires a port.
DefaultPort (integer) --
If the option requires a port, specifies the default port for the option.
OptionsDependedOn (list) --
The options that are prerequisites for this option.
OptionsConflictsWith (list) --
The options that conflict with this option.
Persistent (boolean) --
Persistent options can't be removed from an option group while DB instances are associated with the option group. If you disassociate all DB instances from the option group, your can remove the persistent option from the option group.
Permanent (boolean) --
Permanent options can never be removed from an option group. An option group containing a permanent option can't be removed from a DB instance.
RequiresAutoMinorEngineVersionUpgrade (boolean) --
If true, you must enable the Auto Minor Version Upgrade setting for your DB instance before you can use this option. You can enable Auto Minor Version Upgrade when you first create your DB instance, or by modifying your DB instance later.
VpcOnly (boolean) --
If true, you can only use this option with a DB instance that is in a VPC.
SupportsOptionVersionDowngrade (boolean) --
If true, you can change the option to an earlier version of the option. This only applies to options that have different versions available.
OptionGroupOptionSettings (list) --
The option settings that are available (and the default value) for each option in an option group.
(dict) --
Option group option settings are used to display settings available for each option with their default values and other information. These values are used with the DescribeOptionGroupOptions action.
SettingName (string) --
The name of the option group option.
SettingDescription (string) --
The description of the option group option.
DefaultValue (string) --
The default value for the option group option.
ApplyType (string) --
The DB engine specific parameter type for the option group option.
AllowedValues (string) --
Indicates the acceptable values for the option group option.
IsModifiable (boolean) --
Boolean value where true indicates that this option group option can be changed from the default value.
IsRequired (boolean) --
Boolean value where true indicates that a value must be specified for this option setting of the option group option.
MinimumEngineVersionPerAllowedValue (list) --
The minimum DB engine version required for the corresponding allowed value for this option setting.
(dict) --
The minimum DB engine version required for each corresponding allowed value for an option setting.
AllowedValue (string) --
The allowed value for an option setting.
MinimumEngineVersion (string) --
The minimum DB engine version required for the allowed value.
OptionGroupOptionVersions (list) --
The versions that are available for the option.
(dict) --
The version for an option. Option group option versions are returned by the DescribeOptionGroupOptions action.
Version (string) --
The version of the option.
IsDefault (boolean) --
True if the version is the default version of the option, and otherwise false.
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 .
Examples
This example lists information for all option group options for the specified DB engine.
response = client.describe_option_group_options(
EngineName='mysql',
MajorEngineVersion='5.6',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
describe_option_groups(**kwargs)¶Describes the available option groups.
See also: AWS API Documentation
Request Syntax
response = client.describe_option_groups(
OptionGroupName='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
Marker='string',
MaxRecords=123,
EngineName='string',
MajorEngineVersion='string'
)
This parameter isn't currently supported.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
MaxRecords .The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
Filters the list of option groups to only include groups associated with a specific database engine.
Valid Values:
mariadbmysqloracle-eeoracle-ee-cdboracle-se2oracle-se2-cdbpostgressqlserver-eesqlserver-sesqlserver-exsqlserver-webdict
Response Syntax
{
'OptionGroupsList': [
{
'OptionGroupName': 'string',
'OptionGroupDescription': 'string',
'EngineName': 'string',
'MajorEngineVersion': 'string',
'Options': [
{
'OptionName': 'string',
'OptionDescription': 'string',
'Persistent': True|False,
'Permanent': True|False,
'Port': 123,
'OptionVersion': 'string',
'OptionSettings': [
{
'Name': 'string',
'Value': 'string',
'DefaultValue': 'string',
'Description': 'string',
'ApplyType': 'string',
'DataType': 'string',
'AllowedValues': 'string',
'IsModifiable': True|False,
'IsCollection': True|False
},
],
'DBSecurityGroupMemberships': [
{
'DBSecurityGroupName': 'string',
'Status': 'string'
},
],
'VpcSecurityGroupMemberships': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
]
},
],
'AllowsVpcAndNonVpcInstanceMemberships': True|False,
'VpcId': 'string',
'OptionGroupArn': 'string'
},
],
'Marker': 'string'
}
Response Structure
(dict) --
List of option groups.
OptionGroupsList (list) --
List of option groups.
(dict) --
OptionGroupName (string) --
Specifies the name of the option group.
OptionGroupDescription (string) --
Provides a description of the option group.
EngineName (string) --
Indicates the name of the engine that this option group can be applied to.
MajorEngineVersion (string) --
Indicates the major engine version associated with this option group.
Options (list) --
Indicates what options are available in the option group.
(dict) --
Option details.
OptionName (string) --
The name of the option.
OptionDescription (string) --
The description of the option.
Persistent (boolean) --
Indicate if this option is persistent.
Permanent (boolean) --
Indicate if this option is permanent.
Port (integer) --
If required, the port configured for this option to use.
OptionVersion (string) --
The version of the option.
OptionSettings (list) --
The option settings for this option.
(dict) --
Option settings are the actual settings being applied or configured for that option. It is used when you modify an option group or describe option groups. For example, the NATIVE_NETWORK_ENCRYPTION option has a setting called SQLNET.ENCRYPTION_SERVER that can have several different values.
Name (string) --
The name of the option that has settings that you can set.
Value (string) --
The current value of the option setting.
DefaultValue (string) --
The default value of the option setting.
Description (string) --
The description of the option setting.
ApplyType (string) --
The DB engine specific parameter type.
DataType (string) --
The data type of the option setting.
AllowedValues (string) --
The allowed values of the option setting.
IsModifiable (boolean) --
A Boolean value that, when true, indicates the option setting can be modified from the default.
IsCollection (boolean) --
Indicates if the option setting is part of a collection.
DBSecurityGroupMemberships (list) --
If the option requires access to a port, then this DB security group allows access to the port.
(dict) --
This data type is used as a response element in the following actions:
ModifyDBInstanceRebootDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceToPointInTimeDBSecurityGroupName (string) --
The name of the DB security group.
Status (string) --
The status of the DB security group.
VpcSecurityGroupMemberships (list) --
If the option requires access to a port, then this VPC security group allows access to the port.
(dict) --
This data type is used as a response element for queries on VPC security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The membership status of the VPC security group.
Currently, the only valid status is active .
AllowsVpcAndNonVpcInstanceMemberships (boolean) --
Indicates whether this option group can be applied to both VPC and non-VPC instances. The value true indicates the option group can be applied to both VPC and non-VPC instances.
VpcId (string) --
If AllowsVpcAndNonVpcInstanceMemberships is false , this field is blank. If AllowsVpcAndNonVpcInstanceMemberships is true and this field is blank, then this option group can be applied to both VPC and non-VPC instances. If this field contains a value, then this option group can only be applied to instances that are in the VPC indicated by this field.
OptionGroupArn (string) --
The Amazon Resource Name (ARN) for the option group.
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 .
Exceptions
RDS.Client.exceptions.OptionGroupNotFoundFaultExamples
This example lists information for all option groups for the specified DB engine.
response = client.describe_option_groups(
EngineName='mysql',
MajorEngineVersion='5.6',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
describe_orderable_db_instance_options(**kwargs)¶Returns a list of orderable DB instance options for the specified DB engine, DB engine version, and DB instance class.
See also: AWS API Documentation
Request Syntax
response = client.describe_orderable_db_instance_options(
Engine='string',
EngineVersion='string',
DBInstanceClass='string',
LicenseModel='string',
AvailabilityZoneGroup='string',
Vpc=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
[REQUIRED]
The name of the engine to retrieve DB instance options for.
Valid Values:
aurora (for MySQL 5.6-compatible Aurora)aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)aurora-postgresqlmariadbmysqloracle-eeoracle-ee-cdboracle-se2oracle-se2-cdbpostgressqlserver-eesqlserver-sesqlserver-exsqlserver-webThe license model filter value. Specify this parameter to show only the available offerings matching the specified license model.
RDS Custom supports only the BYOL licensing model.
The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available offerings for the Local Zones in the group.
Omit this parameter to show the available offerings in the specified Amazon Web Services Region.
This setting doesn't apply to RDS Custom.
A value that indicates whether to show only VPC or non-VPC offerings. RDS Custom supports only VPC offerings.
RDS Custom supports only VPC offerings. If you describe non-VPC offerings for RDS Custom, the output shows VPC offerings.
This parameter isn't currently supported.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 10000.
MaxRecords .dict
Response Syntax
{
'OrderableDBInstanceOptions': [
{
'Engine': 'string',
'EngineVersion': 'string',
'DBInstanceClass': 'string',
'LicenseModel': 'string',
'AvailabilityZoneGroup': 'string',
'AvailabilityZones': [
{
'Name': 'string'
},
],
'MultiAZCapable': True|False,
'ReadReplicaCapable': True|False,
'Vpc': True|False,
'SupportsStorageEncryption': True|False,
'StorageType': 'string',
'SupportsIops': True|False,
'SupportsEnhancedMonitoring': True|False,
'SupportsIAMDatabaseAuthentication': True|False,
'SupportsPerformanceInsights': True|False,
'MinStorageSize': 123,
'MaxStorageSize': 123,
'MinIopsPerDbInstance': 123,
'MaxIopsPerDbInstance': 123,
'MinIopsPerGib': 123.0,
'MaxIopsPerGib': 123.0,
'AvailableProcessorFeatures': [
{
'Name': 'string',
'DefaultValue': 'string',
'AllowedValues': 'string'
},
],
'SupportedEngineModes': [
'string',
],
'SupportsStorageAutoscaling': True|False,
'SupportsKerberosAuthentication': True|False,
'OutpostCapable': True|False,
'SupportedActivityStreamModes': [
'string',
],
'SupportsGlobalDatabases': True|False,
'SupportsClusters': True|False,
'SupportedNetworkTypes': [
'string',
]
},
],
'Marker': 'string'
}
Response Structure
(dict) --
Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions action.
OrderableDBInstanceOptions (list) --
An OrderableDBInstanceOption structure containing information about orderable options for the DB instance.
(dict) --
Contains a list of available options for a DB instance.
This data type is used as a response element in the DescribeOrderableDBInstanceOptions action.
Engine (string) --
The engine type of a DB instance.
EngineVersion (string) --
The engine version of a DB instance.
DBInstanceClass (string) --
The DB instance class for a DB instance.
LicenseModel (string) --
The license model for a DB instance.
AvailabilityZoneGroup (string) --
The Availability Zone group for a DB instance.
AvailabilityZones (list) --
A list of Availability Zones for a DB instance.
(dict) --
Contains Availability Zone information.
This data type is used as an element in the OrderableDBInstanceOption data type.
Name (string) --
The name of the Availability Zone.
MultiAZCapable (boolean) --
Indicates whether a DB instance is Multi-AZ capable.
ReadReplicaCapable (boolean) --
Indicates whether a DB instance can have a read replica.
Vpc (boolean) --
Indicates whether a DB instance is in a VPC.
SupportsStorageEncryption (boolean) --
Indicates whether a DB instance supports encrypted storage.
StorageType (string) --
Indicates the storage type for a DB instance.
SupportsIops (boolean) --
Indicates whether a DB instance supports provisioned IOPS.
SupportsEnhancedMonitoring (boolean) --
Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.
SupportsIAMDatabaseAuthentication (boolean) --
Indicates whether a DB instance supports IAM database authentication.
SupportsPerformanceInsights (boolean) --
True if a DB instance supports Performance Insights, otherwise false.
MinStorageSize (integer) --
Minimum storage size for a DB instance.
MaxStorageSize (integer) --
Maximum storage size for a DB instance.
MinIopsPerDbInstance (integer) --
Minimum total provisioned IOPS for a DB instance.
MaxIopsPerDbInstance (integer) --
Maximum total provisioned IOPS for a DB instance.
MinIopsPerGib (float) --
Minimum provisioned IOPS per GiB for a DB instance.
MaxIopsPerGib (float) --
Maximum provisioned IOPS per GiB for a DB instance.
AvailableProcessorFeatures (list) --
A list of the available processor features for the DB instance class of a DB instance.
(dict) --
Contains the available processor feature information for the DB instance class of a DB instance.
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
Name (string) --
The name of the processor feature. Valid names are coreCount and threadsPerCore .
DefaultValue (string) --
The default value for the processor feature of the DB instance class.
AllowedValues (string) --
The allowed values for the processor feature of the DB instance class.
SupportedEngineModes (list) --
A list of the supported DB engine modes.
SupportsStorageAutoscaling (boolean) --
Whether Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class.
SupportsKerberosAuthentication (boolean) --
Whether a DB instance supports Kerberos Authentication.
OutpostCapable (boolean) --
Whether a DB instance supports RDS on Outposts.
For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
SupportedActivityStreamModes (list) --
The list of supported modes for Database Activity Streams. Aurora PostgreSQL returns the value [sync, async] . Aurora MySQL and RDS for Oracle return [async] only. If Database Activity Streams isn't supported, the return value is an empty list.
SupportsGlobalDatabases (boolean) --
A value that indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes.
SupportsClusters (boolean) --
Whether DB instances can be configured as a Multi-AZ DB cluster.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
SupportedNetworkTypes (list) --
The network types supported by the DB instance (IPV4 or DUAL ).
A DB instance can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
Marker (string) --
An optional pagination token provided by a previous OrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
Examples
This example lists information for all orderable DB instance options for the specified DB engine, engine version, DB instance class, license model, and VPC settings.
response = client.describe_orderable_db_instance_options(
DBInstanceClass='db.t2.micro',
Engine='mysql',
EngineVersion='5.6.27',
LicenseModel='general-public-license',
Vpc=True,
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
describe_pending_maintenance_actions(**kwargs)¶Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
See also: AWS API Documentation
Request Syntax
response = client.describe_pending_maintenance_actions(
ResourceIdentifier='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
Marker='string',
MaxRecords=123
)
A filter that specifies one or more resources to return pending maintenance actions for.
Supported filters:
db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes pending maintenance actions for the DB clusters identified by these ARNs.db-instance-id - Accepts DB instance identifiers and DB instance ARNs. The results list only includes pending maintenance actions for the DB instances identified by these ARNs.A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
DescribePendingMaintenanceActions request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by MaxRecords .The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
dict
Response Syntax
{
'PendingMaintenanceActions': [
{
'ResourceIdentifier': 'string',
'PendingMaintenanceActionDetails': [
{
'Action': 'string',
'AutoAppliedAfterDate': datetime(2015, 1, 1),
'ForcedApplyDate': datetime(2015, 1, 1),
'OptInStatus': 'string',
'CurrentApplyDate': datetime(2015, 1, 1),
'Description': 'string'
},
]
},
],
'Marker': 'string'
}
Response Structure
(dict) --
Data returned from the DescribePendingMaintenanceActions action.
PendingMaintenanceActions (list) --
A list of the pending maintenance actions for the resource.
(dict) --
Describes the pending maintenance actions for a resource.
ResourceIdentifier (string) --
The ARN of the resource that has pending maintenance actions.
PendingMaintenanceActionDetails (list) --
A list that provides details about the pending maintenance actions for the resource.
(dict) --
Provides information about a pending maintenance action for a resource.
Action (string) --
The type of pending maintenance action that is available for the resource. Valid actions are system-update , db-upgrade , hardware-maintenance , and ca-certificate-rotation .
AutoAppliedAfterDate (datetime) --
The date of the maintenance window when the action is applied. The maintenance action is applied to the resource during its first maintenance window after this date.
ForcedApplyDate (datetime) --
The date when the maintenance action is automatically applied.
On this date, the maintenance action is applied to the resource as soon as possible, regardless of the maintenance window for the resource. There might be a delay of one or more days from this date before the maintenance action is applied.
OptInStatus (string) --
Indicates the type of opt-in request that has been received for the resource.
CurrentApplyDate (datetime) --
The effective date when the pending maintenance action is applied to the resource. This date takes into account opt-in requests received from the ApplyPendingMaintenanceAction API, the AutoAppliedAfterDate , and the ForcedApplyDate . This value is blank if an opt-in request has not been received and nothing has been specified as AutoAppliedAfterDate or ForcedApplyDate .
Description (string) --
A description providing more detail about the maintenance action.
Marker (string) --
An optional pagination token provided by a previous DescribePendingMaintenanceActions request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by MaxRecords .
Exceptions
RDS.Client.exceptions.ResourceNotFoundFaultExamples
This example lists information for all pending maintenance actions for the specified DB instance.
response = client.describe_pending_maintenance_actions(
ResourceIdentifier='arn:aws:rds:us-east-1:992648334831:db:mymysqlinstance',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
describe_reserved_db_instances(**kwargs)¶Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
See also: AWS API Documentation
Request Syntax
response = client.describe_reserved_db_instances(
ReservedDBInstanceId='string',
ReservedDBInstancesOfferingId='string',
DBInstanceClass='string',
Duration='string',
ProductDescription='string',
OfferingType='string',
MultiAZ=True|False,
LeaseId='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.
Valid Values: 1 | 3 | 31536000 | 94608000
The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.
Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"
The lease identifier filter value. Specify this parameter to show only the reservation that matches the specified lease ID.
Note
Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.
This parameter isn't currently supported.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
MaxRecords .dict
Response Syntax
{
'Marker': 'string',
'ReservedDBInstances': [
{
'ReservedDBInstanceId': 'string',
'ReservedDBInstancesOfferingId': 'string',
'DBInstanceClass': 'string',
'StartTime': datetime(2015, 1, 1),
'Duration': 123,
'FixedPrice': 123.0,
'UsagePrice': 123.0,
'CurrencyCode': 'string',
'DBInstanceCount': 123,
'ProductDescription': 'string',
'OfferingType': 'string',
'MultiAZ': True|False,
'State': 'string',
'RecurringCharges': [
{
'RecurringChargeAmount': 123.0,
'RecurringChargeFrequency': 'string'
},
],
'ReservedDBInstanceArn': 'string',
'LeaseId': 'string'
},
]
}
Response Structure
(dict) --
Contains the result of a successful invocation of the DescribeReservedDBInstances action.
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 .
ReservedDBInstances (list) --
A list of reserved DB instances.
(dict) --
This data type is used as a response element in the DescribeReservedDBInstances and PurchaseReservedDBInstancesOffering actions.
ReservedDBInstanceId (string) --
The unique identifier for the reservation.
ReservedDBInstancesOfferingId (string) --
The offering identifier.
DBInstanceClass (string) --
The DB instance class for the reserved DB instance.
StartTime (datetime) --
The time the reservation started.
Duration (integer) --
The duration of the reservation in seconds.
FixedPrice (float) --
The fixed price charged for this reserved DB instance.
UsagePrice (float) --
The hourly price charged for this reserved DB instance.
CurrencyCode (string) --
The currency code for the reserved DB instance.
DBInstanceCount (integer) --
The number of reserved DB instances.
ProductDescription (string) --
The description of the reserved DB instance.
OfferingType (string) --
The offering type of this reserved DB instance.
MultiAZ (boolean) --
Indicates if the reservation applies to Multi-AZ deployments.
State (string) --
The state of the reserved DB instance.
RecurringCharges (list) --
The recurring price charged to run this reserved DB instance.
(dict) --
This data type is used as a response element in the DescribeReservedDBInstances and DescribeReservedDBInstancesOfferings actions.
RecurringChargeAmount (float) --
The amount of the recurring charge.
RecurringChargeFrequency (string) --
The frequency of the recurring charge.
ReservedDBInstanceArn (string) --
The Amazon Resource Name (ARN) for the reserved DB instance.
LeaseId (string) --
The unique identifier for the lease associated with the reserved DB instance.
Note
Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.
Exceptions
RDS.Client.exceptions.ReservedDBInstanceNotFoundFaultExamples
This example lists information for all reserved DB instances for the specified DB instance class, duration, product, offering type, and availability zone settings.
response = client.describe_reserved_db_instances(
DBInstanceClass='db.t2.micro',
Duration='1y',
MultiAZ=False,
OfferingType='No Upfront',
ProductDescription='mysql',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
describe_reserved_db_instances_offerings(**kwargs)¶Lists available reserved DB instance offerings.
See also: AWS API Documentation
Request Syntax
response = client.describe_reserved_db_instances_offerings(
ReservedDBInstancesOfferingId='string',
DBInstanceClass='string',
Duration='string',
ProductDescription='string',
OfferingType='string',
MultiAZ=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier.
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.
Valid Values: 1 | 3 | 31536000 | 94608000
Product description filter value. Specify this parameter to show only the available offerings that contain the specified product description.
Note
The results show offerings that partially match the filter value.
The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.
Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"
This parameter isn't currently supported.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
MaxRecords .dict
Response Syntax
{
'Marker': 'string',
'ReservedDBInstancesOfferings': [
{
'ReservedDBInstancesOfferingId': 'string',
'DBInstanceClass': 'string',
'Duration': 123,
'FixedPrice': 123.0,
'UsagePrice': 123.0,
'CurrencyCode': 'string',
'ProductDescription': 'string',
'OfferingType': 'string',
'MultiAZ': True|False,
'RecurringCharges': [
{
'RecurringChargeAmount': 123.0,
'RecurringChargeFrequency': 'string'
},
]
},
]
}
Response Structure
(dict) --
Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings action.
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 .
ReservedDBInstancesOfferings (list) --
A list of reserved DB instance offerings.
(dict) --
This data type is used as a response element in the DescribeReservedDBInstancesOfferings action.
ReservedDBInstancesOfferingId (string) --
The offering identifier.
DBInstanceClass (string) --
The DB instance class for the reserved DB instance.
Duration (integer) --
The duration of the offering in seconds.
FixedPrice (float) --
The fixed price charged for this offering.
UsagePrice (float) --
The hourly price charged for this offering.
CurrencyCode (string) --
The currency code for the reserved DB instance offering.
ProductDescription (string) --
The database engine used by the offering.
OfferingType (string) --
The offering type.
MultiAZ (boolean) --
Indicates if the offering applies to Multi-AZ deployments.
RecurringCharges (list) --
The recurring price charged to run this reserved DB instance.
(dict) --
This data type is used as a response element in the DescribeReservedDBInstances and DescribeReservedDBInstancesOfferings actions.
RecurringChargeAmount (float) --
The amount of the recurring charge.
RecurringChargeFrequency (string) --
The frequency of the recurring charge.
Exceptions
RDS.Client.exceptions.ReservedDBInstancesOfferingNotFoundFaultExamples
This example lists information for all reserved DB instance offerings for the specified DB instance class, duration, product, offering type, and availability zone settings.
response = client.describe_reserved_db_instances_offerings(
DBInstanceClass='db.t2.micro',
Duration='1y',
MultiAZ=False,
OfferingType='No Upfront',
ProductDescription='mysql',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
describe_source_regions(**kwargs)¶Returns a list of the source Amazon Web Services Regions where the current Amazon Web Services Region can create a read replica, copy a DB snapshot from, or replicate automated backups from. This API action supports pagination.
See also: AWS API Documentation
Request Syntax
response = client.describe_source_regions(
RegionName='string',
MaxRecords=123,
Marker='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
]
)
The source Amazon Web Services Region name. For example, us-east-1 .
Constraints:
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
DescribeSourceRegions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .This parameter isn't currently supported.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'Marker': 'string',
'SourceRegions': [
{
'RegionName': 'string',
'Endpoint': 'string',
'Status': 'string',
'SupportsDBInstanceAutomatedBackupsReplication': True|False
},
]
}
Response Structure
(dict) --
Contains the result of a successful invocation of the DescribeSourceRegions action.
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 .
SourceRegions (list) --
A list of SourceRegion instances that contains each source Amazon Web Services Region that the current Amazon Web Services Region can get a read replica or a DB snapshot from.
(dict) --
Contains an Amazon Web Services Region name as the result of a successful call to the DescribeSourceRegions action.
RegionName (string) --
The name of the source Amazon Web Services Region.
Endpoint (string) --
The endpoint for the source Amazon Web Services Region endpoint.
Status (string) --
The status of the source Amazon Web Services Region.
SupportsDBInstanceAutomatedBackupsReplication (boolean) --
Whether the source Amazon Web Services Region supports replicating automated backups to the current Amazon Web Services Region.
Examples
To list the AWS regions where a Read Replica can be created.
response = client.describe_source_regions(
)
print(response)
Expected Output:
{
'SourceRegions': [
{
'Endpoint': 'https://rds.ap-northeast-1.amazonaws.com',
'RegionName': 'ap-northeast-1',
'Status': 'available',
},
{
'Endpoint': 'https://rds.ap-northeast-2.amazonaws.com',
'RegionName': 'ap-northeast-2',
'Status': 'available',
},
{
'Endpoint': 'https://rds.ap-south-1.amazonaws.com',
'RegionName': 'ap-south-1',
'Status': 'available',
},
{
'Endpoint': 'https://rds.ap-southeast-1.amazonaws.com',
'RegionName': 'ap-southeast-1',
'Status': 'available',
},
{
'Endpoint': 'https://rds.ap-southeast-2.amazonaws.com',
'RegionName': 'ap-southeast-2',
'Status': 'available',
},
{
'Endpoint': 'https://rds.eu-central-1.amazonaws.com',
'RegionName': 'eu-central-1',
'Status': 'available',
},
{
'Endpoint': 'https://rds.eu-west-1.amazonaws.com',
'RegionName': 'eu-west-1',
'Status': 'available',
},
{
'Endpoint': 'https://rds.sa-east-1.amazonaws.com',
'RegionName': 'sa-east-1',
'Status': 'available',
},
{
'Endpoint': 'https://rds.us-west-1.amazonaws.com',
'RegionName': 'us-west-1',
'Status': 'available',
},
{
'Endpoint': 'https://rds.us-west-2.amazonaws.com',
'RegionName': 'us-west-2',
'Status': 'available',
},
],
'ResponseMetadata': {
'...': '...',
},
}
describe_valid_db_instance_modifications(**kwargs)¶You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance .
This command doesn't apply to RDS Custom.
See also: AWS API Documentation
Request Syntax
response = client.describe_valid_db_instance_modifications(
DBInstanceIdentifier='string'
)
[REQUIRED]
The customer identifier or the ARN of your DB instance.
{
'ValidDBInstanceModificationsMessage': {
'Storage': [
{
'StorageType': 'string',
'StorageSize': [
{
'From': 123,
'To': 123,
'Step': 123
},
],
'ProvisionedIops': [
{
'From': 123,
'To': 123,
'Step': 123
},
],
'IopsToStorageRatio': [
{
'From': 123.0,
'To': 123.0
},
],
'SupportsStorageAutoscaling': True|False
},
],
'ValidProcessorFeatures': [
{
'Name': 'string',
'DefaultValue': 'string',
'AllowedValues': 'string'
},
]
}
}
Response Structure
Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the DescribeValidDBInstanceModifications action. You can use this information when you call ModifyDBInstance .
Valid storage options for your DB instance.
Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the DescribeValidDBInstanceModifications action.
The valid storage types for your DB instance. For example, gp2, io1.
The valid range of storage in gibibytes (GiB). For example, 100 to 16384.
A range of integer values.
The minimum value in the range.
The maximum value in the range.
The step value for the range. For example, if you have a range of 5,000 to 10,000, with a step value of 1,000, the valid values start at 5,000 and step up by 1,000. Even though 7,500 is within the range, it isn't a valid value for the range. The valid values are 5,000, 6,000, 7,000, 8,000...
The valid range of provisioned IOPS. For example, 1000-20000.
A range of integer values.
The minimum value in the range.
The maximum value in the range.
The step value for the range. For example, if you have a range of 5,000 to 10,000, with a step value of 1,000, the valid values start at 5,000 and step up by 1,000. Even though 7,500 is within the range, it isn't a valid value for the range. The valid values are 5,000, 6,000, 7,000, 8,000...
The valid range of Provisioned IOPS to gibibytes of storage multiplier. For example, 3-10, which means that provisioned IOPS can be between 3 and 10 times storage.
A range of double values.
The minimum value in the range.
The maximum value in the range.
Whether or not Amazon RDS can automatically scale storage for DB instances that use the new instance class.
Valid processor features for your DB instance.
Contains the available processor feature information for the DB instance class of a DB instance.
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
The name of the processor feature. Valid names are coreCount and threadsPerCore .
The default value for the processor feature of the DB instance class.
The allowed values for the processor feature of the DB instance class.
Exceptions
RDS.Client.exceptions.DBInstanceNotFoundFaultRDS.Client.exceptions.InvalidDBInstanceStateFaultdownload_db_log_file_portion(**kwargs)¶Downloads all or a portion of the specified log file, up to 1 MB in size.
This command doesn't apply to RDS Custom.
See also: AWS API Documentation
Request Syntax
response = client.download_db_log_file_portion(
DBInstanceIdentifier='string',
LogFileName='string',
Marker='string',
NumberOfLines=123
)
[REQUIRED]
The customer-assigned name of the DB instance that contains the log files you want to list.
Constraints:
[REQUIRED]
The name of the log file to be downloaded.
The number of lines to download. If the number of lines specified results in a file over 1 MB in size, the file is truncated at 1 MB in size.
If the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning or the end of the log file, depending on the value of the Marker parameter.
dict
Response Syntax
{
'LogFileData': 'string',
'Marker': 'string',
'AdditionalDataPending': True|False
}
Response Structure
(dict) --
This data type is used as a response element to DownloadDBLogFilePortion .
LogFileData (string) --
Entries from the specified log file.
Marker (string) --
A pagination token that can be used in a later DownloadDBLogFilePortion request.
AdditionalDataPending (boolean) --
Boolean value that if true, indicates there is more data to be downloaded.
Exceptions
RDS.Client.exceptions.DBInstanceNotFoundFaultRDS.Client.exceptions.DBLogFileNotFoundFaultExamples
This example lists information for the specified log file for the specified DB instance.
response = client.download_db_log_file_portion(
DBInstanceIdentifier='mymysqlinstance',
LogFileName='mysqlUpgrade',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
failover_db_cluster(**kwargs)¶Forces a failover for a DB cluster.
For an Aurora DB cluster, failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer).
For a Multi-AZ DB cluster, failover for a DB cluster promotes one of the readable standby DB instances (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer).
An Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists, when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readable standby DB instance when the primary DB instance fails.
To simulate a failure of a primary instance for testing, you can force a failover. Because each instance in a DB cluster has its own endpoint address, make sure to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide .
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide .
See also: AWS API Documentation
Request Syntax
response = client.failover_db_cluster(
DBClusterIdentifier='string',
TargetDBInstanceIdentifier='string'
)
[REQUIRED]
A DB cluster identifier to force a failover for. This parameter isn't case-sensitive.
Constraints:
The name of the DB instance to promote to the primary DB instance.
Specify the DB instance identifier for an Aurora Replica or a Multi-AZ readable standby in the DB cluster, for example mydbcluster-replica1 .
This setting isn't supported for RDS for MySQL Multi-AZ DB clusters.
dict
Response Syntax
{
'DBCluster': {
'AllocatedStorage': 123,
'AvailabilityZones': [
'string',
],
'BackupRetentionPeriod': 123,
'CharacterSetName': 'string',
'DatabaseName': 'string',
'DBClusterIdentifier': 'string',
'DBClusterParameterGroup': 'string',
'DBSubnetGroup': 'string',
'Status': 'string',
'AutomaticRestartTime': datetime(2015, 1, 1),
'PercentProgress': 'string',
'EarliestRestorableTime': datetime(2015, 1, 1),
'Endpoint': 'string',
'ReaderEndpoint': 'string',
'CustomEndpoints': [
'string',
],
'MultiAZ': True|False,
'Engine': 'string',
'EngineVersion': 'string',
'LatestRestorableTime': datetime(2015, 1, 1),
'Port': 123,
'MasterUsername': 'string',
'DBClusterOptionGroupMemberships': [
{
'DBClusterOptionGroupName': 'string',
'Status': 'string'
},
],
'PreferredBackupWindow': 'string',
'PreferredMaintenanceWindow': 'string',
'ReplicationSourceIdentifier': 'string',
'ReadReplicaIdentifiers': [
'string',
],
'DBClusterMembers': [
{
'DBInstanceIdentifier': 'string',
'IsClusterWriter': True|False,
'DBClusterParameterGroupStatus': 'string',
'PromotionTier': 123
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'HostedZoneId': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbClusterResourceId': 'string',
'DBClusterArn': 'string',
'AssociatedRoles': [
{
'RoleArn': 'string',
'Status': 'string',
'FeatureName': 'string'
},
],
'IAMDatabaseAuthenticationEnabled': True|False,
'CloneGroupId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'EarliestBacktrackTime': datetime(2015, 1, 1),
'BacktrackWindow': 123,
'BacktrackConsumedChangeRecords': 123,
'EnabledCloudwatchLogsExports': [
'string',
],
'Capacity': 123,
'EngineMode': 'string',
'ScalingConfigurationInfo': {
'MinCapacity': 123,
'MaxCapacity': 123,
'AutoPause': True|False,
'SecondsUntilAutoPause': 123,
'TimeoutAction': 'string',
'SecondsBeforeTimeout': 123
},
'DeletionProtection': True|False,
'HttpEndpointEnabled': True|False,
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'CopyTagsToSnapshot': True|False,
'CrossAccountClone': True|False,
'DomainMemberships': [
{
'Domain': 'string',
'Status': 'string',
'FQDN': 'string',
'IAMRoleName': 'string'
},
],
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'GlobalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'unknown',
'GlobalWriteForwardingRequested': True|False,
'PendingModifiedValues': {
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
},
'DBClusterIdentifier': 'string',
'MasterUserPassword': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'EngineVersion': 'string'
},
'DBClusterInstanceClass': 'string',
'StorageType': 'string',
'Iops': 123,
'PubliclyAccessible': True|False,
'AutoMinorVersionUpgrade': True|False,
'MonitoringInterval': 123,
'MonitoringRoleArn': 'string',
'PerformanceInsightsEnabled': True|False,
'PerformanceInsightsKMSKeyId': 'string',
'PerformanceInsightsRetentionPeriod': 123,
'ServerlessV2ScalingConfiguration': {
'MinCapacity': 123.0,
'MaxCapacity': 123.0
}
}
}
Response Structure
(dict) --
DBCluster (dict) --
Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
For an Amazon Aurora DB cluster, this data type is used as a response element in the operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , FailoverDBCluster , ModifyDBCluster , PromoteReadReplicaDBCluster , RestoreDBClusterFromS3 , RestoreDBClusterFromSnapshot , RestoreDBClusterToPointInTime , StartDBCluster , and StopDBCluster .
For a Multi-AZ DB cluster, this data type is used as a response element in the operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , FailoverDBCluster , ModifyDBCluster , RebootDBCluster , RestoreDBClusterFromSnapshot , and RestoreDBClusterToPointInTime .
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
AllocatedStorage (integer) --
For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
AvailabilityZones (list) --
Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.
BackupRetentionPeriod (integer) --
Specifies the number of days for which automatic DB snapshots are retained.
CharacterSetName (string) --
If present, specifies the name of the character set that this cluster is associated with.
DatabaseName (string) --
Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.
DBClusterIdentifier (string) --
Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
DBClusterParameterGroup (string) --
Specifies the name of the DB cluster parameter group for the DB cluster.
DBSubnetGroup (string) --
Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
Status (string) --
Specifies the current state of this DB cluster.
AutomaticRestartTime (datetime) --
The time when a stopped DB cluster is restarted automatically.
PercentProgress (string) --
Specifies the progress of the operation as a percentage.
EarliestRestorableTime (datetime) --
The earliest time to which a database can be restored with point-in-time restore.
Endpoint (string) --
Specifies the connection endpoint for the primary instance of the DB cluster.
ReaderEndpoint (string) --
The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.
If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
CustomEndpoints (list) --
Identifies all custom endpoints associated with the cluster.
MultiAZ (boolean) --
Specifies whether the DB cluster has instances in multiple Availability Zones.
Engine (string) --
The name of the database engine to be used for this DB cluster.
EngineVersion (string) --
Indicates the database engine version.
LatestRestorableTime (datetime) --
Specifies the latest time to which a database can be restored with point-in-time restore.
Port (integer) --
Specifies the port that the database engine is listening on.
MasterUsername (string) --
Contains the master username for the DB cluster.
DBClusterOptionGroupMemberships (list) --
Provides the list of option group memberships for this DB cluster.
(dict) --
Contains status information for a DB cluster option group.
DBClusterOptionGroupName (string) --
Specifies the name of the DB cluster option group.
Status (string) --
Specifies the status of the DB cluster option group.
PreferredBackupWindow (string) --
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
ReplicationSourceIdentifier (string) --
Contains the identifier of the source DB cluster if this DB cluster is a read replica.
ReadReplicaIdentifiers (list) --
Contains one or more identifiers of the read replicas associated with this DB cluster.
DBClusterMembers (list) --
Provides the list of instances that make up the DB cluster.
(dict) --
Contains information about an instance that is part of a DB cluster.
DBInstanceIdentifier (string) --
Specifies the instance identifier for this member of the DB cluster.
IsClusterWriter (boolean) --
Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
DBClusterParameterGroupStatus (string) --
Specifies the status of the DB cluster parameter group for this member of the DB cluster.
PromotionTier (integer) --
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .
VpcSecurityGroups (list) --
Provides a list of VPC security groups that the DB cluster belongs to.
(dict) --
This data type is used as a response element for queries on VPC security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The membership status of the VPC security group.
Currently, the only valid status is active .
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
StorageEncrypted (boolean) --
Specifies whether the DB cluster is encrypted.
KmsKeyId (string) --
If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
DbClusterResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for the DB cluster.
AssociatedRoles (list) --
Provides a list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.
(dict) --
Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB cluster.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
Status (string) --
Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other Amazon Web Services on your behalf.PENDING - the IAM role ARN is being associated with the DB cluster.INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other Amazon Web Services on your behalf.FeatureName (string) --
The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion .
IAMDatabaseAuthenticationEnabled (boolean) --
A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
CloneGroupId (string) --
Identifies the clone group to which the DB cluster is associated.
ClusterCreateTime (datetime) --
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
EarliestBacktrackTime (datetime) --
The earliest time to which a DB cluster can be backtracked.
BacktrackWindow (integer) --
The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.
BacktrackConsumedChangeRecords (integer) --
The number of change records stored for Backtrack.
EnabledCloudwatchLogsExports (list) --
A list of log types that this DB cluster is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.
Capacity (integer) --
The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 (zero) when the cluster is paused.
For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide .
EngineMode (string) --
The DB engine mode of the DB cluster, either provisioned , serverless , parallelquery , global , or multimaster .
For more information, see CreateDBCluster .
ScalingConfigurationInfo (dict) --
Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.
For more information, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide .
MinCapacity (integer) --
The minimum capacity for an Aurora DB cluster in serverless DB engine mode.
MaxCapacity (integer) --
The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
AutoPause (boolean) --
A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.
When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.
SecondsUntilAutoPause (integer) --
The remaining amount of time, in seconds, before the Aurora DB cluster in serverless mode is paused. A DB cluster can be paused only when it's idle (it has no connections).
TimeoutAction (string) --
The action that occurs when Aurora times out while attempting to change the capacity of an Aurora Serverless v1 cluster. The value is either ForceApplyCapacityChange or RollbackCapacityChange .
ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.
RollbackCapacityChangeignores the capacity change if a scaling point isn't found in the timeout period.
SecondsBeforeTimeout (integer) --
The number of seconds before scaling times out. What happens when an attempted scaling action times out is determined by the TimeoutAction setting.
DeletionProtection (boolean) --
Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
HttpEndpointEnabled (boolean) --
A value that indicates whether the HTTP endpoint for an Aurora Serverless v1 DB cluster is enabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide .
ActivityStreamMode (string) --
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.
ActivityStreamStatus (string) --
The status of the database activity stream.
ActivityStreamKmsKeyId (string) --
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
ActivityStreamKinesisStreamName (string) --
The name of the Amazon Kinesis data stream used for the database activity stream.
CopyTagsToSnapshot (boolean) --
Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.
CrossAccountClone (boolean) --
Specifies whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
DomainMemberships (list) --
The Active Directory Domain membership records associated with the DB cluster.
(dict) --
An Active Directory Domain membership record associated with the DB instance or cluster.
Domain (string) --
The identifier of the Active Directory Domain.
Status (string) --
The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.
FQDN (string) --
The fully qualified domain name of the Active Directory Domain.
IAMRoleName (string) --
The name of the IAM role to be used when making API calls to the Directory Service.
TagList (list) --
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
GlobalWriteForwardingStatus (string) --
Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.
GlobalWriteForwardingRequested (boolean) --
Specifies whether you have requested to enable write forwarding for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.
PendingModifiedValues (dict) --
A value that specifies that changes to the DB cluster are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
PendingCloudwatchLogsExports (dict) --
A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.
LogTypesToEnable (list) --
Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.
LogTypesToDisable (list) --
Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.
DBClusterIdentifier (string) --
The DBClusterIdentifier value for the DB cluster.
MasterUserPassword (string) --
The master credentials for the DB cluster.
IAMDatabaseAuthenticationEnabled (boolean) --
A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
EngineVersion (string) --
The database engine version.
DBClusterInstanceClass (string) --
The name of the compute and memory capacity class of the DB instance.
This setting is only for non-Aurora Multi-AZ DB clusters.
StorageType (string) --
The storage type associated with the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
Iops (integer) --
The Provisioned IOPS (I/O operations per second) value.
This setting is only for non-Aurora Multi-AZ DB clusters.
PubliclyAccessible (boolean) --
Specifies the accessibility options for the DB instance.
When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance .
This setting is only for non-Aurora Multi-AZ DB clusters.
AutoMinorVersionUpgrade (boolean) --
A value that indicates that minor version patches are applied automatically.
This setting is only for non-Aurora Multi-AZ DB clusters.
MonitoringInterval (integer) --
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
MonitoringRoleArn (string) --
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
This setting is only for non-Aurora Multi-AZ DB clusters.
PerformanceInsightsEnabled (boolean) --
True if Performance Insights is enabled for the DB cluster, and otherwise false.
This setting is only for non-Aurora Multi-AZ DB clusters.
PerformanceInsightsKMSKeyId (string) --
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
This setting is only for non-Aurora Multi-AZ DB clusters.
PerformanceInsightsRetentionPeriod (integer) --
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
For example, the following values are valid:
This setting is only for non-Aurora Multi-AZ DB clusters.
ServerlessV2ScalingConfiguration (dict) --
Shows the scaling configuration for an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide .
MinCapacity (float) --
The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.
MaxCapacity (float) --
The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128.
Exceptions
RDS.Client.exceptions.DBClusterNotFoundFaultRDS.Client.exceptions.InvalidDBClusterStateFaultRDS.Client.exceptions.InvalidDBInstanceStateFaultExamples
This example performs a failover for the specified DB cluster to the specified DB instance.
response = client.failover_db_cluster(
DBClusterIdentifier='myaurorainstance-cluster',
TargetDBInstanceIdentifier='myaurorareplica',
)
print(response)
Expected Output:
{
'DBCluster': {
},
'ResponseMetadata': {
'...': '...',
},
}
failover_global_cluster(**kwargs)¶Initiates the failover process for an Aurora global database ( GlobalCluster ).
A failover for an Aurora global database promotes one of secondary read-only DB clusters to be the primary DB cluster and demotes the primary DB cluster to being a secondary (read-only) DB cluster. In other words, the role of the current primary DB cluster and the selected (target) DB cluster are switched. The selected secondary DB cluster assumes full read/write capabilities for the Aurora global database.
For more information about failing over an Amazon Aurora global database, see Managed planned failover for Amazon Aurora global databases in the Amazon Aurora User Guide .
Note
This action applies to GlobalCluster (Aurora global databases) only. Use this action only on healthy Aurora global databases with running Aurora DB clusters and no Region-wide outages, to test disaster recovery scenarios or to reconfigure your Aurora global database topology.
See also: AWS API Documentation
Request Syntax
response = client.failover_global_cluster(
GlobalClusterIdentifier='string',
TargetDbClusterIdentifier='string'
)
[REQUIRED]
Identifier of the Aurora global database ( GlobalCluster ) that should be failed over. The identifier is the unique key assigned by the user when the Aurora global database was created. In other words, it's the name of the Aurora global database that you want to fail over.
Constraints:
[REQUIRED]
Identifier of the secondary Aurora DB cluster that you want to promote to primary for the Aurora global database ( GlobalCluster .) Use the Amazon Resource Name (ARN) for the identifier so that Aurora can locate the cluster in its Amazon Web Services Region.
dict
Response Syntax
{
'GlobalCluster': {
'GlobalClusterIdentifier': 'string',
'GlobalClusterResourceId': 'string',
'GlobalClusterArn': 'string',
'Status': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'DatabaseName': 'string',
'StorageEncrypted': True|False,
'DeletionProtection': True|False,
'GlobalClusterMembers': [
{
'DBClusterArn': 'string',
'Readers': [
'string',
],
'IsWriter': True|False,
'GlobalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'unknown'
},
],
'FailoverState': {
'Status': 'pending'|'failing-over'|'cancelling',
'FromDbClusterArn': 'string',
'ToDbClusterArn': 'string'
}
}
}
Response Structure
(dict) --
GlobalCluster (dict) --
A data type representing an Aurora global database.
GlobalClusterIdentifier (string) --
Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster.
GlobalClusterResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB cluster is accessed.
GlobalClusterArn (string) --
The Amazon Resource Name (ARN) for the global database cluster.
Status (string) --
Specifies the current state of this global database cluster.
Engine (string) --
The Aurora database engine used by the global database cluster.
EngineVersion (string) --
Indicates the database engine version.
DatabaseName (string) --
The default database name within the new global database cluster.
StorageEncrypted (boolean) --
The storage encryption setting for the global database cluster.
DeletionProtection (boolean) --
The deletion protection setting for the new global database cluster.
GlobalClusterMembers (list) --
The list of cluster IDs for secondary clusters within the global database cluster. Currently limited to 1 item.
(dict) --
A data structure with information about any primary and secondary clusters associated with an Aurora global database.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for each Aurora cluster.
Readers (list) --
The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global database.
IsWriter (boolean) --
Specifies whether the Aurora cluster is the primary cluster (that is, has read-write capability) for the Aurora global database with which it is associated.
GlobalWriteForwardingStatus (string) --
Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.
FailoverState (dict) --
A data object containing all properties for the current state of an in-process or pending failover process for this Aurora global database. This object is empty unless the FailoverGlobalCluster API operation has been called on this Aurora global database ( GlobalCluster ).
Status (string) --
The current status of the Aurora global database ( GlobalCluster ). Possible values are as follows:
GlobalCluster 's primary DB cluster and the specified secondary DB cluster are being verified before the failover process can start.FromDbClusterArn (string) --
The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being demoted, and which is associated with this state.
ToDbClusterArn (string) --
The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being promoted, and which is associated with this state.
Exceptions
RDS.Client.exceptions.GlobalClusterNotFoundFaultRDS.Client.exceptions.InvalidGlobalClusterStateFaultRDS.Client.exceptions.InvalidDBClusterStateFaultRDS.Client.exceptions.DBClusterNotFoundFaultgenerate_db_auth_token(DBHostname, Port, DBUsername, Region=None)¶Generates an auth token used to connect to a db with IAM credentials.
A presigned url which can be used as an auth token.
get_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_waiter(waiter_name)¶Returns an object that can wait for some condition.
Lists all tags on an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide .
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceName='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
]
)
[REQUIRED]
The Amazon RDS resource with tags to be listed. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide .
This parameter isn't currently supported.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
TagList (list) --
List of tags returned by the ListTagsForResource operation.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Exceptions
RDS.Client.exceptions.DBInstanceNotFoundFaultRDS.Client.exceptions.DBSnapshotNotFoundFaultRDS.Client.exceptions.DBClusterNotFoundFaultRDS.Client.exceptions.DBProxyNotFoundFaultRDS.Client.exceptions.DBProxyTargetGroupNotFoundFaultExamples
This example lists information about all tags associated with the specified DB option group.
response = client.list_tags_for_resource(
ResourceName='arn:aws:rds:us-east-1:992648334831:og:mymysqloptiongroup',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
modify_activity_stream(**kwargs)¶Changes the audit policy state of a database activity stream to either locked (default) or unlocked. A locked policy is read-only, whereas an unlocked policy is read/write. If your activity stream is started and locked, you can unlock it, customize your audit policy, and then lock your activity stream. Restarting the activity stream isn't required. For more information, see Modifying a database activity stream in the Amazon RDS User Guide .
This operation is supported for RDS for Oracle only.
See also: AWS API Documentation
Request Syntax
response = client.modify_activity_stream(
ResourceArn='string',
AuditPolicyState='locked'|'unlocked'
)
arn:aws:rds:us-east-1:12345667890:instance:my-orcl-db .dict
Response Syntax
{
'KmsKeyId': 'string',
'KinesisStreamName': 'string',
'Status': 'stopped'|'starting'|'started'|'stopping',
'Mode': 'sync'|'async',
'EngineNativeAuditFieldsIncluded': True|False,
'PolicyStatus': 'locked'|'unlocked'|'locking-policy'|'unlocking-policy'
}
Response Structure
(dict) --
KmsKeyId (string) --
The Amazon Web Services KMS key identifier for encryption of messages in the database activity stream.
KinesisStreamName (string) --
The name of the Amazon Kinesis data stream to be used for the database activity stream.
Status (string) --
The status of the modification to the database activity stream.
Mode (string) --
The mode of the database activity stream.
EngineNativeAuditFieldsIncluded (boolean) --
Indicates whether engine-native audit fields are included in the database activity stream.
PolicyStatus (string) --
The status of the modification to the policy state of the database activity stream.
Exceptions
RDS.Client.exceptions.InvalidDBInstanceStateFaultRDS.Client.exceptions.ResourceNotFoundFaultRDS.Client.exceptions.DBInstanceNotFoundFaultmodify_certificates(**kwargs)¶Override the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS) certificate for Amazon RDS for new DB instances, or remove the override.
By using this operation, you can specify an RDS-approved SSL/TLS certificate for new DB instances that is different from the default certificate provided by RDS. You can also use this operation to remove the override, so that new DB instances use the default certificate provided by RDS.
You might need to override the default certificate in the following situations:
For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate in the Amazon RDS User Guide .
For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide .
See also: AWS API Documentation
Request Syntax
response = client.modify_certificates(
CertificateIdentifier='string',
RemoveCustomerOverride=True|False
)
The new default certificate identifier to override the current one with.
To determine the valid values, use the describe-certificates CLI command or the DescribeCertificates API operation.
dict
Response Syntax
{
'Certificate': {
'CertificateIdentifier': 'string',
'CertificateType': 'string',
'Thumbprint': 'string',
'ValidFrom': datetime(2015, 1, 1),
'ValidTill': datetime(2015, 1, 1),
'CertificateArn': 'string',
'CustomerOverride': True|False,
'CustomerOverrideValidTill': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Certificate (dict) --
A CA certificate for an Amazon Web Services account.
CertificateIdentifier (string) --
The unique key that identifies a certificate.
CertificateType (string) --
The type of the certificate.
Thumbprint (string) --
The thumbprint of the certificate.
ValidFrom (datetime) --
The starting date from which the certificate is valid.
ValidTill (datetime) --
The final date that the certificate continues to be valid.
CertificateArn (string) --
The Amazon Resource Name (ARN) for the certificate.
CustomerOverride (boolean) --
Whether there is an override for the default certificate identifier.
CustomerOverrideValidTill (datetime) --
If there is an override for the default certificate identifier, when the override expires.
Exceptions
RDS.Client.exceptions.CertificateNotFoundFaultmodify_current_db_cluster_capacity(**kwargs)¶Set the capacity of an Aurora Serverless v1 DB cluster to a specific value.
Aurora Serverless v1 scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might not scale fast enough to meet a sudden change in workload, such as a large number of new transactions. Call ModifyCurrentDBClusterCapacity to set the capacity explicitly.
After this call sets the DB cluster capacity, Aurora Serverless v1 can automatically scale the DB cluster based on the cooldown period for scaling up and the cooldown period for scaling down.
For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide .
Warning
If you call ModifyCurrentDBClusterCapacity with the default TimeoutAction , connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped. For more information about scaling points, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide .
Note
This action only applies to Aurora Serverless v1 DB clusters.
See also: AWS API Documentation
Request Syntax
response = client.modify_current_db_cluster_capacity(
DBClusterIdentifier='string',
Capacity=123,
SecondsBeforeTimeout=123,
TimeoutAction='string'
)
[REQUIRED]
The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.
Constraints:
The DB cluster capacity.
When you change the capacity of a paused Aurora Serverless v1 DB cluster, it automatically resumes.
Constraints:
1 , 2 , 4 , 8 , 16 , 32 , 64 , 128 , and 256 .2 , 4 , 8 , 16 , 32 , 64 , 192 , and 384 .The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.
Specify a value between 10 and 600 seconds.
The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange .
ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.
RollbackCapacityChangeignores the capacity change if a scaling point isn't found in the timeout period.
dict
Response Syntax
{
'DBClusterIdentifier': 'string',
'PendingCapacity': 123,
'CurrentCapacity': 123,
'SecondsBeforeTimeout': 123,
'TimeoutAction': 'string'
}
Response Structure
(dict) --
DBClusterIdentifier (string) --
A user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
PendingCapacity (integer) --
A value that specifies the capacity that the DB cluster scales to next.
CurrentCapacity (integer) --
The current capacity of the DB cluster.
SecondsBeforeTimeout (integer) --
The number of seconds before a call to ModifyCurrentDBClusterCapacity times out.
TimeoutAction (string) --
The timeout action of a call to ModifyCurrentDBClusterCapacity , either ForceApplyCapacityChange or RollbackCapacityChange .
Exceptions
RDS.Client.exceptions.DBClusterNotFoundFaultRDS.Client.exceptions.InvalidDBClusterStateFaultRDS.Client.exceptions.InvalidDBClusterCapacityFaultmodify_custom_db_engine_version(**kwargs)¶Modifies the status of a custom engine version (CEV). You can find CEVs to modify by calling DescribeDBEngineVersions .
Note
The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the ModifyCustomDbEngineVersion event aren't logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the ModifyCustomDbEngineVersion event.
For more information, see Modifying CEV status in the Amazon RDS User Guide .
See also: AWS API Documentation
Request Syntax
response = client.modify_custom_db_engine_version(
Engine='string',
EngineVersion='string',
Description='string',
Status='available'|'inactive'|'inactive-except-restore'
)
[REQUIRED]
The DB engine. The only supported value is custom-oracle-ee .
[REQUIRED]
The custom engine version (CEV) that you want to modify. This option is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Amazon Web Services Region.
The availability status to be assigned to the CEV. Valid values are as follows:
available
You can use this CEV to create a new RDS Custom DB instance.
inactive
You can create a new RDS Custom instance by restoring a DB snapshot with this CEV. You can't patch or create new instances with this CEV.
You can change any status to any status. A typical reason to change status is to prevent the accidental use of a CEV, or to make a deprecated CEV eligible for use again. For example, you might change the status of your CEV from available to inactive , and from inactive back to available . To change the availability status of the CEV, it must not currently be in use by an RDS Custom instance, snapshot, or automated backup.
dict
Response Syntax
{
'Engine': 'string',
'EngineVersion': 'string',
'DBParameterGroupFamily': 'string',
'DBEngineDescription': 'string',
'DBEngineVersionDescription': 'string',
'DefaultCharacterSet': {
'CharacterSetName': 'string',
'CharacterSetDescription': 'string'
},
'SupportedCharacterSets': [
{
'CharacterSetName': 'string',
'CharacterSetDescription': 'string'
},
],
'SupportedNcharCharacterSets': [
{
'CharacterSetName': 'string',
'CharacterSetDescription': 'string'
},
],
'ValidUpgradeTarget': [
{
'Engine': 'string',
'EngineVersion': 'string',
'Description': 'string',
'AutoUpgrade': True|False,
'IsMajorVersionUpgrade': True|False,
'SupportedEngineModes': [
'string',
],
'SupportsParallelQuery': True|False,
'SupportsGlobalDatabases': True|False,
'SupportsBabelfish': True|False
},
],
'SupportedTimezones': [
{
'TimezoneName': 'string'
},
],
'ExportableLogTypes': [
'string',
],
'SupportsLogExportsToCloudwatchLogs': True|False,
'SupportsReadReplica': True|False,
'SupportedEngineModes': [
'string',
],
'SupportedFeatureNames': [
'string',
],
'Status': 'string',
'SupportsParallelQuery': True|False,
'SupportsGlobalDatabases': True|False,
'MajorEngineVersion': 'string',
'DatabaseInstallationFilesS3BucketName': 'string',
'DatabaseInstallationFilesS3Prefix': 'string',
'DBEngineVersionArn': 'string',
'KMSKeyId': 'string',
'CreateTime': datetime(2015, 1, 1),
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'SupportsBabelfish': True|False
}
Response Structure
(dict) --
This data type is used as a response element in the action DescribeDBEngineVersions .
Engine (string) --
The name of the database engine.
EngineVersion (string) --
The version number of the database engine.
DBParameterGroupFamily (string) --
The name of the DB parameter group family for the database engine.
DBEngineDescription (string) --
The description of the database engine.
DBEngineVersionDescription (string) --
The description of the database engine version.
DefaultCharacterSet (dict) --
The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API isn't specified.
CharacterSetName (string) --
The name of the character set.
CharacterSetDescription (string) --
The description of the character set.
SupportedCharacterSets (list) --
A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance operation.
(dict) --
This data type is used as a response element in the action DescribeDBEngineVersions .
CharacterSetName (string) --
The name of the character set.
CharacterSetDescription (string) --
The description of the character set.
SupportedNcharCharacterSets (list) --
A list of the character sets supported by the Oracle DB engine for the NcharCharacterSetName parameter of the CreateDBInstance operation.
(dict) --
This data type is used as a response element in the action DescribeDBEngineVersions .
CharacterSetName (string) --
The name of the character set.
CharacterSetDescription (string) --
The description of the character set.
ValidUpgradeTarget (list) --
A list of engine versions that this database engine version can be upgraded to.
(dict) --
The version of the database engine that a DB 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 a DB 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 upgrading to the target version requires upgrading the major version of the database engine.
SupportedEngineModes (list) --
A list of the supported DB engine modes for the target engine version.
SupportsParallelQuery (boolean) --
A value that indicates whether you can use Aurora parallel query with the target engine version.
SupportsGlobalDatabases (boolean) --
A value that indicates whether you can use Aurora global databases with the target engine version.
SupportsBabelfish (boolean) --
A value that indicates whether you can use Babelfish for Aurora PostgreSQL with the target engine version.
SupportedTimezones (list) --
A list of the time zones supported by this engine for the Timezone parameter of the CreateDBInstance action.
(dict) --
A time zone associated with a DBInstance or a DBSnapshot . This data type is an element in the response to the DescribeDBInstances , the DescribeDBSnapshots , and the DescribeDBEngineVersions actions.
TimezoneName (string) --
The name of the time zone.
ExportableLogTypes (list) --
The types of logs that the database engine has available for export to CloudWatch Logs.
SupportsLogExportsToCloudwatchLogs (boolean) --
A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.
SupportsReadReplica (boolean) --
Indicates whether the database engine version supports read replicas.
SupportedEngineModes (list) --
A list of the supported DB engine modes.
SupportedFeatureNames (list) --
A list of features supported by the DB engine.
The supported features vary by DB engine and DB engine version.
To determine the supported features for a specific DB engine and DB engine version using the CLI, use the following command:
aws rds describe-db-engine-versions --engine <engine_name> --engine-version <engine_version>
For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, use the following command:
aws rds describe-db-engine-versions --engine postgres --engine-version 13.3
The supported features are listed under SupportedFeatureNames in the output.
Status (string) --
The status of the DB engine version, either available or deprecated .
SupportsParallelQuery (boolean) --
A value that indicates whether you can use Aurora parallel query with a specific DB engine version.
SupportsGlobalDatabases (boolean) --
A value that indicates whether you can use Aurora global databases with a specific DB engine version.
MajorEngineVersion (string) --
The major engine version of the CEV.
DatabaseInstallationFilesS3BucketName (string) --
The name of the Amazon S3 bucket that contains your database installation files.
DatabaseInstallationFilesS3Prefix (string) --
The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.
DBEngineVersionArn (string) --
The ARN of the custom engine version.
KMSKeyId (string) --
The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.
CreateTime (datetime) --
The creation time of the DB engine version.
TagList (list) --
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
SupportsBabelfish (boolean) --
A value that indicates whether the engine version supports Babelfish for Aurora PostgreSQL.
Exceptions
RDS.Client.exceptions.CustomDBEngineVersionNotFoundFaultRDS.Client.exceptions.InvalidCustomDBEngineVersionStateFaultmodify_db_cluster(**kwargs)¶Modify the settings for an Amazon Aurora DB cluster or a Multi-AZ DB cluster. You can change one or more settings by specifying these parameters and the new values in the request.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide .
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide .
See also: AWS API Documentation
Request Syntax
response = client.modify_db_cluster(
DBClusterIdentifier='string',
NewDBClusterIdentifier='string',
ApplyImmediately=True|False,
BackupRetentionPeriod=123,
DBClusterParameterGroupName='string',
VpcSecurityGroupIds=[
'string',
],
Port=123,
MasterUserPassword='string',
OptionGroupName='string',
PreferredBackupWindow='string',
PreferredMaintenanceWindow='string',
EnableIAMDatabaseAuthentication=True|False,
BacktrackWindow=123,
CloudwatchLogsExportConfiguration={
'EnableLogTypes': [
'string',
],
'DisableLogTypes': [
'string',
]
},
EngineVersion='string',
AllowMajorVersionUpgrade=True|False,
DBInstanceParameterGroupName='string',
Domain='string',
DomainIAMRoleName='string',
ScalingConfiguration={
'MinCapacity': 123,
'MaxCapacity': 123,
'AutoPause': True|False,
'SecondsUntilAutoPause': 123,
'TimeoutAction': 'string',
'SecondsBeforeTimeout': 123
},
DeletionProtection=True|False,
EnableHttpEndpoint=True|False,
CopyTagsToSnapshot=True|False,
EnableGlobalWriteForwarding=True|False,
DBClusterInstanceClass='string',
AllocatedStorage=123,
StorageType='string',
Iops=123,
AutoMinorVersionUpgrade=True|False,
MonitoringInterval=123,
MonitoringRoleArn='string',
EnablePerformanceInsights=True|False,
PerformanceInsightsKMSKeyId='string',
PerformanceInsightsRetentionPeriod=123,
ServerlessV2ScalingConfiguration={
'MinCapacity': 123.0,
'MaxCapacity': 123.0
}
)
[REQUIRED]
The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.
Constraints: This identifier must match the identifier of an existing DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.
Constraints:
Example: my-cluster2
Valid for: Aurora DB clusters only
A value that indicates whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB cluster. If this parameter is disabled, changes to the DB cluster are applied during the next maintenance window.
The ApplyImmediately parameter only affects the EnableIAMDatabaseAuthentication , MasterUserPassword , and NewDBClusterIdentifier values. If the ApplyImmediately parameter is disabled, then changes to the EnableIAMDatabaseAuthentication , MasterUserPassword , and NewDBClusterIdentifier values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.
By default, this parameter is disabled.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
The number of days for which automated backups are retained. Specify a minimum value of 1.
Default: 1
Constraints:
Valid for: Aurora DB clusters and Multi-AZ DB clusters
The name of the DB cluster parameter group to use for the DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
A list of VPC security groups that the DB cluster will belong to.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
The port number on which the DB cluster accepts connections.
Constraints: Value must be 1150-65535
Default: The same port as the original DB cluster.
Valid for: Aurora DB clusters only
The new password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".
Constraints: Must contain from 8 to 41 characters.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
A value that indicates that the DB cluster should be associated with the specified option group.
DB clusters are associated with a default option group that can't be modified.
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. To view the time blocks available, see Backup window in the Amazon Aurora User Guide .
Constraints:
hh24:mi-hh24:mi .Valid for: Aurora DB clusters and Multi-AZ DB clusters
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide .
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide .
Valid for: Aurora DB clusters only
The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Default: 0
Constraints:
Valid for: Aurora MySQL DB clusters only
The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster. The values in the list depend on the DB engine being used.
RDS for MySQL
Possible values are error , general , and slowquery .
RDS for PostgreSQL
Possible values are postgresql and upgrade .
Aurora MySQL
Possible values are audit , error , general , and slowquery .
Aurora PostgreSQL
Possible value is postgresql .
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide .
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide .
Valid for: Aurora DB clusters and Multi-AZ DB clusters
The list of log types to enable.
The list of log types to disable.
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 MySQL 5.6-compatible Aurora, use the following command:
aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora, use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for Aurora PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for MySQL, use the following command:
aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"
Valid for: Aurora DB clusters and Multi-AZ DB clusters
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 DB cluster's current version.
Valid for: Aurora DB clusters only
The name of the DB parameter group to apply to all instances of the DB cluster.
Note
When you apply a parameter group using the DBInstanceParameterGroupName parameter, the DB cluster isn't rebooted automatically. Also, parameter changes are applied immediately rather than during the next maintenance window.
Default: The existing name setting
Constraints:
DBInstanceParameterGroupName parameter is valid in combination with the AllowMajorVersionUpgrade parameter for a major version upgrade only.Valid for: Aurora DB clusters only
The Active Directory directory ID to move the DB cluster to. Specify none to remove the cluster from its current domain. The domain must be created prior to this operation.
For more information, see Kerberos Authentication in the Amazon Aurora User Guide .
Valid for: Aurora DB clusters only
Specify the name of the IAM role to be used when making API calls to the Directory Service.
Valid for: Aurora DB clusters only
The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.
Valid for: Aurora DB clusters only
The minimum capacity for an Aurora DB cluster in serverless DB engine mode.
For Aurora MySQL, valid capacity values are 1 , 2 , 4 , 8 , 16 , 32 , 64 , 128 , and 256 .
For Aurora PostgreSQL, valid capacity values are 2 , 4 , 8 , 16 , 32 , 64 , 192 , and 384 .
The minimum capacity must be less than or equal to the maximum capacity.
The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
For Aurora MySQL, valid capacity values are 1 , 2 , 4 , 8 , 16 , 32 , 64 , 128 , and 256 .
For Aurora PostgreSQL, valid capacity values are 2 , 4 , 8 , 16 , 32 , 64 , 192 , and 384 .
The maximum capacity must be greater than or equal to the minimum capacity.
A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections).
Note
If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.
The time, in seconds, before an Aurora DB cluster in serverless mode is paused.
Specify a value between 300 and 86,400 seconds.
The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange .
ForceApplyCapacityChangesets the capacity to the specified value as soon as possible.
RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period.
Warning
If you specify ForceApplyCapacityChange , connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped.
For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide .
The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.
Specify a value between 60 and 600 seconds.
A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless v1 DB cluster. By default, the HTTP endpoint is disabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide .
Valid for: Aurora DB clusters only
A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an Aurora global database ( GlobalCluster ). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.
You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by the FailoverGlobalCluster API operation, but it does nothing until then.
Valid for: Aurora DB clusters only
The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
For the full list of DB instance classes and availability for your engine, see DB Instance Class in the Amazon RDS User Guide .
Valid for: Multi-AZ DB clusters only
The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
Type: Integer
Valid for: Multi-AZ DB clusters only
Specifies the storage type to be associated with the DB cluster.
Valid values: io1
When specified, a value for the Iops parameter is required.
Default: io1
Valid for: Multi-AZ DB clusters only
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
For information about valid Iops values, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide .
Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
Valid for: Multi-AZ DB clusters only
A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically.
Valid for: Multi-AZ DB clusters only
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0.
If MonitoringRoleArn is specified, also set MonitoringInterval to a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
Valid for: Multi-AZ DB clusters only
The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is arn:aws:iam:123456789012:role/emaccess . For information on creating a monitoring role, see To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.
Valid for: Multi-AZ DB clusters only
A value that indicates whether to turn on Performance Insights for the DB cluster.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide .
Valid for: Multi-AZ DB clusters only
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you don't specify a value for PerformanceInsightsKMSKeyId , then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
Valid for: Multi-AZ DB clusters only
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
For example, the following values are valid:
If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
Valid for: Multi-AZ DB clusters only
Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide .
The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.
The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128.
dict
Response Syntax
{
'DBCluster': {
'AllocatedStorage': 123,
'AvailabilityZones': [
'string',
],
'BackupRetentionPeriod': 123,
'CharacterSetName': 'string',
'DatabaseName': 'string',
'DBClusterIdentifier': 'string',
'DBClusterParameterGroup': 'string',
'DBSubnetGroup': 'string',
'Status': 'string',
'AutomaticRestartTime': datetime(2015, 1, 1),
'PercentProgress': 'string',
'EarliestRestorableTime': datetime(2015, 1, 1),
'Endpoint': 'string',
'ReaderEndpoint': 'string',
'CustomEndpoints': [
'string',
],
'MultiAZ': True|False,
'Engine': 'string',
'EngineVersion': 'string',
'LatestRestorableTime': datetime(2015, 1, 1),
'Port': 123,
'MasterUsername': 'string',
'DBClusterOptionGroupMemberships': [
{
'DBClusterOptionGroupName': 'string',
'Status': 'string'
},
],
'PreferredBackupWindow': 'string',
'PreferredMaintenanceWindow': 'string',
'ReplicationSourceIdentifier': 'string',
'ReadReplicaIdentifiers': [
'string',
],
'DBClusterMembers': [
{
'DBInstanceIdentifier': 'string',
'IsClusterWriter': True|False,
'DBClusterParameterGroupStatus': 'string',
'PromotionTier': 123
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'HostedZoneId': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbClusterResourceId': 'string',
'DBClusterArn': 'string',
'AssociatedRoles': [
{
'RoleArn': 'string',
'Status': 'string',
'FeatureName': 'string'
},
],
'IAMDatabaseAuthenticationEnabled': True|False,
'CloneGroupId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'EarliestBacktrackTime': datetime(2015, 1, 1),
'BacktrackWindow': 123,
'BacktrackConsumedChangeRecords': 123,
'EnabledCloudwatchLogsExports': [
'string',
],
'Capacity': 123,
'EngineMode': 'string',
'ScalingConfigurationInfo': {
'MinCapacity': 123,
'MaxCapacity': 123,
'AutoPause': True|False,
'SecondsUntilAutoPause': 123,
'TimeoutAction': 'string',
'SecondsBeforeTimeout': 123
},
'DeletionProtection': True|False,
'HttpEndpointEnabled': True|False,
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'CopyTagsToSnapshot': True|False,
'CrossAccountClone': True|False,
'DomainMemberships': [
{
'Domain': 'string',
'Status': 'string',
'FQDN': 'string',
'IAMRoleName': 'string'
},
],
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'GlobalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'unknown',
'GlobalWriteForwardingRequested': True|False,
'PendingModifiedValues': {
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
},
'DBClusterIdentifier': 'string',
'MasterUserPassword': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'EngineVersion': 'string'
},
'DBClusterInstanceClass': 'string',
'StorageType': 'string',
'Iops': 123,
'PubliclyAccessible': True|False,
'AutoMinorVersionUpgrade': True|False,
'MonitoringInterval': 123,
'MonitoringRoleArn': 'string',
'PerformanceInsightsEnabled': True|False,
'PerformanceInsightsKMSKeyId': 'string',
'PerformanceInsightsRetentionPeriod': 123,
'ServerlessV2ScalingConfiguration': {
'MinCapacity': 123.0,
'MaxCapacity': 123.0
}
}
}
Response Structure
(dict) --
DBCluster (dict) --
Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
For an Amazon Aurora DB cluster, this data type is used as a response element in the operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , FailoverDBCluster , ModifyDBCluster , PromoteReadReplicaDBCluster , RestoreDBClusterFromS3 , RestoreDBClusterFromSnapshot , RestoreDBClusterToPointInTime , StartDBCluster , and StopDBCluster .
For a Multi-AZ DB cluster, this data type is used as a response element in the operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , FailoverDBCluster , ModifyDBCluster , RebootDBCluster , RestoreDBClusterFromSnapshot , and RestoreDBClusterToPointInTime .
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
AllocatedStorage (integer) --
For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
AvailabilityZones (list) --
Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.
BackupRetentionPeriod (integer) --
Specifies the number of days for which automatic DB snapshots are retained.
CharacterSetName (string) --
If present, specifies the name of the character set that this cluster is associated with.
DatabaseName (string) --
Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.
DBClusterIdentifier (string) --
Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
DBClusterParameterGroup (string) --
Specifies the name of the DB cluster parameter group for the DB cluster.
DBSubnetGroup (string) --
Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
Status (string) --
Specifies the current state of this DB cluster.
AutomaticRestartTime (datetime) --
The time when a stopped DB cluster is restarted automatically.
PercentProgress (string) --
Specifies the progress of the operation as a percentage.
EarliestRestorableTime (datetime) --
The earliest time to which a database can be restored with point-in-time restore.
Endpoint (string) --
Specifies the connection endpoint for the primary instance of the DB cluster.
ReaderEndpoint (string) --
The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.
If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
CustomEndpoints (list) --
Identifies all custom endpoints associated with the cluster.
MultiAZ (boolean) --
Specifies whether the DB cluster has instances in multiple Availability Zones.
Engine (string) --
The name of the database engine to be used for this DB cluster.
EngineVersion (string) --
Indicates the database engine version.
LatestRestorableTime (datetime) --
Specifies the latest time to which a database can be restored with point-in-time restore.
Port (integer) --
Specifies the port that the database engine is listening on.
MasterUsername (string) --
Contains the master username for the DB cluster.
DBClusterOptionGroupMemberships (list) --
Provides the list of option group memberships for this DB cluster.
(dict) --
Contains status information for a DB cluster option group.
DBClusterOptionGroupName (string) --
Specifies the name of the DB cluster option group.
Status (string) --
Specifies the status of the DB cluster option group.
PreferredBackupWindow (string) --
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
ReplicationSourceIdentifier (string) --
Contains the identifier of the source DB cluster if this DB cluster is a read replica.
ReadReplicaIdentifiers (list) --
Contains one or more identifiers of the read replicas associated with this DB cluster.
DBClusterMembers (list) --
Provides the list of instances that make up the DB cluster.
(dict) --
Contains information about an instance that is part of a DB cluster.
DBInstanceIdentifier (string) --
Specifies the instance identifier for this member of the DB cluster.
IsClusterWriter (boolean) --
Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
DBClusterParameterGroupStatus (string) --
Specifies the status of the DB cluster parameter group for this member of the DB cluster.
PromotionTier (integer) --
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .
VpcSecurityGroups (list) --
Provides a list of VPC security groups that the DB cluster belongs to.
(dict) --
This data type is used as a response element for queries on VPC security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The membership status of the VPC security group.
Currently, the only valid status is active .
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
StorageEncrypted (boolean) --
Specifies whether the DB cluster is encrypted.
KmsKeyId (string) --
If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
DbClusterResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for the DB cluster.
AssociatedRoles (list) --
Provides a list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.
(dict) --
Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB cluster.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
Status (string) --
Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other Amazon Web Services on your behalf.PENDING - the IAM role ARN is being associated with the DB cluster.INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other Amazon Web Services on your behalf.FeatureName (string) --
The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion .
IAMDatabaseAuthenticationEnabled (boolean) --
A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
CloneGroupId (string) --
Identifies the clone group to which the DB cluster is associated.
ClusterCreateTime (datetime) --
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
EarliestBacktrackTime (datetime) --
The earliest time to which a DB cluster can be backtracked.
BacktrackWindow (integer) --
The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.
BacktrackConsumedChangeRecords (integer) --
The number of change records stored for Backtrack.
EnabledCloudwatchLogsExports (list) --
A list of log types that this DB cluster is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.
Capacity (integer) --
The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 (zero) when the cluster is paused.
For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide .
EngineMode (string) --
The DB engine mode of the DB cluster, either provisioned , serverless , parallelquery , global , or multimaster .
For more information, see CreateDBCluster .
ScalingConfigurationInfo (dict) --
Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.
For more information, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide .
MinCapacity (integer) --
The minimum capacity for an Aurora DB cluster in serverless DB engine mode.
MaxCapacity (integer) --
The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
AutoPause (boolean) --
A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.
When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.
SecondsUntilAutoPause (integer) --
The remaining amount of time, in seconds, before the Aurora DB cluster in serverless mode is paused. A DB cluster can be paused only when it's idle (it has no connections).
TimeoutAction (string) --
The action that occurs when Aurora times out while attempting to change the capacity of an Aurora Serverless v1 cluster. The value is either ForceApplyCapacityChange or RollbackCapacityChange .
ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.
RollbackCapacityChangeignores the capacity change if a scaling point isn't found in the timeout period.
SecondsBeforeTimeout (integer) --
The number of seconds before scaling times out. What happens when an attempted scaling action times out is determined by the TimeoutAction setting.
DeletionProtection (boolean) --
Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
HttpEndpointEnabled (boolean) --
A value that indicates whether the HTTP endpoint for an Aurora Serverless v1 DB cluster is enabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide .
ActivityStreamMode (string) --
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.
ActivityStreamStatus (string) --
The status of the database activity stream.
ActivityStreamKmsKeyId (string) --
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
ActivityStreamKinesisStreamName (string) --
The name of the Amazon Kinesis data stream used for the database activity stream.
CopyTagsToSnapshot (boolean) --
Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.
CrossAccountClone (boolean) --
Specifies whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
DomainMemberships (list) --
The Active Directory Domain membership records associated with the DB cluster.
(dict) --
An Active Directory Domain membership record associated with the DB instance or cluster.
Domain (string) --
The identifier of the Active Directory Domain.
Status (string) --
The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.
FQDN (string) --
The fully qualified domain name of the Active Directory Domain.
IAMRoleName (string) --
The name of the IAM role to be used when making API calls to the Directory Service.
TagList (list) --
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
GlobalWriteForwardingStatus (string) --
Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.
GlobalWriteForwardingRequested (boolean) --
Specifies whether you have requested to enable write forwarding for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.
PendingModifiedValues (dict) --
A value that specifies that changes to the DB cluster are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
PendingCloudwatchLogsExports (dict) --
A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.
LogTypesToEnable (list) --
Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.
LogTypesToDisable (list) --
Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.
DBClusterIdentifier (string) --
The DBClusterIdentifier value for the DB cluster.
MasterUserPassword (string) --
The master credentials for the DB cluster.
IAMDatabaseAuthenticationEnabled (boolean) --
A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
EngineVersion (string) --
The database engine version.
DBClusterInstanceClass (string) --
The name of the compute and memory capacity class of the DB instance.
This setting is only for non-Aurora Multi-AZ DB clusters.
StorageType (string) --
The storage type associated with the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
Iops (integer) --
The Provisioned IOPS (I/O operations per second) value.
This setting is only for non-Aurora Multi-AZ DB clusters.
PubliclyAccessible (boolean) --
Specifies the accessibility options for the DB instance.
When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance .
This setting is only for non-Aurora Multi-AZ DB clusters.
AutoMinorVersionUpgrade (boolean) --
A value that indicates that minor version patches are applied automatically.
This setting is only for non-Aurora Multi-AZ DB clusters.
MonitoringInterval (integer) --
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
MonitoringRoleArn (string) --
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
This setting is only for non-Aurora Multi-AZ DB clusters.
PerformanceInsightsEnabled (boolean) --
True if Performance Insights is enabled for the DB cluster, and otherwise false.
This setting is only for non-Aurora Multi-AZ DB clusters.
PerformanceInsightsKMSKeyId (string) --
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
This setting is only for non-Aurora Multi-AZ DB clusters.
PerformanceInsightsRetentionPeriod (integer) --
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
For example, the following values are valid:
This setting is only for non-Aurora Multi-AZ DB clusters.
ServerlessV2ScalingConfiguration (dict) --
Shows the scaling configuration for an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide .
MinCapacity (float) --
The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.
MaxCapacity (float) --
The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128.
Exceptions
RDS.Client.exceptions.DBClusterNotFoundFaultRDS.Client.exceptions.InvalidDBClusterStateFaultRDS.Client.exceptions.StorageQuotaExceededFaultRDS.Client.exceptions.DBSubnetGroupNotFoundFaultRDS.Client.exceptions.InvalidVPCNetworkStateFaultRDS.Client.exceptions.InvalidDBSubnetGroupStateFaultRDS.Client.exceptions.InvalidSubnetRDS.Client.exceptions.DBClusterParameterGroupNotFoundFaultRDS.Client.exceptions.InvalidDBSecurityGroupStateFaultRDS.Client.exceptions.InvalidDBInstanceStateFaultRDS.Client.exceptions.DBClusterAlreadyExistsFaultRDS.Client.exceptions.DomainNotFoundFaultExamples
This example changes the specified settings for the specified DB cluster.
response = client.modify_db_cluster(
ApplyImmediately=True,
DBClusterIdentifier='mydbcluster',
MasterUserPassword='mynewpassword',
NewDBClusterIdentifier='mynewdbcluster',
PreferredBackupWindow='04:00-04:30',
PreferredMaintenanceWindow='Tue:05:00-Tue:05:30',
)
print(response)
Expected Output:
{
'DBCluster': {
},
'ResponseMetadata': {
'...': '...',
},
}
modify_db_cluster_endpoint(**kwargs)¶Modifies the properties of an endpoint in an Amazon Aurora DB cluster.
Note
This action only applies to Aurora DB clusters.
See also: AWS API Documentation
Request Syntax
response = client.modify_db_cluster_endpoint(
DBClusterEndpointIdentifier='string',
EndpointType='string',
StaticMembers=[
'string',
],
ExcludedMembers=[
'string',
]
)
[REQUIRED]
The identifier of the endpoint to modify. This parameter is stored as a lowercase string.
READER , WRITER , ANY .List of DB instance identifiers that are part of the custom endpoint group.
List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.
dict
Response Syntax
{
'DBClusterEndpointIdentifier': 'string',
'DBClusterIdentifier': 'string',
'DBClusterEndpointResourceIdentifier': 'string',
'Endpoint': 'string',
'Status': 'string',
'EndpointType': 'string',
'CustomEndpointType': 'string',
'StaticMembers': [
'string',
],
'ExcludedMembers': [
'string',
],
'DBClusterEndpointArn': 'string'
}
Response Structure
(dict) --
This data type represents the information you need to connect to an Amazon Aurora DB cluster. This data type is used as a response element in the following actions:
CreateDBClusterEndpointDescribeDBClusterEndpointsModifyDBClusterEndpointDeleteDBClusterEndpointFor the data structure that represents Amazon RDS DB instance endpoints, see Endpoint .
DBClusterEndpointIdentifier (string) --
The identifier associated with the endpoint. This parameter is stored as a lowercase string.
DBClusterIdentifier (string) --
The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
DBClusterEndpointResourceIdentifier (string) --
A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.
Endpoint (string) --
The DNS address of the endpoint.
Status (string) --
The current status of the endpoint. One of: creating , available , deleting , inactive , modifying . The inactive state applies to an endpoint that can't be used for a certain kind of cluster, such as a writer endpoint for a read-only secondary cluster in a global database.
EndpointType (string) --
The type of the endpoint. One of: READER , WRITER , CUSTOM .
CustomEndpointType (string) --
The type associated with a custom endpoint. One of: READER , WRITER , ANY .
StaticMembers (list) --
List of DB instance identifiers that are part of the custom endpoint group.
ExcludedMembers (list) --
List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.
DBClusterEndpointArn (string) --
The Amazon Resource Name (ARN) for the endpoint.
Exceptions
RDS.Client.exceptions.InvalidDBClusterStateFaultRDS.Client.exceptions.InvalidDBClusterEndpointStateFaultRDS.Client.exceptions.DBClusterEndpointNotFoundFaultRDS.Client.exceptions.DBInstanceNotFoundFaultRDS.Client.exceptions.InvalidDBInstanceStateFaultmodify_db_cluster_parameter_group(**kwargs)¶Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName , ParameterValue , and ApplyMethod . A maximum of 20 parameters can be modified in a single request.
Warning
After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters operation to verify that your DB cluster parameter group has been created or modified.
If the modified DB cluster parameter group is used by an Aurora Serverless v1 cluster, Aurora applies the update immediately. The cluster restart might interrupt your workload. In that case, your application must reopen any connections and retry any transactions that were active when the parameter changes took effect.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide .
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
See also: AWS API Documentation
Request Syntax
response = client.modify_db_cluster_parameter_group(
DBClusterParameterGroupName='string',
Parameters=[
{
'ParameterName': 'string',
'ParameterValue': 'string',
'Description': 'string',
'Source': 'string',
'ApplyType': 'string',
'DataType': 'string',
'AllowedValues': 'string',
'IsModifiable': True|False,
'MinimumEngineVersion': 'string',
'ApplyMethod': 'immediate'|'pending-reboot',
'SupportedEngineModes': [
'string',
]
},
]
)
[REQUIRED]
The name of the DB cluster parameter group to modify.
[REQUIRED]
A list of parameters in the DB cluster parameter group to modify.
Valid Values (for the application method): immediate | pending-reboot
Note
You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters.
When the application method is immediate , changes to dynamic parameters are applied immediately to the DB clusters associated with the parameter group. When the application method is pending-reboot , changes to dynamic and static parameters are applied after a reboot without failover to the DB clusters associated with the parameter group.
This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions.
This data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions.
Specifies the name of the parameter.
Specifies the value of the parameter.
Provides a description of the parameter.
Indicates the source of the parameter value.
Specifies the engine specific parameters type.
Specifies the valid data type for the parameter.
Specifies the valid range of values for the parameter.
Indicates whether (true ) or not (false ) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
The earliest engine version to which the parameter can apply.
Indicates when to apply parameter updates.
The valid DB engine modes.
dict
Response Syntax
{
'DBClusterParameterGroupName': 'string'
}
Response Structure
(dict) --
DBClusterParameterGroupName (string) --
The name of the DB cluster parameter group.
Constraints:
Note
This value is stored as a lowercase string.
Exceptions
RDS.Client.exceptions.DBParameterGroupNotFoundFaultRDS.Client.exceptions.InvalidDBParameterGroupStateFaultExamples
This example immediately changes the specified setting for the specified DB cluster parameter group.
response = client.modify_db_cluster_parameter_group(
DBClusterParameterGroupName='mydbclusterparametergroup',
Parameters=[
{
'ApplyMethod': 'immediate',
'ParameterName': 'time_zone',
'ParameterValue': 'America/Phoenix',
},
],
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
modify_db_cluster_snapshot_attribute(**kwargs)¶Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.
To share a manual DB cluster snapshot with other Amazon Web Services accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB cluster snapshot. Use the value all to make the manual DB cluster snapshot public, which means that it can be copied or restored by all Amazon Web Services accounts.
Note
Don't add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all Amazon Web Services accounts.
If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.
To view which Amazon Web Services accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot is public or private, use the DescribeDBClusterSnapshotAttributes API operation. The accounts are returned as values for the restore attribute.
See also: AWS API Documentation
Request Syntax
response = client.modify_db_cluster_snapshot_attribute(
DBClusterSnapshotIdentifier='string',
AttributeName='string',
ValuesToAdd=[
'string',
],
ValuesToRemove=[
'string',
]
)
[REQUIRED]
The identifier for the DB cluster snapshot to modify the attributes for.
[REQUIRED]
The name of the DB cluster snapshot attribute to modify.
To manage authorization for other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this value to restore .
Note
To view the list of attributes available to modify, use the DescribeDBClusterSnapshotAttributes API operation.
A list of DB cluster snapshot attributes to add to the attribute specified by AttributeName .
To authorize other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more Amazon Web Services account IDs, or all to make the manual DB cluster snapshot restorable by any Amazon Web Services account. Do not add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all Amazon Web Services accounts.
A list of DB cluster snapshot attributes to remove from the attribute specified by AttributeName .
To remove authorization for other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more Amazon Web Services account identifiers, or all to remove authorization for any Amazon Web Services account to copy or restore the DB cluster snapshot. If you specify all , an Amazon Web Services account whose account ID is explicitly added to the restore attribute can still copy or restore a manual DB cluster snapshot.
dict
Response Syntax
{
'DBClusterSnapshotAttributesResult': {
'DBClusterSnapshotIdentifier': 'string',
'DBClusterSnapshotAttributes': [
{
'AttributeName': 'string',
'AttributeValues': [
'string',
]
},
]
}
}
Response Structure
(dict) --
DBClusterSnapshotAttributesResult (dict) --
Contains the results of a successful call to the DescribeDBClusterSnapshotAttributes API action.
Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.
DBClusterSnapshotIdentifier (string) --
The identifier of the manual DB cluster snapshot that the attributes apply to.
DBClusterSnapshotAttributes (list) --
The list of attributes and values for the manual DB cluster snapshot.
(dict) --
Contains the name and values of a manual DB cluster snapshot attribute.
Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts to restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.
AttributeName (string) --
The name of the manual DB cluster snapshot attribute.
The attribute named restore refers to the list of Amazon Web Services accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.
AttributeValues (list) --
The value(s) for the manual DB cluster snapshot attribute.
If the AttributeName field is set to restore , then this element returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual DB cluster snapshot. If a value of all is in the list, then the manual DB cluster snapshot is public and available for any Amazon Web Services account to copy or restore.
Exceptions
RDS.Client.exceptions.DBClusterSnapshotNotFoundFaultRDS.Client.exceptions.InvalidDBClusterSnapshotStateFaultRDS.Client.exceptions.SharedSnapshotQuotaExceededFaultExamples
The following example gives two AWS accounts access to a manual DB cluster snapshot and ensures that the DB cluster snapshot is private by removing the value "all".
response = client.modify_db_cluster_snapshot_attribute(
AttributeName='restore',
DBClusterSnapshotIdentifier='manual-cluster-snapshot1',
ValuesToAdd=[
'123451234512',
'123456789012',
],
ValuesToRemove=[
'all',
],
)
print(response)
Expected Output:
{
'DBClusterSnapshotAttributesResult': {
},
'ResponseMetadata': {
'...': '...',
},
}
modify_db_instance(**kwargs)¶Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. To learn what modifications you can make to your DB instance, call DescribeValidDBInstanceModifications before you call ModifyDBInstance .
See also: AWS API Documentation
Request Syntax
response = client.modify_db_instance(
DBInstanceIdentifier='string',
AllocatedStorage=123,
DBInstanceClass='string',
DBSubnetGroupName='string',
DBSecurityGroups=[
'string',
],
VpcSecurityGroupIds=[
'string',
],
ApplyImmediately=True|False,
MasterUserPassword='string',
DBParameterGroupName='string',
BackupRetentionPeriod=123,
PreferredBackupWindow='string',
PreferredMaintenanceWindow='string',
MultiAZ=True|False,
EngineVersion='string',
AllowMajorVersionUpgrade=True|False,
AutoMinorVersionUpgrade=True|False,
LicenseModel='string',
Iops=123,
OptionGroupName='string',
NewDBInstanceIdentifier='string',
StorageType='string',
TdeCredentialArn='string',
TdeCredentialPassword='string',
CACertificateIdentifier='string',
Domain='string',
CopyTagsToSnapshot=True|False,
MonitoringInterval=123,
DBPortNumber=123,
PubliclyAccessible=True|False,
MonitoringRoleArn='string',
DomainIAMRoleName='string',
PromotionTier=123,
EnableIAMDatabaseAuthentication=True|False,
EnablePerformanceInsights=True|False,
PerformanceInsightsKMSKeyId='string',
PerformanceInsightsRetentionPeriod=123,
CloudwatchLogsExportConfiguration={
'EnableLogTypes': [
'string',
],
'DisableLogTypes': [
'string',
]
},
ProcessorFeatures=[
{
'Name': 'string',
'Value': 'string'
},
],
UseDefaultProcessorFeatures=True|False,
DeletionProtection=True|False,
MaxAllocatedStorage=123,
CertificateRotationRestart=True|False,
ReplicaMode='open-read-only'|'mounted',
EnableCustomerOwnedIp=True|False,
AwsBackupRecoveryPointArn='string',
AutomationMode='full'|'all-paused',
ResumeFullAutomationModeMinutes=123,
NetworkType='string'
)
[REQUIRED]
The DB instance identifier. This value is stored as a lowercase string.
Constraints:
The new amount of storage in gibibytes (GiB) to allocate for the DB instance.
For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
For the valid values for allocated storage for each engine, see CreateDBInstance .
The new compute and memory capacity of the DB instance, for example db.m5.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB instance classes in the Amazon RDS User Guide or Aurora DB instance classes in the Amazon Aurora User Guide .
If you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless ApplyImmediately is enabled for this request.
This setting doesn't apply to RDS Custom for Oracle.
Default: Uses existing setting
The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC. If your DB instance isn't in a VPC, you can also use this parameter to move your DB instance into a VPC. For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide .
Changing the subnet group causes an outage during the change. The change is applied during the next maintenance window, unless you enable ApplyImmediately .
This parameter doesn't apply to RDS Custom.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an outage and the change is asynchronously applied as soon as possible.
This setting doesn't apply to RDS Custom.
Constraints:
A list of Amazon EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.
This setting doesn't apply to RDS Custom.
Amazon Aurora
Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster .
Constraints:
A value that indicates whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance. By default, this parameter is disabled.
If this parameter is disabled, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next call to RebootDBInstance , or the next failure reboot. Review the table of parameters in Modifying a DB Instance in the Amazon RDS User Guide to see the impact of enabling or disabling ApplyImmediately for each modified parameter and to determine when the changes are applied.
The new password for the master user. The password can include any printable ASCII character except "/", """, or "@".
Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.
This setting doesn't apply to RDS Custom.
Amazon Aurora
Not applicable. The password for the master user is managed by the DB cluster. For more information, see ModifyDBCluster .
Default: Uses existing setting
MariaDB
Constraints: Must contain from 8 to 41 characters.
Microsoft SQL Server
Constraints: Must contain from 8 to 128 characters.
MySQL
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
PostgreSQL
Constraints: Must contain from 8 to 128 characters.
Note
Amazon RDS API operations never return the password, so this action provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked.
The name of the DB parameter group to apply to the DB instance.
Changing this setting doesn't result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. In this case, the DB instance isn't rebooted automatically, and the parameter changes aren't applied during the next maintenance window. However, if you modify dynamic parameters in the newly associated DB parameter group, these changes are applied immediately without a reboot.
This setting doesn't apply to RDS Custom.
Default: Uses existing setting
Constraints: The DB parameter group must be in the same DB parameter group family as the DB instance.
The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Note
Enabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance.
These changes are applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible.
Amazon Aurora
Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see ModifyDBCluster .
Default: Uses existing setting
Constraints:
The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod parameter. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region. For more information, see Backup window in the Amazon RDS User Guide.
Amazon Aurora
Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see ModifyDBCluster .
Constraints:
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, then changing this parameter will cause a reboot of the DB instance. If 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 pending changes are applied.
For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.
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
A value that indicates whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result in an outage. The change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request.
This setting doesn't apply to RDS Custom.
The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request.
For major version upgrades, if a nondefault DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.
If you specify only a major version, Amazon RDS will update the DB instance to the default minor version if the current minor version is lower. For information about valid engine versions, see CreateDBInstance , or call DescribeDBEngineVersions .
In RDS Custom for Oracle, this parameter is supported for read replicas only if they are in the PATCH_DB_FAILURE lifecycle.
A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.
This setting doesn't apply to RDS Custom.
Constraints: Major version upgrades must be allowed when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.
A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window. An outage occurs when all the following conditions are met:
If any of the preceding conditions isn't met, RDS applies the change as soon as possible and doesn't cause an outage.
For an RDS Custom DB instance, set AutoMinorVersionUpgrade to false . Otherwise, the operation returns an error.
The license model for the DB instance.
This setting doesn't apply to RDS Custom.
Valid values: license-included | bring-your-own-license | general-public-license
The new Provisioned IOPS (I/O operations per second) value for the RDS instance.
Changing this setting doesn't result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.
If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.
Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.
Default: Uses existing setting
A value that indicates the DB instance should be associated with the specified option group.
Changing this parameter doesn't result in an outage, with one exception. If the parameter change results in an option group that enables OEM, it can cause a brief period, lasting less than a second, during which new connections are rejected but existing connections aren't interrupted.
The change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance after it is associated with a DB instance.
This setting doesn't apply to RDS Custom.
The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot occurs immediately if you enable ApplyImmediately , or will occur during the next maintenance window if you disable Apply Immediately. This value is stored as a lowercase string.
This setting doesn't apply to RDS Custom.
Constraints:
Example: mydbinstance
Specifies the storage type to be associated with the DB instance.
If you specify Provisioned IOPS (io1 ), you must also include a value for the Iops parameter.
If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.
Valid values: standard | gp2 | io1
Default: io1 if the Iops parameter is specified, otherwise gp2
The ARN from the key store with which to associate the instance for TDE encryption.
This setting doesn't apply to RDS Custom.
The password for the given ARN from the key store in order to access the device.
This setting doesn't apply to RDS Custom.
Specifies the certificate to associate with the DB instance.
This setting doesn't apply to RDS Custom.
The Active Directory directory ID to move the DB instance to. Specify none to remove the instance from its current domain. You must create the domain before this operation. Currently, you can create only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide .
This setting doesn't apply to RDS Custom.
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.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see ModifyDBCluster .
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0, which is the default.
If MonitoringRoleArn is specified, set MonitoringInterval to a value other than 0.
This setting doesn't apply to RDS Custom.
Valid Values: 0, 1, 5, 10, 15, 30, 60
The port number on which the database accepts connections.
The value of the DBPortNumber parameter must not match any of the port values specified for options in the option group for the DB instance.
If you change the DBPortNumber value, your database restarts regardless of the value of the ApplyImmediately parameter.
This setting doesn't apply to RDS Custom.
MySQL
Default: 3306
Valid values: 1150-65535
MariaDB
Default: 3306
Valid values: 1150-65535
PostgreSQL
Default: 5432
Valid values: 1150-65535
Type: Integer
Oracle
Default: 1521
Valid values: 1150-65535
SQL Server
Default: 1433
Valid values: 1150-65535 except 1234 , 1434 , 3260 , 3343 , 3389 , 47001 , and 49152-49156 .
Amazon Aurora
Default: 3306
Valid values: 1150-65535
A value that indicates whether the DB instance is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
PubliclyAccessibleonly applies to DB instances in a VPC. The DB instance must be part of a public subnet andPubliclyAccessiblemust be enabled for it to be publicly accessible.
Changes to the PubliclyAccessible parameter are applied immediately regardless of the value of the ApplyImmediately parameter.
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess . For information on creating a monitoring role, see To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value.
This setting doesn't apply to RDS Custom.
The name of the IAM role to use when making API calls to the Directory Service.
This setting doesn't apply to RDS Custom.
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .
This setting doesn't apply to RDS Custom.
Default: 1
Valid Values: 0 - 15
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
This setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
A value that indicates whether to enable Performance Insights for the DB instance.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide .
This setting doesn't apply to RDS Custom.
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for PerformanceInsightsKMSKeyId , then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
This setting doesn't apply to RDS Custom.
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
For example, the following values are valid:
If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
This setting doesn't apply to RDS Custom.
The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance.
A change to the CloudwatchLogsExportConfiguration parameter is always applied to the DB instance immediately. Therefore, the ApplyImmediately parameter has no effect.
This setting doesn't apply to RDS Custom.
The list of log types to enable.
The list of log types to disable.
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
This setting doesn't apply to RDS Custom.
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstanceModifyDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceFromS3RestoreDBInstanceToPointInTimeYou can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstancesDescribeDBSnapshotsDescribeValidDBInstanceModificationsIf you call DescribeDBInstances , ProcessorFeature returns non-null values only if the following conditions are met:
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
The name of the processor feature. Valid names are coreCount and threadsPerCore .
The value of a processor feature name.
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
This setting doesn't apply to RDS Custom.
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide .
This setting doesn't apply to RDS Custom.
A value that indicates 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.
Warning
Set this parameter only if you are not using SSL/TLS to connect to the DB instance.
If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate:
This setting doesn't apply to RDS Custom.
A value that sets the open mode of a replica database to either mounted or read-only.
Note
Currently, this parameter is only supported for Oracle DB instances.
Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide .
This setting doesn't apply to RDS Custom.
A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide .
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide .
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
This setting doesn't apply to RDS Custom.
full or all paused . If full , the DB instance automates monitoring and instance recovery. If all paused , the instance pauses automation for the duration set by ResumeFullAutomationModeMinutes .60 (default). The maximum value is 1,440 .The network type of the DB instance.
Valid values:
IPV4DUALThe network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
dict
Response Syntax
{
'DBInstance': {
'DBInstanceIdentifier': 'string',
'DBInstanceClass': 'string',
'Engine': 'string',
'DBInstanceStatus': 'string',
'AutomaticRestartTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'DBName': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123,
'HostedZoneId': 'string'
},
'AllocatedStorage': 123,
'InstanceCreateTime': datetime(2015, 1, 1),
'PreferredBackupWindow': 'string',
'BackupRetentionPeriod': 123,
'DBSecurityGroups': [
{
'DBSecurityGroupName': 'string',
'Status': 'string'
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'DBParameterGroups': [
{
'DBParameterGroupName': 'string',
'ParameterApplyStatus': 'string'
},
],
'AvailabilityZone': 'string',
'DBSubnetGroup': {
'DBSubnetGroupName': 'string',
'DBSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetOutpost': {
'Arn': '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',
]
},
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
],
'IAMDatabaseAuthenticationEnabled': True|False,
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1)
},
'LatestRestorableTime': datetime(2015, 1, 1),
'MultiAZ': True|False,
'EngineVersion': 'string',
'AutoMinorVersionUpgrade': True|False,
'ReadReplicaSourceDBInstanceIdentifier': 'string',
'ReadReplicaDBInstanceIdentifiers': [
'string',
],
'ReadReplicaDBClusterIdentifiers': [
'string',
],
'ReplicaMode': 'open-read-only'|'mounted',
'LicenseModel': 'string',
'Iops': 123,
'OptionGroupMemberships': [
{
'OptionGroupName': 'string',
'Status': 'string'
},
],
'CharacterSetName': 'string',
'NcharCharacterSetName': 'string',
'SecondaryAvailabilityZone': 'string',
'PubliclyAccessible': True|False,
'StatusInfos': [
{
'StatusType': 'string',
'Normal': True|False,
'Status': 'string',
'Message': 'string'
},
],
'StorageType': 'string',
'TdeCredentialArn': 'string',
'DbInstancePort': 123,
'DBClusterIdentifier': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbiResourceId': 'string',
'CACertificateIdentifier': 'string',
'DomainMemberships': [
{
'Domain': 'string',
'Status': 'string',
'FQDN': 'string',
'IAMRoleName': 'string'
},
],
'CopyTagsToSnapshot': True|False,
'MonitoringInterval': 123,
'EnhancedMonitoringResourceArn': 'string',
'MonitoringRoleArn': 'string',
'PromotionTier': 123,
'DBInstanceArn': 'string',
'Timezone': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'PerformanceInsightsEnabled': True|False,
'PerformanceInsightsKMSKeyId': 'string',
'PerformanceInsightsRetentionPeriod': 123,
'EnabledCloudwatchLogsExports': [
'string',
],
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
],
'DeletionProtection': True|False,
'AssociatedRoles': [
{
'RoleArn': 'string',
'FeatureName': 'string',
'Status': 'string'
},
],
'ListenerEndpoint': {
'Address': 'string',
'Port': 123,
'HostedZoneId': 'string'
},
'MaxAllocatedStorage': 123,
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'DBInstanceAutomatedBackupsReplications': [
{
'DBInstanceAutomatedBackupsArn': 'string'
},
],
'CustomerOwnedIpEnabled': True|False,
'AwsBackupRecoveryPointArn': 'string',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamEngineNativeAuditFieldsIncluded': True|False,
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1),
'CustomIamInstanceProfile': 'string',
'BackupTarget': 'string',
'NetworkType': 'string',
'ActivityStreamPolicyStatus': 'locked'|'unlocked'|'locking-policy'|'unlocking-policy'
}
}
Response Structure
(dict) --
DBInstance (dict) --
Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations CreateDBInstance , CreateDBInstanceReadReplica , DeleteDBInstance , DescribeDBInstances , ModifyDBInstance , PromoteReadReplica , RebootDBInstance , RestoreDBInstanceFromDBSnapshot , RestoreDBInstanceFromS3 , RestoreDBInstanceToPointInTime , StartDBInstance , and StopDBInstance .
DBInstanceIdentifier (string) --
Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
DBInstanceClass (string) --
Contains the name of the compute and memory capacity class of the DB instance.
Engine (string) --
The name of the database engine to be used for this DB instance.
DBInstanceStatus (string) --
Specifies the current state of this database.
For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.
AutomaticRestartTime (datetime) --
The time when a stopped DB instance is restarted automatically.
MasterUsername (string) --
Contains the master username for the DB instance.
DBName (string) --
The meaning of this parameter differs according to the database engine you use.
MySQL, MariaDB, SQL Server, PostgreSQL
Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
Type: String
Oracle
Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
Endpoint (dict) --
Specifies the connection endpoint.
Note
The endpoint might not be shown for instances whose status is creating .
Address (string) --
Specifies the DNS address of the DB 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.
AllocatedStorage (integer) --
Specifies the allocated storage size specified in gibibytes (GiB).
InstanceCreateTime (datetime) --
Provides the date and time the DB 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 DB snapshots are retained.
DBSecurityGroups (list) --
A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
(dict) --
This data type is used as a response element in the following actions:
ModifyDBInstanceRebootDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceToPointInTimeDBSecurityGroupName (string) --
The name of the DB security group.
Status (string) --
The status of the DB security group.
VpcSecurityGroups (list) --
Provides a list of VPC security group elements that the DB instance belongs to.
(dict) --
This data type is used as a response element for queries on VPC security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The membership status of the VPC security group.
Currently, the only valid status is active .
DBParameterGroups (list) --
Provides the list of DB parameter groups applied to this DB instance.
(dict) --
The status of the DB parameter group.
This data type is used as a response element in the following actions:
CreateDBInstanceCreateDBInstanceReadReplicaDeleteDBInstanceModifyDBInstanceRebootDBInstanceRestoreDBInstanceFromDBSnapshotDBParameterGroupName (string) --
The name of the DB parameter group.
ParameterApplyStatus (string) --
The status of parameter updates.
AvailabilityZone (string) --
Specifies the name of the Availability Zone the DB instance is located in.
DBSubnetGroup (dict) --
Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
DBSubnetGroupName (string) --
The name of the DB subnet group.
DBSubnetGroupDescription (string) --
Provides the description of the DB subnet group.
VpcId (string) --
Provides the VpcId of the DB subnet group.
SubnetGroupStatus (string) --
Provides the status of the DB subnet group.
Subnets (list) --
Contains a list of Subnet elements.
(dict) --
This data type is used as a response element for the DescribeDBSubnetGroups operation.
SubnetIdentifier (string) --
The identifier of the subnet.
SubnetAvailabilityZone (dict) --
Contains Availability Zone information.
This data type is used as an element in the OrderableDBInstanceOption data type.
Name (string) --
The name of the Availability Zone.
SubnetOutpost (dict) --
If the subnet is associated with an Outpost, this value specifies the Outpost.
For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
Arn (string) --
The Amazon Resource Name (ARN) of the Outpost.
SubnetStatus (string) --
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:
IPV4DUALA DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
PendingModifiedValues (dict) --
A value that specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
DBInstanceClass (string) --
The name of the compute and memory capacity class for the DB instance.
AllocatedStorage (integer) --
The allocated storage size for the DB instance specified in gibibytes (GiB).
MasterUserPassword (string) --
The master credentials for the DB instance.
Port (integer) --
The port for the DB instance.
BackupRetentionPeriod (integer) --
The number of days for which automated backups are retained.
MultiAZ (boolean) --
A value that indicates that the Single-AZ DB instance will change to a Multi-AZ deployment.
EngineVersion (string) --
The database engine version.
LicenseModel (string) --
The license model for the DB instance.
Valid values: license-included | bring-your-own-license | general-public-license
Iops (integer) --
The Provisioned IOPS value for the DB instance.
DBInstanceIdentifier (string) --
The database identifier for the DB instance.
StorageType (string) --
The storage type of the DB instance.
CACertificateIdentifier (string) --
The identifier of the CA certificate for the DB instance.
DBSubnetGroupName (string) --
The DB subnet group for the DB instance.
PendingCloudwatchLogsExports (dict) --
A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.
LogTypesToEnable (list) --
Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.
LogTypesToDisable (list) --
Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.
ProcessorFeatures (list) --
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
(dict) --
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstanceModifyDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceFromS3RestoreDBInstanceToPointInTimeYou can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstancesDescribeDBSnapshotsDescribeValidDBInstanceModificationsIf you call DescribeDBInstances , ProcessorFeature returns non-null values only if the following conditions are met:
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
Name (string) --
The name of the processor feature. Valid names are coreCount and threadsPerCore .
Value (string) --
The value of a processor feature name.
IAMDatabaseAuthenticationEnabled (boolean) --
Whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
AutomationMode (string) --
The automation mode of the RDS Custom DB instance: full or all-paused . If full , the DB instance automates monitoring and instance recovery. If all-paused , the instance pauses automation for the duration set by --resume-full-automation-mode-minutes .
ResumeFullAutomationModeTime (datetime) --
The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
LatestRestorableTime (datetime) --
Specifies the latest time to which a database can be restored with point-in-time restore.
MultiAZ (boolean) --
Specifies if the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom.
EngineVersion (string) --
Indicates the database engine version.
AutoMinorVersionUpgrade (boolean) --
A value that indicates that minor version patches are applied automatically.
ReadReplicaSourceDBInstanceIdentifier (string) --
Contains the identifier of the source DB instance if this DB instance is a read replica.
ReadReplicaDBInstanceIdentifiers (list) --
Contains one or more identifiers of the read replicas associated with this DB instance.
ReadReplicaDBClusterIdentifiers (list) --
Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn't contain information about cross-Region Aurora read replicas.
Note
Currently, each RDS DB instance can have only one Aurora read replica.
ReplicaMode (string) --
The open mode of an Oracle read replica. The default is open-read-only . For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide .
Note
This attribute is only supported in RDS for Oracle.
LicenseModel (string) --
License model information for this DB instance. This setting doesn't apply to RDS Custom.
Iops (integer) --
Specifies the Provisioned IOPS (I/O operations per second) value.
OptionGroupMemberships (list) --
Provides the list of option group memberships for this DB instance.
(dict) --
Provides information on the option groups the DB instance is a member of.
OptionGroupName (string) --
The name of the option group that the instance belongs to.
Status (string) --
The status of the DB instance's option group membership. Valid values are: in-sync , pending-apply , pending-removal , pending-maintenance-apply , pending-maintenance-removal , applying , removing , and failed .
CharacterSetName (string) --
If present, specifies the name of the character set that this instance is associated with.
NcharCharacterSetName (string) --
The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.
SecondaryAvailabilityZone (string) --
If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
PubliclyAccessible (boolean) --
Specifies the accessibility options for the DB instance.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance .
StatusInfos (list) --
The status of a read replica. If the instance isn't a read replica, this is blank.
(dict) --
Provides a list of status information for a DB instance.
StatusType (string) --
This value is currently "read replication."
Normal (boolean) --
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 DB instance. For a StatusType of read replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.
Message (string) --
Details of the error if there is an error for the instance. If the instance isn't in an error state, this value is blank.
StorageType (string) --
Specifies the storage type associated with DB instance.
TdeCredentialArn (string) --
The ARN from the key store with which the instance is associated for TDE encryption.
DbInstancePort (integer) --
Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.
DBClusterIdentifier (string) --
If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.
StorageEncrypted (boolean) --
Specifies whether the DB instance is encrypted.
KmsKeyId (string) --
If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
DbiResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB instance is accessed.
CACertificateIdentifier (string) --
The identifier of the CA certificate for this DB instance.
DomainMemberships (list) --
The Active Directory Domain membership records associated with the DB instance.
(dict) --
An Active Directory Domain membership record associated with the DB instance or cluster.
Domain (string) --
The identifier of the Active Directory Domain.
Status (string) --
The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.
FQDN (string) --
The fully qualified domain name of the Active Directory Domain.
IAMRoleName (string) --
The name of the IAM role to be used when making API calls to the Directory Service.
CopyTagsToSnapshot (boolean) --
Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see DBCluster .
MonitoringInterval (integer) --
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
EnhancedMonitoringResourceArn (string) --
The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
MonitoringRoleArn (string) --
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
PromotionTier (integer) --
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .
DBInstanceArn (string) --
The Amazon Resource Name (ARN) for the DB instance.
Timezone (string) --
The time zone of the DB instance. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.
IAMDatabaseAuthenticationEnabled (boolean) --
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
IAM database authentication can be enabled for the following database engines
PerformanceInsightsEnabled (boolean) --
True if Performance Insights is enabled for the DB instance, and otherwise false.
PerformanceInsightsKMSKeyId (string) --
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
PerformanceInsightsRetentionPeriod (integer) --
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
For example, the following values are valid:
EnabledCloudwatchLogsExports (list) --
A list of log types that this DB instance is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon RDS User Guide.
ProcessorFeatures (list) --
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
(dict) --
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstanceModifyDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceFromS3RestoreDBInstanceToPointInTimeYou can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstancesDescribeDBSnapshotsDescribeValidDBInstanceModificationsIf you call DescribeDBInstances , ProcessorFeature returns non-null values only if the following conditions are met:
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
Name (string) --
The name of the processor feature. Valid names are coreCount and threadsPerCore .
Value (string) --
The value of a processor feature name.
DeletionProtection (boolean) --
Indicates if the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance .
AssociatedRoles (list) --
The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
(dict) --
Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.
FeatureName (string) --
The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion .
Status (string) --
Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf.PENDING - the IAM role ARN is being associated with the DB instance.INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf.ListenerEndpoint (dict) --
Specifies the listener connection endpoint for SQL Server Always On.
Address (string) --
Specifies the DNS address of the DB 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.
MaxAllocatedStorage (integer) --
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
TagList (list) --
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
DBInstanceAutomatedBackupsReplications (list) --
The list of replicated automated backups associated with the DB instance.
(dict) --
Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties.
DBInstanceAutomatedBackupsArn (string) --
The Amazon Resource Name (ARN) of the replicated automated backups.
CustomerOwnedIpEnabled (boolean) --
Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide .
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide .
AwsBackupRecoveryPointArn (string) --
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
ActivityStreamStatus (string) --
The status of the database activity stream.
ActivityStreamKmsKeyId (string) --
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
ActivityStreamKinesisStreamName (string) --
The name of the Amazon Kinesis data stream used for the database activity stream.
ActivityStreamMode (string) --
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. RDS for Oracle always handles these events asynchronously.
ActivityStreamEngineNativeAuditFieldsIncluded (boolean) --
Indicates whether engine-native audit fields are included in the database activity stream.
AutomationMode (string) --
The automation mode of the RDS Custom DB instance: full or all paused . If full , the DB instance automates monitoring and instance recovery. If all paused , the instance pauses automation for the duration set by --resume-full-automation-mode-minutes .
ResumeFullAutomationModeTime (datetime) --
The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
CustomIamInstanceProfile (string) --
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
AWSRDSCustom .For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide .
BackupTarget (string) --
Specifies where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
NetworkType (string) --
The network type of the DB instance.
Valid values:
IPV4DUALThe network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide and Working with a DB instance in a VPC in the Amazon Aurora User Guide.
ActivityStreamPolicyStatus (string) --
The status of the policy state of the activity stream.
Exceptions
RDS.Client.exceptions.InvalidDBInstanceStateFaultRDS.Client.exceptions.InvalidDBSecurityGroupStateFaultRDS.Client.exceptions.DBInstanceAlreadyExistsFaultRDS.Client.exceptions.DBInstanceNotFoundFaultRDS.Client.exceptions.DBSecurityGroupNotFoundFaultRDS.Client.exceptions.DBParameterGroupNotFoundFaultRDS.Client.exceptions.InsufficientDBInstanceCapacityFaultRDS.Client.exceptions.StorageQuotaExceededFaultRDS.Client.exceptions.InvalidVPCNetworkStateFaultRDS.Client.exceptions.ProvisionedIopsNotAvailableInAZFaultRDS.Client.exceptions.OptionGroupNotFoundFaultRDS.Client.exceptions.DBUpgradeDependencyFailureFaultRDS.Client.exceptions.StorageTypeNotSupportedFaultRDS.Client.exceptions.AuthorizationNotFoundFaultRDS.Client.exceptions.CertificateNotFoundFaultRDS.Client.exceptions.DomainNotFoundFaultRDS.Client.exceptions.BackupPolicyNotFoundFaultRDS.Client.exceptions.KMSKeyNotAccessibleFaultRDS.Client.exceptions.InvalidDBClusterStateFaultRDS.Client.exceptions.NetworkTypeNotSupportedExamples
This example immediately changes the specified settings for the specified DB instance.
response = client.modify_db_instance(
AllocatedStorage=10,
ApplyImmediately=True,
BackupRetentionPeriod=1,
DBInstanceClass='db.t2.small',
DBInstanceIdentifier='mymysqlinstance',
MasterUserPassword='mynewpassword',
PreferredBackupWindow='04:00-04:30',
PreferredMaintenanceWindow='Tue:05:00-Tue:05:30',
)
print(response)
Expected Output:
{
'DBInstance': {
},
'ResponseMetadata': {
'...': '...',
},
}
modify_db_parameter_group(**kwargs)¶Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: ParameterName , ParameterValue , and ApplyMethod . A maximum of 20 parameters can be modified in a single request.
Warning
After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the modify action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.
See also: AWS API Documentation
Request Syntax
response = client.modify_db_parameter_group(
DBParameterGroupName='string',
Parameters=[
{
'ParameterName': 'string',
'ParameterValue': 'string',
'Description': 'string',
'Source': 'string',
'ApplyType': 'string',
'DataType': 'string',
'AllowedValues': 'string',
'IsModifiable': True|False,
'MinimumEngineVersion': 'string',
'ApplyMethod': 'immediate'|'pending-reboot',
'SupportedEngineModes': [
'string',
]
},
]
)
[REQUIRED]
The name of the DB parameter group.
Constraints:
DBParameterGroup .[REQUIRED]
An array of parameter names, values, and the application methods for the parameter update. At least one parameter name, value, and application method must be supplied; later arguments are optional. A maximum of 20 parameters can be modified in a single request.
Valid Values (for the application method): immediate | pending-reboot
You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters.
When the application method is immediate , changes to dynamic parameters are applied immediately to the DB instances associated with the parameter group.
When the application method is pending-reboot , changes to dynamic and static parameters are applied after a reboot without failover to the DB instances associated with the parameter group.
Note
You can't use pending-reboot with dynamic parameters on RDS for SQL Server DB instances. Use immediate .
For more information on modifying DB parameters, see Working with DB parameter groups in the Amazon RDS User Guide .
This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions.
This data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions.
Specifies the name of the parameter.
Specifies the value of the parameter.
Provides a description of the parameter.
Indicates the source of the parameter value.
Specifies the engine specific parameters type.
Specifies the valid data type for the parameter.
Specifies the valid range of values for the parameter.
Indicates whether (true ) or not (false ) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
The earliest engine version to which the parameter can apply.
Indicates when to apply parameter updates.
The valid DB engine modes.
dict
Response Syntax
{
'DBParameterGroupName': 'string'
}
Response Structure
(dict) --
Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup action.
DBParameterGroupName (string) --
The name of the DB parameter group.
Exceptions
RDS.Client.exceptions.DBParameterGroupNotFoundFaultRDS.Client.exceptions.InvalidDBParameterGroupStateFaultExamples
This example immediately changes the specified setting for the specified DB parameter group.
response = client.modify_db_parameter_group(
DBParameterGroupName='mymysqlparametergroup',
Parameters=[
{
'ApplyMethod': 'immediate',
'ParameterName': 'time_zone',
'ParameterValue': 'America/Phoenix',
},
],
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
modify_db_proxy(**kwargs)¶Changes the settings for an existing DB proxy.
See also: AWS API Documentation
Request Syntax
response = client.modify_db_proxy(
DBProxyName='string',
NewDBProxyName='string',
Auth=[
{
'Description': 'string',
'UserName': 'string',
'AuthScheme': 'SECRETS',
'SecretArn': 'string',
'IAMAuth': 'DISABLED'|'REQUIRED'
},
],
RequireTLS=True|False,
IdleClientTimeout=123,
DebugLogging=True|False,
RoleArn='string',
SecurityGroups=[
'string',
]
)
[REQUIRED]
The identifier for the DBProxy to modify.
DBProxy . An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.The new authentication settings for the DBProxy .
Specifies the details of authentication used by a proxy to log in as a specific database user.
A user-specified description about the authentication used by a proxy to log in as a specific database user.
The name of the database user to which the proxy connects.
The type of authentication that the proxy uses for connections from the proxy to the underlying database.
The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.
Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy.
The new list of security groups for the DBProxy .
dict
Response Syntax
{
'DBProxy': {
'DBProxyName': 'string',
'DBProxyArn': 'string',
'Status': 'available'|'modifying'|'incompatible-network'|'insufficient-resource-limits'|'creating'|'deleting'|'suspended'|'suspending'|'reactivating',
'EngineFamily': 'string',
'VpcId': 'string',
'VpcSecurityGroupIds': [
'string',
],
'VpcSubnetIds': [
'string',
],
'Auth': [
{
'Description': 'string',
'UserName': 'string',
'AuthScheme': 'SECRETS',
'SecretArn': 'string',
'IAMAuth': 'DISABLED'|'REQUIRED'
},
],
'RoleArn': 'string',
'Endpoint': 'string',
'RequireTLS': True|False,
'IdleClientTimeout': 123,
'DebugLogging': True|False,
'CreatedDate': datetime(2015, 1, 1),
'UpdatedDate': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
DBProxy (dict) --
The DBProxy object representing the new settings for the proxy.
DBProxyName (string) --
The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.
DBProxyArn (string) --
The Amazon Resource Name (ARN) for the proxy.
Status (string) --
The current status of this proxy. A status of available means the proxy is ready to handle requests. Other values indicate that you must wait for the proxy to be ready, or take some action to resolve an issue.
EngineFamily (string) --
The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. MYSQL supports Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases. POSTGRESQL supports Aurora PostgreSQL and RDS for PostgreSQL databases.
VpcId (string) --
Provides the VPC ID of the DB proxy.
VpcSecurityGroupIds (list) --
Provides a list of VPC security groups that the proxy belongs to.
VpcSubnetIds (list) --
The EC2 subnet IDs for the proxy.
Auth (list) --
One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.
(dict) --
Returns the details of authentication used by a proxy to log in as a specific database user.
Description (string) --
A user-specified description about the authentication used by a proxy to log in as a specific database user.
UserName (string) --
The name of the database user to which the proxy connects.
AuthScheme (string) --
The type of authentication that the proxy uses for connections from the proxy to the underlying database.
SecretArn (string) --
The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.
IAMAuth (string) --
Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy.
RoleArn (string) --
The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.
Endpoint (string) --
The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.
RequireTLS (boolean) --
Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
IdleClientTimeout (integer) --
The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection. The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by later connection requests.
Default: 1800 (30 minutes)
Constraints: 1 to 28,800
DebugLogging (boolean) --
Whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.
CreatedDate (datetime) --
The date and time when the proxy was first created.
UpdatedDate (datetime) --
The date and time when the proxy was last updated.
Exceptions
RDS.Client.exceptions.DBProxyNotFoundFaultRDS.Client.exceptions.DBProxyAlreadyExistsFaultRDS.Client.exceptions.InvalidDBProxyStateFaultmodify_db_proxy_endpoint(**kwargs)¶Changes the settings for an existing DB proxy endpoint.
See also: AWS API Documentation
Request Syntax
response = client.modify_db_proxy_endpoint(
DBProxyEndpointName='string',
NewDBProxyEndpointName='string',
VpcSecurityGroupIds=[
'string',
]
)
[REQUIRED]
The name of the DB proxy sociated with the DB proxy endpoint that you want to modify.
DBProxyEndpoint . An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.The VPC security group IDs for the DB proxy endpoint. When the DB proxy endpoint uses a different VPC than the original proxy, you also specify a different set of security group IDs than for the original proxy.
dict
Response Syntax
{
'DBProxyEndpoint': {
'DBProxyEndpointName': 'string',
'DBProxyEndpointArn': 'string',
'DBProxyName': 'string',
'Status': 'available'|'modifying'|'incompatible-network'|'insufficient-resource-limits'|'creating'|'deleting',
'VpcId': 'string',
'VpcSecurityGroupIds': [
'string',
],
'VpcSubnetIds': [
'string',
],
'Endpoint': 'string',
'CreatedDate': datetime(2015, 1, 1),
'TargetRole': 'READ_WRITE'|'READ_ONLY',
'IsDefault': True|False
}
}
Response Structure
(dict) --
DBProxyEndpoint (dict) --
The DBProxyEndpoint object representing the new settings for the DB proxy endpoint.
DBProxyEndpointName (string) --
The name for the DB proxy endpoint. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.
DBProxyEndpointArn (string) --
The Amazon Resource Name (ARN) for the DB proxy endpoint.
DBProxyName (string) --
The identifier for the DB proxy that is associated with this DB proxy endpoint.
Status (string) --
The current status of this DB proxy endpoint. A status of available means the endpoint is ready to handle requests. Other values indicate that you must wait for the endpoint to be ready, or take some action to resolve an issue.
VpcId (string) --
Provides the VPC ID of the DB proxy endpoint.
VpcSecurityGroupIds (list) --
Provides a list of VPC security groups that the DB proxy endpoint belongs to.
VpcSubnetIds (list) --
The EC2 subnet IDs for the DB proxy endpoint.
Endpoint (string) --
The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.
CreatedDate (datetime) --
The date and time when the DB proxy endpoint was first created.
TargetRole (string) --
A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
IsDefault (boolean) --
A value that indicates whether this endpoint is the default endpoint for the associated DB proxy. Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be either read/write or read-only.
Exceptions
RDS.Client.exceptions.DBProxyEndpointNotFoundFaultRDS.Client.exceptions.DBProxyEndpointAlreadyExistsFaultRDS.Client.exceptions.InvalidDBProxyEndpointStateFaultRDS.Client.exceptions.InvalidDBProxyStateFaultmodify_db_proxy_target_group(**kwargs)¶Modifies the properties of a DBProxyTargetGroup .
See also: AWS API Documentation
Request Syntax
response = client.modify_db_proxy_target_group(
TargetGroupName='string',
DBProxyName='string',
ConnectionPoolConfig={
'MaxConnectionsPercent': 123,
'MaxIdleConnectionsPercent': 123,
'ConnectionBorrowTimeout': 123,
'SessionPinningFilters': [
'string',
],
'InitQuery': 'string'
},
NewName='string'
)
[REQUIRED]
The name of the target group to modify.
[REQUIRED]
The name of the proxy.
The settings that determine the size and behavior of the connection pool for the target group.
The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.
Default: 100
Constraints: between 1 and 100
Controls how actively the proxy closes idle database connections in the connection pool. The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group. With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.
Default: 50
Constraints: between 0 and MaxConnectionsPercent
The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the proxy has opened its maximum number of connections and all connections are busy with client sessions.
Default: 120
Constraints: between 1 and 3600, or 0 representing unlimited
Each item in the list represents a class of SQL operations that normally cause all later statements in a session using a proxy to be pinned to the same underlying database connection. Including an item in the list exempts that class of SQL operations from the pinning behavior.
Default: no session pinning filters
One or more SQL statements for the proxy to run when opening each new database connection. Typically used with SET statements to make sure that each connection has identical settings such as time zone and character set. For multiple statements, use semicolons as the separator. You can also include multiple variables in a single SET statement, such as SET x=1, y=2 .
Default: no initialization query
DBProxyTarget . An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.dict
Response Syntax
{
'DBProxyTargetGroup': {
'DBProxyName': 'string',
'TargetGroupName': 'string',
'TargetGroupArn': 'string',
'IsDefault': True|False,
'Status': 'string',
'ConnectionPoolConfig': {
'MaxConnectionsPercent': 123,
'MaxIdleConnectionsPercent': 123,
'ConnectionBorrowTimeout': 123,
'SessionPinningFilters': [
'string',
],
'InitQuery': 'string'
},
'CreatedDate': datetime(2015, 1, 1),
'UpdatedDate': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
DBProxyTargetGroup (dict) --
The settings of the modified DBProxyTarget .
DBProxyName (string) --
The identifier for the RDS proxy associated with this target group.
TargetGroupName (string) --
The identifier for the target group. This name must be unique for all target groups owned by your Amazon Web Services account in the specified Amazon Web Services Region.
TargetGroupArn (string) --
The Amazon Resource Name (ARN) representing the target group.
IsDefault (boolean) --
Whether this target group is the first one used for connection requests by the associated proxy. Because each proxy is currently associated with a single target group, currently this setting is always true .
Status (string) --
The current status of this target group. A status of available means the target group is correctly associated with a database. Other values indicate that you must wait for the target group to be ready, or take some action to resolve an issue.
ConnectionPoolConfig (dict) --
The settings that determine the size and behavior of the connection pool for the target group.
MaxConnectionsPercent (integer) --
The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.
MaxIdleConnectionsPercent (integer) --
Controls how actively the proxy closes idle database connections in the connection pool. The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group. With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.
ConnectionBorrowTimeout (integer) --
The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the proxy has opened its maximum number of connections and all connections are busy with client sessions.
SessionPinningFilters (list) --
Each item in the list represents a class of SQL operations that normally cause all later statements in a session using a proxy to be pinned to the same underlying database connection. Including an item in the list exempts that class of SQL operations from the pinning behavior. Currently, the only allowed value is EXCLUDE_VARIABLE_SETS .
InitQuery (string) --
One or more SQL statements for the proxy to run when opening each new database connection. Typically used with SET statements to make sure that each connection has identical settings such as time zone and character set. This setting is empty by default. For multiple statements, use semicolons as the separator. You can also include multiple variables in a single SET statement, such as SET x=1, y=2 .
CreatedDate (datetime) --
The date and time when the target group was first created.
UpdatedDate (datetime) --
The date and time when the target group was last updated.
Exceptions
RDS.Client.exceptions.DBProxyNotFoundFaultRDS.Client.exceptions.DBProxyTargetGroupNotFoundFaultRDS.Client.exceptions.InvalidDBProxyStateFaultmodify_db_snapshot(**kwargs)¶Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted or unencrypted, but not shared or public.
Amazon RDS supports upgrading DB snapshots for MySQL, PostgreSQL, and Oracle. This command doesn't apply to RDS Custom.
See also: AWS API Documentation
Request Syntax
response = client.modify_db_snapshot(
DBSnapshotIdentifier='string',
EngineVersion='string',
OptionGroupName='string'
)
[REQUIRED]
The identifier of the DB snapshot to modify.
The engine version to upgrade the DB snapshot to.
The following are the database engines and engine versions that are available when you upgrade a DB snapshot.
MySQL
5.5.46 (supported for 5.1 DB snapshots)Oracle
12.1.0.2.v8 (supported for 12.1.0.1 DB snapshots)11.2.0.4.v12 (supported for 11.2.0.2 DB snapshots)11.2.0.4.v11 (supported for 11.2.0.3 DB snapshots)PostgreSQL
For the list of engine versions that are available for upgrading a DB snapshot, see Upgrading the PostgreSQL DB Engine for Amazon RDS .
The option group to identify with the upgraded DB snapshot.
You can specify this parameter when you upgrade an Oracle DB snapshot. The same option group considerations apply when upgrading a DB snapshot as when upgrading a DB instance. For more information, see Option group considerations in the Amazon RDS User Guide.
dict
Response Syntax
{
'DBSnapshot': {
'DBSnapshotIdentifier': 'string',
'DBInstanceIdentifier': 'string',
'SnapshotCreateTime': datetime(2015, 1, 1),
'Engine': 'string',
'AllocatedStorage': 123,
'Status': 'string',
'Port': 123,
'AvailabilityZone': 'string',
'VpcId': 'string',
'InstanceCreateTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'EngineVersion': 'string',
'LicenseModel': 'string',
'SnapshotType': 'string',
'Iops': 123,
'OptionGroupName': 'string',
'PercentProgress': 123,
'SourceRegion': 'string',
'SourceDBSnapshotIdentifier': 'string',
'StorageType': 'string',
'TdeCredentialArn': 'string',
'Encrypted': True|False,
'KmsKeyId': 'string',
'DBSnapshotArn': 'string',
'Timezone': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
],
'DbiResourceId': 'string',
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'OriginalSnapshotCreateTime': datetime(2015, 1, 1),
'SnapshotTarget': 'string'
}
}
Response Structure
(dict) --
DBSnapshot (dict) --
Contains the details of an Amazon RDS DB snapshot.
This data type is used as a response element in the DescribeDBSnapshots action.
DBSnapshotIdentifier (string) --
Specifies the identifier for the DB snapshot.
DBInstanceIdentifier (string) --
Specifies the DB instance identifier of the DB instance this DB snapshot was created from.
SnapshotCreateTime (datetime) --
Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied.
Engine (string) --
Specifies the name of the database engine.
AllocatedStorage (integer) --
Specifies the allocated storage size in gibibytes (GiB).
Status (string) --
Specifies the status of this DB snapshot.
Port (integer) --
Specifies the port that the database engine was listening on at the time of the snapshot.
AvailabilityZone (string) --
Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
VpcId (string) --
Provides the VPC ID associated with the DB snapshot.
InstanceCreateTime (datetime) --
Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.
MasterUsername (string) --
Provides the master username for the DB snapshot.
EngineVersion (string) --
Specifies the version of the database engine.
LicenseModel (string) --
License model information for the restored DB instance.
SnapshotType (string) --
Provides the type of the DB snapshot.
Iops (integer) --
Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
OptionGroupName (string) --
Provides the option group name for the DB snapshot.
PercentProgress (integer) --
The percentage of the estimated data that has been transferred.
SourceRegion (string) --
The Amazon Web Services Region that the DB snapshot was created in or copied from.
SourceDBSnapshotIdentifier (string) --
The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has a value in the case of a cross-account or cross-Region copy.
StorageType (string) --
Specifies the storage type associated with DB snapshot.
TdeCredentialArn (string) --
The ARN from the key store with which to associate the instance for TDE encryption.
Encrypted (boolean) --
Specifies whether the DB snapshot is encrypted.
KmsKeyId (string) --
If Encrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
DBSnapshotArn (string) --
The Amazon Resource Name (ARN) for the DB snapshot.
Timezone (string) --
The time zone of the DB snapshot. In most cases, the Timezone element is empty. Timezone content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.
IAMDatabaseAuthenticationEnabled (boolean) --
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
ProcessorFeatures (list) --
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.
(dict) --
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstanceModifyDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceFromS3RestoreDBInstanceToPointInTimeYou can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstancesDescribeDBSnapshotsDescribeValidDBInstanceModificationsIf you call DescribeDBInstances , ProcessorFeature returns non-null values only if the following conditions are met:
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
Name (string) --
The name of the processor feature. Valid names are coreCount and threadsPerCore .
Value (string) --
The value of a processor feature name.
DbiResourceId (string) --
The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
TagList (list) --
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
OriginalSnapshotCreateTime (datetime) --
Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied.
SnapshotTarget (string) --
Specifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
Exceptions
RDS.Client.exceptions.DBSnapshotNotFoundFaultmodify_db_snapshot_attribute(**kwargs)¶Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.
To share a manual DB snapshot with other Amazon Web Services accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB snapshot. Uses the value all to make the manual DB snapshot public, which means it can be copied or restored by all Amazon Web Services accounts.
Note
Don't add the all value for any manual DB snapshots that contain private information that you don't want available to all Amazon Web Services accounts.
If the manual DB snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.
To view which Amazon Web Services accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API operation. The accounts are returned as values for the restore attribute.
See also: AWS API Documentation
Request Syntax
response = client.modify_db_snapshot_attribute(
DBSnapshotIdentifier='string',
AttributeName='string',
ValuesToAdd=[
'string',
],
ValuesToRemove=[
'string',
]
)
[REQUIRED]
The identifier for the DB snapshot to modify the attributes for.
[REQUIRED]
The name of the DB snapshot attribute to modify.
To manage authorization for other Amazon Web Services accounts to copy or restore a manual DB snapshot, set this value to restore .
Note
To view the list of attributes available to modify, use the DescribeDBSnapshotAttributes API operation.
A list of DB snapshot attributes to add to the attribute specified by AttributeName .
To authorize other Amazon Web Services accounts to copy or restore a manual snapshot, set this list to include one or more Amazon Web Services account IDs, or all to make the manual DB snapshot restorable by any Amazon Web Services account. Do not add the all value for any manual DB snapshots that contain private information that you don't want available to all Amazon Web Services accounts.
A list of DB snapshot attributes to remove from the attribute specified by AttributeName .
To remove authorization for other Amazon Web Services accounts to copy or restore a manual snapshot, set this list to include one or more Amazon Web Services account identifiers, or all to remove authorization for any Amazon Web Services account to copy or restore the DB snapshot. If you specify all , an Amazon Web Services account whose account ID is explicitly added to the restore attribute can still copy or restore the manual DB snapshot.
dict
Response Syntax
{
'DBSnapshotAttributesResult': {
'DBSnapshotIdentifier': 'string',
'DBSnapshotAttributes': [
{
'AttributeName': 'string',
'AttributeValues': [
'string',
]
},
]
}
}
Response Structure
(dict) --
DBSnapshotAttributesResult (dict) --
Contains the results of a successful call to the DescribeDBSnapshotAttributes API action.
Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts to copy or restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute API action.
DBSnapshotIdentifier (string) --
The identifier of the manual DB snapshot that the attributes apply to.
DBSnapshotAttributes (list) --
The list of attributes and values for the manual DB snapshot.
(dict) --
Contains the name and values of a manual DB snapshot attribute
Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts to restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute API.
AttributeName (string) --
The name of the manual DB snapshot attribute.
The attribute named restore refers to the list of Amazon Web Services accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the ModifyDBSnapshotAttribute API action.
AttributeValues (list) --
The value or values for the manual DB snapshot attribute.
If the AttributeName field is set to restore , then this element returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual DB snapshot. If a value of all is in the list, then the manual DB snapshot is public and available for any Amazon Web Services account to copy or restore.
Exceptions
RDS.Client.exceptions.DBSnapshotNotFoundFaultRDS.Client.exceptions.InvalidDBSnapshotStateFaultRDS.Client.exceptions.SharedSnapshotQuotaExceededFaultExamples
This example adds the specified attribute for the specified DB snapshot.
response = client.modify_db_snapshot_attribute(
AttributeName='restore',
DBSnapshotIdentifier='mydbsnapshot',
ValuesToAdd=[
'all',
],
)
print(response)
Expected Output:
{
'DBSnapshotAttributesResult': {
},
'ResponseMetadata': {
'...': '...',
},
}
modify_db_subnet_group(**kwargs)¶Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region.
See also: AWS API Documentation
Request Syntax
response = client.modify_db_subnet_group(
DBSubnetGroupName='string',
DBSubnetGroupDescription='string',
SubnetIds=[
'string',
]
)
[REQUIRED]
The name for the DB 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: mydbsubnetgroup
[REQUIRED]
The EC2 subnet IDs for the DB subnet group.
dict
Response Syntax
{
'DBSubnetGroup': {
'DBSubnetGroupName': 'string',
'DBSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetOutpost': {
'Arn': 'string'
},
'SubnetStatus': 'string'
},
],
'DBSubnetGroupArn': 'string',
'SupportedNetworkTypes': [
'string',
]
}
}
Response Structure
(dict) --
DBSubnetGroup (dict) --
Contains the details of an Amazon RDS DB subnet group.
This data type is used as a response element in the DescribeDBSubnetGroups action.
DBSubnetGroupName (string) --
The name of the DB subnet group.
DBSubnetGroupDescription (string) --
Provides the description of the DB subnet group.
VpcId (string) --
Provides the VpcId of the DB subnet group.
SubnetGroupStatus (string) --
Provides the status of the DB subnet group.
Subnets (list) --
Contains a list of Subnet elements.
(dict) --
This data type is used as a response element for the DescribeDBSubnetGroups operation.
SubnetIdentifier (string) --
The identifier of the subnet.
SubnetAvailabilityZone (dict) --
Contains Availability Zone information.
This data type is used as an element in the OrderableDBInstanceOption data type.
Name (string) --
The name of the Availability Zone.
SubnetOutpost (dict) --
If the subnet is associated with an Outpost, this value specifies the Outpost.
For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
Arn (string) --
The Amazon Resource Name (ARN) of the Outpost.
SubnetStatus (string) --
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:
IPV4DUALA DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
Exceptions
RDS.Client.exceptions.DBSubnetGroupNotFoundFaultRDS.Client.exceptions.DBSubnetQuotaExceededFaultRDS.Client.exceptions.SubnetAlreadyInUseRDS.Client.exceptions.DBSubnetGroupDoesNotCoverEnoughAZsRDS.Client.exceptions.InvalidSubnetExamples
This example changes the specified setting for the specified DB subnet group.
response = client.modify_db_subnet_group(
DBSubnetGroupName='mydbsubnetgroup',
SubnetIds=[
'subnet-70e1975a',
'subnet-747a5c49',
],
)
print(response)
Expected Output:
{
'DBSubnetGroup': {
},
'ResponseMetadata': {
'...': '...',
},
}
modify_event_subscription(**kwargs)¶Modifies an existing RDS event notification subscription. You can't modify the source identifiers using this call. To change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.
You can see a list of the event categories for a given source type (SourceType ) in Events in the Amazon RDS User Guide or by using the DescribeEventCategories operation.
See also: AWS API Documentation
Request Syntax
response = client.modify_event_subscription(
SubscriptionName='string',
SnsTopicArn='string',
SourceType='string',
EventCategories=[
'string',
],
Enabled=True|False
)
[REQUIRED]
The name of the RDS event notification subscription.
The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. For RDS Proxy events, specify db-proxy . If this value isn't specified, all events are returned.
Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy
A list of event categories for a source type (SourceType ) that you want to subscribe to. You can see a list of the categories for a given source type in Events in the Amazon RDS User Guide or by using the DescribeEventCategories operation.
dict
Response Syntax
{
'EventSubscription': {
'CustomerAwsId': 'string',
'CustSubscriptionId': 'string',
'SnsTopicArn': 'string',
'Status': 'string',
'SubscriptionCreationTime': 'string',
'SourceType': 'string',
'SourceIdsList': [
'string',
],
'EventCategoriesList': [
'string',
],
'Enabled': True|False,
'EventSubscriptionArn': 'string'
}
}
Response Structure
(dict) --
EventSubscription (dict) --
Contains the results of a successful invocation of the DescribeEventSubscriptions action.
CustomerAwsId (string) --
The Amazon Web Services customer account associated with the RDS event notification subscription.
CustSubscriptionId (string) --
The RDS event notification subscription Id.
SnsTopicArn (string) --
The topic ARN of the RDS event notification subscription.
Status (string) --
The status of the RDS event notification subscription.
Constraints:
Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist
The status "no-permission" indicates that RDS no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.
SubscriptionCreationTime (string) --
The time the RDS event notification subscription was created.
SourceType (string) --
The source type for the RDS event notification subscription.
SourceIdsList (list) --
A list of source IDs for the RDS event notification subscription.
EventCategoriesList (list) --
A list of event categories for the RDS event notification subscription.
Enabled (boolean) --
A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.
EventSubscriptionArn (string) --
The Amazon Resource Name (ARN) for the event subscription.
Exceptions
RDS.Client.exceptions.EventSubscriptionQuotaExceededFaultRDS.Client.exceptions.SubscriptionNotFoundFaultRDS.Client.exceptions.SNSInvalidTopicFaultRDS.Client.exceptions.SNSNoAuthorizationFaultRDS.Client.exceptions.SNSTopicArnNotFoundFaultRDS.Client.exceptions.SubscriptionCategoryNotFoundFaultExamples
This example changes the specified setting for the specified event notification subscription.
response = client.modify_event_subscription(
Enabled=True,
EventCategories=[
'deletion',
'low storage',
],
SourceType='db-instance',
SubscriptionName='mymysqleventsubscription',
)
print(response)
Expected Output:
{
'EventSubscription': {
},
'ResponseMetadata': {
'...': '...',
},
}
modify_global_cluster(**kwargs)¶Modify a setting for an Amazon Aurora global cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide .
Note
This action only applies to Aurora DB clusters.
See also: AWS API Documentation
Request Syntax
response = client.modify_global_cluster(
GlobalClusterIdentifier='string',
NewGlobalClusterIdentifier='string',
DeletionProtection=True|False,
EngineVersion='string',
AllowMajorVersionUpgrade=True|False
)
The DB cluster identifier for the global cluster being modified. This parameter isn't case-sensitive.
Constraints:
The new cluster identifier for the global database cluster when modifying a global database cluster. This value is stored as a lowercase string.
Constraints:
Example: my-cluster2
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 aurora (for MySQL 5.6-compatible Aurora), use the following command:
aws rds describe-db-engine-versions --engine aurora --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'
To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora), use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'
To list all of the available engine versions for aurora-postgresql , use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'
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 DB cluster's current version.
If you upgrade the major version of a global database, the cluster and DB instance parameter groups are set to the default parameter groups for the new version. Apply any custom parameter groups after completing the upgrade.
dict
Response Syntax
{
'GlobalCluster': {
'GlobalClusterIdentifier': 'string',
'GlobalClusterResourceId': 'string',
'GlobalClusterArn': 'string',
'Status': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'DatabaseName': 'string',
'StorageEncrypted': True|False,
'DeletionProtection': True|False,
'GlobalClusterMembers': [
{
'DBClusterArn': 'string',
'Readers': [
'string',
],
'IsWriter': True|False,
'GlobalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'unknown'
},
],
'FailoverState': {
'Status': 'pending'|'failing-over'|'cancelling',
'FromDbClusterArn': 'string',
'ToDbClusterArn': 'string'
}
}
}
Response Structure
(dict) --
GlobalCluster (dict) --
A data type representing an Aurora global database.
GlobalClusterIdentifier (string) --
Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster.
GlobalClusterResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB cluster is accessed.
GlobalClusterArn (string) --
The Amazon Resource Name (ARN) for the global database cluster.
Status (string) --
Specifies the current state of this global database cluster.
Engine (string) --
The Aurora database engine used by the global database cluster.
EngineVersion (string) --
Indicates the database engine version.
DatabaseName (string) --
The default database name within the new global database cluster.
StorageEncrypted (boolean) --
The storage encryption setting for the global database cluster.
DeletionProtection (boolean) --
The deletion protection setting for the new global database cluster.
GlobalClusterMembers (list) --
The list of cluster IDs for secondary clusters within the global database cluster. Currently limited to 1 item.
(dict) --
A data structure with information about any primary and secondary clusters associated with an Aurora global database.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for each Aurora cluster.
Readers (list) --
The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global database.
IsWriter (boolean) --
Specifies whether the Aurora cluster is the primary cluster (that is, has read-write capability) for the Aurora global database with which it is associated.
GlobalWriteForwardingStatus (string) --
Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.
FailoverState (dict) --
A data object containing all properties for the current state of an in-process or pending failover process for this Aurora global database. This object is empty unless the FailoverGlobalCluster API operation has been called on this Aurora global database ( GlobalCluster ).
Status (string) --
The current status of the Aurora global database ( GlobalCluster ). Possible values are as follows:
GlobalCluster 's primary DB cluster and the specified secondary DB cluster are being verified before the failover process can start.FromDbClusterArn (string) --
The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being demoted, and which is associated with this state.
ToDbClusterArn (string) --
The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being promoted, and which is associated with this state.
Exceptions
RDS.Client.exceptions.GlobalClusterNotFoundFaultRDS.Client.exceptions.InvalidGlobalClusterStateFaultRDS.Client.exceptions.InvalidDBClusterStateFaultRDS.Client.exceptions.InvalidDBInstanceStateFaultmodify_option_group(**kwargs)¶Modifies an existing option group.
See also: AWS API Documentation
Request Syntax
response = client.modify_option_group(
OptionGroupName='string',
OptionsToInclude=[
{
'OptionName': 'string',
'Port': 123,
'OptionVersion': 'string',
'DBSecurityGroupMemberships': [
'string',
],
'VpcSecurityGroupMemberships': [
'string',
],
'OptionSettings': [
{
'Name': 'string',
'Value': 'string',
'DefaultValue': 'string',
'Description': 'string',
'ApplyType': 'string',
'DataType': 'string',
'AllowedValues': 'string',
'IsModifiable': True|False,
'IsCollection': True|False
},
]
},
],
OptionsToRemove=[
'string',
],
ApplyImmediately=True|False
)
[REQUIRED]
The name of the option group to be modified.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance
Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration.
A list of all available options
The configuration of options to include in a group.
The optional port for the option.
The version for the option.
A list of DBSecurityGroupMembership name strings used for this option.
A list of VpcSecurityGroupMembership name strings used for this option.
The option settings to include in an option group.
Option settings are the actual settings being applied or configured for that option. It is used when you modify an option group or describe option groups. For example, the NATIVE_NETWORK_ENCRYPTION option has a setting called SQLNET.ENCRYPTION_SERVER that can have several different values.
The name of the option that has settings that you can set.
The current value of the option setting.
The default value of the option setting.
The description of the option setting.
The DB engine specific parameter type.
The data type of the option setting.
The allowed values of the option setting.
A Boolean value that, when true, indicates the option setting can be modified from the default.
Indicates if the option setting is part of a collection.
Options in this list are removed from the option group.
dict
Response Syntax
{
'OptionGroup': {
'OptionGroupName': 'string',
'OptionGroupDescription': 'string',
'EngineName': 'string',
'MajorEngineVersion': 'string',
'Options': [
{
'OptionName': 'string',
'OptionDescription': 'string',
'Persistent': True|False,
'Permanent': True|False,
'Port': 123,
'OptionVersion': 'string',
'OptionSettings': [
{
'Name': 'string',
'Value': 'string',
'DefaultValue': 'string',
'Description': 'string',
'ApplyType': 'string',
'DataType': 'string',
'AllowedValues': 'string',
'IsModifiable': True|False,
'IsCollection': True|False
},
],
'DBSecurityGroupMemberships': [
{
'DBSecurityGroupName': 'string',
'Status': 'string'
},
],
'VpcSecurityGroupMemberships': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
]
},
],
'AllowsVpcAndNonVpcInstanceMemberships': True|False,
'VpcId': 'string',
'OptionGroupArn': 'string'
}
}
Response Structure
(dict) --
OptionGroup (dict) --
OptionGroupName (string) --
Specifies the name of the option group.
OptionGroupDescription (string) --
Provides a description of the option group.
EngineName (string) --
Indicates the name of the engine that this option group can be applied to.
MajorEngineVersion (string) --
Indicates the major engine version associated with this option group.
Options (list) --
Indicates what options are available in the option group.
(dict) --
Option details.
OptionName (string) --
The name of the option.
OptionDescription (string) --
The description of the option.
Persistent (boolean) --
Indicate if this option is persistent.
Permanent (boolean) --
Indicate if this option is permanent.
Port (integer) --
If required, the port configured for this option to use.
OptionVersion (string) --
The version of the option.
OptionSettings (list) --
The option settings for this option.
(dict) --
Option settings are the actual settings being applied or configured for that option. It is used when you modify an option group or describe option groups. For example, the NATIVE_NETWORK_ENCRYPTION option has a setting called SQLNET.ENCRYPTION_SERVER that can have several different values.
Name (string) --
The name of the option that has settings that you can set.
Value (string) --
The current value of the option setting.
DefaultValue (string) --
The default value of the option setting.
Description (string) --
The description of the option setting.
ApplyType (string) --
The DB engine specific parameter type.
DataType (string) --
The data type of the option setting.
AllowedValues (string) --
The allowed values of the option setting.
IsModifiable (boolean) --
A Boolean value that, when true, indicates the option setting can be modified from the default.
IsCollection (boolean) --
Indicates if the option setting is part of a collection.
DBSecurityGroupMemberships (list) --
If the option requires access to a port, then this DB security group allows access to the port.
(dict) --
This data type is used as a response element in the following actions:
ModifyDBInstanceRebootDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceToPointInTimeDBSecurityGroupName (string) --
The name of the DB security group.
Status (string) --
The status of the DB security group.
VpcSecurityGroupMemberships (list) --
If the option requires access to a port, then this VPC security group allows access to the port.
(dict) --
This data type is used as a response element for queries on VPC security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The membership status of the VPC security group.
Currently, the only valid status is active .
AllowsVpcAndNonVpcInstanceMemberships (boolean) --
Indicates whether this option group can be applied to both VPC and non-VPC instances. The value true indicates the option group can be applied to both VPC and non-VPC instances.
VpcId (string) --
If AllowsVpcAndNonVpcInstanceMemberships is false , this field is blank. If AllowsVpcAndNonVpcInstanceMemberships is true and this field is blank, then this option group can be applied to both VPC and non-VPC instances. If this field contains a value, then this option group can only be applied to instances that are in the VPC indicated by this field.
OptionGroupArn (string) --
The Amazon Resource Name (ARN) for the option group.
Exceptions
RDS.Client.exceptions.InvalidOptionGroupStateFaultRDS.Client.exceptions.OptionGroupNotFoundFaultExamples
The following example adds an option to an option group.
response = client.modify_option_group(
ApplyImmediately=True,
OptionGroupName='myawsuser-og02',
OptionsToInclude=[
{
'DBSecurityGroupMemberships': [
'default',
],
'OptionName': 'MEMCACHED',
},
],
)
print(response)
Expected Output:
{
'OptionGroup': {
},
'ResponseMetadata': {
'...': '...',
},
}
promote_read_replica(**kwargs)¶Promotes a read replica DB instance to a standalone DB instance.
Note
backing-up status. If you have enabled backups on your read replica, configure the automated backup window so that daily backups do not interfere with read replica promotion.See also: AWS API Documentation
Request Syntax
response = client.promote_read_replica(
DBInstanceIdentifier='string',
BackupRetentionPeriod=123,
PreferredBackupWindow='string'
)
[REQUIRED]
The DB instance identifier. This value is stored as a lowercase string.
Constraints:
Example: mydbinstance
The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
Default: 1
Constraints:
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. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Constraints:
hh24:mi-hh24:mi .dict
Response Syntax
{
'DBInstance': {
'DBInstanceIdentifier': 'string',
'DBInstanceClass': 'string',
'Engine': 'string',
'DBInstanceStatus': 'string',
'AutomaticRestartTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'DBName': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123,
'HostedZoneId': 'string'
},
'AllocatedStorage': 123,
'InstanceCreateTime': datetime(2015, 1, 1),
'PreferredBackupWindow': 'string',
'BackupRetentionPeriod': 123,
'DBSecurityGroups': [
{
'DBSecurityGroupName': 'string',
'Status': 'string'
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'DBParameterGroups': [
{
'DBParameterGroupName': 'string',
'ParameterApplyStatus': 'string'
},
],
'AvailabilityZone': 'string',
'DBSubnetGroup': {
'DBSubnetGroupName': 'string',
'DBSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetOutpost': {
'Arn': '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',
]
},
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
],
'IAMDatabaseAuthenticationEnabled': True|False,
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1)
},
'LatestRestorableTime': datetime(2015, 1, 1),
'MultiAZ': True|False,
'EngineVersion': 'string',
'AutoMinorVersionUpgrade': True|False,
'ReadReplicaSourceDBInstanceIdentifier': 'string',
'ReadReplicaDBInstanceIdentifiers': [
'string',
],
'ReadReplicaDBClusterIdentifiers': [
'string',
],
'ReplicaMode': 'open-read-only'|'mounted',
'LicenseModel': 'string',
'Iops': 123,
'OptionGroupMemberships': [
{
'OptionGroupName': 'string',
'Status': 'string'
},
],
'CharacterSetName': 'string',
'NcharCharacterSetName': 'string',
'SecondaryAvailabilityZone': 'string',
'PubliclyAccessible': True|False,
'StatusInfos': [
{
'StatusType': 'string',
'Normal': True|False,
'Status': 'string',
'Message': 'string'
},
],
'StorageType': 'string',
'TdeCredentialArn': 'string',
'DbInstancePort': 123,
'DBClusterIdentifier': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbiResourceId': 'string',
'CACertificateIdentifier': 'string',
'DomainMemberships': [
{
'Domain': 'string',
'Status': 'string',
'FQDN': 'string',
'IAMRoleName': 'string'
},
],
'CopyTagsToSnapshot': True|False,
'MonitoringInterval': 123,
'EnhancedMonitoringResourceArn': 'string',
'MonitoringRoleArn': 'string',
'PromotionTier': 123,
'DBInstanceArn': 'string',
'Timezone': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'PerformanceInsightsEnabled': True|False,
'PerformanceInsightsKMSKeyId': 'string',
'PerformanceInsightsRetentionPeriod': 123,
'EnabledCloudwatchLogsExports': [
'string',
],
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
],
'DeletionProtection': True|False,
'AssociatedRoles': [
{
'RoleArn': 'string',
'FeatureName': 'string',
'Status': 'string'
},
],
'ListenerEndpoint': {
'Address': 'string',
'Port': 123,
'HostedZoneId': 'string'
},
'MaxAllocatedStorage': 123,
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'DBInstanceAutomatedBackupsReplications': [
{
'DBInstanceAutomatedBackupsArn': 'string'
},
],
'CustomerOwnedIpEnabled': True|False,
'AwsBackupRecoveryPointArn': 'string',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamEngineNativeAuditFieldsIncluded': True|False,
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1),
'CustomIamInstanceProfile': 'string',
'BackupTarget': 'string',
'NetworkType': 'string',
'ActivityStreamPolicyStatus': 'locked'|'unlocked'|'locking-policy'|'unlocking-policy'
}
}
Response Structure
(dict) --
DBInstance (dict) --
Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations CreateDBInstance , CreateDBInstanceReadReplica , DeleteDBInstance , DescribeDBInstances , ModifyDBInstance , PromoteReadReplica , RebootDBInstance , RestoreDBInstanceFromDBSnapshot , RestoreDBInstanceFromS3 , RestoreDBInstanceToPointInTime , StartDBInstance , and StopDBInstance .
DBInstanceIdentifier (string) --
Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
DBInstanceClass (string) --
Contains the name of the compute and memory capacity class of the DB instance.
Engine (string) --
The name of the database engine to be used for this DB instance.
DBInstanceStatus (string) --
Specifies the current state of this database.
For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.
AutomaticRestartTime (datetime) --
The time when a stopped DB instance is restarted automatically.
MasterUsername (string) --
Contains the master username for the DB instance.
DBName (string) --
The meaning of this parameter differs according to the database engine you use.
MySQL, MariaDB, SQL Server, PostgreSQL
Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
Type: String
Oracle
Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
Endpoint (dict) --
Specifies the connection endpoint.
Note
The endpoint might not be shown for instances whose status is creating .
Address (string) --
Specifies the DNS address of the DB 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.
AllocatedStorage (integer) --
Specifies the allocated storage size specified in gibibytes (GiB).
InstanceCreateTime (datetime) --
Provides the date and time the DB 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 DB snapshots are retained.
DBSecurityGroups (list) --
A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
(dict) --
This data type is used as a response element in the following actions:
ModifyDBInstanceRebootDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceToPointInTimeDBSecurityGroupName (string) --
The name of the DB security group.
Status (string) --
The status of the DB security group.
VpcSecurityGroups (list) --
Provides a list of VPC security group elements that the DB instance belongs to.
(dict) --
This data type is used as a response element for queries on VPC security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The membership status of the VPC security group.
Currently, the only valid status is active .
DBParameterGroups (list) --
Provides the list of DB parameter groups applied to this DB instance.
(dict) --
The status of the DB parameter group.
This data type is used as a response element in the following actions:
CreateDBInstanceCreateDBInstanceReadReplicaDeleteDBInstanceModifyDBInstanceRebootDBInstanceRestoreDBInstanceFromDBSnapshotDBParameterGroupName (string) --
The name of the DB parameter group.
ParameterApplyStatus (string) --
The status of parameter updates.
AvailabilityZone (string) --
Specifies the name of the Availability Zone the DB instance is located in.
DBSubnetGroup (dict) --
Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
DBSubnetGroupName (string) --
The name of the DB subnet group.
DBSubnetGroupDescription (string) --
Provides the description of the DB subnet group.
VpcId (string) --
Provides the VpcId of the DB subnet group.
SubnetGroupStatus (string) --
Provides the status of the DB subnet group.
Subnets (list) --
Contains a list of Subnet elements.
(dict) --
This data type is used as a response element for the DescribeDBSubnetGroups operation.
SubnetIdentifier (string) --
The identifier of the subnet.
SubnetAvailabilityZone (dict) --
Contains Availability Zone information.
This data type is used as an element in the OrderableDBInstanceOption data type.
Name (string) --
The name of the Availability Zone.
SubnetOutpost (dict) --
If the subnet is associated with an Outpost, this value specifies the Outpost.
For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
Arn (string) --
The Amazon Resource Name (ARN) of the Outpost.
SubnetStatus (string) --
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:
IPV4DUALA DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
PendingModifiedValues (dict) --
A value that specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
DBInstanceClass (string) --
The name of the compute and memory capacity class for the DB instance.
AllocatedStorage (integer) --
The allocated storage size for the DB instance specified in gibibytes (GiB).
MasterUserPassword (string) --
The master credentials for the DB instance.
Port (integer) --
The port for the DB instance.
BackupRetentionPeriod (integer) --
The number of days for which automated backups are retained.
MultiAZ (boolean) --
A value that indicates that the Single-AZ DB instance will change to a Multi-AZ deployment.
EngineVersion (string) --
The database engine version.
LicenseModel (string) --
The license model for the DB instance.
Valid values: license-included | bring-your-own-license | general-public-license
Iops (integer) --
The Provisioned IOPS value for the DB instance.
DBInstanceIdentifier (string) --
The database identifier for the DB instance.
StorageType (string) --
The storage type of the DB instance.
CACertificateIdentifier (string) --
The identifier of the CA certificate for the DB instance.
DBSubnetGroupName (string) --
The DB subnet group for the DB instance.
PendingCloudwatchLogsExports (dict) --
A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.
LogTypesToEnable (list) --
Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.
LogTypesToDisable (list) --
Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.
ProcessorFeatures (list) --
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
(dict) --
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstanceModifyDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceFromS3RestoreDBInstanceToPointInTimeYou can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstancesDescribeDBSnapshotsDescribeValidDBInstanceModificationsIf you call DescribeDBInstances , ProcessorFeature returns non-null values only if the following conditions are met:
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
Name (string) --
The name of the processor feature. Valid names are coreCount and threadsPerCore .
Value (string) --
The value of a processor feature name.
IAMDatabaseAuthenticationEnabled (boolean) --
Whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
AutomationMode (string) --
The automation mode of the RDS Custom DB instance: full or all-paused . If full , the DB instance automates monitoring and instance recovery. If all-paused , the instance pauses automation for the duration set by --resume-full-automation-mode-minutes .
ResumeFullAutomationModeTime (datetime) --
The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
LatestRestorableTime (datetime) --
Specifies the latest time to which a database can be restored with point-in-time restore.
MultiAZ (boolean) --
Specifies if the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom.
EngineVersion (string) --
Indicates the database engine version.
AutoMinorVersionUpgrade (boolean) --
A value that indicates that minor version patches are applied automatically.
ReadReplicaSourceDBInstanceIdentifier (string) --
Contains the identifier of the source DB instance if this DB instance is a read replica.
ReadReplicaDBInstanceIdentifiers (list) --
Contains one or more identifiers of the read replicas associated with this DB instance.
ReadReplicaDBClusterIdentifiers (list) --
Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn't contain information about cross-Region Aurora read replicas.
Note
Currently, each RDS DB instance can have only one Aurora read replica.
ReplicaMode (string) --
The open mode of an Oracle read replica. The default is open-read-only . For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide .
Note
This attribute is only supported in RDS for Oracle.
LicenseModel (string) --
License model information for this DB instance. This setting doesn't apply to RDS Custom.
Iops (integer) --
Specifies the Provisioned IOPS (I/O operations per second) value.
OptionGroupMemberships (list) --
Provides the list of option group memberships for this DB instance.
(dict) --
Provides information on the option groups the DB instance is a member of.
OptionGroupName (string) --
The name of the option group that the instance belongs to.
Status (string) --
The status of the DB instance's option group membership. Valid values are: in-sync , pending-apply , pending-removal , pending-maintenance-apply , pending-maintenance-removal , applying , removing , and failed .
CharacterSetName (string) --
If present, specifies the name of the character set that this instance is associated with.
NcharCharacterSetName (string) --
The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.
SecondaryAvailabilityZone (string) --
If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
PubliclyAccessible (boolean) --
Specifies the accessibility options for the DB instance.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance .
StatusInfos (list) --
The status of a read replica. If the instance isn't a read replica, this is blank.
(dict) --
Provides a list of status information for a DB instance.
StatusType (string) --
This value is currently "read replication."
Normal (boolean) --
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 DB instance. For a StatusType of read replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.
Message (string) --
Details of the error if there is an error for the instance. If the instance isn't in an error state, this value is blank.
StorageType (string) --
Specifies the storage type associated with DB instance.
TdeCredentialArn (string) --
The ARN from the key store with which the instance is associated for TDE encryption.
DbInstancePort (integer) --
Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.
DBClusterIdentifier (string) --
If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.
StorageEncrypted (boolean) --
Specifies whether the DB instance is encrypted.
KmsKeyId (string) --
If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
DbiResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB instance is accessed.
CACertificateIdentifier (string) --
The identifier of the CA certificate for this DB instance.
DomainMemberships (list) --
The Active Directory Domain membership records associated with the DB instance.
(dict) --
An Active Directory Domain membership record associated with the DB instance or cluster.
Domain (string) --
The identifier of the Active Directory Domain.
Status (string) --
The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.
FQDN (string) --
The fully qualified domain name of the Active Directory Domain.
IAMRoleName (string) --
The name of the IAM role to be used when making API calls to the Directory Service.
CopyTagsToSnapshot (boolean) --
Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see DBCluster .
MonitoringInterval (integer) --
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
EnhancedMonitoringResourceArn (string) --
The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
MonitoringRoleArn (string) --
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
PromotionTier (integer) --
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .
DBInstanceArn (string) --
The Amazon Resource Name (ARN) for the DB instance.
Timezone (string) --
The time zone of the DB instance. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.
IAMDatabaseAuthenticationEnabled (boolean) --
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
IAM database authentication can be enabled for the following database engines
PerformanceInsightsEnabled (boolean) --
True if Performance Insights is enabled for the DB instance, and otherwise false.
PerformanceInsightsKMSKeyId (string) --
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
PerformanceInsightsRetentionPeriod (integer) --
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
For example, the following values are valid:
EnabledCloudwatchLogsExports (list) --
A list of log types that this DB instance is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon RDS User Guide.
ProcessorFeatures (list) --
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
(dict) --
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstanceModifyDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceFromS3RestoreDBInstanceToPointInTimeYou can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstancesDescribeDBSnapshotsDescribeValidDBInstanceModificationsIf you call DescribeDBInstances , ProcessorFeature returns non-null values only if the following conditions are met:
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
Name (string) --
The name of the processor feature. Valid names are coreCount and threadsPerCore .
Value (string) --
The value of a processor feature name.
DeletionProtection (boolean) --
Indicates if the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance .
AssociatedRoles (list) --
The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
(dict) --
Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.
FeatureName (string) --
The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion .
Status (string) --
Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf.PENDING - the IAM role ARN is being associated with the DB instance.INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf.ListenerEndpoint (dict) --
Specifies the listener connection endpoint for SQL Server Always On.
Address (string) --
Specifies the DNS address of the DB 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.
MaxAllocatedStorage (integer) --
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
TagList (list) --
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
DBInstanceAutomatedBackupsReplications (list) --
The list of replicated automated backups associated with the DB instance.
(dict) --
Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties.
DBInstanceAutomatedBackupsArn (string) --
The Amazon Resource Name (ARN) of the replicated automated backups.
CustomerOwnedIpEnabled (boolean) --
Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide .
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide .
AwsBackupRecoveryPointArn (string) --
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
ActivityStreamStatus (string) --
The status of the database activity stream.
ActivityStreamKmsKeyId (string) --
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
ActivityStreamKinesisStreamName (string) --
The name of the Amazon Kinesis data stream used for the database activity stream.
ActivityStreamMode (string) --
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. RDS for Oracle always handles these events asynchronously.
ActivityStreamEngineNativeAuditFieldsIncluded (boolean) --
Indicates whether engine-native audit fields are included in the database activity stream.
AutomationMode (string) --
The automation mode of the RDS Custom DB instance: full or all paused . If full , the DB instance automates monitoring and instance recovery. If all paused , the instance pauses automation for the duration set by --resume-full-automation-mode-minutes .
ResumeFullAutomationModeTime (datetime) --
The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
CustomIamInstanceProfile (string) --
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
AWSRDSCustom .For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide .
BackupTarget (string) --
Specifies where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
NetworkType (string) --
The network type of the DB instance.
Valid values:
IPV4DUALThe network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide and Working with a DB instance in a VPC in the Amazon Aurora User Guide.
ActivityStreamPolicyStatus (string) --
The status of the policy state of the activity stream.
Exceptions
RDS.Client.exceptions.InvalidDBInstanceStateFaultRDS.Client.exceptions.DBInstanceNotFoundFaultExamples
This example promotes the specified read replica and sets its backup retention period and preferred backup window.
response = client.promote_read_replica(
BackupRetentionPeriod=1,
DBInstanceIdentifier='mydbreadreplica',
PreferredBackupWindow='03:30-04:00',
)
print(response)
Expected Output:
{
'DBInstance': {
},
'ResponseMetadata': {
'...': '...',
},
}
promote_read_replica_db_cluster(**kwargs)¶Promotes a read replica DB cluster to a standalone DB cluster.
See also: AWS API Documentation
Request Syntax
response = client.promote_read_replica_db_cluster(
DBClusterIdentifier='string'
)
[REQUIRED]
The identifier of the DB cluster read replica to promote. This parameter isn't case-sensitive.
Constraints:
Example: my-cluster-replica1
{
'DBCluster': {
'AllocatedStorage': 123,
'AvailabilityZones': [
'string',
],
'BackupRetentionPeriod': 123,
'CharacterSetName': 'string',
'DatabaseName': 'string',
'DBClusterIdentifier': 'string',
'DBClusterParameterGroup': 'string',
'DBSubnetGroup': 'string',
'Status': 'string',
'AutomaticRestartTime': datetime(2015, 1, 1),
'PercentProgress': 'string',
'EarliestRestorableTime': datetime(2015, 1, 1),
'Endpoint': 'string',
'ReaderEndpoint': 'string',
'CustomEndpoints': [
'string',
],
'MultiAZ': True|False,
'Engine': 'string',
'EngineVersion': 'string',
'LatestRestorableTime': datetime(2015, 1, 1),
'Port': 123,
'MasterUsername': 'string',
'DBClusterOptionGroupMemberships': [
{
'DBClusterOptionGroupName': 'string',
'Status': 'string'
},
],
'PreferredBackupWindow': 'string',
'PreferredMaintenanceWindow': 'string',
'ReplicationSourceIdentifier': 'string',
'ReadReplicaIdentifiers': [
'string',
],
'DBClusterMembers': [
{
'DBInstanceIdentifier': 'string',
'IsClusterWriter': True|False,
'DBClusterParameterGroupStatus': 'string',
'PromotionTier': 123
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'HostedZoneId': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbClusterResourceId': 'string',
'DBClusterArn': 'string',
'AssociatedRoles': [
{
'RoleArn': 'string',
'Status': 'string',
'FeatureName': 'string'
},
],
'IAMDatabaseAuthenticationEnabled': True|False,
'CloneGroupId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'EarliestBacktrackTime': datetime(2015, 1, 1),
'BacktrackWindow': 123,
'BacktrackConsumedChangeRecords': 123,
'EnabledCloudwatchLogsExports': [
'string',
],
'Capacity': 123,
'EngineMode': 'string',
'ScalingConfigurationInfo': {
'MinCapacity': 123,
'MaxCapacity': 123,
'AutoPause': True|False,
'SecondsUntilAutoPause': 123,
'TimeoutAction': 'string',
'SecondsBeforeTimeout': 123
},
'DeletionProtection': True|False,
'HttpEndpointEnabled': True|False,
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'CopyTagsToSnapshot': True|False,
'CrossAccountClone': True|False,
'DomainMemberships': [
{
'Domain': 'string',
'Status': 'string',
'FQDN': 'string',
'IAMRoleName': 'string'
},
],
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'GlobalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'unknown',
'GlobalWriteForwardingRequested': True|False,
'PendingModifiedValues': {
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
},
'DBClusterIdentifier': 'string',
'MasterUserPassword': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'EngineVersion': 'string'
},
'DBClusterInstanceClass': 'string',
'StorageType': 'string',
'Iops': 123,
'PubliclyAccessible': True|False,
'AutoMinorVersionUpgrade': True|False,
'MonitoringInterval': 123,
'MonitoringRoleArn': 'string',
'PerformanceInsightsEnabled': True|False,
'PerformanceInsightsKMSKeyId': 'string',
'PerformanceInsightsRetentionPeriod': 123,
'ServerlessV2ScalingConfiguration': {
'MinCapacity': 123.0,
'MaxCapacity': 123.0
}
}
}
Response Structure
Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
For an Amazon Aurora DB cluster, this data type is used as a response element in the operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , FailoverDBCluster , ModifyDBCluster , PromoteReadReplicaDBCluster , RestoreDBClusterFromS3 , RestoreDBClusterFromSnapshot , RestoreDBClusterToPointInTime , StartDBCluster , and StopDBCluster .
For a Multi-AZ DB cluster, this data type is used as a response element in the operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , FailoverDBCluster , ModifyDBCluster , RebootDBCluster , RestoreDBClusterFromSnapshot , and RestoreDBClusterToPointInTime .
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.
Specifies the number of days for which automatic DB snapshots are retained.
If present, specifies the name of the character set that this cluster is associated with.
Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.
Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
Specifies the name of the DB cluster parameter group for the DB cluster.
Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
Specifies the current state of this DB cluster.
The time when a stopped DB cluster is restarted automatically.
Specifies the progress of the operation as a percentage.
The earliest time to which a database can be restored with point-in-time restore.
Specifies the connection endpoint for the primary instance of the DB cluster.
The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.
If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
Identifies all custom endpoints associated with the cluster.
Specifies whether the DB cluster has instances in multiple Availability Zones.
The name of the database engine to be used for this DB cluster.
Indicates the database engine version.
Specifies the latest time to which a database can be restored with point-in-time restore.
Specifies the port that the database engine is listening on.
Contains the master username for the DB cluster.
Provides the list of option group memberships for this DB cluster.
Contains status information for a DB cluster option group.
Specifies the name of the DB cluster option group.
Specifies the status of the DB cluster option group.
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Contains the identifier of the source DB cluster if this DB cluster is a read replica.
Contains one or more identifiers of the read replicas associated with this DB cluster.
Provides the list of instances that make up the DB cluster.
Contains information about an instance that is part of a DB cluster.
Specifies the instance identifier for this member of the DB cluster.
Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
Specifies the status of the DB cluster parameter group for this member of the DB cluster.
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .
Provides a list of VPC security groups that the DB cluster belongs to.
This data type is used as a response element for queries on VPC security group membership.
The name of the VPC security group.
The membership status of the VPC security group.
Currently, the only valid status is active .
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
Specifies whether the DB cluster is encrypted.
If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
The Amazon Resource Name (ARN) for the DB cluster.
Provides a list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.
Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB cluster.
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other Amazon Web Services on your behalf.PENDING - the IAM role ARN is being associated with the DB cluster.INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other Amazon Web Services on your behalf.The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion .
A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
Identifies the clone group to which the DB cluster is associated.
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
The earliest time to which a DB cluster can be backtracked.
The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.
The number of change records stored for Backtrack.
A list of log types that this DB cluster is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.
The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 (zero) when the cluster is paused.
For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide .
The DB engine mode of the DB cluster, either provisioned , serverless , parallelquery , global , or multimaster .
For more information, see CreateDBCluster .
Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.
For more information, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide .
The minimum capacity for an Aurora DB cluster in serverless DB engine mode.
The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.
When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.
The remaining amount of time, in seconds, before the Aurora DB cluster in serverless mode is paused. A DB cluster can be paused only when it's idle (it has no connections).
The action that occurs when Aurora times out while attempting to change the capacity of an Aurora Serverless v1 cluster. The value is either ForceApplyCapacityChange or RollbackCapacityChange .
ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.
RollbackCapacityChangeignores the capacity change if a scaling point isn't found in the timeout period.
The number of seconds before scaling times out. What happens when an attempted scaling action times out is determined by the TimeoutAction setting.
Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
A value that indicates whether the HTTP endpoint for an Aurora Serverless v1 DB cluster is enabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide .
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.
The status of the database activity stream.
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
The name of the Amazon Kinesis data stream used for the database activity stream.
Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.
Specifies whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
The Active Directory Domain membership records associated with the DB cluster.
An Active Directory Domain membership record associated with the DB instance or cluster.
The identifier of the Active Directory Domain.
The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.
The fully qualified domain name of the Active Directory Domain.
The name of the IAM role to be used when making API calls to the Directory Service.
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.
Specifies whether you have requested to enable write forwarding for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.
A value that specifies that changes to the DB cluster are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.
Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.
Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.
The DBClusterIdentifier value for the DB cluster.
The master credentials for the DB cluster.
A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
The database engine version.
The name of the compute and memory capacity class of the DB instance.
This setting is only for non-Aurora Multi-AZ DB clusters.
The storage type associated with the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
The Provisioned IOPS (I/O operations per second) value.
This setting is only for non-Aurora Multi-AZ DB clusters.
Specifies the accessibility options for the DB instance.
When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance .
This setting is only for non-Aurora Multi-AZ DB clusters.
A value that indicates that minor version patches are applied automatically.
This setting is only for non-Aurora Multi-AZ DB clusters.
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
This setting is only for non-Aurora Multi-AZ DB clusters.
True if Performance Insights is enabled for the DB cluster, and otherwise false.
This setting is only for non-Aurora Multi-AZ DB clusters.
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
This setting is only for non-Aurora Multi-AZ DB clusters.
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
For example, the following values are valid:
This setting is only for non-Aurora Multi-AZ DB clusters.
Shows the scaling configuration for an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide .
The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.
The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128.
Exceptions
RDS.Client.exceptions.DBClusterNotFoundFaultRDS.Client.exceptions.InvalidDBClusterStateFaultpurchase_reserved_db_instances_offering(**kwargs)¶Purchases a reserved DB instance offering.
See also: AWS API Documentation
Request Syntax
response = client.purchase_reserved_db_instances_offering(
ReservedDBInstancesOfferingId='string',
ReservedDBInstanceId='string',
DBInstanceCount=123,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The ID of the Reserved DB instance offering to purchase.
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
Customer-specified identifier to track this reservation.
Example: myreservationID
The number of instances to reserve.
Default: 1
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
dict
Response Syntax
{
'ReservedDBInstance': {
'ReservedDBInstanceId': 'string',
'ReservedDBInstancesOfferingId': 'string',
'DBInstanceClass': 'string',
'StartTime': datetime(2015, 1, 1),
'Duration': 123,
'FixedPrice': 123.0,
'UsagePrice': 123.0,
'CurrencyCode': 'string',
'DBInstanceCount': 123,
'ProductDescription': 'string',
'OfferingType': 'string',
'MultiAZ': True|False,
'State': 'string',
'RecurringCharges': [
{
'RecurringChargeAmount': 123.0,
'RecurringChargeFrequency': 'string'
},
],
'ReservedDBInstanceArn': 'string',
'LeaseId': 'string'
}
}
Response Structure
(dict) --
ReservedDBInstance (dict) --
This data type is used as a response element in the DescribeReservedDBInstances and PurchaseReservedDBInstancesOffering actions.
ReservedDBInstanceId (string) --
The unique identifier for the reservation.
ReservedDBInstancesOfferingId (string) --
The offering identifier.
DBInstanceClass (string) --
The DB instance class for the reserved DB instance.
StartTime (datetime) --
The time the reservation started.
Duration (integer) --
The duration of the reservation in seconds.
FixedPrice (float) --
The fixed price charged for this reserved DB instance.
UsagePrice (float) --
The hourly price charged for this reserved DB instance.
CurrencyCode (string) --
The currency code for the reserved DB instance.
DBInstanceCount (integer) --
The number of reserved DB instances.
ProductDescription (string) --
The description of the reserved DB instance.
OfferingType (string) --
The offering type of this reserved DB instance.
MultiAZ (boolean) --
Indicates if the reservation applies to Multi-AZ deployments.
State (string) --
The state of the reserved DB instance.
RecurringCharges (list) --
The recurring price charged to run this reserved DB instance.
(dict) --
This data type is used as a response element in the DescribeReservedDBInstances and DescribeReservedDBInstancesOfferings actions.
RecurringChargeAmount (float) --
The amount of the recurring charge.
RecurringChargeFrequency (string) --
The frequency of the recurring charge.
ReservedDBInstanceArn (string) --
The Amazon Resource Name (ARN) for the reserved DB instance.
LeaseId (string) --
The unique identifier for the lease associated with the reserved DB instance.
Note
Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.
Exceptions
RDS.Client.exceptions.ReservedDBInstancesOfferingNotFoundFaultRDS.Client.exceptions.ReservedDBInstanceAlreadyExistsFaultRDS.Client.exceptions.ReservedDBInstanceQuotaExceededFaultExamples
This example purchases a reserved DB instance offering that matches the specified settings.
response = client.purchase_reserved_db_instances_offering(
ReservedDBInstanceId='myreservationid',
ReservedDBInstancesOfferingId='fb29428a-646d-4390-850e-5fe89926e727',
)
print(response)
Expected Output:
{
'ReservedDBInstance': {
},
'ResponseMetadata': {
'...': '...',
},
}
reboot_db_cluster(**kwargs)¶You might need to reboot your DB cluster, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB cluster parameter group associated with the DB cluster, reboot the DB cluster for the changes to take effect.
Rebooting a DB cluster restarts the database engine service. Rebooting a DB cluster results in a momentary outage, during which the DB cluster status is set to rebooting.
Use this operation only for a non-Aurora Multi-AZ DB cluster.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
See also: AWS API Documentation
Request Syntax
response = client.reboot_db_cluster(
DBClusterIdentifier='string'
)
[REQUIRED]
The DB cluster identifier. This parameter is stored as a lowercase string.
Constraints:
{
'DBCluster': {
'AllocatedStorage': 123,
'AvailabilityZones': [
'string',
],
'BackupRetentionPeriod': 123,
'CharacterSetName': 'string',
'DatabaseName': 'string',
'DBClusterIdentifier': 'string',
'DBClusterParameterGroup': 'string',
'DBSubnetGroup': 'string',
'Status': 'string',
'AutomaticRestartTime': datetime(2015, 1, 1),
'PercentProgress': 'string',
'EarliestRestorableTime': datetime(2015, 1, 1),
'Endpoint': 'string',
'ReaderEndpoint': 'string',
'CustomEndpoints': [
'string',
],
'MultiAZ': True|False,
'Engine': 'string',
'EngineVersion': 'string',
'LatestRestorableTime': datetime(2015, 1, 1),
'Port': 123,
'MasterUsername': 'string',
'DBClusterOptionGroupMemberships': [
{
'DBClusterOptionGroupName': 'string',
'Status': 'string'
},
],
'PreferredBackupWindow': 'string',
'PreferredMaintenanceWindow': 'string',
'ReplicationSourceIdentifier': 'string',
'ReadReplicaIdentifiers': [
'string',
],
'DBClusterMembers': [
{
'DBInstanceIdentifier': 'string',
'IsClusterWriter': True|False,
'DBClusterParameterGroupStatus': 'string',
'PromotionTier': 123
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'HostedZoneId': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbClusterResourceId': 'string',
'DBClusterArn': 'string',
'AssociatedRoles': [
{
'RoleArn': 'string',
'Status': 'string',
'FeatureName': 'string'
},
],
'IAMDatabaseAuthenticationEnabled': True|False,
'CloneGroupId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'EarliestBacktrackTime': datetime(2015, 1, 1),
'BacktrackWindow': 123,
'BacktrackConsumedChangeRecords': 123,
'EnabledCloudwatchLogsExports': [
'string',
],
'Capacity': 123,
'EngineMode': 'string',
'ScalingConfigurationInfo': {
'MinCapacity': 123,
'MaxCapacity': 123,
'AutoPause': True|False,
'SecondsUntilAutoPause': 123,
'TimeoutAction': 'string',
'SecondsBeforeTimeout': 123
},
'DeletionProtection': True|False,
'HttpEndpointEnabled': True|False,
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'CopyTagsToSnapshot': True|False,
'CrossAccountClone': True|False,
'DomainMemberships': [
{
'Domain': 'string',
'Status': 'string',
'FQDN': 'string',
'IAMRoleName': 'string'
},
],
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'GlobalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'unknown',
'GlobalWriteForwardingRequested': True|False,
'PendingModifiedValues': {
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
},
'DBClusterIdentifier': 'string',
'MasterUserPassword': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'EngineVersion': 'string'
},
'DBClusterInstanceClass': 'string',
'StorageType': 'string',
'Iops': 123,
'PubliclyAccessible': True|False,
'AutoMinorVersionUpgrade': True|False,
'MonitoringInterval': 123,
'MonitoringRoleArn': 'string',
'PerformanceInsightsEnabled': True|False,
'PerformanceInsightsKMSKeyId': 'string',
'PerformanceInsightsRetentionPeriod': 123,
'ServerlessV2ScalingConfiguration': {
'MinCapacity': 123.0,
'MaxCapacity': 123.0
}
}
}
Response Structure
Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
For an Amazon Aurora DB cluster, this data type is used as a response element in the operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , FailoverDBCluster , ModifyDBCluster , PromoteReadReplicaDBCluster , RestoreDBClusterFromS3 , RestoreDBClusterFromSnapshot , RestoreDBClusterToPointInTime , StartDBCluster , and StopDBCluster .
For a Multi-AZ DB cluster, this data type is used as a response element in the operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , FailoverDBCluster , ModifyDBCluster , RebootDBCluster , RestoreDBClusterFromSnapshot , and RestoreDBClusterToPointInTime .
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.
Specifies the number of days for which automatic DB snapshots are retained.
If present, specifies the name of the character set that this cluster is associated with.
Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.
Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
Specifies the name of the DB cluster parameter group for the DB cluster.
Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
Specifies the current state of this DB cluster.
The time when a stopped DB cluster is restarted automatically.
Specifies the progress of the operation as a percentage.
The earliest time to which a database can be restored with point-in-time restore.
Specifies the connection endpoint for the primary instance of the DB cluster.
The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.
If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
Identifies all custom endpoints associated with the cluster.
Specifies whether the DB cluster has instances in multiple Availability Zones.
The name of the database engine to be used for this DB cluster.
Indicates the database engine version.
Specifies the latest time to which a database can be restored with point-in-time restore.
Specifies the port that the database engine is listening on.
Contains the master username for the DB cluster.
Provides the list of option group memberships for this DB cluster.
Contains status information for a DB cluster option group.
Specifies the name of the DB cluster option group.
Specifies the status of the DB cluster option group.
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Contains the identifier of the source DB cluster if this DB cluster is a read replica.
Contains one or more identifiers of the read replicas associated with this DB cluster.
Provides the list of instances that make up the DB cluster.
Contains information about an instance that is part of a DB cluster.
Specifies the instance identifier for this member of the DB cluster.
Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
Specifies the status of the DB cluster parameter group for this member of the DB cluster.
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .
Provides a list of VPC security groups that the DB cluster belongs to.
This data type is used as a response element for queries on VPC security group membership.
The name of the VPC security group.
The membership status of the VPC security group.
Currently, the only valid status is active .
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
Specifies whether the DB cluster is encrypted.
If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
The Amazon Resource Name (ARN) for the DB cluster.
Provides a list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.
Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB cluster.
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other Amazon Web Services on your behalf.PENDING - the IAM role ARN is being associated with the DB cluster.INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other Amazon Web Services on your behalf.The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion .
A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
Identifies the clone group to which the DB cluster is associated.
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
The earliest time to which a DB cluster can be backtracked.
The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.
The number of change records stored for Backtrack.
A list of log types that this DB cluster is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.
The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 (zero) when the cluster is paused.
For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide .
The DB engine mode of the DB cluster, either provisioned , serverless , parallelquery , global , or multimaster .
For more information, see CreateDBCluster .
Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.
For more information, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide .
The minimum capacity for an Aurora DB cluster in serverless DB engine mode.
The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.
When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.
The remaining amount of time, in seconds, before the Aurora DB cluster in serverless mode is paused. A DB cluster can be paused only when it's idle (it has no connections).
The action that occurs when Aurora times out while attempting to change the capacity of an Aurora Serverless v1 cluster. The value is either ForceApplyCapacityChange or RollbackCapacityChange .
ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.
RollbackCapacityChangeignores the capacity change if a scaling point isn't found in the timeout period.
The number of seconds before scaling times out. What happens when an attempted scaling action times out is determined by the TimeoutAction setting.
Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
A value that indicates whether the HTTP endpoint for an Aurora Serverless v1 DB cluster is enabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide .
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.
The status of the database activity stream.
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
The name of the Amazon Kinesis data stream used for the database activity stream.
Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.
Specifies whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
The Active Directory Domain membership records associated with the DB cluster.
An Active Directory Domain membership record associated with the DB instance or cluster.
The identifier of the Active Directory Domain.
The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.
The fully qualified domain name of the Active Directory Domain.
The name of the IAM role to be used when making API calls to the Directory Service.
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.
Specifies whether you have requested to enable write forwarding for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.
A value that specifies that changes to the DB cluster are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.
Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.
Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.
The DBClusterIdentifier value for the DB cluster.
The master credentials for the DB cluster.
A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
The database engine version.
The name of the compute and memory capacity class of the DB instance.
This setting is only for non-Aurora Multi-AZ DB clusters.
The storage type associated with the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
The Provisioned IOPS (I/O operations per second) value.
This setting is only for non-Aurora Multi-AZ DB clusters.
Specifies the accessibility options for the DB instance.
When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance .
This setting is only for non-Aurora Multi-AZ DB clusters.
A value that indicates that minor version patches are applied automatically.
This setting is only for non-Aurora Multi-AZ DB clusters.
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
This setting is only for non-Aurora Multi-AZ DB clusters.
True if Performance Insights is enabled for the DB cluster, and otherwise false.
This setting is only for non-Aurora Multi-AZ DB clusters.
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
This setting is only for non-Aurora Multi-AZ DB clusters.
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
For example, the following values are valid:
This setting is only for non-Aurora Multi-AZ DB clusters.
Shows the scaling configuration for an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide .
The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.
The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128.
Exceptions
RDS.Client.exceptions.DBClusterNotFoundFaultRDS.Client.exceptions.InvalidDBClusterStateFaultRDS.Client.exceptions.InvalidDBInstanceStateFaultreboot_db_instance(**kwargs)¶You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect.
Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.
For more information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide.
This command doesn't apply to RDS Custom.
If your DB instance is part of a Multi-AZ DB cluster, you can reboot the DB cluster with the RebootDBCluster operation.
See also: AWS API Documentation
Request Syntax
response = client.reboot_db_instance(
DBInstanceIdentifier='string',
ForceFailover=True|False
)
[REQUIRED]
The DB instance identifier. This parameter is stored as a lowercase string.
Constraints:
A value that indicates whether the reboot is conducted through a Multi-AZ failover.
Constraint: You can't enable force failover if the instance isn't configured for Multi-AZ.
dict
Response Syntax
{
'DBInstance': {
'DBInstanceIdentifier': 'string',
'DBInstanceClass': 'string',
'Engine': 'string',
'DBInstanceStatus': 'string',
'AutomaticRestartTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'DBName': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123,
'HostedZoneId': 'string'
},
'AllocatedStorage': 123,
'InstanceCreateTime': datetime(2015, 1, 1),
'PreferredBackupWindow': 'string',
'BackupRetentionPeriod': 123,
'DBSecurityGroups': [
{
'DBSecurityGroupName': 'string',
'Status': 'string'
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'DBParameterGroups': [
{
'DBParameterGroupName': 'string',
'ParameterApplyStatus': 'string'
},
],
'AvailabilityZone': 'string',
'DBSubnetGroup': {
'DBSubnetGroupName': 'string',
'DBSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetOutpost': {
'Arn': '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',
]
},
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
],
'IAMDatabaseAuthenticationEnabled': True|False,
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1)
},
'LatestRestorableTime': datetime(2015, 1, 1),
'MultiAZ': True|False,
'EngineVersion': 'string',
'AutoMinorVersionUpgrade': True|False,
'ReadReplicaSourceDBInstanceIdentifier': 'string',
'ReadReplicaDBInstanceIdentifiers': [
'string',
],
'ReadReplicaDBClusterIdentifiers': [
'string',
],
'ReplicaMode': 'open-read-only'|'mounted',
'LicenseModel': 'string',
'Iops': 123,
'OptionGroupMemberships': [
{
'OptionGroupName': 'string',
'Status': 'string'
},
],
'CharacterSetName': 'string',
'NcharCharacterSetName': 'string',
'SecondaryAvailabilityZone': 'string',
'PubliclyAccessible': True|False,
'StatusInfos': [
{
'StatusType': 'string',
'Normal': True|False,
'Status': 'string',
'Message': 'string'
},
],
'StorageType': 'string',
'TdeCredentialArn': 'string',
'DbInstancePort': 123,
'DBClusterIdentifier': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbiResourceId': 'string',
'CACertificateIdentifier': 'string',
'DomainMemberships': [
{
'Domain': 'string',
'Status': 'string',
'FQDN': 'string',
'IAMRoleName': 'string'
},
],
'CopyTagsToSnapshot': True|False,
'MonitoringInterval': 123,
'EnhancedMonitoringResourceArn': 'string',
'MonitoringRoleArn': 'string',
'PromotionTier': 123,
'DBInstanceArn': 'string',
'Timezone': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'PerformanceInsightsEnabled': True|False,
'PerformanceInsightsKMSKeyId': 'string',
'PerformanceInsightsRetentionPeriod': 123,
'EnabledCloudwatchLogsExports': [
'string',
],
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
],
'DeletionProtection': True|False,
'AssociatedRoles': [
{
'RoleArn': 'string',
'FeatureName': 'string',
'Status': 'string'
},
],
'ListenerEndpoint': {
'Address': 'string',
'Port': 123,
'HostedZoneId': 'string'
},
'MaxAllocatedStorage': 123,
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'DBInstanceAutomatedBackupsReplications': [
{
'DBInstanceAutomatedBackupsArn': 'string'
},
],
'CustomerOwnedIpEnabled': True|False,
'AwsBackupRecoveryPointArn': 'string',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamEngineNativeAuditFieldsIncluded': True|False,
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1),
'CustomIamInstanceProfile': 'string',
'BackupTarget': 'string',
'NetworkType': 'string',
'ActivityStreamPolicyStatus': 'locked'|'unlocked'|'locking-policy'|'unlocking-policy'
}
}
Response Structure
(dict) --
DBInstance (dict) --
Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations CreateDBInstance , CreateDBInstanceReadReplica , DeleteDBInstance , DescribeDBInstances , ModifyDBInstance , PromoteReadReplica , RebootDBInstance , RestoreDBInstanceFromDBSnapshot , RestoreDBInstanceFromS3 , RestoreDBInstanceToPointInTime , StartDBInstance , and StopDBInstance .
DBInstanceIdentifier (string) --
Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
DBInstanceClass (string) --
Contains the name of the compute and memory capacity class of the DB instance.
Engine (string) --
The name of the database engine to be used for this DB instance.
DBInstanceStatus (string) --
Specifies the current state of this database.
For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.
AutomaticRestartTime (datetime) --
The time when a stopped DB instance is restarted automatically.
MasterUsername (string) --
Contains the master username for the DB instance.
DBName (string) --
The meaning of this parameter differs according to the database engine you use.
MySQL, MariaDB, SQL Server, PostgreSQL
Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
Type: String
Oracle
Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
Endpoint (dict) --
Specifies the connection endpoint.
Note
The endpoint might not be shown for instances whose status is creating .
Address (string) --
Specifies the DNS address of the DB 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.
AllocatedStorage (integer) --
Specifies the allocated storage size specified in gibibytes (GiB).
InstanceCreateTime (datetime) --
Provides the date and time the DB 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 DB snapshots are retained.
DBSecurityGroups (list) --
A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
(dict) --
This data type is used as a response element in the following actions:
ModifyDBInstanceRebootDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceToPointInTimeDBSecurityGroupName (string) --
The name of the DB security group.
Status (string) --
The status of the DB security group.
VpcSecurityGroups (list) --
Provides a list of VPC security group elements that the DB instance belongs to.
(dict) --
This data type is used as a response element for queries on VPC security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The membership status of the VPC security group.
Currently, the only valid status is active .
DBParameterGroups (list) --
Provides the list of DB parameter groups applied to this DB instance.
(dict) --
The status of the DB parameter group.
This data type is used as a response element in the following actions:
CreateDBInstanceCreateDBInstanceReadReplicaDeleteDBInstanceModifyDBInstanceRebootDBInstanceRestoreDBInstanceFromDBSnapshotDBParameterGroupName (string) --
The name of the DB parameter group.
ParameterApplyStatus (string) --
The status of parameter updates.
AvailabilityZone (string) --
Specifies the name of the Availability Zone the DB instance is located in.
DBSubnetGroup (dict) --
Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
DBSubnetGroupName (string) --
The name of the DB subnet group.
DBSubnetGroupDescription (string) --
Provides the description of the DB subnet group.
VpcId (string) --
Provides the VpcId of the DB subnet group.
SubnetGroupStatus (string) --
Provides the status of the DB subnet group.
Subnets (list) --
Contains a list of Subnet elements.
(dict) --
This data type is used as a response element for the DescribeDBSubnetGroups operation.
SubnetIdentifier (string) --
The identifier of the subnet.
SubnetAvailabilityZone (dict) --
Contains Availability Zone information.
This data type is used as an element in the OrderableDBInstanceOption data type.
Name (string) --
The name of the Availability Zone.
SubnetOutpost (dict) --
If the subnet is associated with an Outpost, this value specifies the Outpost.
For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
Arn (string) --
The Amazon Resource Name (ARN) of the Outpost.
SubnetStatus (string) --
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:
IPV4DUALA DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
PendingModifiedValues (dict) --
A value that specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
DBInstanceClass (string) --
The name of the compute and memory capacity class for the DB instance.
AllocatedStorage (integer) --
The allocated storage size for the DB instance specified in gibibytes (GiB).
MasterUserPassword (string) --
The master credentials for the DB instance.
Port (integer) --
The port for the DB instance.
BackupRetentionPeriod (integer) --
The number of days for which automated backups are retained.
MultiAZ (boolean) --
A value that indicates that the Single-AZ DB instance will change to a Multi-AZ deployment.
EngineVersion (string) --
The database engine version.
LicenseModel (string) --
The license model for the DB instance.
Valid values: license-included | bring-your-own-license | general-public-license
Iops (integer) --
The Provisioned IOPS value for the DB instance.
DBInstanceIdentifier (string) --
The database identifier for the DB instance.
StorageType (string) --
The storage type of the DB instance.
CACertificateIdentifier (string) --
The identifier of the CA certificate for the DB instance.
DBSubnetGroupName (string) --
The DB subnet group for the DB instance.
PendingCloudwatchLogsExports (dict) --
A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.
LogTypesToEnable (list) --
Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.
LogTypesToDisable (list) --
Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.
ProcessorFeatures (list) --
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
(dict) --
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstanceModifyDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceFromS3RestoreDBInstanceToPointInTimeYou can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstancesDescribeDBSnapshotsDescribeValidDBInstanceModificationsIf you call DescribeDBInstances , ProcessorFeature returns non-null values only if the following conditions are met:
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
Name (string) --
The name of the processor feature. Valid names are coreCount and threadsPerCore .
Value (string) --
The value of a processor feature name.
IAMDatabaseAuthenticationEnabled (boolean) --
Whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
AutomationMode (string) --
The automation mode of the RDS Custom DB instance: full or all-paused . If full , the DB instance automates monitoring and instance recovery. If all-paused , the instance pauses automation for the duration set by --resume-full-automation-mode-minutes .
ResumeFullAutomationModeTime (datetime) --
The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
LatestRestorableTime (datetime) --
Specifies the latest time to which a database can be restored with point-in-time restore.
MultiAZ (boolean) --
Specifies if the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom.
EngineVersion (string) --
Indicates the database engine version.
AutoMinorVersionUpgrade (boolean) --
A value that indicates that minor version patches are applied automatically.
ReadReplicaSourceDBInstanceIdentifier (string) --
Contains the identifier of the source DB instance if this DB instance is a read replica.
ReadReplicaDBInstanceIdentifiers (list) --
Contains one or more identifiers of the read replicas associated with this DB instance.
ReadReplicaDBClusterIdentifiers (list) --
Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn't contain information about cross-Region Aurora read replicas.
Note
Currently, each RDS DB instance can have only one Aurora read replica.
ReplicaMode (string) --
The open mode of an Oracle read replica. The default is open-read-only . For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide .
Note
This attribute is only supported in RDS for Oracle.
LicenseModel (string) --
License model information for this DB instance. This setting doesn't apply to RDS Custom.
Iops (integer) --
Specifies the Provisioned IOPS (I/O operations per second) value.
OptionGroupMemberships (list) --
Provides the list of option group memberships for this DB instance.
(dict) --
Provides information on the option groups the DB instance is a member of.
OptionGroupName (string) --
The name of the option group that the instance belongs to.
Status (string) --
The status of the DB instance's option group membership. Valid values are: in-sync , pending-apply , pending-removal , pending-maintenance-apply , pending-maintenance-removal , applying , removing , and failed .
CharacterSetName (string) --
If present, specifies the name of the character set that this instance is associated with.
NcharCharacterSetName (string) --
The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.
SecondaryAvailabilityZone (string) --
If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
PubliclyAccessible (boolean) --
Specifies the accessibility options for the DB instance.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance .
StatusInfos (list) --
The status of a read replica. If the instance isn't a read replica, this is blank.
(dict) --
Provides a list of status information for a DB instance.
StatusType (string) --
This value is currently "read replication."
Normal (boolean) --
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 DB instance. For a StatusType of read replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.
Message (string) --
Details of the error if there is an error for the instance. If the instance isn't in an error state, this value is blank.
StorageType (string) --
Specifies the storage type associated with DB instance.
TdeCredentialArn (string) --
The ARN from the key store with which the instance is associated for TDE encryption.
DbInstancePort (integer) --
Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.
DBClusterIdentifier (string) --
If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.
StorageEncrypted (boolean) --
Specifies whether the DB instance is encrypted.
KmsKeyId (string) --
If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
DbiResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB instance is accessed.
CACertificateIdentifier (string) --
The identifier of the CA certificate for this DB instance.
DomainMemberships (list) --
The Active Directory Domain membership records associated with the DB instance.
(dict) --
An Active Directory Domain membership record associated with the DB instance or cluster.
Domain (string) --
The identifier of the Active Directory Domain.
Status (string) --
The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.
FQDN (string) --
The fully qualified domain name of the Active Directory Domain.
IAMRoleName (string) --
The name of the IAM role to be used when making API calls to the Directory Service.
CopyTagsToSnapshot (boolean) --
Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see DBCluster .
MonitoringInterval (integer) --
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
EnhancedMonitoringResourceArn (string) --
The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
MonitoringRoleArn (string) --
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
PromotionTier (integer) --
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .
DBInstanceArn (string) --
The Amazon Resource Name (ARN) for the DB instance.
Timezone (string) --
The time zone of the DB instance. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.
IAMDatabaseAuthenticationEnabled (boolean) --
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
IAM database authentication can be enabled for the following database engines
PerformanceInsightsEnabled (boolean) --
True if Performance Insights is enabled for the DB instance, and otherwise false.
PerformanceInsightsKMSKeyId (string) --
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
PerformanceInsightsRetentionPeriod (integer) --
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
For example, the following values are valid:
EnabledCloudwatchLogsExports (list) --
A list of log types that this DB instance is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon RDS User Guide.
ProcessorFeatures (list) --
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
(dict) --
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstanceModifyDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceFromS3RestoreDBInstanceToPointInTimeYou can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstancesDescribeDBSnapshotsDescribeValidDBInstanceModificationsIf you call DescribeDBInstances , ProcessorFeature returns non-null values only if the following conditions are met:
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
Name (string) --
The name of the processor feature. Valid names are coreCount and threadsPerCore .
Value (string) --
The value of a processor feature name.
DeletionProtection (boolean) --
Indicates if the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance .
AssociatedRoles (list) --
The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
(dict) --
Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.
FeatureName (string) --
The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion .
Status (string) --
Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf.PENDING - the IAM role ARN is being associated with the DB instance.INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf.ListenerEndpoint (dict) --
Specifies the listener connection endpoint for SQL Server Always On.
Address (string) --
Specifies the DNS address of the DB 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.
MaxAllocatedStorage (integer) --
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
TagList (list) --
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
DBInstanceAutomatedBackupsReplications (list) --
The list of replicated automated backups associated with the DB instance.
(dict) --
Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties.
DBInstanceAutomatedBackupsArn (string) --
The Amazon Resource Name (ARN) of the replicated automated backups.
CustomerOwnedIpEnabled (boolean) --
Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide .
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide .
AwsBackupRecoveryPointArn (string) --
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
ActivityStreamStatus (string) --
The status of the database activity stream.
ActivityStreamKmsKeyId (string) --
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
ActivityStreamKinesisStreamName (string) --
The name of the Amazon Kinesis data stream used for the database activity stream.
ActivityStreamMode (string) --
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. RDS for Oracle always handles these events asynchronously.
ActivityStreamEngineNativeAuditFieldsIncluded (boolean) --
Indicates whether engine-native audit fields are included in the database activity stream.
AutomationMode (string) --
The automation mode of the RDS Custom DB instance: full or all paused . If full , the DB instance automates monitoring and instance recovery. If all paused , the instance pauses automation for the duration set by --resume-full-automation-mode-minutes .
ResumeFullAutomationModeTime (datetime) --
The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
CustomIamInstanceProfile (string) --
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
AWSRDSCustom .For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide .
BackupTarget (string) --
Specifies where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
NetworkType (string) --
The network type of the DB instance.
Valid values:
IPV4DUALThe network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide and Working with a DB instance in a VPC in the Amazon Aurora User Guide.
ActivityStreamPolicyStatus (string) --
The status of the policy state of the activity stream.
Exceptions
RDS.Client.exceptions.InvalidDBInstanceStateFaultRDS.Client.exceptions.DBInstanceNotFoundFaultExamples
This example reboots the specified DB instance without forcing a failover.
response = client.reboot_db_instance(
DBInstanceIdentifier='mymysqlinstance',
ForceFailover=False,
)
print(response)
Expected Output:
{
'DBInstance': {
},
'ResponseMetadata': {
'...': '...',
},
}
register_db_proxy_targets(**kwargs)¶Associate one or more DBProxyTarget data structures with a DBProxyTargetGroup .
See also: AWS API Documentation
Request Syntax
response = client.register_db_proxy_targets(
DBProxyName='string',
TargetGroupName='string',
DBInstanceIdentifiers=[
'string',
],
DBClusterIdentifiers=[
'string',
]
)
[REQUIRED]
The identifier of the DBProxy that is associated with the DBProxyTargetGroup .
DBProxyTargetGroup .One or more DB instance identifiers.
One or more DB cluster identifiers.
dict
Response Syntax
{
'DBProxyTargets': [
{
'TargetArn': 'string',
'Endpoint': 'string',
'TrackedClusterId': 'string',
'RdsResourceId': 'string',
'Port': 123,
'Type': 'RDS_INSTANCE'|'RDS_SERVERLESS_ENDPOINT'|'TRACKED_CLUSTER',
'Role': 'READ_WRITE'|'READ_ONLY'|'UNKNOWN',
'TargetHealth': {
'State': 'REGISTERING'|'AVAILABLE'|'UNAVAILABLE',
'Reason': 'UNREACHABLE'|'CONNECTION_FAILED'|'AUTH_FAILURE'|'PENDING_PROXY_CAPACITY'|'INVALID_REPLICATION_STATE',
'Description': 'string'
}
},
]
}
Response Structure
(dict) --
DBProxyTargets (list) --
One or more DBProxyTarget objects that are created when you register targets with a target group.
(dict) --
Contains the details for an RDS Proxy target. It represents an RDS DB instance or Aurora DB cluster that the proxy can connect to. One or more targets are associated with an RDS Proxy target group.
This data type is used as a response element in the DescribeDBProxyTargets action.
TargetArn (string) --
The Amazon Resource Name (ARN) for the RDS DB instance or Aurora DB cluster.
Endpoint (string) --
The writer endpoint for the RDS DB instance or Aurora DB cluster.
TrackedClusterId (string) --
The DB cluster identifier when the target represents an Aurora DB cluster. This field is blank when the target represents an RDS DB instance.
RdsResourceId (string) --
The identifier representing the target. It can be the instance identifier for an RDS DB instance, or the cluster identifier for an Aurora DB cluster.
Port (integer) --
The port that the RDS Proxy uses to connect to the target RDS DB instance or Aurora DB cluster.
Type (string) --
Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents.
Role (string) --
A value that indicates whether the target of the proxy can be used for read/write or read-only operations.
TargetHealth (dict) --
Information about the connection health of the RDS Proxy target.
State (string) --
The current state of the connection health lifecycle for the RDS Proxy target. The following is a typical lifecycle example for the states of an RDS Proxy target:
registering>unavailable>available>unavailable>available
Reason (string) --
The reason for the current health State of the RDS Proxy target.
Description (string) --
A description of the health of the RDS Proxy target. If the State is AVAILABLE , a description is not included.
Exceptions
RDS.Client.exceptions.DBProxyNotFoundFaultRDS.Client.exceptions.DBProxyTargetGroupNotFoundFaultRDS.Client.exceptions.DBClusterNotFoundFaultRDS.Client.exceptions.DBInstanceNotFoundFaultRDS.Client.exceptions.DBProxyTargetAlreadyRegisteredFaultRDS.Client.exceptions.InvalidDBInstanceStateFaultRDS.Client.exceptions.InvalidDBClusterStateFaultRDS.Client.exceptions.InvalidDBProxyStateFaultRDS.Client.exceptions.InsufficientAvailableIPsInSubnetFaultremove_from_global_cluster(**kwargs)¶Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary cluster in a different Region.
Note
This action only applies to Aurora DB clusters.
See also: AWS API Documentation
Request Syntax
response = client.remove_from_global_cluster(
GlobalClusterIdentifier='string',
DbClusterIdentifier='string'
)
dict
Response Syntax
{
'GlobalCluster': {
'GlobalClusterIdentifier': 'string',
'GlobalClusterResourceId': 'string',
'GlobalClusterArn': 'string',
'Status': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'DatabaseName': 'string',
'StorageEncrypted': True|False,
'DeletionProtection': True|False,
'GlobalClusterMembers': [
{
'DBClusterArn': 'string',
'Readers': [
'string',
],
'IsWriter': True|False,
'GlobalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'unknown'
},
],
'FailoverState': {
'Status': 'pending'|'failing-over'|'cancelling',
'FromDbClusterArn': 'string',
'ToDbClusterArn': 'string'
}
}
}
Response Structure
(dict) --
GlobalCluster (dict) --
A data type representing an Aurora global database.
GlobalClusterIdentifier (string) --
Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster.
GlobalClusterResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB cluster is accessed.
GlobalClusterArn (string) --
The Amazon Resource Name (ARN) for the global database cluster.
Status (string) --
Specifies the current state of this global database cluster.
Engine (string) --
The Aurora database engine used by the global database cluster.
EngineVersion (string) --
Indicates the database engine version.
DatabaseName (string) --
The default database name within the new global database cluster.
StorageEncrypted (boolean) --
The storage encryption setting for the global database cluster.
DeletionProtection (boolean) --
The deletion protection setting for the new global database cluster.
GlobalClusterMembers (list) --
The list of cluster IDs for secondary clusters within the global database cluster. Currently limited to 1 item.
(dict) --
A data structure with information about any primary and secondary clusters associated with an Aurora global database.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for each Aurora cluster.
Readers (list) --
The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global database.
IsWriter (boolean) --
Specifies whether the Aurora cluster is the primary cluster (that is, has read-write capability) for the Aurora global database with which it is associated.
GlobalWriteForwardingStatus (string) --
Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.
FailoverState (dict) --
A data object containing all properties for the current state of an in-process or pending failover process for this Aurora global database. This object is empty unless the FailoverGlobalCluster API operation has been called on this Aurora global database ( GlobalCluster ).
Status (string) --
The current status of the Aurora global database ( GlobalCluster ). Possible values are as follows:
GlobalCluster 's primary DB cluster and the specified secondary DB cluster are being verified before the failover process can start.FromDbClusterArn (string) --
The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being demoted, and which is associated with this state.
ToDbClusterArn (string) --
The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being promoted, and which is associated with this state.
Exceptions
RDS.Client.exceptions.GlobalClusterNotFoundFaultRDS.Client.exceptions.InvalidGlobalClusterStateFaultRDS.Client.exceptions.DBClusterNotFoundFaultremove_role_from_db_cluster(**kwargs)¶Removes the asssociation of an Amazon Web Services Identity and Access Management (IAM) role from a DB cluster.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide .
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
See also: AWS API Documentation
Request Syntax
response = client.remove_role_from_db_cluster(
DBClusterIdentifier='string',
RoleArn='string',
FeatureName='string'
)
[REQUIRED]
The name of the DB cluster to disassociate the IAM role from.
[REQUIRED]
The Amazon Resource Name (ARN) of the IAM role to disassociate from the Aurora DB cluster, for example arn:aws:iam::123456789012:role/AuroraAccessRole .
None
Exceptions
RDS.Client.exceptions.DBClusterNotFoundFaultRDS.Client.exceptions.DBClusterRoleNotFoundFaultRDS.Client.exceptions.InvalidDBClusterStateFaultremove_role_from_db_instance(**kwargs)¶Disassociates an Amazon Web Services Identity and Access Management (IAM) role from a DB instance.
See also: AWS API Documentation
Request Syntax
response = client.remove_role_from_db_instance(
DBInstanceIdentifier='string',
RoleArn='string',
FeatureName='string'
)
[REQUIRED]
The name of the DB instance to disassociate the IAM role from.
[REQUIRED]
The Amazon Resource Name (ARN) of the IAM role to disassociate from the DB instance, for example, arn:aws:iam::123456789012:role/AccessRole .
[REQUIRED]
The name of the feature for the DB instance that the IAM role is to be disassociated from. For information about supported feature names, see DBEngineVersion .
None
Exceptions
RDS.Client.exceptions.DBInstanceNotFoundFaultRDS.Client.exceptions.DBInstanceRoleNotFoundFaultRDS.Client.exceptions.InvalidDBInstanceStateFaultremove_source_identifier_from_subscription(**kwargs)¶Removes a source identifier from an existing RDS event notification subscription.
See also: AWS API Documentation
Request Syntax
response = client.remove_source_identifier_from_subscription(
SubscriptionName='string',
SourceIdentifier='string'
)
[REQUIRED]
The name of the RDS event notification subscription you want to remove a source identifier from.
[REQUIRED]
The source identifier to be removed from the subscription, such as the DB instance identifier for a DB instance or the name of a security group.
dict
Response Syntax
{
'EventSubscription': {
'CustomerAwsId': 'string',
'CustSubscriptionId': 'string',
'SnsTopicArn': 'string',
'Status': 'string',
'SubscriptionCreationTime': 'string',
'SourceType': 'string',
'SourceIdsList': [
'string',
],
'EventCategoriesList': [
'string',
],
'Enabled': True|False,
'EventSubscriptionArn': 'string'
}
}
Response Structure
(dict) --
EventSubscription (dict) --
Contains the results of a successful invocation of the DescribeEventSubscriptions action.
CustomerAwsId (string) --
The Amazon Web Services customer account associated with the RDS event notification subscription.
CustSubscriptionId (string) --
The RDS event notification subscription Id.
SnsTopicArn (string) --
The topic ARN of the RDS event notification subscription.
Status (string) --
The status of the RDS event notification subscription.
Constraints:
Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist
The status "no-permission" indicates that RDS no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.
SubscriptionCreationTime (string) --
The time the RDS event notification subscription was created.
SourceType (string) --
The source type for the RDS event notification subscription.
SourceIdsList (list) --
A list of source IDs for the RDS event notification subscription.
EventCategoriesList (list) --
A list of event categories for the RDS event notification subscription.
Enabled (boolean) --
A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.
EventSubscriptionArn (string) --
The Amazon Resource Name (ARN) for the event subscription.
Exceptions
RDS.Client.exceptions.SubscriptionNotFoundFaultRDS.Client.exceptions.SourceNotFoundFaultExamples
This example removes the specified source identifier from the specified DB event subscription.
response = client.remove_source_identifier_from_subscription(
SourceIdentifier='mymysqlinstance',
SubscriptionName='myeventsubscription',
)
print(response)
Expected Output:
{
'EventSubscription': {
},
'ResponseMetadata': {
'...': '...',
},
}
Removes metadata tags from an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
See also: AWS API Documentation
Request Syntax
response = client.remove_tags_from_resource(
ResourceName='string',
TagKeys=[
'string',
]
)
[REQUIRED]
The Amazon RDS resource that the tags are removed from. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.
[REQUIRED]
The tag key (name) of the tag to be removed.
None
Exceptions
RDS.Client.exceptions.DBInstanceNotFoundFaultRDS.Client.exceptions.DBSnapshotNotFoundFaultRDS.Client.exceptions.DBClusterNotFoundFaultRDS.Client.exceptions.DBProxyNotFoundFaultRDS.Client.exceptions.DBProxyTargetGroupNotFoundFaultExamples
This example removes the specified tag associated with the specified DB option group.
response = client.remove_tags_from_resource(
ResourceName='arn:aws:rds:us-east-1:992648334831:og:mydboptiongroup',
TagKeys=[
'MyKey',
],
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
reset_db_cluster_parameter_group(**kwargs)¶Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod . To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters.
When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide .
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
See also: AWS API Documentation
Request Syntax
response = client.reset_db_cluster_parameter_group(
DBClusterParameterGroupName='string',
ResetAllParameters=True|False,
Parameters=[
{
'ParameterName': 'string',
'ParameterValue': 'string',
'Description': 'string',
'Source': 'string',
'ApplyType': 'string',
'DataType': 'string',
'AllowedValues': 'string',
'IsModifiable': True|False,
'MinimumEngineVersion': 'string',
'ApplyMethod': 'immediate'|'pending-reboot',
'SupportedEngineModes': [
'string',
]
},
]
)
[REQUIRED]
The name of the DB cluster parameter group to reset.
Parameters parameter.A list of parameter names in the DB cluster parameter group to reset to the default values. You can't use this parameter if the ResetAllParameters parameter is enabled.
This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions.
This data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions.
Specifies the name of the parameter.
Specifies the value of the parameter.
Provides a description of the parameter.
Indicates the source of the parameter value.
Specifies the engine specific parameters type.
Specifies the valid data type for the parameter.
Specifies the valid range of values for the parameter.
Indicates whether (true ) or not (false ) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
The earliest engine version to which the parameter can apply.
Indicates when to apply parameter updates.
The valid DB engine modes.
dict
Response Syntax
{
'DBClusterParameterGroupName': 'string'
}
Response Structure
(dict) --
DBClusterParameterGroupName (string) --
The name of the DB cluster parameter group.
Constraints:
Note
This value is stored as a lowercase string.
Exceptions
RDS.Client.exceptions.InvalidDBParameterGroupStateFaultRDS.Client.exceptions.DBParameterGroupNotFoundFaultExamples
This example resets all parameters for the specified DB cluster parameter group to their default values.
response = client.reset_db_cluster_parameter_group(
DBClusterParameterGroupName='mydbclusterparametergroup',
ResetAllParameters=True,
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
reset_db_parameter_group(**kwargs)¶Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod . To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request.
See also: AWS API Documentation
Request Syntax
response = client.reset_db_parameter_group(
DBParameterGroupName='string',
ResetAllParameters=True|False,
Parameters=[
{
'ParameterName': 'string',
'ParameterValue': 'string',
'Description': 'string',
'Source': 'string',
'ApplyType': 'string',
'DataType': 'string',
'AllowedValues': 'string',
'IsModifiable': True|False,
'MinimumEngineVersion': 'string',
'ApplyMethod': 'immediate'|'pending-reboot',
'SupportedEngineModes': [
'string',
]
},
]
)
[REQUIRED]
The name of the DB parameter group.
Constraints:
DBParameterGroup .To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod . A maximum of 20 parameters can be modified in a single request.
MySQL
Valid Values (for Apply method): immediate | pending-reboot
You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots.
MariaDB
Valid Values (for Apply method): immediate | pending-reboot
You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots.
Oracle
Valid Values (for Apply method): pending-reboot
This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions.
This data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions.
Specifies the name of the parameter.
Specifies the value of the parameter.
Provides a description of the parameter.
Indicates the source of the parameter value.
Specifies the engine specific parameters type.
Specifies the valid data type for the parameter.
Specifies the valid range of values for the parameter.
Indicates whether (true ) or not (false ) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
The earliest engine version to which the parameter can apply.
Indicates when to apply parameter updates.
The valid DB engine modes.
dict
Response Syntax
{
'DBParameterGroupName': 'string'
}
Response Structure
(dict) --
Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup action.
DBParameterGroupName (string) --
The name of the DB parameter group.
Exceptions
RDS.Client.exceptions.InvalidDBParameterGroupStateFaultRDS.Client.exceptions.DBParameterGroupNotFoundFaultExamples
This example resets all parameters for the specified DB parameter group to their default values.
response = client.reset_db_parameter_group(
DBParameterGroupName='mydbparametergroup',
ResetAllParameters=True,
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
restore_db_cluster_from_s3(**kwargs)¶Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket in the Amazon Aurora User Guide .
Note
This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier . You can create DB instances only after the RestoreDBClusterFromS3 action has completed and the DB cluster is available.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide .
Note
This action only applies to Aurora DB clusters. The source DB engine must be MySQL.
See also: AWS API Documentation
Request Syntax
response = client.restore_db_cluster_from_s3(
AvailabilityZones=[
'string',
],
BackupRetentionPeriod=123,
CharacterSetName='string',
DatabaseName='string',
DBClusterIdentifier='string',
DBClusterParameterGroupName='string',
VpcSecurityGroupIds=[
'string',
],
DBSubnetGroupName='string',
Engine='string',
EngineVersion='string',
Port=123,
MasterUsername='string',
MasterUserPassword='string',
OptionGroupName='string',
PreferredBackupWindow='string',
PreferredMaintenanceWindow='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
StorageEncrypted=True|False,
KmsKeyId='string',
EnableIAMDatabaseAuthentication=True|False,
SourceEngine='string',
SourceEngineVersion='string',
S3BucketName='string',
S3Prefix='string',
S3IngestionRoleArn='string',
BacktrackWindow=123,
EnableCloudwatchLogsExports=[
'string',
],
DeletionProtection=True|False,
CopyTagsToSnapshot=True|False,
Domain='string',
DomainIAMRoleName='string',
ServerlessV2ScalingConfiguration={
'MinCapacity': 123.0,
'MaxCapacity': 123.0
}
)
A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
The number of days for which automated backups of the restored DB cluster are retained. You must specify a minimum value of 1.
Default: 1
Constraints:
[REQUIRED]
The name of the DB cluster to create from the source data in the Amazon S3 bucket. This parameter isn't case-sensitive.
Constraints:
Example: my-cluster1
The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is omitted, default.aurora5.6 is used.
Constraints:
A list of EC2 VPC security groups to associate with the restored DB cluster.
A DB subnet group to associate with the restored DB cluster.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
[REQUIRED]
The name of the database engine to be used for this DB cluster.
Valid Values: aurora (for MySQL 5.6-compatible Aurora) and aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
The version number of the database engine to use.
To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:
aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora), use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"Aurora MySQL
Example: 5.6.10a , 5.6.mysql_aurora.1.19.2 , 5.7.mysql_aurora.2.07.1 , 8.0.mysql_aurora.3.02.0
The port number on which the instances in the restored DB cluster accept connections.
Default: 3306
[REQUIRED]
The name of the master user for the restored DB cluster.
Constraints:
[REQUIRED]
The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".
Constraints: Must contain from 8 to 41 characters.
A value that indicates that the restored DB cluster should be associated with the specified option group.
Permanent options can't be removed from an option group. An option group can't be removed from a DB cluster once it is associated with a DB cluster.
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. To view the time blocks available, see Backup window in the Amazon Aurora User Guide .
Constraints:
hh24:mi-hh24:mi .The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide .
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
The Amazon Web Services KMS key identifier for an encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide .
[REQUIRED]
The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.
Valid values: mysql
[REQUIRED]
The version of the database that the backup files were created from.
MySQL versions 5.5, 5.6, and 5.7 are supported.
Example: 5.6.40 , 5.7.28
[REQUIRED]
The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.
[REQUIRED]
The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.
The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Note
Currently, Backtrack is only supported for Aurora MySQL DB clusters.
Default: 0
Constraints:
The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used.
Aurora MySQL
Possible values are audit , error , general , and slowquery .
Aurora PostgreSQL
Possible value is postgresql .
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide .
Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.
For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide .
Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide .
The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.
The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128.
dict
Response Syntax
{
'DBCluster': {
'AllocatedStorage': 123,
'AvailabilityZones': [
'string',
],
'BackupRetentionPeriod': 123,
'CharacterSetName': 'string',
'DatabaseName': 'string',
'DBClusterIdentifier': 'string',
'DBClusterParameterGroup': 'string',
'DBSubnetGroup': 'string',
'Status': 'string',
'AutomaticRestartTime': datetime(2015, 1, 1),
'PercentProgress': 'string',
'EarliestRestorableTime': datetime(2015, 1, 1),
'Endpoint': 'string',
'ReaderEndpoint': 'string',
'CustomEndpoints': [
'string',
],
'MultiAZ': True|False,
'Engine': 'string',
'EngineVersion': 'string',
'LatestRestorableTime': datetime(2015, 1, 1),
'Port': 123,
'MasterUsername': 'string',
'DBClusterOptionGroupMemberships': [
{
'DBClusterOptionGroupName': 'string',
'Status': 'string'
},
],
'PreferredBackupWindow': 'string',
'PreferredMaintenanceWindow': 'string',
'ReplicationSourceIdentifier': 'string',
'ReadReplicaIdentifiers': [
'string',
],
'DBClusterMembers': [
{
'DBInstanceIdentifier': 'string',
'IsClusterWriter': True|False,
'DBClusterParameterGroupStatus': 'string',
'PromotionTier': 123
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'HostedZoneId': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbClusterResourceId': 'string',
'DBClusterArn': 'string',
'AssociatedRoles': [
{
'RoleArn': 'string',
'Status': 'string',
'FeatureName': 'string'
},
],
'IAMDatabaseAuthenticationEnabled': True|False,
'CloneGroupId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'EarliestBacktrackTime': datetime(2015, 1, 1),
'BacktrackWindow': 123,
'BacktrackConsumedChangeRecords': 123,
'EnabledCloudwatchLogsExports': [
'string',
],
'Capacity': 123,
'EngineMode': 'string',
'ScalingConfigurationInfo': {
'MinCapacity': 123,
'MaxCapacity': 123,
'AutoPause': True|False,
'SecondsUntilAutoPause': 123,
'TimeoutAction': 'string',
'SecondsBeforeTimeout': 123
},
'DeletionProtection': True|False,
'HttpEndpointEnabled': True|False,
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'CopyTagsToSnapshot': True|False,
'CrossAccountClone': True|False,
'DomainMemberships': [
{
'Domain': 'string',
'Status': 'string',
'FQDN': 'string',
'IAMRoleName': 'string'
},
],
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'GlobalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'unknown',
'GlobalWriteForwardingRequested': True|False,
'PendingModifiedValues': {
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
},
'DBClusterIdentifier': 'string',
'MasterUserPassword': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'EngineVersion': 'string'
},
'DBClusterInstanceClass': 'string',
'StorageType': 'string',
'Iops': 123,
'PubliclyAccessible': True|False,
'AutoMinorVersionUpgrade': True|False,
'MonitoringInterval': 123,
'MonitoringRoleArn': 'string',
'PerformanceInsightsEnabled': True|False,
'PerformanceInsightsKMSKeyId': 'string',
'PerformanceInsightsRetentionPeriod': 123,
'ServerlessV2ScalingConfiguration': {
'MinCapacity': 123.0,
'MaxCapacity': 123.0
}
}
}
Response Structure
(dict) --
DBCluster (dict) --
Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
For an Amazon Aurora DB cluster, this data type is used as a response element in the operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , FailoverDBCluster , ModifyDBCluster , PromoteReadReplicaDBCluster , RestoreDBClusterFromS3 , RestoreDBClusterFromSnapshot , RestoreDBClusterToPointInTime , StartDBCluster , and StopDBCluster .
For a Multi-AZ DB cluster, this data type is used as a response element in the operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , FailoverDBCluster , ModifyDBCluster , RebootDBCluster , RestoreDBClusterFromSnapshot , and RestoreDBClusterToPointInTime .
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
AllocatedStorage (integer) --
For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
AvailabilityZones (list) --
Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.
BackupRetentionPeriod (integer) --
Specifies the number of days for which automatic DB snapshots are retained.
CharacterSetName (string) --
If present, specifies the name of the character set that this cluster is associated with.
DatabaseName (string) --
Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.
DBClusterIdentifier (string) --
Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
DBClusterParameterGroup (string) --
Specifies the name of the DB cluster parameter group for the DB cluster.
DBSubnetGroup (string) --
Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
Status (string) --
Specifies the current state of this DB cluster.
AutomaticRestartTime (datetime) --
The time when a stopped DB cluster is restarted automatically.
PercentProgress (string) --
Specifies the progress of the operation as a percentage.
EarliestRestorableTime (datetime) --
The earliest time to which a database can be restored with point-in-time restore.
Endpoint (string) --
Specifies the connection endpoint for the primary instance of the DB cluster.
ReaderEndpoint (string) --
The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.
If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
CustomEndpoints (list) --
Identifies all custom endpoints associated with the cluster.
MultiAZ (boolean) --
Specifies whether the DB cluster has instances in multiple Availability Zones.
Engine (string) --
The name of the database engine to be used for this DB cluster.
EngineVersion (string) --
Indicates the database engine version.
LatestRestorableTime (datetime) --
Specifies the latest time to which a database can be restored with point-in-time restore.
Port (integer) --
Specifies the port that the database engine is listening on.
MasterUsername (string) --
Contains the master username for the DB cluster.
DBClusterOptionGroupMemberships (list) --
Provides the list of option group memberships for this DB cluster.
(dict) --
Contains status information for a DB cluster option group.
DBClusterOptionGroupName (string) --
Specifies the name of the DB cluster option group.
Status (string) --
Specifies the status of the DB cluster option group.
PreferredBackupWindow (string) --
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
ReplicationSourceIdentifier (string) --
Contains the identifier of the source DB cluster if this DB cluster is a read replica.
ReadReplicaIdentifiers (list) --
Contains one or more identifiers of the read replicas associated with this DB cluster.
DBClusterMembers (list) --
Provides the list of instances that make up the DB cluster.
(dict) --
Contains information about an instance that is part of a DB cluster.
DBInstanceIdentifier (string) --
Specifies the instance identifier for this member of the DB cluster.
IsClusterWriter (boolean) --
Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
DBClusterParameterGroupStatus (string) --
Specifies the status of the DB cluster parameter group for this member of the DB cluster.
PromotionTier (integer) --
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .
VpcSecurityGroups (list) --
Provides a list of VPC security groups that the DB cluster belongs to.
(dict) --
This data type is used as a response element for queries on VPC security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The membership status of the VPC security group.
Currently, the only valid status is active .
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
StorageEncrypted (boolean) --
Specifies whether the DB cluster is encrypted.
KmsKeyId (string) --
If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
DbClusterResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for the DB cluster.
AssociatedRoles (list) --
Provides a list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.
(dict) --
Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB cluster.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
Status (string) --
Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other Amazon Web Services on your behalf.PENDING - the IAM role ARN is being associated with the DB cluster.INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other Amazon Web Services on your behalf.FeatureName (string) --
The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion .
IAMDatabaseAuthenticationEnabled (boolean) --
A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
CloneGroupId (string) --
Identifies the clone group to which the DB cluster is associated.
ClusterCreateTime (datetime) --
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
EarliestBacktrackTime (datetime) --
The earliest time to which a DB cluster can be backtracked.
BacktrackWindow (integer) --
The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.
BacktrackConsumedChangeRecords (integer) --
The number of change records stored for Backtrack.
EnabledCloudwatchLogsExports (list) --
A list of log types that this DB cluster is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.
Capacity (integer) --
The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 (zero) when the cluster is paused.
For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide .
EngineMode (string) --
The DB engine mode of the DB cluster, either provisioned , serverless , parallelquery , global , or multimaster .
For more information, see CreateDBCluster .
ScalingConfigurationInfo (dict) --
Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.
For more information, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide .
MinCapacity (integer) --
The minimum capacity for an Aurora DB cluster in serverless DB engine mode.
MaxCapacity (integer) --
The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
AutoPause (boolean) --
A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.
When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.
SecondsUntilAutoPause (integer) --
The remaining amount of time, in seconds, before the Aurora DB cluster in serverless mode is paused. A DB cluster can be paused only when it's idle (it has no connections).
TimeoutAction (string) --
The action that occurs when Aurora times out while attempting to change the capacity of an Aurora Serverless v1 cluster. The value is either ForceApplyCapacityChange or RollbackCapacityChange .
ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.
RollbackCapacityChangeignores the capacity change if a scaling point isn't found in the timeout period.
SecondsBeforeTimeout (integer) --
The number of seconds before scaling times out. What happens when an attempted scaling action times out is determined by the TimeoutAction setting.
DeletionProtection (boolean) --
Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
HttpEndpointEnabled (boolean) --
A value that indicates whether the HTTP endpoint for an Aurora Serverless v1 DB cluster is enabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide .
ActivityStreamMode (string) --
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.
ActivityStreamStatus (string) --
The status of the database activity stream.
ActivityStreamKmsKeyId (string) --
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
ActivityStreamKinesisStreamName (string) --
The name of the Amazon Kinesis data stream used for the database activity stream.
CopyTagsToSnapshot (boolean) --
Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.
CrossAccountClone (boolean) --
Specifies whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
DomainMemberships (list) --
The Active Directory Domain membership records associated with the DB cluster.
(dict) --
An Active Directory Domain membership record associated with the DB instance or cluster.
Domain (string) --
The identifier of the Active Directory Domain.
Status (string) --
The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.
FQDN (string) --
The fully qualified domain name of the Active Directory Domain.
IAMRoleName (string) --
The name of the IAM role to be used when making API calls to the Directory Service.
TagList (list) --
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
GlobalWriteForwardingStatus (string) --
Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.
GlobalWriteForwardingRequested (boolean) --
Specifies whether you have requested to enable write forwarding for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.
PendingModifiedValues (dict) --
A value that specifies that changes to the DB cluster are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
PendingCloudwatchLogsExports (dict) --
A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.
LogTypesToEnable (list) --
Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.
LogTypesToDisable (list) --
Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.
DBClusterIdentifier (string) --
The DBClusterIdentifier value for the DB cluster.
MasterUserPassword (string) --
The master credentials for the DB cluster.
IAMDatabaseAuthenticationEnabled (boolean) --
A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
EngineVersion (string) --
The database engine version.
DBClusterInstanceClass (string) --
The name of the compute and memory capacity class of the DB instance.
This setting is only for non-Aurora Multi-AZ DB clusters.
StorageType (string) --
The storage type associated with the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
Iops (integer) --
The Provisioned IOPS (I/O operations per second) value.
This setting is only for non-Aurora Multi-AZ DB clusters.
PubliclyAccessible (boolean) --
Specifies the accessibility options for the DB instance.
When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance .
This setting is only for non-Aurora Multi-AZ DB clusters.
AutoMinorVersionUpgrade (boolean) --
A value that indicates that minor version patches are applied automatically.
This setting is only for non-Aurora Multi-AZ DB clusters.
MonitoringInterval (integer) --
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
MonitoringRoleArn (string) --
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
This setting is only for non-Aurora Multi-AZ DB clusters.
PerformanceInsightsEnabled (boolean) --
True if Performance Insights is enabled for the DB cluster, and otherwise false.
This setting is only for non-Aurora Multi-AZ DB clusters.
PerformanceInsightsKMSKeyId (string) --
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
This setting is only for non-Aurora Multi-AZ DB clusters.
PerformanceInsightsRetentionPeriod (integer) --
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
For example, the following values are valid:
This setting is only for non-Aurora Multi-AZ DB clusters.
ServerlessV2ScalingConfiguration (dict) --
Shows the scaling configuration for an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide .
MinCapacity (float) --
The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.
MaxCapacity (float) --
The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128.
Exceptions
RDS.Client.exceptions.DBClusterAlreadyExistsFaultRDS.Client.exceptions.DBClusterQuotaExceededFaultRDS.Client.exceptions.StorageQuotaExceededFaultRDS.Client.exceptions.DBSubnetGroupNotFoundFaultRDS.Client.exceptions.InvalidVPCNetworkStateFaultRDS.Client.exceptions.InvalidDBClusterStateFaultRDS.Client.exceptions.InvalidDBSubnetGroupStateFaultRDS.Client.exceptions.InvalidSubnetRDS.Client.exceptions.InvalidS3BucketFaultRDS.Client.exceptions.DBClusterParameterGroupNotFoundFaultRDS.Client.exceptions.KMSKeyNotAccessibleFaultRDS.Client.exceptions.DBClusterNotFoundFaultRDS.Client.exceptions.DomainNotFoundFaultRDS.Client.exceptions.InsufficientStorageClusterCapacityFaultrestore_db_cluster_from_snapshot(**kwargs)¶Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
The target DB cluster is created from the source snapshot with a default configuration. If you don't specify a security group, the new DB cluster is associated with the default security group.
Note
This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier . You can create DB instances only after the RestoreDBClusterFromSnapshot action has completed and the DB cluster is available.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide .
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
See also: AWS API Documentation
Request Syntax
response = client.restore_db_cluster_from_snapshot(
AvailabilityZones=[
'string',
],
DBClusterIdentifier='string',
SnapshotIdentifier='string',
Engine='string',
EngineVersion='string',
Port=123,
DBSubnetGroupName='string',
DatabaseName='string',
OptionGroupName='string',
VpcSecurityGroupIds=[
'string',
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
KmsKeyId='string',
EnableIAMDatabaseAuthentication=True|False,
BacktrackWindow=123,
EnableCloudwatchLogsExports=[
'string',
],
EngineMode='string',
ScalingConfiguration={
'MinCapacity': 123,
'MaxCapacity': 123,
'AutoPause': True|False,
'SecondsUntilAutoPause': 123,
'TimeoutAction': 'string',
'SecondsBeforeTimeout': 123
},
DBClusterParameterGroupName='string',
DeletionProtection=True|False,
CopyTagsToSnapshot=True|False,
Domain='string',
DomainIAMRoleName='string',
DBClusterInstanceClass='string',
StorageType='string',
Iops=123,
PubliclyAccessible=True|False,
ServerlessV2ScalingConfiguration={
'MinCapacity': 123.0,
'MaxCapacity': 123.0
}
)
Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
Valid for: Aurora DB clusters only
[REQUIRED]
The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't case-sensitive.
Constraints:
Example: my-snapshot-id
Valid for: Aurora DB clusters and Multi-AZ DB clusters
[REQUIRED]
The identifier for the DB snapshot or DB cluster snapshot to restore from.
You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.
Constraints:
Valid for: Aurora DB clusters and Multi-AZ DB clusters
[REQUIRED]
The database engine to use for the new DB cluster.
Default: The same as source
Constraint: Must be compatible with the engine of the source
Valid for: Aurora DB clusters and Multi-AZ DB clusters
The version of the database engine to use for the new DB cluster.
To list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command:
aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora, use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for Aurora PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for MySQL, use the following command:
aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"Aurora MySQL
See MySQL on Amazon RDS Versions in the Amazon Aurora User Guide .
Aurora PostgreSQL
See Amazon Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide .
MySQL
See MySQL on Amazon RDS Versions in the Amazon RDS User Guide.
PostgreSQL
See Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
The port number on which the new DB cluster accepts connections.
Constraints: This value must be 1150-65535
Default: The same port as the original DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
The name of the DB subnet group to use for the new DB cluster.
Constraints: If supplied, must match the name of an existing DB subnet group.
Example: mydbsubnetgroup
Valid for: Aurora DB clusters and Multi-AZ DB clusters
The database name for the restored DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
The name of the option group to use for the restored DB cluster.
DB clusters are associated with a default option group that can't be modified.
A list of VPC security groups that the new DB cluster will belong to.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
The tags to be assigned to the restored DB cluster.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
When you don't specify a value for the KmsKeyId parameter, then the following occurs:
SnapshotIdentifier is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot.SnapshotIdentifier isn't encrypted, then the restored DB cluster isn't encrypted.Valid for: Aurora DB clusters and Multi-AZ DB clusters
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide .
Valid for: Aurora DB clusters only
The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Note
Currently, Backtrack is only supported for Aurora MySQL DB clusters.
Default: 0
Constraints:
Valid for: Aurora DB clusters only
The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the list depend on the DB engine being used.
RDS for MySQL
Possible values are error , general , and slowquery .
RDS for PostgreSQL
Possible values are postgresql and upgrade .
Aurora MySQL
Possible values are audit , error , general , and slowquery .
Aurora PostgreSQL
Possible value is postgresql .
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide .
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide .
Valid for: Aurora DB clusters and Multi-AZ DB clusters
The DB engine mode of the DB cluster, either provisioned , serverless , parallelquery , global , or multimaster .
For more information, see CreateDBCluster .
Valid for: Aurora DB clusters only
For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
Valid for: Aurora DB clusters only
The minimum capacity for an Aurora DB cluster in serverless DB engine mode.
For Aurora MySQL, valid capacity values are 1 , 2 , 4 , 8 , 16 , 32 , 64 , 128 , and 256 .
For Aurora PostgreSQL, valid capacity values are 2 , 4 , 8 , 16 , 32 , 64 , 192 , and 384 .
The minimum capacity must be less than or equal to the maximum capacity.
The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
For Aurora MySQL, valid capacity values are 1 , 2 , 4 , 8 , 16 , 32 , 64 , 128 , and 256 .
For Aurora PostgreSQL, valid capacity values are 2 , 4 , 8 , 16 , 32 , 64 , 192 , and 384 .
The maximum capacity must be greater than or equal to the minimum capacity.
A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections).
Note
If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.
The time, in seconds, before an Aurora DB cluster in serverless mode is paused.
Specify a value between 300 and 86,400 seconds.
The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange .
ForceApplyCapacityChangesets the capacity to the specified value as soon as possible.
RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period.
Warning
If you specify ForceApplyCapacityChange , connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped.
For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide .
The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.
Specify a value between 60 and 600 seconds.
The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.
Constraints:
Valid for: Aurora DB clusters and Multi-AZ DB clusters
A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide .
Valid for: Aurora DB clusters only
Specify the name of the IAM role to be used when making API calls to the Directory Service.
Valid for: Aurora DB clusters only
The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Valid for: Multi-AZ DB clusters only
Specifies the storage type to be associated with the each DB instance in the Multi-AZ DB cluster.
Valid values: io1
When specified, a value for the Iops parameter is required.
Default: io1
Valid for: Aurora DB clusters and Multi-AZ DB clusters
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
For information about valid Iops values, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide .
Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
A value that indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
Valid for: Aurora DB clusters and Multi-AZ DB clusters
Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide .
The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.
The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128.
dict
Response Syntax
{
'DBCluster': {
'AllocatedStorage': 123,
'AvailabilityZones': [
'string',
],
'BackupRetentionPeriod': 123,
'CharacterSetName': 'string',
'DatabaseName': 'string',
'DBClusterIdentifier': 'string',
'DBClusterParameterGroup': 'string',
'DBSubnetGroup': 'string',
'Status': 'string',
'AutomaticRestartTime': datetime(2015, 1, 1),
'PercentProgress': 'string',
'EarliestRestorableTime': datetime(2015, 1, 1),
'Endpoint': 'string',
'ReaderEndpoint': 'string',
'CustomEndpoints': [
'string',
],
'MultiAZ': True|False,
'Engine': 'string',
'EngineVersion': 'string',
'LatestRestorableTime': datetime(2015, 1, 1),
'Port': 123,
'MasterUsername': 'string',
'DBClusterOptionGroupMemberships': [
{
'DBClusterOptionGroupName': 'string',
'Status': 'string'
},
],
'PreferredBackupWindow': 'string',
'PreferredMaintenanceWindow': 'string',
'ReplicationSourceIdentifier': 'string',
'ReadReplicaIdentifiers': [
'string',
],
'DBClusterMembers': [
{
'DBInstanceIdentifier': 'string',
'IsClusterWriter': True|False,
'DBClusterParameterGroupStatus': 'string',
'PromotionTier': 123
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'HostedZoneId': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbClusterResourceId': 'string',
'DBClusterArn': 'string',
'AssociatedRoles': [
{
'RoleArn': 'string',
'Status': 'string',
'FeatureName': 'string'
},
],
'IAMDatabaseAuthenticationEnabled': True|False,
'CloneGroupId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'EarliestBacktrackTime': datetime(2015, 1, 1),
'BacktrackWindow': 123,
'BacktrackConsumedChangeRecords': 123,
'EnabledCloudwatchLogsExports': [
'string',
],
'Capacity': 123,
'EngineMode': 'string',
'ScalingConfigurationInfo': {
'MinCapacity': 123,
'MaxCapacity': 123,
'AutoPause': True|False,
'SecondsUntilAutoPause': 123,
'TimeoutAction': 'string',
'SecondsBeforeTimeout': 123
},
'DeletionProtection': True|False,
'HttpEndpointEnabled': True|False,
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'CopyTagsToSnapshot': True|False,
'CrossAccountClone': True|False,
'DomainMemberships': [
{
'Domain': 'string',
'Status': 'string',
'FQDN': 'string',
'IAMRoleName': 'string'
},
],
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'GlobalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'unknown',
'GlobalWriteForwardingRequested': True|False,
'PendingModifiedValues': {
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
},
'DBClusterIdentifier': 'string',
'MasterUserPassword': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'EngineVersion': 'string'
},
'DBClusterInstanceClass': 'string',
'StorageType': 'string',
'Iops': 123,
'PubliclyAccessible': True|False,
'AutoMinorVersionUpgrade': True|False,
'MonitoringInterval': 123,
'MonitoringRoleArn': 'string',
'PerformanceInsightsEnabled': True|False,
'PerformanceInsightsKMSKeyId': 'string',
'PerformanceInsightsRetentionPeriod': 123,
'ServerlessV2ScalingConfiguration': {
'MinCapacity': 123.0,
'MaxCapacity': 123.0
}
}
}
Response Structure
(dict) --
DBCluster (dict) --
Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
For an Amazon Aurora DB cluster, this data type is used as a response element in the operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , FailoverDBCluster , ModifyDBCluster , PromoteReadReplicaDBCluster , RestoreDBClusterFromS3 , RestoreDBClusterFromSnapshot , RestoreDBClusterToPointInTime , StartDBCluster , and StopDBCluster .
For a Multi-AZ DB cluster, this data type is used as a response element in the operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , FailoverDBCluster , ModifyDBCluster , RebootDBCluster , RestoreDBClusterFromSnapshot , and RestoreDBClusterToPointInTime .
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
AllocatedStorage (integer) --
For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
AvailabilityZones (list) --
Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.
BackupRetentionPeriod (integer) --
Specifies the number of days for which automatic DB snapshots are retained.
CharacterSetName (string) --
If present, specifies the name of the character set that this cluster is associated with.
DatabaseName (string) --
Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.
DBClusterIdentifier (string) --
Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
DBClusterParameterGroup (string) --
Specifies the name of the DB cluster parameter group for the DB cluster.
DBSubnetGroup (string) --
Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
Status (string) --
Specifies the current state of this DB cluster.
AutomaticRestartTime (datetime) --
The time when a stopped DB cluster is restarted automatically.
PercentProgress (string) --
Specifies the progress of the operation as a percentage.
EarliestRestorableTime (datetime) --
The earliest time to which a database can be restored with point-in-time restore.
Endpoint (string) --
Specifies the connection endpoint for the primary instance of the DB cluster.
ReaderEndpoint (string) --
The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.
If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
CustomEndpoints (list) --
Identifies all custom endpoints associated with the cluster.
MultiAZ (boolean) --
Specifies whether the DB cluster has instances in multiple Availability Zones.
Engine (string) --
The name of the database engine to be used for this DB cluster.
EngineVersion (string) --
Indicates the database engine version.
LatestRestorableTime (datetime) --
Specifies the latest time to which a database can be restored with point-in-time restore.
Port (integer) --
Specifies the port that the database engine is listening on.
MasterUsername (string) --
Contains the master username for the DB cluster.
DBClusterOptionGroupMemberships (list) --
Provides the list of option group memberships for this DB cluster.
(dict) --
Contains status information for a DB cluster option group.
DBClusterOptionGroupName (string) --
Specifies the name of the DB cluster option group.
Status (string) --
Specifies the status of the DB cluster option group.
PreferredBackupWindow (string) --
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
ReplicationSourceIdentifier (string) --
Contains the identifier of the source DB cluster if this DB cluster is a read replica.
ReadReplicaIdentifiers (list) --
Contains one or more identifiers of the read replicas associated with this DB cluster.
DBClusterMembers (list) --
Provides the list of instances that make up the DB cluster.
(dict) --
Contains information about an instance that is part of a DB cluster.
DBInstanceIdentifier (string) --
Specifies the instance identifier for this member of the DB cluster.
IsClusterWriter (boolean) --
Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
DBClusterParameterGroupStatus (string) --
Specifies the status of the DB cluster parameter group for this member of the DB cluster.
PromotionTier (integer) --
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .
VpcSecurityGroups (list) --
Provides a list of VPC security groups that the DB cluster belongs to.
(dict) --
This data type is used as a response element for queries on VPC security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The membership status of the VPC security group.
Currently, the only valid status is active .
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
StorageEncrypted (boolean) --
Specifies whether the DB cluster is encrypted.
KmsKeyId (string) --
If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
DbClusterResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for the DB cluster.
AssociatedRoles (list) --
Provides a list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.
(dict) --
Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB cluster.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
Status (string) --
Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other Amazon Web Services on your behalf.PENDING - the IAM role ARN is being associated with the DB cluster.INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other Amazon Web Services on your behalf.FeatureName (string) --
The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion .
IAMDatabaseAuthenticationEnabled (boolean) --
A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
CloneGroupId (string) --
Identifies the clone group to which the DB cluster is associated.
ClusterCreateTime (datetime) --
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
EarliestBacktrackTime (datetime) --
The earliest time to which a DB cluster can be backtracked.
BacktrackWindow (integer) --
The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.
BacktrackConsumedChangeRecords (integer) --
The number of change records stored for Backtrack.
EnabledCloudwatchLogsExports (list) --
A list of log types that this DB cluster is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.
Capacity (integer) --
The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 (zero) when the cluster is paused.
For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide .
EngineMode (string) --
The DB engine mode of the DB cluster, either provisioned , serverless , parallelquery , global , or multimaster .
For more information, see CreateDBCluster .
ScalingConfigurationInfo (dict) --
Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.
For more information, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide .
MinCapacity (integer) --
The minimum capacity for an Aurora DB cluster in serverless DB engine mode.
MaxCapacity (integer) --
The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
AutoPause (boolean) --
A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.
When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.
SecondsUntilAutoPause (integer) --
The remaining amount of time, in seconds, before the Aurora DB cluster in serverless mode is paused. A DB cluster can be paused only when it's idle (it has no connections).
TimeoutAction (string) --
The action that occurs when Aurora times out while attempting to change the capacity of an Aurora Serverless v1 cluster. The value is either ForceApplyCapacityChange or RollbackCapacityChange .
ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.
RollbackCapacityChangeignores the capacity change if a scaling point isn't found in the timeout period.
SecondsBeforeTimeout (integer) --
The number of seconds before scaling times out. What happens when an attempted scaling action times out is determined by the TimeoutAction setting.
DeletionProtection (boolean) --
Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
HttpEndpointEnabled (boolean) --
A value that indicates whether the HTTP endpoint for an Aurora Serverless v1 DB cluster is enabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide .
ActivityStreamMode (string) --
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.
ActivityStreamStatus (string) --
The status of the database activity stream.
ActivityStreamKmsKeyId (string) --
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
ActivityStreamKinesisStreamName (string) --
The name of the Amazon Kinesis data stream used for the database activity stream.
CopyTagsToSnapshot (boolean) --
Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.
CrossAccountClone (boolean) --
Specifies whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
DomainMemberships (list) --
The Active Directory Domain membership records associated with the DB cluster.
(dict) --
An Active Directory Domain membership record associated with the DB instance or cluster.
Domain (string) --
The identifier of the Active Directory Domain.
Status (string) --
The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.
FQDN (string) --
The fully qualified domain name of the Active Directory Domain.
IAMRoleName (string) --
The name of the IAM role to be used when making API calls to the Directory Service.
TagList (list) --
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
GlobalWriteForwardingStatus (string) --
Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.
GlobalWriteForwardingRequested (boolean) --
Specifies whether you have requested to enable write forwarding for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.
PendingModifiedValues (dict) --
A value that specifies that changes to the DB cluster are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
PendingCloudwatchLogsExports (dict) --
A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.
LogTypesToEnable (list) --
Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.
LogTypesToDisable (list) --
Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.
DBClusterIdentifier (string) --
The DBClusterIdentifier value for the DB cluster.
MasterUserPassword (string) --
The master credentials for the DB cluster.
IAMDatabaseAuthenticationEnabled (boolean) --
A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
EngineVersion (string) --
The database engine version.
DBClusterInstanceClass (string) --
The name of the compute and memory capacity class of the DB instance.
This setting is only for non-Aurora Multi-AZ DB clusters.
StorageType (string) --
The storage type associated with the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
Iops (integer) --
The Provisioned IOPS (I/O operations per second) value.
This setting is only for non-Aurora Multi-AZ DB clusters.
PubliclyAccessible (boolean) --
Specifies the accessibility options for the DB instance.
When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance .
This setting is only for non-Aurora Multi-AZ DB clusters.
AutoMinorVersionUpgrade (boolean) --
A value that indicates that minor version patches are applied automatically.
This setting is only for non-Aurora Multi-AZ DB clusters.
MonitoringInterval (integer) --
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
MonitoringRoleArn (string) --
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
This setting is only for non-Aurora Multi-AZ DB clusters.
PerformanceInsightsEnabled (boolean) --
True if Performance Insights is enabled for the DB cluster, and otherwise false.
This setting is only for non-Aurora Multi-AZ DB clusters.
PerformanceInsightsKMSKeyId (string) --
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
This setting is only for non-Aurora Multi-AZ DB clusters.
PerformanceInsightsRetentionPeriod (integer) --
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
For example, the following values are valid:
This setting is only for non-Aurora Multi-AZ DB clusters.
ServerlessV2ScalingConfiguration (dict) --
Shows the scaling configuration for an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide .
MinCapacity (float) --
The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.
MaxCapacity (float) --
The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128.
Exceptions
RDS.Client.exceptions.DBClusterAlreadyExistsFaultRDS.Client.exceptions.DBClusterQuotaExceededFaultRDS.Client.exceptions.StorageQuotaExceededFaultRDS.Client.exceptions.DBSubnetGroupNotFoundFaultRDS.Client.exceptions.DBSnapshotNotFoundFaultRDS.Client.exceptions.DBClusterSnapshotNotFoundFaultRDS.Client.exceptions.InsufficientDBClusterCapacityFaultRDS.Client.exceptions.InsufficientStorageClusterCapacityFaultRDS.Client.exceptions.InvalidDBSnapshotStateFaultRDS.Client.exceptions.InvalidDBClusterSnapshotStateFaultRDS.Client.exceptions.StorageQuotaExceededFaultRDS.Client.exceptions.InvalidVPCNetworkStateFaultRDS.Client.exceptions.InvalidRestoreFaultRDS.Client.exceptions.DBSubnetGroupNotFoundFaultRDS.Client.exceptions.InvalidSubnetRDS.Client.exceptions.OptionGroupNotFoundFaultRDS.Client.exceptions.KMSKeyNotAccessibleFaultRDS.Client.exceptions.DomainNotFoundFaultRDS.Client.exceptions.DBClusterParameterGroupNotFoundFaultExamples
The following example restores an Amazon Aurora DB cluster from a DB cluster snapshot.
response = client.restore_db_cluster_from_snapshot(
DBClusterIdentifier='restored-cluster1',
Engine='aurora',
SnapshotIdentifier='sample-cluster-snapshot1',
)
print(response)
Expected Output:
{
'DBCluster': {
},
'ResponseMetadata': {
'...': '...',
},
}
restore_db_cluster_to_point_in_time(**kwargs)¶Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group.
Note
For Aurora, this action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier . You can create DB instances only after the RestoreDBClusterToPointInTime action has completed and the DB cluster is available.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide .
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
See also: AWS API Documentation
Request Syntax
response = client.restore_db_cluster_to_point_in_time(
DBClusterIdentifier='string',
RestoreType='string',
SourceDBClusterIdentifier='string',
RestoreToTime=datetime(2015, 1, 1),
UseLatestRestorableTime=True|False,
Port=123,
DBSubnetGroupName='string',
OptionGroupName='string',
VpcSecurityGroupIds=[
'string',
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
KmsKeyId='string',
EnableIAMDatabaseAuthentication=True|False,
BacktrackWindow=123,
EnableCloudwatchLogsExports=[
'string',
],
DBClusterParameterGroupName='string',
DeletionProtection=True|False,
CopyTagsToSnapshot=True|False,
Domain='string',
DomainIAMRoleName='string',
ScalingConfiguration={
'MinCapacity': 123,
'MaxCapacity': 123,
'AutoPause': True|False,
'SecondsUntilAutoPause': 123,
'TimeoutAction': 'string',
'SecondsBeforeTimeout': 123
},
EngineMode='string',
DBClusterInstanceClass='string',
StorageType='string',
PubliclyAccessible=True|False,
Iops=123,
ServerlessV2ScalingConfiguration={
'MinCapacity': 123.0,
'MaxCapacity': 123.0
}
)
[REQUIRED]
The name of the new DB cluster to be created.
Constraints:
Valid for: Aurora DB clusters and Multi-AZ DB clusters
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.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
[REQUIRED]
The identifier of the source DB cluster from which to restore.
Constraints:
Valid for: Aurora DB clusters and Multi-AZ DB clusters
The date and time to restore the DB cluster to.
Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
Constraints:
UseLatestRestorableTime parameter isn't providedUseLatestRestorableTime parameter is enabledRestoreType parameter is copy-on-writeExample: 2015-03-07T23:45:00Z
Valid for: Aurora DB clusters and Multi-AZ DB clusters
A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster isn't restored to the latest restorable backup time.
Constraints: Can't be specified if RestoreToTime parameter is provided.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
The port number on which the new DB cluster accepts connections.
Constraints: A value from 1150-65535 .
Default: The default port for the engine.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
The DB subnet group name to use for the new DB cluster.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
Valid for: Aurora DB clusters and Multi-AZ DB clusters
The name of the option group for the new DB cluster.
DB clusters are associated with a default option group that can't be modified.
A list of VPC security groups that the new DB cluster belongs to.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different from the KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key identified by the KmsKeyId parameter.
If you don't specify a value for the KmsKeyId parameter, then the following occurs:
If DBClusterIdentifier refers to a DB cluster that isn't encrypted, then the restore request is rejected.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide .
Valid for: Aurora DB clusters only
The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Default: 0
Constraints:
Valid for: Aurora MySQL DB clusters only
The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used.
RDS for MySQL
Possible values are error , general , and slowquery .
RDS for PostgreSQL
Possible values are postgresql and upgrade .
Aurora MySQL
Possible values are audit , error , general , and slowquery .
Aurora PostgreSQL
Possible value is postgresql .
For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide .
For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide .
Valid for: Aurora DB clusters and Multi-AZ DB clusters
The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.
Constraints:
Valid for: Aurora DB clusters and Multi-AZ DB clusters
A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
Valid for: Aurora DB clusters and Multi-AZ DB clusters
Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.
For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the Amazon Aurora User Guide .
Valid for: Aurora DB clusters only
Specify the name of the IAM role to be used when making API calls to the Directory Service.
Valid for: Aurora DB clusters only
For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
Valid for: Aurora DB clusters only
The minimum capacity for an Aurora DB cluster in serverless DB engine mode.
For Aurora MySQL, valid capacity values are 1 , 2 , 4 , 8 , 16 , 32 , 64 , 128 , and 256 .
For Aurora PostgreSQL, valid capacity values are 2 , 4 , 8 , 16 , 32 , 64 , 192 , and 384 .
The minimum capacity must be less than or equal to the maximum capacity.
The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
For Aurora MySQL, valid capacity values are 1 , 2 , 4 , 8 , 16 , 32 , 64 , 128 , and 256 .
For Aurora PostgreSQL, valid capacity values are 2 , 4 , 8 , 16 , 32 , 64 , 192 , and 384 .
The maximum capacity must be greater than or equal to the minimum capacity.
A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections).
Note
If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.
The time, in seconds, before an Aurora DB cluster in serverless mode is paused.
Specify a value between 300 and 86,400 seconds.
The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange .
ForceApplyCapacityChangesets the capacity to the specified value as soon as possible.
RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period.
Warning
If you specify ForceApplyCapacityChange , connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped.
For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide .
The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.
Specify a value between 60 and 600 seconds.
The engine mode of the new cluster. Specify provisioned or serverless , depending on the type of the cluster you are creating. You can create an Aurora Serverless v1 clone from a provisioned cluster, or a provisioned clone from an Aurora Serverless v1 cluster. To create a clone that is an Aurora Serverless v1 cluster, the original cluster must be an Aurora Serverless v1 cluster or an encrypted provisioned cluster.
Valid for: Aurora DB clusters only
The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.
For the full list of DB instance classes, and availability for your engine, see DB instance class in the Amazon RDS User Guide.
Valid for: Multi-AZ DB clusters only
Specifies the storage type to be associated with the each DB instance in the Multi-AZ DB cluster.
Valid values: io1
When specified, a value for the Iops parameter is required.
Default: io1
Valid for: Multi-AZ DB clusters only
A value that indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether DBSubnetGroupName is specified.
If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:
If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:
Valid for: Multi-AZ DB clusters only
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
For information about valid Iops values, see Amazon RDS Provisioned IOPS storage to improve performance in the Amazon RDS User Guide .
Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance.
Valid for: Multi-AZ DB clusters only
Contains the scaling configuration of an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide .
The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.
The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128.
dict
Response Syntax
{
'DBCluster': {
'AllocatedStorage': 123,
'AvailabilityZones': [
'string',
],
'BackupRetentionPeriod': 123,
'CharacterSetName': 'string',
'DatabaseName': 'string',
'DBClusterIdentifier': 'string',
'DBClusterParameterGroup': 'string',
'DBSubnetGroup': 'string',
'Status': 'string',
'AutomaticRestartTime': datetime(2015, 1, 1),
'PercentProgress': 'string',
'EarliestRestorableTime': datetime(2015, 1, 1),
'Endpoint': 'string',
'ReaderEndpoint': 'string',
'CustomEndpoints': [
'string',
],
'MultiAZ': True|False,
'Engine': 'string',
'EngineVersion': 'string',
'LatestRestorableTime': datetime(2015, 1, 1),
'Port': 123,
'MasterUsername': 'string',
'DBClusterOptionGroupMemberships': [
{
'DBClusterOptionGroupName': 'string',
'Status': 'string'
},
],
'PreferredBackupWindow': 'string',
'PreferredMaintenanceWindow': 'string',
'ReplicationSourceIdentifier': 'string',
'ReadReplicaIdentifiers': [
'string',
],
'DBClusterMembers': [
{
'DBInstanceIdentifier': 'string',
'IsClusterWriter': True|False,
'DBClusterParameterGroupStatus': 'string',
'PromotionTier': 123
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'HostedZoneId': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbClusterResourceId': 'string',
'DBClusterArn': 'string',
'AssociatedRoles': [
{
'RoleArn': 'string',
'Status': 'string',
'FeatureName': 'string'
},
],
'IAMDatabaseAuthenticationEnabled': True|False,
'CloneGroupId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'EarliestBacktrackTime': datetime(2015, 1, 1),
'BacktrackWindow': 123,
'BacktrackConsumedChangeRecords': 123,
'EnabledCloudwatchLogsExports': [
'string',
],
'Capacity': 123,
'EngineMode': 'string',
'ScalingConfigurationInfo': {
'MinCapacity': 123,
'MaxCapacity': 123,
'AutoPause': True|False,
'SecondsUntilAutoPause': 123,
'TimeoutAction': 'string',
'SecondsBeforeTimeout': 123
},
'DeletionProtection': True|False,
'HttpEndpointEnabled': True|False,
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'CopyTagsToSnapshot': True|False,
'CrossAccountClone': True|False,
'DomainMemberships': [
{
'Domain': 'string',
'Status': 'string',
'FQDN': 'string',
'IAMRoleName': 'string'
},
],
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'GlobalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'unknown',
'GlobalWriteForwardingRequested': True|False,
'PendingModifiedValues': {
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
},
'DBClusterIdentifier': 'string',
'MasterUserPassword': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'EngineVersion': 'string'
},
'DBClusterInstanceClass': 'string',
'StorageType': 'string',
'Iops': 123,
'PubliclyAccessible': True|False,
'AutoMinorVersionUpgrade': True|False,
'MonitoringInterval': 123,
'MonitoringRoleArn': 'string',
'PerformanceInsightsEnabled': True|False,
'PerformanceInsightsKMSKeyId': 'string',
'PerformanceInsightsRetentionPeriod': 123,
'ServerlessV2ScalingConfiguration': {
'MinCapacity': 123.0,
'MaxCapacity': 123.0
}
}
}
Response Structure
(dict) --
DBCluster (dict) --
Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
For an Amazon Aurora DB cluster, this data type is used as a response element in the operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , FailoverDBCluster , ModifyDBCluster , PromoteReadReplicaDBCluster , RestoreDBClusterFromS3 , RestoreDBClusterFromSnapshot , RestoreDBClusterToPointInTime , StartDBCluster , and StopDBCluster .
For a Multi-AZ DB cluster, this data type is used as a response element in the operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , FailoverDBCluster , ModifyDBCluster , RebootDBCluster , RestoreDBClusterFromSnapshot , and RestoreDBClusterToPointInTime .
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
AllocatedStorage (integer) --
For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
AvailabilityZones (list) --
Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.
BackupRetentionPeriod (integer) --
Specifies the number of days for which automatic DB snapshots are retained.
CharacterSetName (string) --
If present, specifies the name of the character set that this cluster is associated with.
DatabaseName (string) --
Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.
DBClusterIdentifier (string) --
Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
DBClusterParameterGroup (string) --
Specifies the name of the DB cluster parameter group for the DB cluster.
DBSubnetGroup (string) --
Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
Status (string) --
Specifies the current state of this DB cluster.
AutomaticRestartTime (datetime) --
The time when a stopped DB cluster is restarted automatically.
PercentProgress (string) --
Specifies the progress of the operation as a percentage.
EarliestRestorableTime (datetime) --
The earliest time to which a database can be restored with point-in-time restore.
Endpoint (string) --
Specifies the connection endpoint for the primary instance of the DB cluster.
ReaderEndpoint (string) --
The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.
If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
CustomEndpoints (list) --
Identifies all custom endpoints associated with the cluster.
MultiAZ (boolean) --
Specifies whether the DB cluster has instances in multiple Availability Zones.
Engine (string) --
The name of the database engine to be used for this DB cluster.
EngineVersion (string) --
Indicates the database engine version.
LatestRestorableTime (datetime) --
Specifies the latest time to which a database can be restored with point-in-time restore.
Port (integer) --
Specifies the port that the database engine is listening on.
MasterUsername (string) --
Contains the master username for the DB cluster.
DBClusterOptionGroupMemberships (list) --
Provides the list of option group memberships for this DB cluster.
(dict) --
Contains status information for a DB cluster option group.
DBClusterOptionGroupName (string) --
Specifies the name of the DB cluster option group.
Status (string) --
Specifies the status of the DB cluster option group.
PreferredBackupWindow (string) --
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
ReplicationSourceIdentifier (string) --
Contains the identifier of the source DB cluster if this DB cluster is a read replica.
ReadReplicaIdentifiers (list) --
Contains one or more identifiers of the read replicas associated with this DB cluster.
DBClusterMembers (list) --
Provides the list of instances that make up the DB cluster.
(dict) --
Contains information about an instance that is part of a DB cluster.
DBInstanceIdentifier (string) --
Specifies the instance identifier for this member of the DB cluster.
IsClusterWriter (boolean) --
Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
DBClusterParameterGroupStatus (string) --
Specifies the status of the DB cluster parameter group for this member of the DB cluster.
PromotionTier (integer) --
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .
VpcSecurityGroups (list) --
Provides a list of VPC security groups that the DB cluster belongs to.
(dict) --
This data type is used as a response element for queries on VPC security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The membership status of the VPC security group.
Currently, the only valid status is active .
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
StorageEncrypted (boolean) --
Specifies whether the DB cluster is encrypted.
KmsKeyId (string) --
If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
DbClusterResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for the DB cluster.
AssociatedRoles (list) --
Provides a list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.
(dict) --
Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB cluster.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
Status (string) --
Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other Amazon Web Services on your behalf.PENDING - the IAM role ARN is being associated with the DB cluster.INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other Amazon Web Services on your behalf.FeatureName (string) --
The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion .
IAMDatabaseAuthenticationEnabled (boolean) --
A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
CloneGroupId (string) --
Identifies the clone group to which the DB cluster is associated.
ClusterCreateTime (datetime) --
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
EarliestBacktrackTime (datetime) --
The earliest time to which a DB cluster can be backtracked.
BacktrackWindow (integer) --
The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.
BacktrackConsumedChangeRecords (integer) --
The number of change records stored for Backtrack.
EnabledCloudwatchLogsExports (list) --
A list of log types that this DB cluster is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.
Capacity (integer) --
The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 (zero) when the cluster is paused.
For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide .
EngineMode (string) --
The DB engine mode of the DB cluster, either provisioned , serverless , parallelquery , global , or multimaster .
For more information, see CreateDBCluster .
ScalingConfigurationInfo (dict) --
Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.
For more information, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide .
MinCapacity (integer) --
The minimum capacity for an Aurora DB cluster in serverless DB engine mode.
MaxCapacity (integer) --
The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
AutoPause (boolean) --
A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.
When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.
SecondsUntilAutoPause (integer) --
The remaining amount of time, in seconds, before the Aurora DB cluster in serverless mode is paused. A DB cluster can be paused only when it's idle (it has no connections).
TimeoutAction (string) --
The action that occurs when Aurora times out while attempting to change the capacity of an Aurora Serverless v1 cluster. The value is either ForceApplyCapacityChange or RollbackCapacityChange .
ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.
RollbackCapacityChangeignores the capacity change if a scaling point isn't found in the timeout period.
SecondsBeforeTimeout (integer) --
The number of seconds before scaling times out. What happens when an attempted scaling action times out is determined by the TimeoutAction setting.
DeletionProtection (boolean) --
Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
HttpEndpointEnabled (boolean) --
A value that indicates whether the HTTP endpoint for an Aurora Serverless v1 DB cluster is enabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide .
ActivityStreamMode (string) --
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.
ActivityStreamStatus (string) --
The status of the database activity stream.
ActivityStreamKmsKeyId (string) --
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
ActivityStreamKinesisStreamName (string) --
The name of the Amazon Kinesis data stream used for the database activity stream.
CopyTagsToSnapshot (boolean) --
Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.
CrossAccountClone (boolean) --
Specifies whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
DomainMemberships (list) --
The Active Directory Domain membership records associated with the DB cluster.
(dict) --
An Active Directory Domain membership record associated with the DB instance or cluster.
Domain (string) --
The identifier of the Active Directory Domain.
Status (string) --
The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.
FQDN (string) --
The fully qualified domain name of the Active Directory Domain.
IAMRoleName (string) --
The name of the IAM role to be used when making API calls to the Directory Service.
TagList (list) --
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
GlobalWriteForwardingStatus (string) --
Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.
GlobalWriteForwardingRequested (boolean) --
Specifies whether you have requested to enable write forwarding for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.
PendingModifiedValues (dict) --
A value that specifies that changes to the DB cluster are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
PendingCloudwatchLogsExports (dict) --
A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.
LogTypesToEnable (list) --
Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.
LogTypesToDisable (list) --
Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.
DBClusterIdentifier (string) --
The DBClusterIdentifier value for the DB cluster.
MasterUserPassword (string) --
The master credentials for the DB cluster.
IAMDatabaseAuthenticationEnabled (boolean) --
A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
EngineVersion (string) --
The database engine version.
DBClusterInstanceClass (string) --
The name of the compute and memory capacity class of the DB instance.
This setting is only for non-Aurora Multi-AZ DB clusters.
StorageType (string) --
The storage type associated with the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
Iops (integer) --
The Provisioned IOPS (I/O operations per second) value.
This setting is only for non-Aurora Multi-AZ DB clusters.
PubliclyAccessible (boolean) --
Specifies the accessibility options for the DB instance.
When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance .
This setting is only for non-Aurora Multi-AZ DB clusters.
AutoMinorVersionUpgrade (boolean) --
A value that indicates that minor version patches are applied automatically.
This setting is only for non-Aurora Multi-AZ DB clusters.
MonitoringInterval (integer) --
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
MonitoringRoleArn (string) --
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
This setting is only for non-Aurora Multi-AZ DB clusters.
PerformanceInsightsEnabled (boolean) --
True if Performance Insights is enabled for the DB cluster, and otherwise false.
This setting is only for non-Aurora Multi-AZ DB clusters.
PerformanceInsightsKMSKeyId (string) --
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
This setting is only for non-Aurora Multi-AZ DB clusters.
PerformanceInsightsRetentionPeriod (integer) --
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
For example, the following values are valid:
This setting is only for non-Aurora Multi-AZ DB clusters.
ServerlessV2ScalingConfiguration (dict) --
Shows the scaling configuration for an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide .
MinCapacity (float) --
The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.
MaxCapacity (float) --
The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128.
Exceptions
RDS.Client.exceptions.DBClusterAlreadyExistsFaultRDS.Client.exceptions.DBClusterNotFoundFaultRDS.Client.exceptions.DBClusterQuotaExceededFaultRDS.Client.exceptions.DBClusterSnapshotNotFoundFaultRDS.Client.exceptions.DBSubnetGroupNotFoundFaultRDS.Client.exceptions.InsufficientDBClusterCapacityFaultRDS.Client.exceptions.InsufficientStorageClusterCapacityFaultRDS.Client.exceptions.InvalidDBClusterSnapshotStateFaultRDS.Client.exceptions.InvalidDBClusterStateFaultRDS.Client.exceptions.InvalidDBSnapshotStateFaultRDS.Client.exceptions.InvalidRestoreFaultRDS.Client.exceptions.InvalidSubnetRDS.Client.exceptions.InvalidVPCNetworkStateFaultRDS.Client.exceptions.KMSKeyNotAccessibleFaultRDS.Client.exceptions.OptionGroupNotFoundFaultRDS.Client.exceptions.StorageQuotaExceededFaultRDS.Client.exceptions.DomainNotFoundFaultRDS.Client.exceptions.DBClusterParameterGroupNotFoundFaultExamples
The following example restores a DB cluster to a new DB cluster at a point in time from the source DB cluster.
response = client.restore_db_cluster_to_point_in_time(
DBClusterIdentifier='sample-restored-cluster1',
RestoreToTime=datetime(2016, 9, 13, 18, 45, 0, 1, 257, 0),
SourceDBClusterIdentifier='sample-cluster1',
)
print(response)
Expected Output:
{
'DBCluster': {
},
'ResponseMetadata': {
'...': '...',
},
}
restore_db_instance_from_db_snapshot(**kwargs)¶Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with most of the source's original configuration, including the default security group and DB parameter group. By default, the new DB instance is created as a Single-AZ deployment, except when the instance is a SQL Server instance that has an option group associated with mirroring. In this case, the instance becomes a Multi-AZ deployment, not a Single-AZ deployment.
If you want to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot action. RDS doesn't allow two DB instances with the same name. After you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you replace the original DB instance with the DB instance created from the snapshot.
If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.
Note
This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterFromSnapshot .
See also: AWS API Documentation
Request Syntax
response = client.restore_db_instance_from_db_snapshot(
DBInstanceIdentifier='string',
DBSnapshotIdentifier='string',
DBInstanceClass='string',
Port=123,
AvailabilityZone='string',
DBSubnetGroupName='string',
MultiAZ=True|False,
PubliclyAccessible=True|False,
AutoMinorVersionUpgrade=True|False,
LicenseModel='string',
DBName='string',
Engine='string',
Iops=123,
OptionGroupName='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
StorageType='string',
TdeCredentialArn='string',
TdeCredentialPassword='string',
VpcSecurityGroupIds=[
'string',
],
Domain='string',
CopyTagsToSnapshot=True|False,
DomainIAMRoleName='string',
EnableIAMDatabaseAuthentication=True|False,
EnableCloudwatchLogsExports=[
'string',
],
ProcessorFeatures=[
{
'Name': 'string',
'Value': 'string'
},
],
UseDefaultProcessorFeatures=True|False,
DBParameterGroupName='string',
DeletionProtection=True|False,
EnableCustomerOwnedIp=True|False,
CustomIamInstanceProfile='string',
BackupTarget='string',
NetworkType='string'
)
[REQUIRED]
Name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive.
Constraints:
Example: my-snapshot-id
[REQUIRED]
The identifier for the DB snapshot to restore from.
Constraints:
DBSnapshotIdentifier must be the ARN of the shared DB snapshot.The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Default: The same DBInstanceClass as the original DB instance.
The port number on which the database accepts connections.
Default: The same port as the original DB instance
Constraints: Value must be 1150-65535
The Availability Zone (AZ) where the DB instance will be created.
Default: A random, system-chosen Availability Zone.
Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
Example: us-east-1a
The DB subnet group name to use for the new instance.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
A value that indicates whether the DB instance is a Multi-AZ deployment.
This setting doesn't apply to RDS Custom.
Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
A value that indicates whether the DB instance is publicly accessible.
When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance .
A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.
If you restore an RDS Custom DB instance, you must disable this parameter.
License model information for the restored DB instance.
This setting doesn't apply to RDS Custom.
Default: Same as source.
Valid values: license-included | bring-your-own-license | general-public-license
The database name for the restored DB instance.
This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines. It also doesn't apply to RDS Custom DB instances.
The database engine to use for the new instance.
This setting doesn't apply to RDS Custom.
Default: The same as source
Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.
Valid Values:
mariadbmysqloracle-eeoracle-ee-cdboracle-se2oracle-se2-cdbpostgressqlserver-eesqlserver-sesqlserver-exsqlserver-webSpecifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter isn't specified, the IOPS value is taken from the backup. If this parameter is set to 0, the new instance is converted to a non-PIOPS instance. The conversion takes additional time, though your DB instance is available for connections before the conversion starts.
The provisioned IOPS value must follow the requirements for your database engine. For more information, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.
Constraints: Must be an integer greater than 1000.
The name of the option group to be used for the restored DB instance.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance after it is associated with a DB instance.
This setting doesn't apply to RDS Custom.
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Specifies the storage type to be associated with the DB instance.
Valid values: standard | gp2 | io1
If you specify io1 , you must also include a value for the Iops parameter.
Default: io1 if the Iops parameter is specified, otherwise gp2
The ARN from the key store with which to associate the instance for TDE encryption.
This setting doesn't apply to RDS Custom.
The password for the given ARN from the key store in order to access the device.
This setting doesn't apply to RDS Custom.
A list of EC2 VPC security groups to associate with this DB instance.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
Specify the Active Directory directory ID to restore the DB instance in. The domain/ must be created prior to this operation. Currently, you can create only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide .
This setting doesn't apply to RDS Custom.
A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance.
In most cases, tags aren't copied by default. However, when you restore a DB instance from a DB snapshot, RDS checks whether you specify new tags. If yes, the new tags are added to the restored DB instance. If there are no new tags, RDS looks for the tags from the source DB instance for the DB snapshot, and then adds those tags to the restored DB instance.
For more information, see Copying tags to DB instance snapshots in the Amazon RDS User Guide .
Specify the name of the IAM role to be used when making API calls to the Directory Service.
This setting doesn't apply to RDS Custom.
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide .
This setting doesn't apply to RDS Custom.
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
This setting doesn't apply to RDS Custom.
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstanceModifyDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceFromS3RestoreDBInstanceToPointInTimeYou can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstancesDescribeDBSnapshotsDescribeValidDBInstanceModificationsIf you call DescribeDBInstances , ProcessorFeature returns non-null values only if the following conditions are met:
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
The name of the processor feature. Valid names are coreCount and threadsPerCore .
The value of a processor feature name.
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
This setting doesn't apply to RDS Custom.
The name of the DB parameter group to associate with this DB instance.
If you don't specify a value for DBParameterGroupName , then RDS uses the default DBParameterGroup for the specified DB engine.
This setting doesn't apply to RDS Custom.
Constraints:
A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
This setting doesn't apply to RDS Custom.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide .
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide .
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
AWSRDSCustom .For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide .
This setting is required for RDS Custom.
Specifies where automated backups and manual snapshots are stored for the restored DB instance.
Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region .
For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide .
The network type of the DB instance.
Valid values:
IPV4DUALThe network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
dict
Response Syntax
{
'DBInstance': {
'DBInstanceIdentifier': 'string',
'DBInstanceClass': 'string',
'Engine': 'string',
'DBInstanceStatus': 'string',
'AutomaticRestartTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'DBName': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123,
'HostedZoneId': 'string'
},
'AllocatedStorage': 123,
'InstanceCreateTime': datetime(2015, 1, 1),
'PreferredBackupWindow': 'string',
'BackupRetentionPeriod': 123,
'DBSecurityGroups': [
{
'DBSecurityGroupName': 'string',
'Status': 'string'
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'DBParameterGroups': [
{
'DBParameterGroupName': 'string',
'ParameterApplyStatus': 'string'
},
],
'AvailabilityZone': 'string',
'DBSubnetGroup': {
'DBSubnetGroupName': 'string',
'DBSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetOutpost': {
'Arn': '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',
]
},
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
],
'IAMDatabaseAuthenticationEnabled': True|False,
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1)
},
'LatestRestorableTime': datetime(2015, 1, 1),
'MultiAZ': True|False,
'EngineVersion': 'string',
'AutoMinorVersionUpgrade': True|False,
'ReadReplicaSourceDBInstanceIdentifier': 'string',
'ReadReplicaDBInstanceIdentifiers': [
'string',
],
'ReadReplicaDBClusterIdentifiers': [
'string',
],
'ReplicaMode': 'open-read-only'|'mounted',
'LicenseModel': 'string',
'Iops': 123,
'OptionGroupMemberships': [
{
'OptionGroupName': 'string',
'Status': 'string'
},
],
'CharacterSetName': 'string',
'NcharCharacterSetName': 'string',
'SecondaryAvailabilityZone': 'string',
'PubliclyAccessible': True|False,
'StatusInfos': [
{
'StatusType': 'string',
'Normal': True|False,
'Status': 'string',
'Message': 'string'
},
],
'StorageType': 'string',
'TdeCredentialArn': 'string',
'DbInstancePort': 123,
'DBClusterIdentifier': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbiResourceId': 'string',
'CACertificateIdentifier': 'string',
'DomainMemberships': [
{
'Domain': 'string',
'Status': 'string',
'FQDN': 'string',
'IAMRoleName': 'string'
},
],
'CopyTagsToSnapshot': True|False,
'MonitoringInterval': 123,
'EnhancedMonitoringResourceArn': 'string',
'MonitoringRoleArn': 'string',
'PromotionTier': 123,
'DBInstanceArn': 'string',
'Timezone': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'PerformanceInsightsEnabled': True|False,
'PerformanceInsightsKMSKeyId': 'string',
'PerformanceInsightsRetentionPeriod': 123,
'EnabledCloudwatchLogsExports': [
'string',
],
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
],
'DeletionProtection': True|False,
'AssociatedRoles': [
{
'RoleArn': 'string',
'FeatureName': 'string',
'Status': 'string'
},
],
'ListenerEndpoint': {
'Address': 'string',
'Port': 123,
'HostedZoneId': 'string'
},
'MaxAllocatedStorage': 123,
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'DBInstanceAutomatedBackupsReplications': [
{
'DBInstanceAutomatedBackupsArn': 'string'
},
],
'CustomerOwnedIpEnabled': True|False,
'AwsBackupRecoveryPointArn': 'string',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamEngineNativeAuditFieldsIncluded': True|False,
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1),
'CustomIamInstanceProfile': 'string',
'BackupTarget': 'string',
'NetworkType': 'string',
'ActivityStreamPolicyStatus': 'locked'|'unlocked'|'locking-policy'|'unlocking-policy'
}
}
Response Structure
(dict) --
DBInstance (dict) --
Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations CreateDBInstance , CreateDBInstanceReadReplica , DeleteDBInstance , DescribeDBInstances , ModifyDBInstance , PromoteReadReplica , RebootDBInstance , RestoreDBInstanceFromDBSnapshot , RestoreDBInstanceFromS3 , RestoreDBInstanceToPointInTime , StartDBInstance , and StopDBInstance .
DBInstanceIdentifier (string) --
Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
DBInstanceClass (string) --
Contains the name of the compute and memory capacity class of the DB instance.
Engine (string) --
The name of the database engine to be used for this DB instance.
DBInstanceStatus (string) --
Specifies the current state of this database.
For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.
AutomaticRestartTime (datetime) --
The time when a stopped DB instance is restarted automatically.
MasterUsername (string) --
Contains the master username for the DB instance.
DBName (string) --
The meaning of this parameter differs according to the database engine you use.
MySQL, MariaDB, SQL Server, PostgreSQL
Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
Type: String
Oracle
Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
Endpoint (dict) --
Specifies the connection endpoint.
Note
The endpoint might not be shown for instances whose status is creating .
Address (string) --
Specifies the DNS address of the DB 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.
AllocatedStorage (integer) --
Specifies the allocated storage size specified in gibibytes (GiB).
InstanceCreateTime (datetime) --
Provides the date and time the DB 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 DB snapshots are retained.
DBSecurityGroups (list) --
A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
(dict) --
This data type is used as a response element in the following actions:
ModifyDBInstanceRebootDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceToPointInTimeDBSecurityGroupName (string) --
The name of the DB security group.
Status (string) --
The status of the DB security group.
VpcSecurityGroups (list) --
Provides a list of VPC security group elements that the DB instance belongs to.
(dict) --
This data type is used as a response element for queries on VPC security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The membership status of the VPC security group.
Currently, the only valid status is active .
DBParameterGroups (list) --
Provides the list of DB parameter groups applied to this DB instance.
(dict) --
The status of the DB parameter group.
This data type is used as a response element in the following actions:
CreateDBInstanceCreateDBInstanceReadReplicaDeleteDBInstanceModifyDBInstanceRebootDBInstanceRestoreDBInstanceFromDBSnapshotDBParameterGroupName (string) --
The name of the DB parameter group.
ParameterApplyStatus (string) --
The status of parameter updates.
AvailabilityZone (string) --
Specifies the name of the Availability Zone the DB instance is located in.
DBSubnetGroup (dict) --
Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
DBSubnetGroupName (string) --
The name of the DB subnet group.
DBSubnetGroupDescription (string) --
Provides the description of the DB subnet group.
VpcId (string) --
Provides the VpcId of the DB subnet group.
SubnetGroupStatus (string) --
Provides the status of the DB subnet group.
Subnets (list) --
Contains a list of Subnet elements.
(dict) --
This data type is used as a response element for the DescribeDBSubnetGroups operation.
SubnetIdentifier (string) --
The identifier of the subnet.
SubnetAvailabilityZone (dict) --
Contains Availability Zone information.
This data type is used as an element in the OrderableDBInstanceOption data type.
Name (string) --
The name of the Availability Zone.
SubnetOutpost (dict) --
If the subnet is associated with an Outpost, this value specifies the Outpost.
For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
Arn (string) --
The Amazon Resource Name (ARN) of the Outpost.
SubnetStatus (string) --
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:
IPV4DUALA DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
PendingModifiedValues (dict) --
A value that specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
DBInstanceClass (string) --
The name of the compute and memory capacity class for the DB instance.
AllocatedStorage (integer) --
The allocated storage size for the DB instance specified in gibibytes (GiB).
MasterUserPassword (string) --
The master credentials for the DB instance.
Port (integer) --
The port for the DB instance.
BackupRetentionPeriod (integer) --
The number of days for which automated backups are retained.
MultiAZ (boolean) --
A value that indicates that the Single-AZ DB instance will change to a Multi-AZ deployment.
EngineVersion (string) --
The database engine version.
LicenseModel (string) --
The license model for the DB instance.
Valid values: license-included | bring-your-own-license | general-public-license
Iops (integer) --
The Provisioned IOPS value for the DB instance.
DBInstanceIdentifier (string) --
The database identifier for the DB instance.
StorageType (string) --
The storage type of the DB instance.
CACertificateIdentifier (string) --
The identifier of the CA certificate for the DB instance.
DBSubnetGroupName (string) --
The DB subnet group for the DB instance.
PendingCloudwatchLogsExports (dict) --
A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.
LogTypesToEnable (list) --
Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.
LogTypesToDisable (list) --
Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.
ProcessorFeatures (list) --
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
(dict) --
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstanceModifyDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceFromS3RestoreDBInstanceToPointInTimeYou can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstancesDescribeDBSnapshotsDescribeValidDBInstanceModificationsIf you call DescribeDBInstances , ProcessorFeature returns non-null values only if the following conditions are met:
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
Name (string) --
The name of the processor feature. Valid names are coreCount and threadsPerCore .
Value (string) --
The value of a processor feature name.
IAMDatabaseAuthenticationEnabled (boolean) --
Whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
AutomationMode (string) --
The automation mode of the RDS Custom DB instance: full or all-paused . If full , the DB instance automates monitoring and instance recovery. If all-paused , the instance pauses automation for the duration set by --resume-full-automation-mode-minutes .
ResumeFullAutomationModeTime (datetime) --
The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
LatestRestorableTime (datetime) --
Specifies the latest time to which a database can be restored with point-in-time restore.
MultiAZ (boolean) --
Specifies if the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom.
EngineVersion (string) --
Indicates the database engine version.
AutoMinorVersionUpgrade (boolean) --
A value that indicates that minor version patches are applied automatically.
ReadReplicaSourceDBInstanceIdentifier (string) --
Contains the identifier of the source DB instance if this DB instance is a read replica.
ReadReplicaDBInstanceIdentifiers (list) --
Contains one or more identifiers of the read replicas associated with this DB instance.
ReadReplicaDBClusterIdentifiers (list) --
Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn't contain information about cross-Region Aurora read replicas.
Note
Currently, each RDS DB instance can have only one Aurora read replica.
ReplicaMode (string) --
The open mode of an Oracle read replica. The default is open-read-only . For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide .
Note
This attribute is only supported in RDS for Oracle.
LicenseModel (string) --
License model information for this DB instance. This setting doesn't apply to RDS Custom.
Iops (integer) --
Specifies the Provisioned IOPS (I/O operations per second) value.
OptionGroupMemberships (list) --
Provides the list of option group memberships for this DB instance.
(dict) --
Provides information on the option groups the DB instance is a member of.
OptionGroupName (string) --
The name of the option group that the instance belongs to.
Status (string) --
The status of the DB instance's option group membership. Valid values are: in-sync , pending-apply , pending-removal , pending-maintenance-apply , pending-maintenance-removal , applying , removing , and failed .
CharacterSetName (string) --
If present, specifies the name of the character set that this instance is associated with.
NcharCharacterSetName (string) --
The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.
SecondaryAvailabilityZone (string) --
If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
PubliclyAccessible (boolean) --
Specifies the accessibility options for the DB instance.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance .
StatusInfos (list) --
The status of a read replica. If the instance isn't a read replica, this is blank.
(dict) --
Provides a list of status information for a DB instance.
StatusType (string) --
This value is currently "read replication."
Normal (boolean) --
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 DB instance. For a StatusType of read replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.
Message (string) --
Details of the error if there is an error for the instance. If the instance isn't in an error state, this value is blank.
StorageType (string) --
Specifies the storage type associated with DB instance.
TdeCredentialArn (string) --
The ARN from the key store with which the instance is associated for TDE encryption.
DbInstancePort (integer) --
Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.
DBClusterIdentifier (string) --
If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.
StorageEncrypted (boolean) --
Specifies whether the DB instance is encrypted.
KmsKeyId (string) --
If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
DbiResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB instance is accessed.
CACertificateIdentifier (string) --
The identifier of the CA certificate for this DB instance.
DomainMemberships (list) --
The Active Directory Domain membership records associated with the DB instance.
(dict) --
An Active Directory Domain membership record associated with the DB instance or cluster.
Domain (string) --
The identifier of the Active Directory Domain.
Status (string) --
The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.
FQDN (string) --
The fully qualified domain name of the Active Directory Domain.
IAMRoleName (string) --
The name of the IAM role to be used when making API calls to the Directory Service.
CopyTagsToSnapshot (boolean) --
Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see DBCluster .
MonitoringInterval (integer) --
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
EnhancedMonitoringResourceArn (string) --
The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
MonitoringRoleArn (string) --
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
PromotionTier (integer) --
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .
DBInstanceArn (string) --
The Amazon Resource Name (ARN) for the DB instance.
Timezone (string) --
The time zone of the DB instance. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.
IAMDatabaseAuthenticationEnabled (boolean) --
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
IAM database authentication can be enabled for the following database engines
PerformanceInsightsEnabled (boolean) --
True if Performance Insights is enabled for the DB instance, and otherwise false.
PerformanceInsightsKMSKeyId (string) --
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
PerformanceInsightsRetentionPeriod (integer) --
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
For example, the following values are valid:
EnabledCloudwatchLogsExports (list) --
A list of log types that this DB instance is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon RDS User Guide.
ProcessorFeatures (list) --
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
(dict) --
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstanceModifyDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceFromS3RestoreDBInstanceToPointInTimeYou can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstancesDescribeDBSnapshotsDescribeValidDBInstanceModificationsIf you call DescribeDBInstances , ProcessorFeature returns non-null values only if the following conditions are met:
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
Name (string) --
The name of the processor feature. Valid names are coreCount and threadsPerCore .
Value (string) --
The value of a processor feature name.
DeletionProtection (boolean) --
Indicates if the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance .
AssociatedRoles (list) --
The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
(dict) --
Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.
FeatureName (string) --
The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion .
Status (string) --
Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf.PENDING - the IAM role ARN is being associated with the DB instance.INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf.ListenerEndpoint (dict) --
Specifies the listener connection endpoint for SQL Server Always On.
Address (string) --
Specifies the DNS address of the DB 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.
MaxAllocatedStorage (integer) --
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
TagList (list) --
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
DBInstanceAutomatedBackupsReplications (list) --
The list of replicated automated backups associated with the DB instance.
(dict) --
Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties.
DBInstanceAutomatedBackupsArn (string) --
The Amazon Resource Name (ARN) of the replicated automated backups.
CustomerOwnedIpEnabled (boolean) --
Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide .
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide .
AwsBackupRecoveryPointArn (string) --
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
ActivityStreamStatus (string) --
The status of the database activity stream.
ActivityStreamKmsKeyId (string) --
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
ActivityStreamKinesisStreamName (string) --
The name of the Amazon Kinesis data stream used for the database activity stream.
ActivityStreamMode (string) --
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. RDS for Oracle always handles these events asynchronously.
ActivityStreamEngineNativeAuditFieldsIncluded (boolean) --
Indicates whether engine-native audit fields are included in the database activity stream.
AutomationMode (string) --
The automation mode of the RDS Custom DB instance: full or all paused . If full , the DB instance automates monitoring and instance recovery. If all paused , the instance pauses automation for the duration set by --resume-full-automation-mode-minutes .
ResumeFullAutomationModeTime (datetime) --
The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
CustomIamInstanceProfile (string) --
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
AWSRDSCustom .For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide .
BackupTarget (string) --
Specifies where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
NetworkType (string) --
The network type of the DB instance.
Valid values:
IPV4DUALThe network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide and Working with a DB instance in a VPC in the Amazon Aurora User Guide.
ActivityStreamPolicyStatus (string) --
The status of the policy state of the activity stream.
Exceptions
RDS.Client.exceptions.DBInstanceAlreadyExistsFaultRDS.Client.exceptions.DBSnapshotNotFoundFaultRDS.Client.exceptions.InstanceQuotaExceededFaultRDS.Client.exceptions.InsufficientDBInstanceCapacityFaultRDS.Client.exceptions.InvalidDBSnapshotStateFaultRDS.Client.exceptions.StorageQuotaExceededFaultRDS.Client.exceptions.InvalidVPCNetworkStateFaultRDS.Client.exceptions.InvalidRestoreFaultRDS.Client.exceptions.DBSubnetGroupNotFoundFaultRDS.Client.exceptions.DBSubnetGroupDoesNotCoverEnoughAZsRDS.Client.exceptions.InvalidSubnetRDS.Client.exceptions.ProvisionedIopsNotAvailableInAZFaultRDS.Client.exceptions.OptionGroupNotFoundFaultRDS.Client.exceptions.StorageTypeNotSupportedFaultRDS.Client.exceptions.AuthorizationNotFoundFaultRDS.Client.exceptions.KMSKeyNotAccessibleFaultRDS.Client.exceptions.DBSecurityGroupNotFoundFaultRDS.Client.exceptions.DomainNotFoundFaultRDS.Client.exceptions.DBParameterGroupNotFoundFaultRDS.Client.exceptions.BackupPolicyNotFoundFaultRDS.Client.exceptions.NetworkTypeNotSupportedExamples
The following example restores a DB instance from a DB snapshot.
response = client.restore_db_instance_from_db_snapshot(
DBInstanceIdentifier='mysqldb-restored',
DBSnapshotIdentifier='rds:mysqldb-2014-04-22-08-15',
)
print(response)
Expected Output:
{
'DBInstance': {
'AllocatedStorage': 200,
'AutoMinorVersionUpgrade': True,
'AvailabilityZone': 'us-west-2b',
'BackupRetentionPeriod': 7,
'CACertificateIdentifier': 'rds-ca-2015',
'CopyTagsToSnapshot': False,
'DBInstanceArn': 'arn:aws:rds:us-west-2:123456789012:db:mysqldb-restored',
'DBInstanceClass': 'db.t2.small',
'DBInstanceIdentifier': 'mysqldb-restored',
'DBInstanceStatus': 'available',
'DBName': 'sample',
'DBParameterGroups': [
{
'DBParameterGroupName': 'default.mysql5.6',
'ParameterApplyStatus': 'in-sync',
},
],
'DBSecurityGroups': [
],
'DBSubnetGroup': {
'DBSubnetGroupDescription': 'default',
'DBSubnetGroupName': 'default',
'SubnetGroupStatus': 'Complete',
'Subnets': [
{
'SubnetAvailabilityZone': {
'Name': 'us-west-2a',
},
'SubnetIdentifier': 'subnet-77e8db03',
'SubnetStatus': 'Active',
},
{
'SubnetAvailabilityZone': {
'Name': 'us-west-2b',
},
'SubnetIdentifier': 'subnet-c39989a1',
'SubnetStatus': 'Active',
},
{
'SubnetAvailabilityZone': {
'Name': 'us-west-2c',
},
'SubnetIdentifier': 'subnet-4b267b0d',
'SubnetStatus': 'Active',
},
],
'VpcId': 'vpc-c1c5b3a3',
},
'DbInstancePort': 0,
'DbiResourceId': 'db-VNZUCCBTEDC4WR7THXNJO72HVQ',
'DomainMemberships': [
],
'Engine': 'mysql',
'EngineVersion': '5.6.27',
'LicenseModel': 'general-public-license',
'MasterUsername': 'mymasteruser',
'MonitoringInterval': 0,
'MultiAZ': False,
'OptionGroupMemberships': [
{
'OptionGroupName': 'default:mysql-5-6',
'Status': 'in-sync',
},
],
'PendingModifiedValues': {
},
'PreferredBackupWindow': '12:58-13:28',
'PreferredMaintenanceWindow': 'tue:10:16-tue:10:46',
'PubliclyAccessible': True,
'ReadReplicaDBInstanceIdentifiers': [
],
'StorageEncrypted': False,
'StorageType': 'gp2',
'VpcSecurityGroups': [
{
'Status': 'active',
'VpcSecurityGroupId': 'sg-e5e5b0d2',
},
],
},
'ResponseMetadata': {
'...': '...',
},
}
restore_db_instance_from_s3(**kwargs)¶Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files. You can create a backup of your on-premises database, store it on Amazon Simple Storage Service (Amazon S3), and then restore the backup file onto a new Amazon RDS DB instance running MySQL. For more information, see Importing Data into an Amazon RDS MySQL DB Instance in the Amazon RDS User Guide.
This command doesn't apply to RDS Custom.
See also: AWS API Documentation
Request Syntax
response = client.restore_db_instance_from_s3(
DBName='string',
DBInstanceIdentifier='string',
AllocatedStorage=123,
DBInstanceClass='string',
Engine='string',
MasterUsername='string',
MasterUserPassword='string',
DBSecurityGroups=[
'string',
],
VpcSecurityGroupIds=[
'string',
],
AvailabilityZone='string',
DBSubnetGroupName='string',
PreferredMaintenanceWindow='string',
DBParameterGroupName='string',
BackupRetentionPeriod=123,
PreferredBackupWindow='string',
Port=123,
MultiAZ=True|False,
EngineVersion='string',
AutoMinorVersionUpgrade=True|False,
LicenseModel='string',
Iops=123,
OptionGroupName='string',
PubliclyAccessible=True|False,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
StorageType='string',
StorageEncrypted=True|False,
KmsKeyId='string',
CopyTagsToSnapshot=True|False,
MonitoringInterval=123,
MonitoringRoleArn='string',
EnableIAMDatabaseAuthentication=True|False,
SourceEngine='string',
SourceEngineVersion='string',
S3BucketName='string',
S3Prefix='string',
S3IngestionRoleArn='string',
EnablePerformanceInsights=True|False,
PerformanceInsightsKMSKeyId='string',
PerformanceInsightsRetentionPeriod=123,
EnableCloudwatchLogsExports=[
'string',
],
ProcessorFeatures=[
{
'Name': 'string',
'Value': 'string'
},
],
UseDefaultProcessorFeatures=True|False,
DeletionProtection=True|False,
MaxAllocatedStorage=123,
NetworkType='string'
)
CreateDBInstance .[REQUIRED]
The DB instance identifier. This parameter is stored as a lowercase string.
Constraints:
Example: mydbinstance
The amount of storage (in gigabytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance .
Note
Be sure to allocate enough memory for your new DB instance so that the restore operation can succeed. You can also allocate additional memory for future growth.
[REQUIRED]
The compute and memory capacity of the DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.
Importing from Amazon S3 isn't supported on the db.t2.micro DB instance class.
[REQUIRED]
The name of the database engine to be used for this instance.
Valid Values: mysql
The name for the master user.
Constraints:
The password for the master user. The password can include any printable ASCII character except "/", """, or "@".
Constraints: Must contain from 8 to 41 characters.
A list of DB security groups to associate with this DB instance.
Default: The default DB security group for the database engine.
A list of VPC security groups to associate with this DB instance.
The Availability Zone that the DB instance is created in. For information about Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones in the Amazon RDS User Guide.
Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.
Example: us-east-1d
Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.
A DB subnet group to associate with this DB instance.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.
Constraints:
ddd:hh24:mi-ddd:hh24:mi .The name of the DB parameter group to associate with this DB instance.
If you do not specify a value for DBParameterGroupName , then the default DBParameterGroup for the specified DB engine is used.
CreateDBInstance .The time range each day during which automated backups are created if automated backups are enabled. For more information, see Backup window in the Amazon RDS User Guide.
Constraints:
hh24:mi-hh24:mi .The port number on which the database accepts connections.
Type: Integer
Valid Values: 1150 -65535
Default: 3306
AvailabilityZone parameter.CreateDBInstance , or call DescribeDBEngineVersions .general-public-license .A value that indicates whether the DB instance is publicly accessible.
When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance .
A list of tags to associate with this DB instance. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Specifies the storage type to be associated with the DB instance.
Valid values: standard | gp2 | io1
If you specify io1 , you must also include a value for the Iops parameter.
Default: io1 if the Iops parameter is specified; otherwise gp2
The Amazon Web Services KMS key identifier for an encrypted DB instance.
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 the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0.
If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60
Default: 0
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess . For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
[REQUIRED]
The name of the engine of your source database.
Valid Values: mysql
[REQUIRED]
The version of the database that the backup files were created from.
MySQL versions 5.6 and 5.7 are supported.
Example: 5.6.40
[REQUIRED]
The name of your Amazon S3 bucket that contains your database backup file.
[REQUIRED]
An Amazon Web Services Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket.
A value that indicates whether to enable Performance Insights for the DB instance.
For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide .
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
If you do not specify a value for PerformanceInsightsKMSKeyId , then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
For example, the following values are valid:
If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide .
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstanceModifyDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceFromS3RestoreDBInstanceToPointInTimeYou can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstancesDescribeDBSnapshotsDescribeValidDBInstanceModificationsIf you call DescribeDBInstances , ProcessorFeature returns non-null values only if the following conditions are met:
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
The name of the processor feature. Valid names are coreCount and threadsPerCore .
The value of a processor feature name.
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide .
The network type of the DB instance.
Valid values:
IPV4DUALThe network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
dict
Response Syntax
{
'DBInstance': {
'DBInstanceIdentifier': 'string',
'DBInstanceClass': 'string',
'Engine': 'string',
'DBInstanceStatus': 'string',
'AutomaticRestartTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'DBName': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123,
'HostedZoneId': 'string'
},
'AllocatedStorage': 123,
'InstanceCreateTime': datetime(2015, 1, 1),
'PreferredBackupWindow': 'string',
'BackupRetentionPeriod': 123,
'DBSecurityGroups': [
{
'DBSecurityGroupName': 'string',
'Status': 'string'
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'DBParameterGroups': [
{
'DBParameterGroupName': 'string',
'ParameterApplyStatus': 'string'
},
],
'AvailabilityZone': 'string',
'DBSubnetGroup': {
'DBSubnetGroupName': 'string',
'DBSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetOutpost': {
'Arn': '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',
]
},
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
],
'IAMDatabaseAuthenticationEnabled': True|False,
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1)
},
'LatestRestorableTime': datetime(2015, 1, 1),
'MultiAZ': True|False,
'EngineVersion': 'string',
'AutoMinorVersionUpgrade': True|False,
'ReadReplicaSourceDBInstanceIdentifier': 'string',
'ReadReplicaDBInstanceIdentifiers': [
'string',
],
'ReadReplicaDBClusterIdentifiers': [
'string',
],
'ReplicaMode': 'open-read-only'|'mounted',
'LicenseModel': 'string',
'Iops': 123,
'OptionGroupMemberships': [
{
'OptionGroupName': 'string',
'Status': 'string'
},
],
'CharacterSetName': 'string',
'NcharCharacterSetName': 'string',
'SecondaryAvailabilityZone': 'string',
'PubliclyAccessible': True|False,
'StatusInfos': [
{
'StatusType': 'string',
'Normal': True|False,
'Status': 'string',
'Message': 'string'
},
],
'StorageType': 'string',
'TdeCredentialArn': 'string',
'DbInstancePort': 123,
'DBClusterIdentifier': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbiResourceId': 'string',
'CACertificateIdentifier': 'string',
'DomainMemberships': [
{
'Domain': 'string',
'Status': 'string',
'FQDN': 'string',
'IAMRoleName': 'string'
},
],
'CopyTagsToSnapshot': True|False,
'MonitoringInterval': 123,
'EnhancedMonitoringResourceArn': 'string',
'MonitoringRoleArn': 'string',
'PromotionTier': 123,
'DBInstanceArn': 'string',
'Timezone': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'PerformanceInsightsEnabled': True|False,
'PerformanceInsightsKMSKeyId': 'string',
'PerformanceInsightsRetentionPeriod': 123,
'EnabledCloudwatchLogsExports': [
'string',
],
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
],
'DeletionProtection': True|False,
'AssociatedRoles': [
{
'RoleArn': 'string',
'FeatureName': 'string',
'Status': 'string'
},
],
'ListenerEndpoint': {
'Address': 'string',
'Port': 123,
'HostedZoneId': 'string'
},
'MaxAllocatedStorage': 123,
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'DBInstanceAutomatedBackupsReplications': [
{
'DBInstanceAutomatedBackupsArn': 'string'
},
],
'CustomerOwnedIpEnabled': True|False,
'AwsBackupRecoveryPointArn': 'string',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamEngineNativeAuditFieldsIncluded': True|False,
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1),
'CustomIamInstanceProfile': 'string',
'BackupTarget': 'string',
'NetworkType': 'string',
'ActivityStreamPolicyStatus': 'locked'|'unlocked'|'locking-policy'|'unlocking-policy'
}
}
Response Structure
(dict) --
DBInstance (dict) --
Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations CreateDBInstance , CreateDBInstanceReadReplica , DeleteDBInstance , DescribeDBInstances , ModifyDBInstance , PromoteReadReplica , RebootDBInstance , RestoreDBInstanceFromDBSnapshot , RestoreDBInstanceFromS3 , RestoreDBInstanceToPointInTime , StartDBInstance , and StopDBInstance .
DBInstanceIdentifier (string) --
Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
DBInstanceClass (string) --
Contains the name of the compute and memory capacity class of the DB instance.
Engine (string) --
The name of the database engine to be used for this DB instance.
DBInstanceStatus (string) --
Specifies the current state of this database.
For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.
AutomaticRestartTime (datetime) --
The time when a stopped DB instance is restarted automatically.
MasterUsername (string) --
Contains the master username for the DB instance.
DBName (string) --
The meaning of this parameter differs according to the database engine you use.
MySQL, MariaDB, SQL Server, PostgreSQL
Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
Type: String
Oracle
Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
Endpoint (dict) --
Specifies the connection endpoint.
Note
The endpoint might not be shown for instances whose status is creating .
Address (string) --
Specifies the DNS address of the DB 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.
AllocatedStorage (integer) --
Specifies the allocated storage size specified in gibibytes (GiB).
InstanceCreateTime (datetime) --
Provides the date and time the DB 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 DB snapshots are retained.
DBSecurityGroups (list) --
A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
(dict) --
This data type is used as a response element in the following actions:
ModifyDBInstanceRebootDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceToPointInTimeDBSecurityGroupName (string) --
The name of the DB security group.
Status (string) --
The status of the DB security group.
VpcSecurityGroups (list) --
Provides a list of VPC security group elements that the DB instance belongs to.
(dict) --
This data type is used as a response element for queries on VPC security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The membership status of the VPC security group.
Currently, the only valid status is active .
DBParameterGroups (list) --
Provides the list of DB parameter groups applied to this DB instance.
(dict) --
The status of the DB parameter group.
This data type is used as a response element in the following actions:
CreateDBInstanceCreateDBInstanceReadReplicaDeleteDBInstanceModifyDBInstanceRebootDBInstanceRestoreDBInstanceFromDBSnapshotDBParameterGroupName (string) --
The name of the DB parameter group.
ParameterApplyStatus (string) --
The status of parameter updates.
AvailabilityZone (string) --
Specifies the name of the Availability Zone the DB instance is located in.
DBSubnetGroup (dict) --
Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
DBSubnetGroupName (string) --
The name of the DB subnet group.
DBSubnetGroupDescription (string) --
Provides the description of the DB subnet group.
VpcId (string) --
Provides the VpcId of the DB subnet group.
SubnetGroupStatus (string) --
Provides the status of the DB subnet group.
Subnets (list) --
Contains a list of Subnet elements.
(dict) --
This data type is used as a response element for the DescribeDBSubnetGroups operation.
SubnetIdentifier (string) --
The identifier of the subnet.
SubnetAvailabilityZone (dict) --
Contains Availability Zone information.
This data type is used as an element in the OrderableDBInstanceOption data type.
Name (string) --
The name of the Availability Zone.
SubnetOutpost (dict) --
If the subnet is associated with an Outpost, this value specifies the Outpost.
For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
Arn (string) --
The Amazon Resource Name (ARN) of the Outpost.
SubnetStatus (string) --
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:
IPV4DUALA DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
PendingModifiedValues (dict) --
A value that specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
DBInstanceClass (string) --
The name of the compute and memory capacity class for the DB instance.
AllocatedStorage (integer) --
The allocated storage size for the DB instance specified in gibibytes (GiB).
MasterUserPassword (string) --
The master credentials for the DB instance.
Port (integer) --
The port for the DB instance.
BackupRetentionPeriod (integer) --
The number of days for which automated backups are retained.
MultiAZ (boolean) --
A value that indicates that the Single-AZ DB instance will change to a Multi-AZ deployment.
EngineVersion (string) --
The database engine version.
LicenseModel (string) --
The license model for the DB instance.
Valid values: license-included | bring-your-own-license | general-public-license
Iops (integer) --
The Provisioned IOPS value for the DB instance.
DBInstanceIdentifier (string) --
The database identifier for the DB instance.
StorageType (string) --
The storage type of the DB instance.
CACertificateIdentifier (string) --
The identifier of the CA certificate for the DB instance.
DBSubnetGroupName (string) --
The DB subnet group for the DB instance.
PendingCloudwatchLogsExports (dict) --
A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.
LogTypesToEnable (list) --
Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.
LogTypesToDisable (list) --
Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.
ProcessorFeatures (list) --
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
(dict) --
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstanceModifyDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceFromS3RestoreDBInstanceToPointInTimeYou can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstancesDescribeDBSnapshotsDescribeValidDBInstanceModificationsIf you call DescribeDBInstances , ProcessorFeature returns non-null values only if the following conditions are met:
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
Name (string) --
The name of the processor feature. Valid names are coreCount and threadsPerCore .
Value (string) --
The value of a processor feature name.
IAMDatabaseAuthenticationEnabled (boolean) --
Whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
AutomationMode (string) --
The automation mode of the RDS Custom DB instance: full or all-paused . If full , the DB instance automates monitoring and instance recovery. If all-paused , the instance pauses automation for the duration set by --resume-full-automation-mode-minutes .
ResumeFullAutomationModeTime (datetime) --
The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
LatestRestorableTime (datetime) --
Specifies the latest time to which a database can be restored with point-in-time restore.
MultiAZ (boolean) --
Specifies if the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom.
EngineVersion (string) --
Indicates the database engine version.
AutoMinorVersionUpgrade (boolean) --
A value that indicates that minor version patches are applied automatically.
ReadReplicaSourceDBInstanceIdentifier (string) --
Contains the identifier of the source DB instance if this DB instance is a read replica.
ReadReplicaDBInstanceIdentifiers (list) --
Contains one or more identifiers of the read replicas associated with this DB instance.
ReadReplicaDBClusterIdentifiers (list) --
Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn't contain information about cross-Region Aurora read replicas.
Note
Currently, each RDS DB instance can have only one Aurora read replica.
ReplicaMode (string) --
The open mode of an Oracle read replica. The default is open-read-only . For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide .
Note
This attribute is only supported in RDS for Oracle.
LicenseModel (string) --
License model information for this DB instance. This setting doesn't apply to RDS Custom.
Iops (integer) --
Specifies the Provisioned IOPS (I/O operations per second) value.
OptionGroupMemberships (list) --
Provides the list of option group memberships for this DB instance.
(dict) --
Provides information on the option groups the DB instance is a member of.
OptionGroupName (string) --
The name of the option group that the instance belongs to.
Status (string) --
The status of the DB instance's option group membership. Valid values are: in-sync , pending-apply , pending-removal , pending-maintenance-apply , pending-maintenance-removal , applying , removing , and failed .
CharacterSetName (string) --
If present, specifies the name of the character set that this instance is associated with.
NcharCharacterSetName (string) --
The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.
SecondaryAvailabilityZone (string) --
If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
PubliclyAccessible (boolean) --
Specifies the accessibility options for the DB instance.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance .
StatusInfos (list) --
The status of a read replica. If the instance isn't a read replica, this is blank.
(dict) --
Provides a list of status information for a DB instance.
StatusType (string) --
This value is currently "read replication."
Normal (boolean) --
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 DB instance. For a StatusType of read replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.
Message (string) --
Details of the error if there is an error for the instance. If the instance isn't in an error state, this value is blank.
StorageType (string) --
Specifies the storage type associated with DB instance.
TdeCredentialArn (string) --
The ARN from the key store with which the instance is associated for TDE encryption.
DbInstancePort (integer) --
Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.
DBClusterIdentifier (string) --
If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.
StorageEncrypted (boolean) --
Specifies whether the DB instance is encrypted.
KmsKeyId (string) --
If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
DbiResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB instance is accessed.
CACertificateIdentifier (string) --
The identifier of the CA certificate for this DB instance.
DomainMemberships (list) --
The Active Directory Domain membership records associated with the DB instance.
(dict) --
An Active Directory Domain membership record associated with the DB instance or cluster.
Domain (string) --
The identifier of the Active Directory Domain.
Status (string) --
The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.
FQDN (string) --
The fully qualified domain name of the Active Directory Domain.
IAMRoleName (string) --
The name of the IAM role to be used when making API calls to the Directory Service.
CopyTagsToSnapshot (boolean) --
Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see DBCluster .
MonitoringInterval (integer) --
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
EnhancedMonitoringResourceArn (string) --
The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
MonitoringRoleArn (string) --
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
PromotionTier (integer) --
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .
DBInstanceArn (string) --
The Amazon Resource Name (ARN) for the DB instance.
Timezone (string) --
The time zone of the DB instance. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.
IAMDatabaseAuthenticationEnabled (boolean) --
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
IAM database authentication can be enabled for the following database engines
PerformanceInsightsEnabled (boolean) --
True if Performance Insights is enabled for the DB instance, and otherwise false.
PerformanceInsightsKMSKeyId (string) --
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
PerformanceInsightsRetentionPeriod (integer) --
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
For example, the following values are valid:
EnabledCloudwatchLogsExports (list) --
A list of log types that this DB instance is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon RDS User Guide.
ProcessorFeatures (list) --
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
(dict) --
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstanceModifyDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceFromS3RestoreDBInstanceToPointInTimeYou can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstancesDescribeDBSnapshotsDescribeValidDBInstanceModificationsIf you call DescribeDBInstances , ProcessorFeature returns non-null values only if the following conditions are met:
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
Name (string) --
The name of the processor feature. Valid names are coreCount and threadsPerCore .
Value (string) --
The value of a processor feature name.
DeletionProtection (boolean) --
Indicates if the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance .
AssociatedRoles (list) --
The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
(dict) --
Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.
FeatureName (string) --
The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion .
Status (string) --
Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf.PENDING - the IAM role ARN is being associated with the DB instance.INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf.ListenerEndpoint (dict) --
Specifies the listener connection endpoint for SQL Server Always On.
Address (string) --
Specifies the DNS address of the DB 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.
MaxAllocatedStorage (integer) --
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
TagList (list) --
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
DBInstanceAutomatedBackupsReplications (list) --
The list of replicated automated backups associated with the DB instance.
(dict) --
Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties.
DBInstanceAutomatedBackupsArn (string) --
The Amazon Resource Name (ARN) of the replicated automated backups.
CustomerOwnedIpEnabled (boolean) --
Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide .
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide .
AwsBackupRecoveryPointArn (string) --
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
ActivityStreamStatus (string) --
The status of the database activity stream.
ActivityStreamKmsKeyId (string) --
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
ActivityStreamKinesisStreamName (string) --
The name of the Amazon Kinesis data stream used for the database activity stream.
ActivityStreamMode (string) --
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. RDS for Oracle always handles these events asynchronously.
ActivityStreamEngineNativeAuditFieldsIncluded (boolean) --
Indicates whether engine-native audit fields are included in the database activity stream.
AutomationMode (string) --
The automation mode of the RDS Custom DB instance: full or all paused . If full , the DB instance automates monitoring and instance recovery. If all paused , the instance pauses automation for the duration set by --resume-full-automation-mode-minutes .
ResumeFullAutomationModeTime (datetime) --
The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
CustomIamInstanceProfile (string) --
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
AWSRDSCustom .For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide .
BackupTarget (string) --
Specifies where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
NetworkType (string) --
The network type of the DB instance.
Valid values:
IPV4DUALThe network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide and Working with a DB instance in a VPC in the Amazon Aurora User Guide.
ActivityStreamPolicyStatus (string) --
The status of the policy state of the activity stream.
Exceptions
RDS.Client.exceptions.DBInstanceAlreadyExistsFaultRDS.Client.exceptions.InsufficientDBInstanceCapacityFaultRDS.Client.exceptions.DBParameterGroupNotFoundFaultRDS.Client.exceptions.DBSecurityGroupNotFoundFaultRDS.Client.exceptions.InstanceQuotaExceededFaultRDS.Client.exceptions.StorageQuotaExceededFaultRDS.Client.exceptions.DBSubnetGroupNotFoundFaultRDS.Client.exceptions.DBSubnetGroupDoesNotCoverEnoughAZsRDS.Client.exceptions.InvalidSubnetRDS.Client.exceptions.InvalidVPCNetworkStateFaultRDS.Client.exceptions.InvalidS3BucketFaultRDS.Client.exceptions.ProvisionedIopsNotAvailableInAZFaultRDS.Client.exceptions.OptionGroupNotFoundFaultRDS.Client.exceptions.StorageTypeNotSupportedFaultRDS.Client.exceptions.AuthorizationNotFoundFaultRDS.Client.exceptions.KMSKeyNotAccessibleFaultRDS.Client.exceptions.BackupPolicyNotFoundFaultRDS.Client.exceptions.NetworkTypeNotSupportedrestore_db_instance_to_point_in_time(**kwargs)¶Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property.
The target database is created with most of the original configuration, but in a system-selected Availability Zone, with the default security group, the default subnet group, and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored deployment and not a single-AZ deployment.
Note
This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterToPointInTime .
See also: AWS API Documentation
Request Syntax
response = client.restore_db_instance_to_point_in_time(
SourceDBInstanceIdentifier='string',
TargetDBInstanceIdentifier='string',
RestoreTime=datetime(2015, 1, 1),
UseLatestRestorableTime=True|False,
DBInstanceClass='string',
Port=123,
AvailabilityZone='string',
DBSubnetGroupName='string',
MultiAZ=True|False,
PubliclyAccessible=True|False,
AutoMinorVersionUpgrade=True|False,
LicenseModel='string',
DBName='string',
Engine='string',
Iops=123,
OptionGroupName='string',
CopyTagsToSnapshot=True|False,
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
StorageType='string',
TdeCredentialArn='string',
TdeCredentialPassword='string',
VpcSecurityGroupIds=[
'string',
],
Domain='string',
DomainIAMRoleName='string',
EnableIAMDatabaseAuthentication=True|False,
EnableCloudwatchLogsExports=[
'string',
],
ProcessorFeatures=[
{
'Name': 'string',
'Value': 'string'
},
],
UseDefaultProcessorFeatures=True|False,
DBParameterGroupName='string',
DeletionProtection=True|False,
SourceDbiResourceId='string',
MaxAllocatedStorage=123,
SourceDBInstanceAutomatedBackupsArn='string',
EnableCustomerOwnedIp=True|False,
CustomIamInstanceProfile='string',
BackupTarget='string',
NetworkType='string'
)
The identifier of the source DB instance from which to restore.
Constraints:
[REQUIRED]
The name of the new DB instance to be created.
Constraints:
The date and time to restore from.
Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
Constraints:
UseLatestRestorableTime parameter is enabledExample: 2009-09-07T23:45:00Z
A value that indicates whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time.
Constraints: Can't be specified if the RestoreTime parameter is provided.
The compute and memory capacity of the Amazon RDS DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide .
Default: The same DBInstanceClass as the original DB instance.
The port number on which the database accepts connections.
Constraints: Value must be 1150-65535
Default: The same port as the original DB instance.
The Availability Zone (AZ) where the DB instance will be created.
Default: A random, system-chosen Availability Zone.
Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
Example: us-east-1a
The DB subnet group name to use for the new instance.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mydbsubnetgroup
A value that indicates whether the DB instance is a Multi-AZ deployment.
This setting doesn't apply to RDS Custom.
Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
A value that indicates whether the DB instance is publicly accessible.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance .
A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.
This setting doesn't apply to RDS Custom.
License model information for the restored DB instance.
This setting doesn't apply to RDS Custom.
Default: Same as source.
Valid values: license-included | bring-your-own-license | general-public-license
The database name for the restored DB instance.
Note
This parameter isn't supported for the MySQL or MariaDB engines. It also doesn't apply to RDS Custom.
The database engine to use for the new instance.
This setting doesn't apply to RDS Custom.
Default: The same as source
Constraint: Must be compatible with the engine of the source
Valid Values:
mariadbmysqloracle-eeoracle-ee-cdboracle-se2oracle-se2-cdbpostgressqlserver-eesqlserver-sesqlserver-exsqlserver-webThe amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
Constraints: Must be an integer greater than 1000.
SQL Server
Setting the IOPS value for the SQL Server database engine isn't supported.
The name of the option group to be used for the restored DB instance.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance after it is associated with a DB instance
This setting doesn't apply to RDS Custom.
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Specifies the storage type to be associated with the DB instance.
Valid values: standard | gp2 | io1
If you specify io1 , you must also include a value for the Iops parameter.
Default: io1 if the Iops parameter is specified, otherwise gp2
The ARN from the key store with which to associate the instance for TDE encryption.
This setting doesn't apply to RDS Custom.
The password for the given ARN from the key store in order to access the device.
This setting doesn't apply to RDS Custom.
A list of EC2 VPC security groups to associate with this DB instance.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
Specify the Active Directory directory ID to restore the DB instance in. Create the domain before running this command. Currently, you can create only the MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
This setting doesn't apply to RDS Custom.
For more information, see Kerberos Authentication in the Amazon RDS User Guide .
Specify the name of the IAM role to be used when making API calls to the Directory Service.
This setting doesn't apply to RDS Custom.
A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.
This setting doesn't apply to RDS Custom.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide .
This setting doesn't apply to RDS Custom.
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
This setting doesn't apply to RDS Custom.
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstanceModifyDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceFromS3RestoreDBInstanceToPointInTimeYou can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstancesDescribeDBSnapshotsDescribeValidDBInstanceModificationsIf you call DescribeDBInstances , ProcessorFeature returns non-null values only if the following conditions are met:
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
The name of the processor feature. Valid names are coreCount and threadsPerCore .
The value of a processor feature name.
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
This setting doesn't apply to RDS Custom.
The name of the DB parameter group to associate with this DB instance.
If you do not specify a value for DBParameterGroupName , then the default DBParameterGroup for the specified DB engine is used.
This setting doesn't apply to RDS Custom.
Constraints:
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide .
This setting doesn't apply to RDS Custom.
The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE .
This setting doesn't apply to RDS Custom.
A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
This setting doesn't apply to RDS Custom.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide .
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide .
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
AWSRDSCustom .For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide .
This setting is required for RDS Custom.
Specifies where automated backups and manual snapshots are stored for the restored DB instance.
Possible values are outposts (Amazon Web Services Outposts) and region (Amazon Web Services Region). The default is region .
For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide .
The network type of the DB instance.
Valid values:
IPV4DUALThe network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
dict
Response Syntax
{
'DBInstance': {
'DBInstanceIdentifier': 'string',
'DBInstanceClass': 'string',
'Engine': 'string',
'DBInstanceStatus': 'string',
'AutomaticRestartTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'DBName': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123,
'HostedZoneId': 'string'
},
'AllocatedStorage': 123,
'InstanceCreateTime': datetime(2015, 1, 1),
'PreferredBackupWindow': 'string',
'BackupRetentionPeriod': 123,
'DBSecurityGroups': [
{
'DBSecurityGroupName': 'string',
'Status': 'string'
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'DBParameterGroups': [
{
'DBParameterGroupName': 'string',
'ParameterApplyStatus': 'string'
},
],
'AvailabilityZone': 'string',
'DBSubnetGroup': {
'DBSubnetGroupName': 'string',
'DBSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetOutpost': {
'Arn': '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',
]
},
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
],
'IAMDatabaseAuthenticationEnabled': True|False,
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1)
},
'LatestRestorableTime': datetime(2015, 1, 1),
'MultiAZ': True|False,
'EngineVersion': 'string',
'AutoMinorVersionUpgrade': True|False,
'ReadReplicaSourceDBInstanceIdentifier': 'string',
'ReadReplicaDBInstanceIdentifiers': [
'string',
],
'ReadReplicaDBClusterIdentifiers': [
'string',
],
'ReplicaMode': 'open-read-only'|'mounted',
'LicenseModel': 'string',
'Iops': 123,
'OptionGroupMemberships': [
{
'OptionGroupName': 'string',
'Status': 'string'
},
],
'CharacterSetName': 'string',
'NcharCharacterSetName': 'string',
'SecondaryAvailabilityZone': 'string',
'PubliclyAccessible': True|False,
'StatusInfos': [
{
'StatusType': 'string',
'Normal': True|False,
'Status': 'string',
'Message': 'string'
},
],
'StorageType': 'string',
'TdeCredentialArn': 'string',
'DbInstancePort': 123,
'DBClusterIdentifier': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbiResourceId': 'string',
'CACertificateIdentifier': 'string',
'DomainMemberships': [
{
'Domain': 'string',
'Status': 'string',
'FQDN': 'string',
'IAMRoleName': 'string'
},
],
'CopyTagsToSnapshot': True|False,
'MonitoringInterval': 123,
'EnhancedMonitoringResourceArn': 'string',
'MonitoringRoleArn': 'string',
'PromotionTier': 123,
'DBInstanceArn': 'string',
'Timezone': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'PerformanceInsightsEnabled': True|False,
'PerformanceInsightsKMSKeyId': 'string',
'PerformanceInsightsRetentionPeriod': 123,
'EnabledCloudwatchLogsExports': [
'string',
],
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
],
'DeletionProtection': True|False,
'AssociatedRoles': [
{
'RoleArn': 'string',
'FeatureName': 'string',
'Status': 'string'
},
],
'ListenerEndpoint': {
'Address': 'string',
'Port': 123,
'HostedZoneId': 'string'
},
'MaxAllocatedStorage': 123,
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'DBInstanceAutomatedBackupsReplications': [
{
'DBInstanceAutomatedBackupsArn': 'string'
},
],
'CustomerOwnedIpEnabled': True|False,
'AwsBackupRecoveryPointArn': 'string',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamEngineNativeAuditFieldsIncluded': True|False,
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1),
'CustomIamInstanceProfile': 'string',
'BackupTarget': 'string',
'NetworkType': 'string',
'ActivityStreamPolicyStatus': 'locked'|'unlocked'|'locking-policy'|'unlocking-policy'
}
}
Response Structure
(dict) --
DBInstance (dict) --
Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations CreateDBInstance , CreateDBInstanceReadReplica , DeleteDBInstance , DescribeDBInstances , ModifyDBInstance , PromoteReadReplica , RebootDBInstance , RestoreDBInstanceFromDBSnapshot , RestoreDBInstanceFromS3 , RestoreDBInstanceToPointInTime , StartDBInstance , and StopDBInstance .
DBInstanceIdentifier (string) --
Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
DBInstanceClass (string) --
Contains the name of the compute and memory capacity class of the DB instance.
Engine (string) --
The name of the database engine to be used for this DB instance.
DBInstanceStatus (string) --
Specifies the current state of this database.
For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.
AutomaticRestartTime (datetime) --
The time when a stopped DB instance is restarted automatically.
MasterUsername (string) --
Contains the master username for the DB instance.
DBName (string) --
The meaning of this parameter differs according to the database engine you use.
MySQL, MariaDB, SQL Server, PostgreSQL
Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
Type: String
Oracle
Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
Endpoint (dict) --
Specifies the connection endpoint.
Note
The endpoint might not be shown for instances whose status is creating .
Address (string) --
Specifies the DNS address of the DB 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.
AllocatedStorage (integer) --
Specifies the allocated storage size specified in gibibytes (GiB).
InstanceCreateTime (datetime) --
Provides the date and time the DB 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 DB snapshots are retained.
DBSecurityGroups (list) --
A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
(dict) --
This data type is used as a response element in the following actions:
ModifyDBInstanceRebootDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceToPointInTimeDBSecurityGroupName (string) --
The name of the DB security group.
Status (string) --
The status of the DB security group.
VpcSecurityGroups (list) --
Provides a list of VPC security group elements that the DB instance belongs to.
(dict) --
This data type is used as a response element for queries on VPC security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The membership status of the VPC security group.
Currently, the only valid status is active .
DBParameterGroups (list) --
Provides the list of DB parameter groups applied to this DB instance.
(dict) --
The status of the DB parameter group.
This data type is used as a response element in the following actions:
CreateDBInstanceCreateDBInstanceReadReplicaDeleteDBInstanceModifyDBInstanceRebootDBInstanceRestoreDBInstanceFromDBSnapshotDBParameterGroupName (string) --
The name of the DB parameter group.
ParameterApplyStatus (string) --
The status of parameter updates.
AvailabilityZone (string) --
Specifies the name of the Availability Zone the DB instance is located in.
DBSubnetGroup (dict) --
Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
DBSubnetGroupName (string) --
The name of the DB subnet group.
DBSubnetGroupDescription (string) --
Provides the description of the DB subnet group.
VpcId (string) --
Provides the VpcId of the DB subnet group.
SubnetGroupStatus (string) --
Provides the status of the DB subnet group.
Subnets (list) --
Contains a list of Subnet elements.
(dict) --
This data type is used as a response element for the DescribeDBSubnetGroups operation.
SubnetIdentifier (string) --
The identifier of the subnet.
SubnetAvailabilityZone (dict) --
Contains Availability Zone information.
This data type is used as an element in the OrderableDBInstanceOption data type.
Name (string) --
The name of the Availability Zone.
SubnetOutpost (dict) --
If the subnet is associated with an Outpost, this value specifies the Outpost.
For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
Arn (string) --
The Amazon Resource Name (ARN) of the Outpost.
SubnetStatus (string) --
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:
IPV4DUALA DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
PendingModifiedValues (dict) --
A value that specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
DBInstanceClass (string) --
The name of the compute and memory capacity class for the DB instance.
AllocatedStorage (integer) --
The allocated storage size for the DB instance specified in gibibytes (GiB).
MasterUserPassword (string) --
The master credentials for the DB instance.
Port (integer) --
The port for the DB instance.
BackupRetentionPeriod (integer) --
The number of days for which automated backups are retained.
MultiAZ (boolean) --
A value that indicates that the Single-AZ DB instance will change to a Multi-AZ deployment.
EngineVersion (string) --
The database engine version.
LicenseModel (string) --
The license model for the DB instance.
Valid values: license-included | bring-your-own-license | general-public-license
Iops (integer) --
The Provisioned IOPS value for the DB instance.
DBInstanceIdentifier (string) --
The database identifier for the DB instance.
StorageType (string) --
The storage type of the DB instance.
CACertificateIdentifier (string) --
The identifier of the CA certificate for the DB instance.
DBSubnetGroupName (string) --
The DB subnet group for the DB instance.
PendingCloudwatchLogsExports (dict) --
A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.
LogTypesToEnable (list) --
Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.
LogTypesToDisable (list) --
Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.
ProcessorFeatures (list) --
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
(dict) --
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstanceModifyDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceFromS3RestoreDBInstanceToPointInTimeYou can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstancesDescribeDBSnapshotsDescribeValidDBInstanceModificationsIf you call DescribeDBInstances , ProcessorFeature returns non-null values only if the following conditions are met:
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
Name (string) --
The name of the processor feature. Valid names are coreCount and threadsPerCore .
Value (string) --
The value of a processor feature name.
IAMDatabaseAuthenticationEnabled (boolean) --
Whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
AutomationMode (string) --
The automation mode of the RDS Custom DB instance: full or all-paused . If full , the DB instance automates monitoring and instance recovery. If all-paused , the instance pauses automation for the duration set by --resume-full-automation-mode-minutes .
ResumeFullAutomationModeTime (datetime) --
The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
LatestRestorableTime (datetime) --
Specifies the latest time to which a database can be restored with point-in-time restore.
MultiAZ (boolean) --
Specifies if the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom.
EngineVersion (string) --
Indicates the database engine version.
AutoMinorVersionUpgrade (boolean) --
A value that indicates that minor version patches are applied automatically.
ReadReplicaSourceDBInstanceIdentifier (string) --
Contains the identifier of the source DB instance if this DB instance is a read replica.
ReadReplicaDBInstanceIdentifiers (list) --
Contains one or more identifiers of the read replicas associated with this DB instance.
ReadReplicaDBClusterIdentifiers (list) --
Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn't contain information about cross-Region Aurora read replicas.
Note
Currently, each RDS DB instance can have only one Aurora read replica.
ReplicaMode (string) --
The open mode of an Oracle read replica. The default is open-read-only . For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide .
Note
This attribute is only supported in RDS for Oracle.
LicenseModel (string) --
License model information for this DB instance. This setting doesn't apply to RDS Custom.
Iops (integer) --
Specifies the Provisioned IOPS (I/O operations per second) value.
OptionGroupMemberships (list) --
Provides the list of option group memberships for this DB instance.
(dict) --
Provides information on the option groups the DB instance is a member of.
OptionGroupName (string) --
The name of the option group that the instance belongs to.
Status (string) --
The status of the DB instance's option group membership. Valid values are: in-sync , pending-apply , pending-removal , pending-maintenance-apply , pending-maintenance-removal , applying , removing , and failed .
CharacterSetName (string) --
If present, specifies the name of the character set that this instance is associated with.
NcharCharacterSetName (string) --
The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.
SecondaryAvailabilityZone (string) --
If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
PubliclyAccessible (boolean) --
Specifies the accessibility options for the DB instance.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance .
StatusInfos (list) --
The status of a read replica. If the instance isn't a read replica, this is blank.
(dict) --
Provides a list of status information for a DB instance.
StatusType (string) --
This value is currently "read replication."
Normal (boolean) --
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 DB instance. For a StatusType of read replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.
Message (string) --
Details of the error if there is an error for the instance. If the instance isn't in an error state, this value is blank.
StorageType (string) --
Specifies the storage type associated with DB instance.
TdeCredentialArn (string) --
The ARN from the key store with which the instance is associated for TDE encryption.
DbInstancePort (integer) --
Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.
DBClusterIdentifier (string) --
If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.
StorageEncrypted (boolean) --
Specifies whether the DB instance is encrypted.
KmsKeyId (string) --
If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
DbiResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB instance is accessed.
CACertificateIdentifier (string) --
The identifier of the CA certificate for this DB instance.
DomainMemberships (list) --
The Active Directory Domain membership records associated with the DB instance.
(dict) --
An Active Directory Domain membership record associated with the DB instance or cluster.
Domain (string) --
The identifier of the Active Directory Domain.
Status (string) --
The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.
FQDN (string) --
The fully qualified domain name of the Active Directory Domain.
IAMRoleName (string) --
The name of the IAM role to be used when making API calls to the Directory Service.
CopyTagsToSnapshot (boolean) --
Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see DBCluster .
MonitoringInterval (integer) --
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
EnhancedMonitoringResourceArn (string) --
The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
MonitoringRoleArn (string) --
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
PromotionTier (integer) --
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .
DBInstanceArn (string) --
The Amazon Resource Name (ARN) for the DB instance.
Timezone (string) --
The time zone of the DB instance. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.
IAMDatabaseAuthenticationEnabled (boolean) --
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
IAM database authentication can be enabled for the following database engines
PerformanceInsightsEnabled (boolean) --
True if Performance Insights is enabled for the DB instance, and otherwise false.
PerformanceInsightsKMSKeyId (string) --
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
PerformanceInsightsRetentionPeriod (integer) --
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
For example, the following values are valid:
EnabledCloudwatchLogsExports (list) --
A list of log types that this DB instance is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon RDS User Guide.
ProcessorFeatures (list) --
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
(dict) --
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstanceModifyDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceFromS3RestoreDBInstanceToPointInTimeYou can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstancesDescribeDBSnapshotsDescribeValidDBInstanceModificationsIf you call DescribeDBInstances , ProcessorFeature returns non-null values only if the following conditions are met:
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
Name (string) --
The name of the processor feature. Valid names are coreCount and threadsPerCore .
Value (string) --
The value of a processor feature name.
DeletionProtection (boolean) --
Indicates if the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance .
AssociatedRoles (list) --
The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
(dict) --
Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.
FeatureName (string) --
The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion .
Status (string) --
Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf.PENDING - the IAM role ARN is being associated with the DB instance.INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf.ListenerEndpoint (dict) --
Specifies the listener connection endpoint for SQL Server Always On.
Address (string) --
Specifies the DNS address of the DB 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.
MaxAllocatedStorage (integer) --
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
TagList (list) --
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
DBInstanceAutomatedBackupsReplications (list) --
The list of replicated automated backups associated with the DB instance.
(dict) --
Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties.
DBInstanceAutomatedBackupsArn (string) --
The Amazon Resource Name (ARN) of the replicated automated backups.
CustomerOwnedIpEnabled (boolean) --
Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide .
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide .
AwsBackupRecoveryPointArn (string) --
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
ActivityStreamStatus (string) --
The status of the database activity stream.
ActivityStreamKmsKeyId (string) --
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
ActivityStreamKinesisStreamName (string) --
The name of the Amazon Kinesis data stream used for the database activity stream.
ActivityStreamMode (string) --
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. RDS for Oracle always handles these events asynchronously.
ActivityStreamEngineNativeAuditFieldsIncluded (boolean) --
Indicates whether engine-native audit fields are included in the database activity stream.
AutomationMode (string) --
The automation mode of the RDS Custom DB instance: full or all paused . If full , the DB instance automates monitoring and instance recovery. If all paused , the instance pauses automation for the duration set by --resume-full-automation-mode-minutes .
ResumeFullAutomationModeTime (datetime) --
The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
CustomIamInstanceProfile (string) --
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
AWSRDSCustom .For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide .
BackupTarget (string) --
Specifies where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
NetworkType (string) --
The network type of the DB instance.
Valid values:
IPV4DUALThe network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide and Working with a DB instance in a VPC in the Amazon Aurora User Guide.
ActivityStreamPolicyStatus (string) --
The status of the policy state of the activity stream.
Exceptions
RDS.Client.exceptions.DBInstanceAlreadyExistsFaultRDS.Client.exceptions.DBInstanceNotFoundFaultRDS.Client.exceptions.InstanceQuotaExceededFaultRDS.Client.exceptions.InsufficientDBInstanceCapacityFaultRDS.Client.exceptions.InvalidDBInstanceStateFaultRDS.Client.exceptions.PointInTimeRestoreNotEnabledFaultRDS.Client.exceptions.StorageQuotaExceededFaultRDS.Client.exceptions.InvalidVPCNetworkStateFaultRDS.Client.exceptions.InvalidRestoreFaultRDS.Client.exceptions.DBSubnetGroupNotFoundFaultRDS.Client.exceptions.DBSubnetGroupDoesNotCoverEnoughAZsRDS.Client.exceptions.InvalidSubnetRDS.Client.exceptions.ProvisionedIopsNotAvailableInAZFaultRDS.Client.exceptions.OptionGroupNotFoundFaultRDS.Client.exceptions.StorageTypeNotSupportedFaultRDS.Client.exceptions.AuthorizationNotFoundFaultRDS.Client.exceptions.KMSKeyNotAccessibleFaultRDS.Client.exceptions.DBSecurityGroupNotFoundFaultRDS.Client.exceptions.DomainNotFoundFaultRDS.Client.exceptions.BackupPolicyNotFoundFaultRDS.Client.exceptions.DBParameterGroupNotFoundFaultRDS.Client.exceptions.DBInstanceAutomatedBackupNotFoundFaultRDS.Client.exceptions.NetworkTypeNotSupportedExamples
The following example restores a DB instance to a new DB instance at a point in time from the source DB instance.
response = client.restore_db_instance_to_point_in_time(
RestoreTime=datetime(2016, 9, 13, 18, 45, 0, 1, 257, 0),
SourceDBInstanceIdentifier='mysql-sample',
TargetDBInstanceIdentifier='mysql-sample-restored',
)
print(response)
Expected Output:
{
'DBInstance': {
'AllocatedStorage': 200,
'AutoMinorVersionUpgrade': True,
'AvailabilityZone': 'us-west-2b',
'BackupRetentionPeriod': 7,
'CACertificateIdentifier': 'rds-ca-2015',
'CopyTagsToSnapshot': False,
'DBInstanceArn': 'arn:aws:rds:us-west-2:123456789012:db:mysql-sample-restored',
'DBInstanceClass': 'db.t2.small',
'DBInstanceIdentifier': 'mysql-sample-restored',
'DBInstanceStatus': 'available',
'DBName': 'sample',
'DBParameterGroups': [
{
'DBParameterGroupName': 'default.mysql5.6',
'ParameterApplyStatus': 'in-sync',
},
],
'DBSecurityGroups': [
],
'DBSubnetGroup': {
'DBSubnetGroupDescription': 'default',
'DBSubnetGroupName': 'default',
'SubnetGroupStatus': 'Complete',
'Subnets': [
{
'SubnetAvailabilityZone': {
'Name': 'us-west-2a',
},
'SubnetIdentifier': 'subnet-77e8db03',
'SubnetStatus': 'Active',
},
{
'SubnetAvailabilityZone': {
'Name': 'us-west-2b',
},
'SubnetIdentifier': 'subnet-c39989a1',
'SubnetStatus': 'Active',
},
{
'SubnetAvailabilityZone': {
'Name': 'us-west-2c',
},
'SubnetIdentifier': 'subnet-4b267b0d',
'SubnetStatus': 'Active',
},
],
'VpcId': 'vpc-c1c5b3a3',
},
'DbInstancePort': 0,
'DbiResourceId': 'db-VNZUCCBTEDC4WR7THXNJO72HVQ',
'DomainMemberships': [
],
'Engine': 'mysql',
'EngineVersion': '5.6.27',
'LicenseModel': 'general-public-license',
'MasterUsername': 'mymasteruser',
'MonitoringInterval': 0,
'MultiAZ': False,
'OptionGroupMemberships': [
{
'OptionGroupName': 'default:mysql-5-6',
'Status': 'in-sync',
},
],
'PendingModifiedValues': {
},
'PreferredBackupWindow': '12:58-13:28',
'PreferredMaintenanceWindow': 'tue:10:16-tue:10:46',
'PubliclyAccessible': True,
'ReadReplicaDBInstanceIdentifiers': [
],
'StorageEncrypted': False,
'StorageType': 'gp2',
'VpcSecurityGroups': [
{
'Status': 'active',
'VpcSecurityGroupId': 'sg-e5e5b0d2',
},
],
},
'ResponseMetadata': {
'...': '...',
},
}
revoke_db_security_group_ingress(**kwargs)¶Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC security groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId).
See also: AWS API Documentation
Request Syntax
response = client.revoke_db_security_group_ingress(
DBSecurityGroupName='string',
CIDRIP='string',
EC2SecurityGroupName='string',
EC2SecurityGroupId='string',
EC2SecurityGroupOwnerId='string'
)
[REQUIRED]
The name of the DB security group to revoke ingress from.
CIDRIP is specified, EC2SecurityGroupName , EC2SecurityGroupId and EC2SecurityGroupOwnerId can't be provided.EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.EC2SecurityGroupName parameter. The Amazon Web Services access key ID isn't an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.dict
Response Syntax
{
'DBSecurityGroup': {
'OwnerId': 'string',
'DBSecurityGroupName': 'string',
'DBSecurityGroupDescription': 'string',
'VpcId': 'string',
'EC2SecurityGroups': [
{
'Status': 'string',
'EC2SecurityGroupName': 'string',
'EC2SecurityGroupId': 'string',
'EC2SecurityGroupOwnerId': 'string'
},
],
'IPRanges': [
{
'Status': 'string',
'CIDRIP': 'string'
},
],
'DBSecurityGroupArn': 'string'
}
}
Response Structure
(dict) --
DBSecurityGroup (dict) --
Contains the details for an Amazon RDS DB security group.
This data type is used as a response element in the DescribeDBSecurityGroups action.
OwnerId (string) --
Provides the Amazon Web Services ID of the owner of a specific DB security group.
DBSecurityGroupName (string) --
Specifies the name of the DB security group.
DBSecurityGroupDescription (string) --
Provides the description of the DB security group.
VpcId (string) --
Provides the VpcId of the DB security group.
EC2SecurityGroups (list) --
Contains a list of EC2SecurityGroup elements.
(dict) --
This data type is used as a response element in the following actions:
AuthorizeDBSecurityGroupIngressDescribeDBSecurityGroupsRevokeDBSecurityGroupIngressStatus (string) --
Provides the status of the EC2 security group. Status can be "authorizing", "authorized", "revoking", and "revoked".
EC2SecurityGroupName (string) --
Specifies the name of the EC2 security group.
EC2SecurityGroupId (string) --
Specifies the id of the EC2 security group.
EC2SecurityGroupOwnerId (string) --
Specifies the Amazon Web Services ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.
IPRanges (list) --
Contains a list of IPRange elements.
(dict) --
This data type is used as a response element in the DescribeDBSecurityGroups action.
Status (string) --
Specifies the status of the IP range. Status can be "authorizing", "authorized", "revoking", and "revoked".
CIDRIP (string) --
Specifies the IP range.
DBSecurityGroupArn (string) --
The Amazon Resource Name (ARN) for the DB security group.
Exceptions
RDS.Client.exceptions.DBSecurityGroupNotFoundFaultRDS.Client.exceptions.AuthorizationNotFoundFaultRDS.Client.exceptions.InvalidDBSecurityGroupStateFaultExamples
This example revokes ingress for the specified CIDR block associated with the specified DB security group.
response = client.revoke_db_security_group_ingress(
CIDRIP='203.0.113.5/32',
DBSecurityGroupName='mydbsecuritygroup',
)
print(response)
Expected Output:
{
'DBSecurityGroup': {
},
'ResponseMetadata': {
'...': '...',
},
}
start_activity_stream(**kwargs)¶Starts a database activity stream to monitor activity on the database. For more information, see Database Activity Streams in the Amazon Aurora User Guide .
See also: AWS API Documentation
Request Syntax
response = client.start_activity_stream(
ResourceArn='string',
Mode='sync'|'async',
KmsKeyId='string',
ApplyImmediately=True|False,
EngineNativeAuditFieldsIncluded=True|False
)
[REQUIRED]
The Amazon Resource Name (ARN) of the DB cluster, for example, arn:aws:rds:us-east-1:12345667890:cluster:das-cluster .
[REQUIRED]
Specifies the mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.
[REQUIRED]
The Amazon Web Services KMS key identifier for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
dict
Response Syntax
{
'KmsKeyId': 'string',
'KinesisStreamName': 'string',
'Status': 'stopped'|'starting'|'started'|'stopping',
'Mode': 'sync'|'async',
'ApplyImmediately': True|False,
'EngineNativeAuditFieldsIncluded': True|False
}
Response Structure
(dict) --
KmsKeyId (string) --
The Amazon Web Services KMS key identifier for encryption of messages in the database activity stream.
KinesisStreamName (string) --
The name of the Amazon Kinesis data stream to be used for the database activity stream.
Status (string) --
The status of the database activity stream.
Mode (string) --
The mode of the database activity stream.
ApplyImmediately (boolean) --
Indicates whether or not the database activity stream will start as soon as possible, regardless of the maintenance window for the database.
EngineNativeAuditFieldsIncluded (boolean) --
Indicates whether engine-native audit fields are included in the database activity stream.
Exceptions
RDS.Client.exceptions.InvalidDBInstanceStateFaultRDS.Client.exceptions.InvalidDBClusterStateFaultRDS.Client.exceptions.ResourceNotFoundFaultRDS.Client.exceptions.DBClusterNotFoundFaultRDS.Client.exceptions.DBInstanceNotFoundFaultRDS.Client.exceptions.KMSKeyNotAccessibleFaultstart_db_cluster(**kwargs)¶Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster CLI command, or the StopDBCluster action.
For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide .
Note
This action only applies to Aurora DB clusters.
See also: AWS API Documentation
Request Syntax
response = client.start_db_cluster(
DBClusterIdentifier='string'
)
[REQUIRED]
The DB cluster identifier of the Amazon Aurora DB cluster to be started. This parameter is stored as a lowercase string.
{
'DBCluster': {
'AllocatedStorage': 123,
'AvailabilityZones': [
'string',
],
'BackupRetentionPeriod': 123,
'CharacterSetName': 'string',
'DatabaseName': 'string',
'DBClusterIdentifier': 'string',
'DBClusterParameterGroup': 'string',
'DBSubnetGroup': 'string',
'Status': 'string',
'AutomaticRestartTime': datetime(2015, 1, 1),
'PercentProgress': 'string',
'EarliestRestorableTime': datetime(2015, 1, 1),
'Endpoint': 'string',
'ReaderEndpoint': 'string',
'CustomEndpoints': [
'string',
],
'MultiAZ': True|False,
'Engine': 'string',
'EngineVersion': 'string',
'LatestRestorableTime': datetime(2015, 1, 1),
'Port': 123,
'MasterUsername': 'string',
'DBClusterOptionGroupMemberships': [
{
'DBClusterOptionGroupName': 'string',
'Status': 'string'
},
],
'PreferredBackupWindow': 'string',
'PreferredMaintenanceWindow': 'string',
'ReplicationSourceIdentifier': 'string',
'ReadReplicaIdentifiers': [
'string',
],
'DBClusterMembers': [
{
'DBInstanceIdentifier': 'string',
'IsClusterWriter': True|False,
'DBClusterParameterGroupStatus': 'string',
'PromotionTier': 123
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'HostedZoneId': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbClusterResourceId': 'string',
'DBClusterArn': 'string',
'AssociatedRoles': [
{
'RoleArn': 'string',
'Status': 'string',
'FeatureName': 'string'
},
],
'IAMDatabaseAuthenticationEnabled': True|False,
'CloneGroupId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'EarliestBacktrackTime': datetime(2015, 1, 1),
'BacktrackWindow': 123,
'BacktrackConsumedChangeRecords': 123,
'EnabledCloudwatchLogsExports': [
'string',
],
'Capacity': 123,
'EngineMode': 'string',
'ScalingConfigurationInfo': {
'MinCapacity': 123,
'MaxCapacity': 123,
'AutoPause': True|False,
'SecondsUntilAutoPause': 123,
'TimeoutAction': 'string',
'SecondsBeforeTimeout': 123
},
'DeletionProtection': True|False,
'HttpEndpointEnabled': True|False,
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'CopyTagsToSnapshot': True|False,
'CrossAccountClone': True|False,
'DomainMemberships': [
{
'Domain': 'string',
'Status': 'string',
'FQDN': 'string',
'IAMRoleName': 'string'
},
],
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'GlobalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'unknown',
'GlobalWriteForwardingRequested': True|False,
'PendingModifiedValues': {
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
},
'DBClusterIdentifier': 'string',
'MasterUserPassword': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'EngineVersion': 'string'
},
'DBClusterInstanceClass': 'string',
'StorageType': 'string',
'Iops': 123,
'PubliclyAccessible': True|False,
'AutoMinorVersionUpgrade': True|False,
'MonitoringInterval': 123,
'MonitoringRoleArn': 'string',
'PerformanceInsightsEnabled': True|False,
'PerformanceInsightsKMSKeyId': 'string',
'PerformanceInsightsRetentionPeriod': 123,
'ServerlessV2ScalingConfiguration': {
'MinCapacity': 123.0,
'MaxCapacity': 123.0
}
}
}
Response Structure
Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
For an Amazon Aurora DB cluster, this data type is used as a response element in the operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , FailoverDBCluster , ModifyDBCluster , PromoteReadReplicaDBCluster , RestoreDBClusterFromS3 , RestoreDBClusterFromSnapshot , RestoreDBClusterToPointInTime , StartDBCluster , and StopDBCluster .
For a Multi-AZ DB cluster, this data type is used as a response element in the operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , FailoverDBCluster , ModifyDBCluster , RebootDBCluster , RestoreDBClusterFromSnapshot , and RestoreDBClusterToPointInTime .
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.
Specifies the number of days for which automatic DB snapshots are retained.
If present, specifies the name of the character set that this cluster is associated with.
Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.
Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
Specifies the name of the DB cluster parameter group for the DB cluster.
Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
Specifies the current state of this DB cluster.
The time when a stopped DB cluster is restarted automatically.
Specifies the progress of the operation as a percentage.
The earliest time to which a database can be restored with point-in-time restore.
Specifies the connection endpoint for the primary instance of the DB cluster.
The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.
If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
Identifies all custom endpoints associated with the cluster.
Specifies whether the DB cluster has instances in multiple Availability Zones.
The name of the database engine to be used for this DB cluster.
Indicates the database engine version.
Specifies the latest time to which a database can be restored with point-in-time restore.
Specifies the port that the database engine is listening on.
Contains the master username for the DB cluster.
Provides the list of option group memberships for this DB cluster.
Contains status information for a DB cluster option group.
Specifies the name of the DB cluster option group.
Specifies the status of the DB cluster option group.
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Contains the identifier of the source DB cluster if this DB cluster is a read replica.
Contains one or more identifiers of the read replicas associated with this DB cluster.
Provides the list of instances that make up the DB cluster.
Contains information about an instance that is part of a DB cluster.
Specifies the instance identifier for this member of the DB cluster.
Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
Specifies the status of the DB cluster parameter group for this member of the DB cluster.
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .
Provides a list of VPC security groups that the DB cluster belongs to.
This data type is used as a response element for queries on VPC security group membership.
The name of the VPC security group.
The membership status of the VPC security group.
Currently, the only valid status is active .
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
Specifies whether the DB cluster is encrypted.
If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
The Amazon Resource Name (ARN) for the DB cluster.
Provides a list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.
Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB cluster.
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other Amazon Web Services on your behalf.PENDING - the IAM role ARN is being associated with the DB cluster.INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other Amazon Web Services on your behalf.The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion .
A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
Identifies the clone group to which the DB cluster is associated.
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
The earliest time to which a DB cluster can be backtracked.
The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.
The number of change records stored for Backtrack.
A list of log types that this DB cluster is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.
The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 (zero) when the cluster is paused.
For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide .
The DB engine mode of the DB cluster, either provisioned , serverless , parallelquery , global , or multimaster .
For more information, see CreateDBCluster .
Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.
For more information, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide .
The minimum capacity for an Aurora DB cluster in serverless DB engine mode.
The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.
When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.
The remaining amount of time, in seconds, before the Aurora DB cluster in serverless mode is paused. A DB cluster can be paused only when it's idle (it has no connections).
The action that occurs when Aurora times out while attempting to change the capacity of an Aurora Serverless v1 cluster. The value is either ForceApplyCapacityChange or RollbackCapacityChange .
ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.
RollbackCapacityChangeignores the capacity change if a scaling point isn't found in the timeout period.
The number of seconds before scaling times out. What happens when an attempted scaling action times out is determined by the TimeoutAction setting.
Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
A value that indicates whether the HTTP endpoint for an Aurora Serverless v1 DB cluster is enabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide .
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.
The status of the database activity stream.
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
The name of the Amazon Kinesis data stream used for the database activity stream.
Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.
Specifies whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
The Active Directory Domain membership records associated with the DB cluster.
An Active Directory Domain membership record associated with the DB instance or cluster.
The identifier of the Active Directory Domain.
The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.
The fully qualified domain name of the Active Directory Domain.
The name of the IAM role to be used when making API calls to the Directory Service.
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.
Specifies whether you have requested to enable write forwarding for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.
A value that specifies that changes to the DB cluster are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.
Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.
Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.
The DBClusterIdentifier value for the DB cluster.
The master credentials for the DB cluster.
A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
The database engine version.
The name of the compute and memory capacity class of the DB instance.
This setting is only for non-Aurora Multi-AZ DB clusters.
The storage type associated with the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
The Provisioned IOPS (I/O operations per second) value.
This setting is only for non-Aurora Multi-AZ DB clusters.
Specifies the accessibility options for the DB instance.
When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance .
This setting is only for non-Aurora Multi-AZ DB clusters.
A value that indicates that minor version patches are applied automatically.
This setting is only for non-Aurora Multi-AZ DB clusters.
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
This setting is only for non-Aurora Multi-AZ DB clusters.
True if Performance Insights is enabled for the DB cluster, and otherwise false.
This setting is only for non-Aurora Multi-AZ DB clusters.
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
This setting is only for non-Aurora Multi-AZ DB clusters.
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
For example, the following values are valid:
This setting is only for non-Aurora Multi-AZ DB clusters.
Shows the scaling configuration for an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide .
The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.
The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128.
Exceptions
RDS.Client.exceptions.DBClusterNotFoundFaultRDS.Client.exceptions.InvalidDBClusterStateFaultRDS.Client.exceptions.InvalidDBInstanceStateFaultstart_db_instance(**kwargs)¶Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the StopDBInstance action.
For more information, see Starting an Amazon RDS DB instance That Was Previously Stopped in the Amazon RDS User Guide.
Note
This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora DB clusters, use StartDBCluster instead.
See also: AWS API Documentation
Request Syntax
response = client.start_db_instance(
DBInstanceIdentifier='string'
)
[REQUIRED]
The user-supplied instance identifier.
{
'DBInstance': {
'DBInstanceIdentifier': 'string',
'DBInstanceClass': 'string',
'Engine': 'string',
'DBInstanceStatus': 'string',
'AutomaticRestartTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'DBName': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123,
'HostedZoneId': 'string'
},
'AllocatedStorage': 123,
'InstanceCreateTime': datetime(2015, 1, 1),
'PreferredBackupWindow': 'string',
'BackupRetentionPeriod': 123,
'DBSecurityGroups': [
{
'DBSecurityGroupName': 'string',
'Status': 'string'
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'DBParameterGroups': [
{
'DBParameterGroupName': 'string',
'ParameterApplyStatus': 'string'
},
],
'AvailabilityZone': 'string',
'DBSubnetGroup': {
'DBSubnetGroupName': 'string',
'DBSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetOutpost': {
'Arn': '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',
]
},
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
],
'IAMDatabaseAuthenticationEnabled': True|False,
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1)
},
'LatestRestorableTime': datetime(2015, 1, 1),
'MultiAZ': True|False,
'EngineVersion': 'string',
'AutoMinorVersionUpgrade': True|False,
'ReadReplicaSourceDBInstanceIdentifier': 'string',
'ReadReplicaDBInstanceIdentifiers': [
'string',
],
'ReadReplicaDBClusterIdentifiers': [
'string',
],
'ReplicaMode': 'open-read-only'|'mounted',
'LicenseModel': 'string',
'Iops': 123,
'OptionGroupMemberships': [
{
'OptionGroupName': 'string',
'Status': 'string'
},
],
'CharacterSetName': 'string',
'NcharCharacterSetName': 'string',
'SecondaryAvailabilityZone': 'string',
'PubliclyAccessible': True|False,
'StatusInfos': [
{
'StatusType': 'string',
'Normal': True|False,
'Status': 'string',
'Message': 'string'
},
],
'StorageType': 'string',
'TdeCredentialArn': 'string',
'DbInstancePort': 123,
'DBClusterIdentifier': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbiResourceId': 'string',
'CACertificateIdentifier': 'string',
'DomainMemberships': [
{
'Domain': 'string',
'Status': 'string',
'FQDN': 'string',
'IAMRoleName': 'string'
},
],
'CopyTagsToSnapshot': True|False,
'MonitoringInterval': 123,
'EnhancedMonitoringResourceArn': 'string',
'MonitoringRoleArn': 'string',
'PromotionTier': 123,
'DBInstanceArn': 'string',
'Timezone': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'PerformanceInsightsEnabled': True|False,
'PerformanceInsightsKMSKeyId': 'string',
'PerformanceInsightsRetentionPeriod': 123,
'EnabledCloudwatchLogsExports': [
'string',
],
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
],
'DeletionProtection': True|False,
'AssociatedRoles': [
{
'RoleArn': 'string',
'FeatureName': 'string',
'Status': 'string'
},
],
'ListenerEndpoint': {
'Address': 'string',
'Port': 123,
'HostedZoneId': 'string'
},
'MaxAllocatedStorage': 123,
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'DBInstanceAutomatedBackupsReplications': [
{
'DBInstanceAutomatedBackupsArn': 'string'
},
],
'CustomerOwnedIpEnabled': True|False,
'AwsBackupRecoveryPointArn': 'string',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamEngineNativeAuditFieldsIncluded': True|False,
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1),
'CustomIamInstanceProfile': 'string',
'BackupTarget': 'string',
'NetworkType': 'string',
'ActivityStreamPolicyStatus': 'locked'|'unlocked'|'locking-policy'|'unlocking-policy'
}
}
Response Structure
Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations CreateDBInstance , CreateDBInstanceReadReplica , DeleteDBInstance , DescribeDBInstances , ModifyDBInstance , PromoteReadReplica , RebootDBInstance , RestoreDBInstanceFromDBSnapshot , RestoreDBInstanceFromS3 , RestoreDBInstanceToPointInTime , StartDBInstance , and StopDBInstance .
Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
Contains the name of the compute and memory capacity class of the DB instance.
The name of the database engine to be used for this DB instance.
Specifies the current state of this database.
For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.
The time when a stopped DB instance is restarted automatically.
Contains the master username for the DB instance.
The meaning of this parameter differs according to the database engine you use.
MySQL, MariaDB, SQL Server, PostgreSQL
Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
Type: String
Oracle
Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
Specifies the connection endpoint.
Note
The endpoint might not be shown for instances whose status is creating .
Specifies the DNS address of the DB instance.
Specifies the port that the database engine is listening on.
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
Specifies the allocated storage size specified in gibibytes (GiB).
Provides the date and time the DB instance was created.
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .
Specifies the number of days for which automatic DB snapshots are retained.
A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
This data type is used as a response element in the following actions:
ModifyDBInstanceRebootDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceToPointInTimeThe name of the DB security group.
The status of the DB security group.
Provides a list of VPC security group elements that the DB instance belongs to.
This data type is used as a response element for queries on VPC security group membership.
The name of the VPC security group.
The membership status of the VPC security group.
Currently, the only valid status is active .
Provides the list of DB parameter groups applied to this DB instance.
The status of the DB parameter group.
This data type is used as a response element in the following actions:
CreateDBInstanceCreateDBInstanceReadReplicaDeleteDBInstanceModifyDBInstanceRebootDBInstanceRestoreDBInstanceFromDBSnapshotThe name of the DB parameter group.
The status of parameter updates.
Specifies the name of the Availability Zone the DB instance is located in.
Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
The name of the DB subnet group.
Provides the description of the DB subnet group.
Provides the VpcId of the DB subnet group.
Provides the status of the DB subnet group.
Contains a list of Subnet elements.
This data type is used as a response element for the DescribeDBSubnetGroups operation.
The identifier of the subnet.
Contains Availability Zone information.
This data type is used as an element in the OrderableDBInstanceOption data type.
The name of the Availability Zone.
If the subnet is associated with an Outpost, this value specifies the Outpost.
For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
The Amazon Resource Name (ARN) of the Outpost.
The status of the subnet.
The Amazon Resource Name (ARN) for the DB subnet group.
The network type of the DB subnet group.
Valid values:
IPV4DUALA DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
A value that specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
The name of the compute and memory capacity class for the DB instance.
The allocated storage size for the DB instance specified in gibibytes (GiB).
The master credentials for the DB instance.
The port for the DB instance.
The number of days for which automated backups are retained.
A value that indicates that the Single-AZ DB instance will change to a Multi-AZ deployment.
The database engine version.
The license model for the DB instance.
Valid values: license-included | bring-your-own-license | general-public-license
The Provisioned IOPS value for the DB instance.
The database identifier for the DB instance.
The storage type of the DB instance.
The identifier of the CA certificate for the DB instance.
The DB subnet group for the DB instance.
A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.
Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.
Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstanceModifyDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceFromS3RestoreDBInstanceToPointInTimeYou can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstancesDescribeDBSnapshotsDescribeValidDBInstanceModificationsIf you call DescribeDBInstances , ProcessorFeature returns non-null values only if the following conditions are met:
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
The name of the processor feature. Valid names are coreCount and threadsPerCore .
The value of a processor feature name.
Whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
The automation mode of the RDS Custom DB instance: full or all-paused . If full , the DB instance automates monitoring and instance recovery. If all-paused , the instance pauses automation for the duration set by --resume-full-automation-mode-minutes .
The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
Specifies the latest time to which a database can be restored with point-in-time restore.
Specifies if the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom.
Indicates the database engine version.
A value that indicates that minor version patches are applied automatically.
Contains the identifier of the source DB instance if this DB instance is a read replica.
Contains one or more identifiers of the read replicas associated with this DB instance.
Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn't contain information about cross-Region Aurora read replicas.
Note
Currently, each RDS DB instance can have only one Aurora read replica.
The open mode of an Oracle read replica. The default is open-read-only . For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide .
Note
This attribute is only supported in RDS for Oracle.
License model information for this DB instance. This setting doesn't apply to RDS Custom.
Specifies the Provisioned IOPS (I/O operations per second) value.
Provides the list of option group memberships for this DB instance.
Provides information on the option groups the DB instance is a member of.
The name of the option group that the instance belongs to.
The status of the DB instance's option group membership. Valid values are: in-sync , pending-apply , pending-removal , pending-maintenance-apply , pending-maintenance-removal , applying , removing , and failed .
If present, specifies the name of the character set that this instance is associated with.
The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.
If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
Specifies the accessibility options for the DB instance.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance .
The status of a read replica. If the instance isn't a read replica, this is blank.
Provides a list of status information for a DB instance.
This value is currently "read replication."
Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.
Status of the DB instance. For a StatusType of read replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.
Details of the error if there is an error for the instance. If the instance isn't in an error state, this value is blank.
Specifies the storage type associated with DB instance.
The ARN from the key store with which the instance is associated for TDE encryption.
Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.
If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.
Specifies whether the DB instance is encrypted.
If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB instance is accessed.
The identifier of the CA certificate for this DB instance.
The Active Directory Domain membership records associated with the DB instance.
An Active Directory Domain membership record associated with the DB instance or cluster.
The identifier of the Active Directory Domain.
The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.
The fully qualified domain name of the Active Directory Domain.
The name of the IAM role to be used when making API calls to the Directory Service.
Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see DBCluster .
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .
The Amazon Resource Name (ARN) for the DB instance.
The time zone of the DB instance. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
IAM database authentication can be enabled for the following database engines
True if Performance Insights is enabled for the DB instance, and otherwise false.
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
For example, the following values are valid:
A list of log types that this DB instance is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon RDS User Guide.
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstanceModifyDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceFromS3RestoreDBInstanceToPointInTimeYou can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstancesDescribeDBSnapshotsDescribeValidDBInstanceModificationsIf you call DescribeDBInstances , ProcessorFeature returns non-null values only if the following conditions are met:
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
The name of the processor feature. Valid names are coreCount and threadsPerCore .
The value of a processor feature name.
Indicates if the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance .
The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance.
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.
The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion .
Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf.PENDING - the IAM role ARN is being associated with the DB instance.INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf.Specifies the listener connection endpoint for SQL Server Always On.
Specifies the DNS address of the DB instance.
Specifies the port that the database engine is listening on.
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
The list of replicated automated backups associated with the DB instance.
Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties.
The Amazon Resource Name (ARN) of the replicated automated backups.
Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide .
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide .
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
The status of the database activity stream.
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
The name of the Amazon Kinesis data stream used for the database activity stream.
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. RDS for Oracle always handles these events asynchronously.
Indicates whether engine-native audit fields are included in the database activity stream.
The automation mode of the RDS Custom DB instance: full or all paused . If full , the DB instance automates monitoring and instance recovery. If all paused , the instance pauses automation for the duration set by --resume-full-automation-mode-minutes .
The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
AWSRDSCustom .For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide .
Specifies where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
The network type of the DB instance.
Valid values:
IPV4DUALThe network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide and Working with a DB instance in a VPC in the Amazon Aurora User Guide.
The status of the policy state of the activity stream.
Exceptions
RDS.Client.exceptions.DBInstanceNotFoundFaultRDS.Client.exceptions.InvalidDBInstanceStateFaultRDS.Client.exceptions.InsufficientDBInstanceCapacityFaultRDS.Client.exceptions.DBSubnetGroupNotFoundFaultRDS.Client.exceptions.DBSubnetGroupDoesNotCoverEnoughAZsRDS.Client.exceptions.InvalidDBClusterStateFaultRDS.Client.exceptions.InvalidSubnetRDS.Client.exceptions.InvalidVPCNetworkStateFaultRDS.Client.exceptions.DBClusterNotFoundFaultRDS.Client.exceptions.AuthorizationNotFoundFaultRDS.Client.exceptions.KMSKeyNotAccessibleFaultstart_db_instance_automated_backups_replication(**kwargs)¶Enables replication of automated backups to a different Amazon Web Services Region.
This command doesn't apply to RDS Custom.
For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.
See also: AWS API Documentation
Request Syntax
response = client.start_db_instance_automated_backups_replication(
SourceDBInstanceArn='string',
BackupRetentionPeriod=123,
KmsKeyId='string',
SourceRegion='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the source DB instance for the replicated automated backups, for example, arn:aws:rds:us-west-2:123456789012:db:mydatabase .
arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE .In an Amazon Web Services GovCloud (US) Region, an URL that contains a Signature Version 4 signed request for the StartDBInstanceAutomatedBackupsReplication operation to call in the Amazon Web Services Region of the source DB instance. The presigned URL must be a valid request for the StartDBInstanceAutomatedBackupsReplication API operation that can run in the Amazon Web Services Region that contains the source DB instance.
This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other Amazon Web Services Regions.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process .
Note
If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.
Please note that this parameter is automatically populated if it is not provided. Including this parameter is not required
dict
Response Syntax
{
'DBInstanceAutomatedBackup': {
'DBInstanceArn': 'string',
'DbiResourceId': 'string',
'Region': 'string',
'DBInstanceIdentifier': 'string',
'RestoreWindow': {
'EarliestTime': datetime(2015, 1, 1),
'LatestTime': datetime(2015, 1, 1)
},
'AllocatedStorage': 123,
'Status': 'string',
'Port': 123,
'AvailabilityZone': 'string',
'VpcId': 'string',
'InstanceCreateTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'LicenseModel': 'string',
'Iops': 123,
'OptionGroupName': 'string',
'TdeCredentialArn': 'string',
'Encrypted': True|False,
'StorageType': 'string',
'KmsKeyId': 'string',
'Timezone': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'BackupRetentionPeriod': 123,
'DBInstanceAutomatedBackupsArn': 'string',
'DBInstanceAutomatedBackupsReplications': [
{
'DBInstanceAutomatedBackupsArn': 'string'
},
],
'BackupTarget': 'string'
}
}
Response Structure
(dict) --
DBInstanceAutomatedBackup (dict) --
An automated backup of a DB instance. It consists of system backups, transaction logs, and the database instance properties that existed at the time you deleted the source instance.
DBInstanceArn (string) --
The Amazon Resource Name (ARN) for the automated backups.
DbiResourceId (string) --
The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
Region (string) --
The Amazon Web Services Region associated with the automated backup.
DBInstanceIdentifier (string) --
The customer id of the instance that is/was associated with the automated backup.
RestoreWindow (dict) --
Earliest and latest time an instance can be restored to.
EarliestTime (datetime) --
The earliest time you can restore an instance to.
LatestTime (datetime) --
The latest time you can restore an instance to.
AllocatedStorage (integer) --
Specifies the allocated storage size in gibibytes (GiB).
Status (string) --
Provides a list of status information for an automated backup:
active - automated backups for current instancesretained - automated backups for deleted instancescreating - automated backups that are waiting for the first automated snapshot to be available.Port (integer) --
The port number that the automated backup used for connections.
Default: Inherits from the source DB instance
Valid Values: 1150-65535
AvailabilityZone (string) --
The Availability Zone that the automated backup was created in. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones .
VpcId (string) --
Provides the VPC ID associated with the DB instance
InstanceCreateTime (datetime) --
Provides the date and time that the DB instance was created.
MasterUsername (string) --
The license model of an automated backup.
Engine (string) --
The name of the database engine for this automated backup.
EngineVersion (string) --
The version of the database engine for the automated backup.
LicenseModel (string) --
License model information for the automated backup.
Iops (integer) --
The IOPS (I/O operations per second) value for the automated backup.
OptionGroupName (string) --
The option group the automated backup is associated with. If omitted, the default option group for the engine specified is used.
TdeCredentialArn (string) --
The ARN from the key store with which the automated backup is associated for TDE encryption.
Encrypted (boolean) --
Specifies whether the automated backup is encrypted.
StorageType (string) --
Specifies the storage type associated with the automated backup.
KmsKeyId (string) --
The Amazon Web Services KMS key ID for an automated backup.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
Timezone (string) --
The time zone of the automated backup. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.
IAMDatabaseAuthenticationEnabled (boolean) --
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
BackupRetentionPeriod (integer) --
The retention period for the automated backups.
DBInstanceAutomatedBackupsArn (string) --
The Amazon Resource Name (ARN) for the replicated automated backups.
DBInstanceAutomatedBackupsReplications (list) --
The list of replications to different Amazon Web Services Regions associated with the automated backup.
(dict) --
Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties.
DBInstanceAutomatedBackupsArn (string) --
The Amazon Resource Name (ARN) of the replicated automated backups.
BackupTarget (string) --
Specifies where automated backups are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
Exceptions
RDS.Client.exceptions.DBInstanceNotFoundFaultRDS.Client.exceptions.InvalidDBInstanceStateFaultRDS.Client.exceptions.KMSKeyNotAccessibleFaultRDS.Client.exceptions.DBInstanceAutomatedBackupQuotaExceededFaultRDS.Client.exceptions.StorageTypeNotSupportedFaultstart_export_task(**kwargs)¶Starts an export of a snapshot to Amazon S3. The provided IAM role must have access to the S3 bucket.
This command doesn't apply to RDS Custom.
See also: AWS API Documentation
Request Syntax
response = client.start_export_task(
ExportTaskIdentifier='string',
SourceArn='string',
S3BucketName='string',
IamRoleArn='string',
KmsKeyId='string',
S3Prefix='string',
ExportOnly=[
'string',
]
)
[REQUIRED]
A unique identifier for the snapshot export task. This ID isn't an identifier for the Amazon S3 bucket where the snapshot is to be exported to.
[REQUIRED]
The Amazon Resource Name (ARN) of the snapshot to export to Amazon S3.
[REQUIRED]
The name of the Amazon S3 bucket to export the snapshot to.
[REQUIRED]
The name of the IAM role to use for writing to the Amazon S3 bucket when exporting a snapshot.
[REQUIRED]
The ID of the Amazon Web Services KMS key to use to encrypt the snapshot exported to Amazon S3. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. The caller of this operation must be authorized to execute the following operations. These can be set in the Amazon Web Services KMS key policy:
The data to be exported from the snapshot. If this parameter is not provided, all the snapshot data is exported. Valid values are the following:
database - Export all the data from a specified database.database.table table-name - Export a table of the snapshot. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.database.schema schema-name - Export a database schema of the snapshot. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.database.schema.table table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.dict
Response Syntax
{
'ExportTaskIdentifier': 'string',
'SourceArn': 'string',
'ExportOnly': [
'string',
],
'SnapshotTime': datetime(2015, 1, 1),
'TaskStartTime': datetime(2015, 1, 1),
'TaskEndTime': datetime(2015, 1, 1),
'S3Bucket': 'string',
'S3Prefix': 'string',
'IamRoleArn': 'string',
'KmsKeyId': 'string',
'Status': 'string',
'PercentProgress': 123,
'TotalExtractedDataInGB': 123,
'FailureCause': 'string',
'WarningMessage': 'string'
}
Response Structure
(dict) --
Contains the details of a snapshot export to Amazon S3.
This data type is used as a response element in the DescribeExportTasks action.
ExportTaskIdentifier (string) --
A unique identifier for the snapshot export task. This ID isn't an identifier for the Amazon S3 bucket where the snapshot is exported to.
SourceArn (string) --
The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.
ExportOnly (list) --
The data exported from the snapshot. Valid values are the following:
database - Export all the data from a specified database.database.table table-name - Export a table of the snapshot. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.database.schema schema-name - Export a database schema of the snapshot. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.database.schema.table table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.SnapshotTime (datetime) --
The time that the snapshot was created.
TaskStartTime (datetime) --
The time that the snapshot export task started.
TaskEndTime (datetime) --
The time that the snapshot export task completed.
S3Bucket (string) --
The Amazon S3 bucket that the snapshot is exported to.
S3Prefix (string) --
The Amazon S3 bucket prefix that is the file name and path of the exported snapshot.
IamRoleArn (string) --
The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot.
KmsKeyId (string) --
The key identifier of the Amazon Web Services KMS key that is used to encrypt the snapshot when it's exported to Amazon S3. The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the snapshot export must have encryption and decryption permissions to use this KMS key.
Status (string) --
The progress status of the export task.
PercentProgress (integer) --
The progress of the snapshot export task as a percentage.
TotalExtractedDataInGB (integer) --
The total amount of data exported, in gigabytes.
FailureCause (string) --
The reason the export failed, if it failed.
WarningMessage (string) --
A warning about the snapshot export task.
Exceptions
RDS.Client.exceptions.DBSnapshotNotFoundFaultRDS.Client.exceptions.DBClusterSnapshotNotFoundFaultRDS.Client.exceptions.ExportTaskAlreadyExistsFaultRDS.Client.exceptions.InvalidS3BucketFaultRDS.Client.exceptions.IamRoleNotFoundFaultRDS.Client.exceptions.IamRoleMissingPermissionsFaultRDS.Client.exceptions.InvalidExportOnlyFaultRDS.Client.exceptions.KMSKeyNotAccessibleFaultRDS.Client.exceptions.InvalidExportSourceStateFaultstop_activity_stream(**kwargs)¶Stops a database activity stream that was started using the Amazon Web Services console, the start-activity-stream CLI command, or the StartActivityStream action.
For more information, see Database Activity Streams in the Amazon Aurora User Guide .
See also: AWS API Documentation
Request Syntax
response = client.stop_activity_stream(
ResourceArn='string',
ApplyImmediately=True|False
)
[REQUIRED]
The Amazon Resource Name (ARN) of the DB cluster for the database activity stream. For example, arn:aws:rds:us-east-1:12345667890:cluster:das-cluster .
dict
Response Syntax
{
'KmsKeyId': 'string',
'KinesisStreamName': 'string',
'Status': 'stopped'|'starting'|'started'|'stopping'
}
Response Structure
(dict) --
KmsKeyId (string) --
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
KinesisStreamName (string) --
The name of the Amazon Kinesis data stream used for the database activity stream.
Status (string) --
The status of the database activity stream.
Exceptions
RDS.Client.exceptions.InvalidDBInstanceStateFaultRDS.Client.exceptions.InvalidDBClusterStateFaultRDS.Client.exceptions.ResourceNotFoundFaultRDS.Client.exceptions.DBClusterNotFoundFaultRDS.Client.exceptions.DBInstanceNotFoundFaultstop_db_cluster(**kwargs)¶Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster's metadata, including its endpoints and DB parameter groups. Aurora also retains the transaction logs so you can do a point-in-time restore if necessary.
For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide .
Note
This action only applies to Aurora DB clusters.
See also: AWS API Documentation
Request Syntax
response = client.stop_db_cluster(
DBClusterIdentifier='string'
)
[REQUIRED]
The DB cluster identifier of the Amazon Aurora DB cluster to be stopped. This parameter is stored as a lowercase string.
{
'DBCluster': {
'AllocatedStorage': 123,
'AvailabilityZones': [
'string',
],
'BackupRetentionPeriod': 123,
'CharacterSetName': 'string',
'DatabaseName': 'string',
'DBClusterIdentifier': 'string',
'DBClusterParameterGroup': 'string',
'DBSubnetGroup': 'string',
'Status': 'string',
'AutomaticRestartTime': datetime(2015, 1, 1),
'PercentProgress': 'string',
'EarliestRestorableTime': datetime(2015, 1, 1),
'Endpoint': 'string',
'ReaderEndpoint': 'string',
'CustomEndpoints': [
'string',
],
'MultiAZ': True|False,
'Engine': 'string',
'EngineVersion': 'string',
'LatestRestorableTime': datetime(2015, 1, 1),
'Port': 123,
'MasterUsername': 'string',
'DBClusterOptionGroupMemberships': [
{
'DBClusterOptionGroupName': 'string',
'Status': 'string'
},
],
'PreferredBackupWindow': 'string',
'PreferredMaintenanceWindow': 'string',
'ReplicationSourceIdentifier': 'string',
'ReadReplicaIdentifiers': [
'string',
],
'DBClusterMembers': [
{
'DBInstanceIdentifier': 'string',
'IsClusterWriter': True|False,
'DBClusterParameterGroupStatus': 'string',
'PromotionTier': 123
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'HostedZoneId': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbClusterResourceId': 'string',
'DBClusterArn': 'string',
'AssociatedRoles': [
{
'RoleArn': 'string',
'Status': 'string',
'FeatureName': 'string'
},
],
'IAMDatabaseAuthenticationEnabled': True|False,
'CloneGroupId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'EarliestBacktrackTime': datetime(2015, 1, 1),
'BacktrackWindow': 123,
'BacktrackConsumedChangeRecords': 123,
'EnabledCloudwatchLogsExports': [
'string',
],
'Capacity': 123,
'EngineMode': 'string',
'ScalingConfigurationInfo': {
'MinCapacity': 123,
'MaxCapacity': 123,
'AutoPause': True|False,
'SecondsUntilAutoPause': 123,
'TimeoutAction': 'string',
'SecondsBeforeTimeout': 123
},
'DeletionProtection': True|False,
'HttpEndpointEnabled': True|False,
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'CopyTagsToSnapshot': True|False,
'CrossAccountClone': True|False,
'DomainMemberships': [
{
'Domain': 'string',
'Status': 'string',
'FQDN': 'string',
'IAMRoleName': 'string'
},
],
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'GlobalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'unknown',
'GlobalWriteForwardingRequested': True|False,
'PendingModifiedValues': {
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
},
'DBClusterIdentifier': 'string',
'MasterUserPassword': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'EngineVersion': 'string'
},
'DBClusterInstanceClass': 'string',
'StorageType': 'string',
'Iops': 123,
'PubliclyAccessible': True|False,
'AutoMinorVersionUpgrade': True|False,
'MonitoringInterval': 123,
'MonitoringRoleArn': 'string',
'PerformanceInsightsEnabled': True|False,
'PerformanceInsightsKMSKeyId': 'string',
'PerformanceInsightsRetentionPeriod': 123,
'ServerlessV2ScalingConfiguration': {
'MinCapacity': 123.0,
'MaxCapacity': 123.0
}
}
}
Response Structure
Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
For an Amazon Aurora DB cluster, this data type is used as a response element in the operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , FailoverDBCluster , ModifyDBCluster , PromoteReadReplicaDBCluster , RestoreDBClusterFromS3 , RestoreDBClusterFromSnapshot , RestoreDBClusterToPointInTime , StartDBCluster , and StopDBCluster .
For a Multi-AZ DB cluster, this data type is used as a response element in the operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , FailoverDBCluster , ModifyDBCluster , RebootDBCluster , RestoreDBClusterFromSnapshot , and RestoreDBClusterToPointInTime .
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.
Specifies the number of days for which automatic DB snapshots are retained.
If present, specifies the name of the character set that this cluster is associated with.
Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.
Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
Specifies the name of the DB cluster parameter group for the DB cluster.
Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
Specifies the current state of this DB cluster.
The time when a stopped DB cluster is restarted automatically.
Specifies the progress of the operation as a percentage.
The earliest time to which a database can be restored with point-in-time restore.
Specifies the connection endpoint for the primary instance of the DB cluster.
The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.
If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
Identifies all custom endpoints associated with the cluster.
Specifies whether the DB cluster has instances in multiple Availability Zones.
The name of the database engine to be used for this DB cluster.
Indicates the database engine version.
Specifies the latest time to which a database can be restored with point-in-time restore.
Specifies the port that the database engine is listening on.
Contains the master username for the DB cluster.
Provides the list of option group memberships for this DB cluster.
Contains status information for a DB cluster option group.
Specifies the name of the DB cluster option group.
Specifies the status of the DB cluster option group.
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Contains the identifier of the source DB cluster if this DB cluster is a read replica.
Contains one or more identifiers of the read replicas associated with this DB cluster.
Provides the list of instances that make up the DB cluster.
Contains information about an instance that is part of a DB cluster.
Specifies the instance identifier for this member of the DB cluster.
Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
Specifies the status of the DB cluster parameter group for this member of the DB cluster.
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .
Provides a list of VPC security groups that the DB cluster belongs to.
This data type is used as a response element for queries on VPC security group membership.
The name of the VPC security group.
The membership status of the VPC security group.
Currently, the only valid status is active .
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
Specifies whether the DB cluster is encrypted.
If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
The Amazon Resource Name (ARN) for the DB cluster.
Provides a list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.
Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB cluster.
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other Amazon Web Services on your behalf.PENDING - the IAM role ARN is being associated with the DB cluster.INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other Amazon Web Services on your behalf.The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion .
A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
Identifies the clone group to which the DB cluster is associated.
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
The earliest time to which a DB cluster can be backtracked.
The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.
The number of change records stored for Backtrack.
A list of log types that this DB cluster is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.
The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 (zero) when the cluster is paused.
For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide .
The DB engine mode of the DB cluster, either provisioned , serverless , parallelquery , global , or multimaster .
For more information, see CreateDBCluster .
Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.
For more information, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide .
The minimum capacity for an Aurora DB cluster in serverless DB engine mode.
The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.
When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.
The remaining amount of time, in seconds, before the Aurora DB cluster in serverless mode is paused. A DB cluster can be paused only when it's idle (it has no connections).
The action that occurs when Aurora times out while attempting to change the capacity of an Aurora Serverless v1 cluster. The value is either ForceApplyCapacityChange or RollbackCapacityChange .
ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.
RollbackCapacityChangeignores the capacity change if a scaling point isn't found in the timeout period.
The number of seconds before scaling times out. What happens when an attempted scaling action times out is determined by the TimeoutAction setting.
Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
A value that indicates whether the HTTP endpoint for an Aurora Serverless v1 DB cluster is enabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide .
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.
The status of the database activity stream.
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
The name of the Amazon Kinesis data stream used for the database activity stream.
Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.
Specifies whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
The Active Directory Domain membership records associated with the DB cluster.
An Active Directory Domain membership record associated with the DB instance or cluster.
The identifier of the Active Directory Domain.
The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.
The fully qualified domain name of the Active Directory Domain.
The name of the IAM role to be used when making API calls to the Directory Service.
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.
Specifies whether you have requested to enable write forwarding for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.
A value that specifies that changes to the DB cluster are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.
Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.
Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.
The DBClusterIdentifier value for the DB cluster.
The master credentials for the DB cluster.
A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
The database engine version.
The name of the compute and memory capacity class of the DB instance.
This setting is only for non-Aurora Multi-AZ DB clusters.
The storage type associated with the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
The Provisioned IOPS (I/O operations per second) value.
This setting is only for non-Aurora Multi-AZ DB clusters.
Specifies the accessibility options for the DB instance.
When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance .
This setting is only for non-Aurora Multi-AZ DB clusters.
A value that indicates that minor version patches are applied automatically.
This setting is only for non-Aurora Multi-AZ DB clusters.
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
This setting is only for non-Aurora Multi-AZ DB clusters.
True if Performance Insights is enabled for the DB cluster, and otherwise false.
This setting is only for non-Aurora Multi-AZ DB clusters.
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
This setting is only for non-Aurora Multi-AZ DB clusters.
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
For example, the following values are valid:
This setting is only for non-Aurora Multi-AZ DB clusters.
Shows the scaling configuration for an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide .
The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.
The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128.
Exceptions
RDS.Client.exceptions.DBClusterNotFoundFaultRDS.Client.exceptions.InvalidDBClusterStateFaultRDS.Client.exceptions.InvalidDBInstanceStateFaultstop_db_instance(**kwargs)¶Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if necessary.
For more information, see Stopping an Amazon RDS DB Instance Temporarily in the Amazon RDS User Guide.
Note
This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora clusters, use StopDBCluster instead.
See also: AWS API Documentation
Request Syntax
response = client.stop_db_instance(
DBInstanceIdentifier='string',
DBSnapshotIdentifier='string'
)
[REQUIRED]
The user-supplied instance identifier.
dict
Response Syntax
{
'DBInstance': {
'DBInstanceIdentifier': 'string',
'DBInstanceClass': 'string',
'Engine': 'string',
'DBInstanceStatus': 'string',
'AutomaticRestartTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'DBName': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123,
'HostedZoneId': 'string'
},
'AllocatedStorage': 123,
'InstanceCreateTime': datetime(2015, 1, 1),
'PreferredBackupWindow': 'string',
'BackupRetentionPeriod': 123,
'DBSecurityGroups': [
{
'DBSecurityGroupName': 'string',
'Status': 'string'
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'DBParameterGroups': [
{
'DBParameterGroupName': 'string',
'ParameterApplyStatus': 'string'
},
],
'AvailabilityZone': 'string',
'DBSubnetGroup': {
'DBSubnetGroupName': 'string',
'DBSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetOutpost': {
'Arn': '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',
]
},
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
],
'IAMDatabaseAuthenticationEnabled': True|False,
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1)
},
'LatestRestorableTime': datetime(2015, 1, 1),
'MultiAZ': True|False,
'EngineVersion': 'string',
'AutoMinorVersionUpgrade': True|False,
'ReadReplicaSourceDBInstanceIdentifier': 'string',
'ReadReplicaDBInstanceIdentifiers': [
'string',
],
'ReadReplicaDBClusterIdentifiers': [
'string',
],
'ReplicaMode': 'open-read-only'|'mounted',
'LicenseModel': 'string',
'Iops': 123,
'OptionGroupMemberships': [
{
'OptionGroupName': 'string',
'Status': 'string'
},
],
'CharacterSetName': 'string',
'NcharCharacterSetName': 'string',
'SecondaryAvailabilityZone': 'string',
'PubliclyAccessible': True|False,
'StatusInfos': [
{
'StatusType': 'string',
'Normal': True|False,
'Status': 'string',
'Message': 'string'
},
],
'StorageType': 'string',
'TdeCredentialArn': 'string',
'DbInstancePort': 123,
'DBClusterIdentifier': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbiResourceId': 'string',
'CACertificateIdentifier': 'string',
'DomainMemberships': [
{
'Domain': 'string',
'Status': 'string',
'FQDN': 'string',
'IAMRoleName': 'string'
},
],
'CopyTagsToSnapshot': True|False,
'MonitoringInterval': 123,
'EnhancedMonitoringResourceArn': 'string',
'MonitoringRoleArn': 'string',
'PromotionTier': 123,
'DBInstanceArn': 'string',
'Timezone': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'PerformanceInsightsEnabled': True|False,
'PerformanceInsightsKMSKeyId': 'string',
'PerformanceInsightsRetentionPeriod': 123,
'EnabledCloudwatchLogsExports': [
'string',
],
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
],
'DeletionProtection': True|False,
'AssociatedRoles': [
{
'RoleArn': 'string',
'FeatureName': 'string',
'Status': 'string'
},
],
'ListenerEndpoint': {
'Address': 'string',
'Port': 123,
'HostedZoneId': 'string'
},
'MaxAllocatedStorage': 123,
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'DBInstanceAutomatedBackupsReplications': [
{
'DBInstanceAutomatedBackupsArn': 'string'
},
],
'CustomerOwnedIpEnabled': True|False,
'AwsBackupRecoveryPointArn': 'string',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamEngineNativeAuditFieldsIncluded': True|False,
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1),
'CustomIamInstanceProfile': 'string',
'BackupTarget': 'string',
'NetworkType': 'string',
'ActivityStreamPolicyStatus': 'locked'|'unlocked'|'locking-policy'|'unlocking-policy'
}
}
Response Structure
(dict) --
DBInstance (dict) --
Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations CreateDBInstance , CreateDBInstanceReadReplica , DeleteDBInstance , DescribeDBInstances , ModifyDBInstance , PromoteReadReplica , RebootDBInstance , RestoreDBInstanceFromDBSnapshot , RestoreDBInstanceFromS3 , RestoreDBInstanceToPointInTime , StartDBInstance , and StopDBInstance .
DBInstanceIdentifier (string) --
Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
DBInstanceClass (string) --
Contains the name of the compute and memory capacity class of the DB instance.
Engine (string) --
The name of the database engine to be used for this DB instance.
DBInstanceStatus (string) --
Specifies the current state of this database.
For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.
AutomaticRestartTime (datetime) --
The time when a stopped DB instance is restarted automatically.
MasterUsername (string) --
Contains the master username for the DB instance.
DBName (string) --
The meaning of this parameter differs according to the database engine you use.
MySQL, MariaDB, SQL Server, PostgreSQL
Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
Type: String
Oracle
Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
Endpoint (dict) --
Specifies the connection endpoint.
Note
The endpoint might not be shown for instances whose status is creating .
Address (string) --
Specifies the DNS address of the DB 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.
AllocatedStorage (integer) --
Specifies the allocated storage size specified in gibibytes (GiB).
InstanceCreateTime (datetime) --
Provides the date and time the DB 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 DB snapshots are retained.
DBSecurityGroups (list) --
A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
(dict) --
This data type is used as a response element in the following actions:
ModifyDBInstanceRebootDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceToPointInTimeDBSecurityGroupName (string) --
The name of the DB security group.
Status (string) --
The status of the DB security group.
VpcSecurityGroups (list) --
Provides a list of VPC security group elements that the DB instance belongs to.
(dict) --
This data type is used as a response element for queries on VPC security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The membership status of the VPC security group.
Currently, the only valid status is active .
DBParameterGroups (list) --
Provides the list of DB parameter groups applied to this DB instance.
(dict) --
The status of the DB parameter group.
This data type is used as a response element in the following actions:
CreateDBInstanceCreateDBInstanceReadReplicaDeleteDBInstanceModifyDBInstanceRebootDBInstanceRestoreDBInstanceFromDBSnapshotDBParameterGroupName (string) --
The name of the DB parameter group.
ParameterApplyStatus (string) --
The status of parameter updates.
AvailabilityZone (string) --
Specifies the name of the Availability Zone the DB instance is located in.
DBSubnetGroup (dict) --
Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
DBSubnetGroupName (string) --
The name of the DB subnet group.
DBSubnetGroupDescription (string) --
Provides the description of the DB subnet group.
VpcId (string) --
Provides the VpcId of the DB subnet group.
SubnetGroupStatus (string) --
Provides the status of the DB subnet group.
Subnets (list) --
Contains a list of Subnet elements.
(dict) --
This data type is used as a response element for the DescribeDBSubnetGroups operation.
SubnetIdentifier (string) --
The identifier of the subnet.
SubnetAvailabilityZone (dict) --
Contains Availability Zone information.
This data type is used as an element in the OrderableDBInstanceOption data type.
Name (string) --
The name of the Availability Zone.
SubnetOutpost (dict) --
If the subnet is associated with an Outpost, this value specifies the Outpost.
For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
Arn (string) --
The Amazon Resource Name (ARN) of the Outpost.
SubnetStatus (string) --
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:
IPV4DUALA DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
PendingModifiedValues (dict) --
A value that specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
DBInstanceClass (string) --
The name of the compute and memory capacity class for the DB instance.
AllocatedStorage (integer) --
The allocated storage size for the DB instance specified in gibibytes (GiB).
MasterUserPassword (string) --
The master credentials for the DB instance.
Port (integer) --
The port for the DB instance.
BackupRetentionPeriod (integer) --
The number of days for which automated backups are retained.
MultiAZ (boolean) --
A value that indicates that the Single-AZ DB instance will change to a Multi-AZ deployment.
EngineVersion (string) --
The database engine version.
LicenseModel (string) --
The license model for the DB instance.
Valid values: license-included | bring-your-own-license | general-public-license
Iops (integer) --
The Provisioned IOPS value for the DB instance.
DBInstanceIdentifier (string) --
The database identifier for the DB instance.
StorageType (string) --
The storage type of the DB instance.
CACertificateIdentifier (string) --
The identifier of the CA certificate for the DB instance.
DBSubnetGroupName (string) --
The DB subnet group for the DB instance.
PendingCloudwatchLogsExports (dict) --
A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.
LogTypesToEnable (list) --
Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.
LogTypesToDisable (list) --
Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.
ProcessorFeatures (list) --
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
(dict) --
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstanceModifyDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceFromS3RestoreDBInstanceToPointInTimeYou can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstancesDescribeDBSnapshotsDescribeValidDBInstanceModificationsIf you call DescribeDBInstances , ProcessorFeature returns non-null values only if the following conditions are met:
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
Name (string) --
The name of the processor feature. Valid names are coreCount and threadsPerCore .
Value (string) --
The value of a processor feature name.
IAMDatabaseAuthenticationEnabled (boolean) --
Whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
AutomationMode (string) --
The automation mode of the RDS Custom DB instance: full or all-paused . If full , the DB instance automates monitoring and instance recovery. If all-paused , the instance pauses automation for the duration set by --resume-full-automation-mode-minutes .
ResumeFullAutomationModeTime (datetime) --
The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
LatestRestorableTime (datetime) --
Specifies the latest time to which a database can be restored with point-in-time restore.
MultiAZ (boolean) --
Specifies if the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom.
EngineVersion (string) --
Indicates the database engine version.
AutoMinorVersionUpgrade (boolean) --
A value that indicates that minor version patches are applied automatically.
ReadReplicaSourceDBInstanceIdentifier (string) --
Contains the identifier of the source DB instance if this DB instance is a read replica.
ReadReplicaDBInstanceIdentifiers (list) --
Contains one or more identifiers of the read replicas associated with this DB instance.
ReadReplicaDBClusterIdentifiers (list) --
Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn't contain information about cross-Region Aurora read replicas.
Note
Currently, each RDS DB instance can have only one Aurora read replica.
ReplicaMode (string) --
The open mode of an Oracle read replica. The default is open-read-only . For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide .
Note
This attribute is only supported in RDS for Oracle.
LicenseModel (string) --
License model information for this DB instance. This setting doesn't apply to RDS Custom.
Iops (integer) --
Specifies the Provisioned IOPS (I/O operations per second) value.
OptionGroupMemberships (list) --
Provides the list of option group memberships for this DB instance.
(dict) --
Provides information on the option groups the DB instance is a member of.
OptionGroupName (string) --
The name of the option group that the instance belongs to.
Status (string) --
The status of the DB instance's option group membership. Valid values are: in-sync , pending-apply , pending-removal , pending-maintenance-apply , pending-maintenance-removal , applying , removing , and failed .
CharacterSetName (string) --
If present, specifies the name of the character set that this instance is associated with.
NcharCharacterSetName (string) --
The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.
SecondaryAvailabilityZone (string) --
If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
PubliclyAccessible (boolean) --
Specifies the accessibility options for the DB instance.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance .
StatusInfos (list) --
The status of a read replica. If the instance isn't a read replica, this is blank.
(dict) --
Provides a list of status information for a DB instance.
StatusType (string) --
This value is currently "read replication."
Normal (boolean) --
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 DB instance. For a StatusType of read replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.
Message (string) --
Details of the error if there is an error for the instance. If the instance isn't in an error state, this value is blank.
StorageType (string) --
Specifies the storage type associated with DB instance.
TdeCredentialArn (string) --
The ARN from the key store with which the instance is associated for TDE encryption.
DbInstancePort (integer) --
Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.
DBClusterIdentifier (string) --
If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.
StorageEncrypted (boolean) --
Specifies whether the DB instance is encrypted.
KmsKeyId (string) --
If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
DbiResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB instance is accessed.
CACertificateIdentifier (string) --
The identifier of the CA certificate for this DB instance.
DomainMemberships (list) --
The Active Directory Domain membership records associated with the DB instance.
(dict) --
An Active Directory Domain membership record associated with the DB instance or cluster.
Domain (string) --
The identifier of the Active Directory Domain.
Status (string) --
The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.
FQDN (string) --
The fully qualified domain name of the Active Directory Domain.
IAMRoleName (string) --
The name of the IAM role to be used when making API calls to the Directory Service.
CopyTagsToSnapshot (boolean) --
Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see DBCluster .
MonitoringInterval (integer) --
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
EnhancedMonitoringResourceArn (string) --
The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
MonitoringRoleArn (string) --
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
PromotionTier (integer) --
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .
DBInstanceArn (string) --
The Amazon Resource Name (ARN) for the DB instance.
Timezone (string) --
The time zone of the DB instance. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.
IAMDatabaseAuthenticationEnabled (boolean) --
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
IAM database authentication can be enabled for the following database engines
PerformanceInsightsEnabled (boolean) --
True if Performance Insights is enabled for the DB instance, and otherwise false.
PerformanceInsightsKMSKeyId (string) --
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
PerformanceInsightsRetentionPeriod (integer) --
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
For example, the following values are valid:
EnabledCloudwatchLogsExports (list) --
A list of log types that this DB instance is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon RDS User Guide.
ProcessorFeatures (list) --
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
(dict) --
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstanceModifyDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceFromS3RestoreDBInstanceToPointInTimeYou can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstancesDescribeDBSnapshotsDescribeValidDBInstanceModificationsIf you call DescribeDBInstances , ProcessorFeature returns non-null values only if the following conditions are met:
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
Name (string) --
The name of the processor feature. Valid names are coreCount and threadsPerCore .
Value (string) --
The value of a processor feature name.
DeletionProtection (boolean) --
Indicates if the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance .
AssociatedRoles (list) --
The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
(dict) --
Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.
FeatureName (string) --
The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion .
Status (string) --
Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf.PENDING - the IAM role ARN is being associated with the DB instance.INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf.ListenerEndpoint (dict) --
Specifies the listener connection endpoint for SQL Server Always On.
Address (string) --
Specifies the DNS address of the DB 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.
MaxAllocatedStorage (integer) --
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
TagList (list) --
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
DBInstanceAutomatedBackupsReplications (list) --
The list of replicated automated backups associated with the DB instance.
(dict) --
Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties.
DBInstanceAutomatedBackupsArn (string) --
The Amazon Resource Name (ARN) of the replicated automated backups.
CustomerOwnedIpEnabled (boolean) --
Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide .
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide .
AwsBackupRecoveryPointArn (string) --
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
ActivityStreamStatus (string) --
The status of the database activity stream.
ActivityStreamKmsKeyId (string) --
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
ActivityStreamKinesisStreamName (string) --
The name of the Amazon Kinesis data stream used for the database activity stream.
ActivityStreamMode (string) --
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. RDS for Oracle always handles these events asynchronously.
ActivityStreamEngineNativeAuditFieldsIncluded (boolean) --
Indicates whether engine-native audit fields are included in the database activity stream.
AutomationMode (string) --
The automation mode of the RDS Custom DB instance: full or all paused . If full , the DB instance automates monitoring and instance recovery. If all paused , the instance pauses automation for the duration set by --resume-full-automation-mode-minutes .
ResumeFullAutomationModeTime (datetime) --
The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
CustomIamInstanceProfile (string) --
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
AWSRDSCustom .For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide .
BackupTarget (string) --
Specifies where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
NetworkType (string) --
The network type of the DB instance.
Valid values:
IPV4DUALThe network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide and Working with a DB instance in a VPC in the Amazon Aurora User Guide.
ActivityStreamPolicyStatus (string) --
The status of the policy state of the activity stream.
Exceptions
RDS.Client.exceptions.DBInstanceNotFoundFaultRDS.Client.exceptions.InvalidDBInstanceStateFaultRDS.Client.exceptions.DBSnapshotAlreadyExistsFaultRDS.Client.exceptions.SnapshotQuotaExceededFaultRDS.Client.exceptions.InvalidDBClusterStateFaultstop_db_instance_automated_backups_replication(**kwargs)¶Stops automated backup replication for a DB instance.
This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.
For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.
See also: AWS API Documentation
Request Syntax
response = client.stop_db_instance_automated_backups_replication(
SourceDBInstanceArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the source DB instance for which to stop replicating automated backups, for example, arn:aws:rds:us-west-2:123456789012:db:mydatabase .
{
'DBInstanceAutomatedBackup': {
'DBInstanceArn': 'string',
'DbiResourceId': 'string',
'Region': 'string',
'DBInstanceIdentifier': 'string',
'RestoreWindow': {
'EarliestTime': datetime(2015, 1, 1),
'LatestTime': datetime(2015, 1, 1)
},
'AllocatedStorage': 123,
'Status': 'string',
'Port': 123,
'AvailabilityZone': 'string',
'VpcId': 'string',
'InstanceCreateTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'LicenseModel': 'string',
'Iops': 123,
'OptionGroupName': 'string',
'TdeCredentialArn': 'string',
'Encrypted': True|False,
'StorageType': 'string',
'KmsKeyId': 'string',
'Timezone': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'BackupRetentionPeriod': 123,
'DBInstanceAutomatedBackupsArn': 'string',
'DBInstanceAutomatedBackupsReplications': [
{
'DBInstanceAutomatedBackupsArn': 'string'
},
],
'BackupTarget': 'string'
}
}
Response Structure
An automated backup of a DB instance. It consists of system backups, transaction logs, and the database instance properties that existed at the time you deleted the source instance.
The Amazon Resource Name (ARN) for the automated backups.
The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
The Amazon Web Services Region associated with the automated backup.
The customer id of the instance that is/was associated with the automated backup.
Earliest and latest time an instance can be restored to.
The earliest time you can restore an instance to.
The latest time you can restore an instance to.
Specifies the allocated storage size in gibibytes (GiB).
Provides a list of status information for an automated backup:
active - automated backups for current instancesretained - automated backups for deleted instancescreating - automated backups that are waiting for the first automated snapshot to be available.The port number that the automated backup used for connections.
Default: Inherits from the source DB instance
Valid Values: 1150-65535
The Availability Zone that the automated backup was created in. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones .
Provides the VPC ID associated with the DB instance
Provides the date and time that the DB instance was created.
The license model of an automated backup.
The name of the database engine for this automated backup.
The version of the database engine for the automated backup.
License model information for the automated backup.
The IOPS (I/O operations per second) value for the automated backup.
The option group the automated backup is associated with. If omitted, the default option group for the engine specified is used.
The ARN from the key store with which the automated backup is associated for TDE encryption.
Specifies whether the automated backup is encrypted.
Specifies the storage type associated with the automated backup.
The Amazon Web Services KMS key ID for an automated backup.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
The time zone of the automated backup. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
The retention period for the automated backups.
The Amazon Resource Name (ARN) for the replicated automated backups.
The list of replications to different Amazon Web Services Regions associated with the automated backup.
Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties.
The Amazon Resource Name (ARN) of the replicated automated backups.
Specifies where automated backups are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
Exceptions
RDS.Client.exceptions.DBInstanceNotFoundFaultRDS.Client.exceptions.InvalidDBInstanceStateFaultThe available paginators are:
RDS.Paginator.DescribeCertificatesRDS.Paginator.DescribeDBClusterBacktracksRDS.Paginator.DescribeDBClusterEndpointsRDS.Paginator.DescribeDBClusterParameterGroupsRDS.Paginator.DescribeDBClusterParametersRDS.Paginator.DescribeDBClusterSnapshotsRDS.Paginator.DescribeDBClustersRDS.Paginator.DescribeDBEngineVersionsRDS.Paginator.DescribeDBInstanceAutomatedBackupsRDS.Paginator.DescribeDBInstancesRDS.Paginator.DescribeDBLogFilesRDS.Paginator.DescribeDBParameterGroupsRDS.Paginator.DescribeDBParametersRDS.Paginator.DescribeDBProxiesRDS.Paginator.DescribeDBProxyEndpointsRDS.Paginator.DescribeDBProxyTargetGroupsRDS.Paginator.DescribeDBProxyTargetsRDS.Paginator.DescribeDBSecurityGroupsRDS.Paginator.DescribeDBSnapshotsRDS.Paginator.DescribeDBSubnetGroupsRDS.Paginator.DescribeEngineDefaultClusterParametersRDS.Paginator.DescribeEngineDefaultParametersRDS.Paginator.DescribeEventSubscriptionsRDS.Paginator.DescribeEventsRDS.Paginator.DescribeExportTasksRDS.Paginator.DescribeGlobalClustersRDS.Paginator.DescribeOptionGroupOptionsRDS.Paginator.DescribeOptionGroupsRDS.Paginator.DescribeOrderableDBInstanceOptionsRDS.Paginator.DescribePendingMaintenanceActionsRDS.Paginator.DescribeReservedDBInstancesRDS.Paginator.DescribeReservedDBInstancesOfferingsRDS.Paginator.DescribeSourceRegionsRDS.Paginator.DownloadDBLogFilePortionRDS.Paginator.DescribeCertificates¶paginator = client.get_paginator('describe_certificates')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from RDS.Client.describe_certificates().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
CertificateIdentifier='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The user-supplied certificate identifier. If this parameter is specified, information for only the identified certificate is returned. This parameter isn't case-sensitive.
Constraints:
This parameter isn't currently supported.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Certificates': [
{
'CertificateIdentifier': 'string',
'CertificateType': 'string',
'Thumbprint': 'string',
'ValidFrom': datetime(2015, 1, 1),
'ValidTill': datetime(2015, 1, 1),
'CertificateArn': 'string',
'CustomerOverride': True|False,
'CustomerOverrideValidTill': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Data returned by the DescribeCertificates action.
Certificates (list) --
The list of Certificate objects for the Amazon Web Services account.
(dict) --
A CA certificate for an Amazon Web Services account.
CertificateIdentifier (string) --
The unique key that identifies a certificate.
CertificateType (string) --
The type of the certificate.
Thumbprint (string) --
The thumbprint of the certificate.
ValidFrom (datetime) --
The starting date from which the certificate is valid.
ValidTill (datetime) --
The final date that the certificate continues to be valid.
CertificateArn (string) --
The Amazon Resource Name (ARN) for the certificate.
CustomerOverride (boolean) --
Whether there is an override for the default certificate identifier.
CustomerOverrideValidTill (datetime) --
If there is an override for the default certificate identifier, when the override expires.
NextToken (string) --
A token to resume pagination.
RDS.Paginator.DescribeDBClusterBacktracks¶paginator = client.get_paginator('describe_db_cluster_backtracks')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from RDS.Client.describe_db_cluster_backtracks().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DBClusterIdentifier='string',
BacktrackIdentifier='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The DB cluster identifier of the DB cluster to be described. This parameter is stored as a lowercase string.
Constraints:
Example: my-cluster1
If specified, this value is the backtrack identifier of the backtrack to be described.
Constraints:
Example: 123e4567-e89b-12d3-a456-426655440000
A filter that specifies one or more DB clusters to describe. Supported filters include the following:
db-cluster-backtrack-id - Accepts backtrack identifiers. The results list includes information about only the backtracks identified by these identifiers.db-cluster-backtrack-status - Accepts any of the following backtrack status values:applyingcompletedfailedpendingThe results list includes information about only the backtracks identified by these values.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'DBClusterBacktracks': [
{
'DBClusterIdentifier': 'string',
'BacktrackIdentifier': 'string',
'BacktrackTo': datetime(2015, 1, 1),
'BacktrackedFrom': datetime(2015, 1, 1),
'BacktrackRequestCreationTime': datetime(2015, 1, 1),
'Status': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Contains the result of a successful invocation of the DescribeDBClusterBacktracks action.
DBClusterBacktracks (list) --
Contains a list of backtracks for the user.
(dict) --
This data type is used as a response element in the DescribeDBClusterBacktracks action.
DBClusterIdentifier (string) --
Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
BacktrackIdentifier (string) --
Contains the backtrack identifier.
BacktrackTo (datetime) --
The timestamp of the time to which the DB cluster was backtracked.
BacktrackedFrom (datetime) --
The timestamp of the time from which the DB cluster was backtracked.
BacktrackRequestCreationTime (datetime) --
The timestamp of the time at which the backtrack was requested.
Status (string) --
The status of the backtrack. This property returns one of the following values:
applying - The backtrack is currently being applied to or rolled back from the DB cluster.completed - The backtrack has successfully been applied to or rolled back from the DB cluster.failed - An error occurred while the backtrack was applied to or rolled back from the DB cluster.pending - The backtrack is currently pending application to or rollback from the DB cluster.NextToken (string) --
A token to resume pagination.
RDS.Paginator.DescribeDBClusterEndpoints¶paginator = client.get_paginator('describe_db_cluster_endpoints')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from RDS.Client.describe_db_cluster_endpoints().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DBClusterIdentifier='string',
DBClusterEndpointIdentifier='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A set of name-value pairs that define which endpoints to include in the output. The filters are specified as name-value pairs, in the format Name=*endpoint_type* ,Values=*endpoint_type1* ,*endpoint_type2* ,... . Name can be one of: db-cluster-endpoint-type , db-cluster-endpoint-custom-type , db-cluster-endpoint-id , db-cluster-endpoint-status . Values for the db-cluster-endpoint-type filter can be one or more of: reader , writer , custom . Values for the db-cluster-endpoint-custom-type filter can be one or more of: reader , any . Values for the db-cluster-endpoint-status filter can be one or more of: available , creating , deleting , inactive , modifying .
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'DBClusterEndpoints': [
{
'DBClusterEndpointIdentifier': 'string',
'DBClusterIdentifier': 'string',
'DBClusterEndpointResourceIdentifier': 'string',
'Endpoint': 'string',
'Status': 'string',
'EndpointType': 'string',
'CustomEndpointType': 'string',
'StaticMembers': [
'string',
],
'ExcludedMembers': [
'string',
],
'DBClusterEndpointArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
DBClusterEndpoints (list) --
Contains the details of the endpoints associated with the cluster and matching any filter conditions.
(dict) --
This data type represents the information you need to connect to an Amazon Aurora DB cluster. This data type is used as a response element in the following actions:
CreateDBClusterEndpointDescribeDBClusterEndpointsModifyDBClusterEndpointDeleteDBClusterEndpointFor the data structure that represents Amazon RDS DB instance endpoints, see Endpoint .
DBClusterEndpointIdentifier (string) --
The identifier associated with the endpoint. This parameter is stored as a lowercase string.
DBClusterIdentifier (string) --
The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
DBClusterEndpointResourceIdentifier (string) --
A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.
Endpoint (string) --
The DNS address of the endpoint.
Status (string) --
The current status of the endpoint. One of: creating , available , deleting , inactive , modifying . The inactive state applies to an endpoint that can't be used for a certain kind of cluster, such as a writer endpoint for a read-only secondary cluster in a global database.
EndpointType (string) --
The type of the endpoint. One of: READER , WRITER , CUSTOM .
CustomEndpointType (string) --
The type associated with a custom endpoint. One of: READER , WRITER , ANY .
StaticMembers (list) --
List of DB instance identifiers that are part of the custom endpoint group.
ExcludedMembers (list) --
List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.
DBClusterEndpointArn (string) --
The Amazon Resource Name (ARN) for the endpoint.
NextToken (string) --
A token to resume pagination.
RDS.Paginator.DescribeDBClusterParameterGroups¶paginator = client.get_paginator('describe_db_cluster_parameter_groups')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from RDS.Client.describe_db_cluster_parameter_groups().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DBClusterParameterGroupName='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The name of a specific DB cluster parameter group to return details for.
Constraints:
This parameter isn't currently supported.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'DBClusterParameterGroups': [
{
'DBClusterParameterGroupName': 'string',
'DBParameterGroupFamily': 'string',
'Description': 'string',
'DBClusterParameterGroupArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
DBClusterParameterGroups (list) --
A list of DB cluster parameter groups.
(dict) --
Contains the details of an Amazon RDS DB cluster parameter group.
This data type is used as a response element in the DescribeDBClusterParameterGroups action.
DBClusterParameterGroupName (string) --
The name of the DB cluster parameter group.
DBParameterGroupFamily (string) --
The name of the DB parameter group family that this DB cluster parameter group is compatible with.
Description (string) --
Provides the customer-specified description for this DB cluster parameter group.
DBClusterParameterGroupArn (string) --
The Amazon Resource Name (ARN) for the DB cluster parameter group.
NextToken (string) --
A token to resume pagination.
RDS.Paginator.DescribeDBClusterParameters¶paginator = client.get_paginator('describe_db_cluster_parameters')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from RDS.Client.describe_db_cluster_parameters().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DBClusterParameterGroupName='string',
Source='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of a specific DB cluster parameter group to return parameter details for.
Constraints:
engine , service , or customer .This parameter isn't currently supported.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Parameters': [
{
'ParameterName': 'string',
'ParameterValue': 'string',
'Description': 'string',
'Source': 'string',
'ApplyType': 'string',
'DataType': 'string',
'AllowedValues': 'string',
'IsModifiable': True|False,
'MinimumEngineVersion': 'string',
'ApplyMethod': 'immediate'|'pending-reboot',
'SupportedEngineModes': [
'string',
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Provides details about a DB cluster parameter group including the parameters in the DB cluster parameter group.
Parameters (list) --
Provides a list of parameters for the DB cluster parameter group.
(dict) --
This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions.
This data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions.
ParameterName (string) --
Specifies the name of the parameter.
ParameterValue (string) --
Specifies the value of the parameter.
Description (string) --
Provides a description of the parameter.
Source (string) --
Indicates the source of the parameter value.
ApplyType (string) --
Specifies the engine specific parameters type.
DataType (string) --
Specifies the valid data type for the parameter.
AllowedValues (string) --
Specifies the valid range of values for the parameter.
IsModifiable (boolean) --
Indicates whether (true ) or not (false ) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
MinimumEngineVersion (string) --
The earliest engine version to which the parameter can apply.
ApplyMethod (string) --
Indicates when to apply parameter updates.
SupportedEngineModes (list) --
The valid DB engine modes.
NextToken (string) --
A token to resume pagination.
RDS.Paginator.DescribeDBClusterSnapshots¶paginator = client.get_paginator('describe_db_cluster_snapshots')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from RDS.Client.describe_db_cluster_snapshots().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DBClusterIdentifier='string',
DBClusterSnapshotIdentifier='string',
SnapshotType='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
IncludeShared=True|False,
IncludePublic=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter isn't case-sensitive.
Constraints:
A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with the DBClusterIdentifier parameter. This value is stored as a lowercase string.
Constraints:
SnapshotType parameter must also be specified.The type of DB cluster snapshots to be returned. You can specify one of the following values:
automated - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.manual - Return all DB cluster snapshots that have been taken by my Amazon Web Services account.shared - Return all manual DB cluster snapshots that have been shared to my Amazon Web Services account.public - Return all DB cluster snapshots that have been marked as public.If you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by enabling the IncludeShared parameter. You can include public DB cluster snapshots with these results by enabling the IncludePublic parameter.
The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated . The IncludePublic parameter doesn't apply when SnapshotType is set to shared . The IncludeShared parameter doesn't apply when SnapshotType is set to public .
A filter that specifies one or more DB cluster snapshots to describe.
Supported filters:
db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs).db-cluster-snapshot-id - Accepts DB cluster snapshot identifiers.snapshot-type - Accepts types of DB cluster snapshots.engine - Accepts names of database engines.A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
A value that indicates whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.
You can give an Amazon Web Services account permission to restore a manual DB cluster snapshot from another Amazon Web Services account by the ModifyDBClusterSnapshotAttribute API action.
A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.
You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'DBClusterSnapshots': [
{
'AvailabilityZones': [
'string',
],
'DBClusterSnapshotIdentifier': 'string',
'DBClusterIdentifier': 'string',
'SnapshotCreateTime': datetime(2015, 1, 1),
'Engine': 'string',
'EngineMode': 'string',
'AllocatedStorage': 123,
'Status': 'string',
'Port': 123,
'VpcId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'EngineVersion': 'string',
'LicenseModel': 'string',
'SnapshotType': 'string',
'PercentProgress': 123,
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DBClusterSnapshotArn': 'string',
'SourceDBClusterSnapshotArn': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Provides a list of DB cluster snapshots for the user as the result of a call to the DescribeDBClusterSnapshots action.
DBClusterSnapshots (list) --
Provides a list of DB cluster snapshots for the user.
(dict) --
Contains the details for an Amazon RDS DB cluster snapshot
This data type is used as a response element in the DescribeDBClusterSnapshots action.
AvailabilityZones (list) --
Provides the list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
DBClusterSnapshotIdentifier (string) --
Specifies the identifier for the DB cluster snapshot.
DBClusterIdentifier (string) --
Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
SnapshotCreateTime (datetime) --
Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
Engine (string) --
Specifies the name of the database engine for this DB cluster snapshot.
EngineMode (string) --
Provides the engine mode of the database engine for this DB cluster snapshot.
AllocatedStorage (integer) --
Specifies the allocated storage size in gibibytes (GiB).
Status (string) --
Specifies the status of this DB cluster snapshot. Valid statuses are the following:
availablecopyingcreatingPort (integer) --
Specifies the port that the DB cluster was listening on at the time of the snapshot.
VpcId (string) --
Provides the VPC ID associated with the DB cluster snapshot.
ClusterCreateTime (datetime) --
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
MasterUsername (string) --
Provides the master username for this DB cluster snapshot.
EngineVersion (string) --
Provides the version of the database engine for this DB cluster snapshot.
LicenseModel (string) --
Provides the license model information for this DB cluster snapshot.
SnapshotType (string) --
Provides the type of the DB cluster snapshot.
PercentProgress (integer) --
Specifies the percentage of the estimated data that has been transferred.
StorageEncrypted (boolean) --
Specifies whether the DB cluster snapshot is encrypted.
KmsKeyId (string) --
If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
DBClusterSnapshotArn (string) --
The Amazon Resource Name (ARN) for the DB cluster snapshot.
SourceDBClusterSnapshotArn (string) --
If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.
IAMDatabaseAuthenticationEnabled (boolean) --
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
TagList (list) --
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
NextToken (string) --
A token to resume pagination.
RDS.Paginator.DescribeDBClusters¶paginator = client.get_paginator('describe_db_clusters')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from RDS.Client.describe_db_clusters().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DBClusterIdentifier='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
IncludeShared=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.
Constraints:
A filter that specifies one or more DB clusters to describe.
Supported filters:
clone-group-id - Accepts clone group identifiers. The results list only includes information about the DB clusters associated with these clone groups.db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB clusters identified by these ARNs.domain - Accepts Active Directory directory IDs. The results list only includes information about the DB clusters associated with these domains.engine - Accepts engine names. The results list only includes information about the DB clusters for these engines.A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'DBClusters': [
{
'AllocatedStorage': 123,
'AvailabilityZones': [
'string',
],
'BackupRetentionPeriod': 123,
'CharacterSetName': 'string',
'DatabaseName': 'string',
'DBClusterIdentifier': 'string',
'DBClusterParameterGroup': 'string',
'DBSubnetGroup': 'string',
'Status': 'string',
'AutomaticRestartTime': datetime(2015, 1, 1),
'PercentProgress': 'string',
'EarliestRestorableTime': datetime(2015, 1, 1),
'Endpoint': 'string',
'ReaderEndpoint': 'string',
'CustomEndpoints': [
'string',
],
'MultiAZ': True|False,
'Engine': 'string',
'EngineVersion': 'string',
'LatestRestorableTime': datetime(2015, 1, 1),
'Port': 123,
'MasterUsername': 'string',
'DBClusterOptionGroupMemberships': [
{
'DBClusterOptionGroupName': 'string',
'Status': 'string'
},
],
'PreferredBackupWindow': 'string',
'PreferredMaintenanceWindow': 'string',
'ReplicationSourceIdentifier': 'string',
'ReadReplicaIdentifiers': [
'string',
],
'DBClusterMembers': [
{
'DBInstanceIdentifier': 'string',
'IsClusterWriter': True|False,
'DBClusterParameterGroupStatus': 'string',
'PromotionTier': 123
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'HostedZoneId': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbClusterResourceId': 'string',
'DBClusterArn': 'string',
'AssociatedRoles': [
{
'RoleArn': 'string',
'Status': 'string',
'FeatureName': 'string'
},
],
'IAMDatabaseAuthenticationEnabled': True|False,
'CloneGroupId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'EarliestBacktrackTime': datetime(2015, 1, 1),
'BacktrackWindow': 123,
'BacktrackConsumedChangeRecords': 123,
'EnabledCloudwatchLogsExports': [
'string',
],
'Capacity': 123,
'EngineMode': 'string',
'ScalingConfigurationInfo': {
'MinCapacity': 123,
'MaxCapacity': 123,
'AutoPause': True|False,
'SecondsUntilAutoPause': 123,
'TimeoutAction': 'string',
'SecondsBeforeTimeout': 123
},
'DeletionProtection': True|False,
'HttpEndpointEnabled': True|False,
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'CopyTagsToSnapshot': True|False,
'CrossAccountClone': True|False,
'DomainMemberships': [
{
'Domain': 'string',
'Status': 'string',
'FQDN': 'string',
'IAMRoleName': 'string'
},
],
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'GlobalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'unknown',
'GlobalWriteForwardingRequested': True|False,
'PendingModifiedValues': {
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
},
'DBClusterIdentifier': 'string',
'MasterUserPassword': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'EngineVersion': 'string'
},
'DBClusterInstanceClass': 'string',
'StorageType': 'string',
'Iops': 123,
'PubliclyAccessible': True|False,
'AutoMinorVersionUpgrade': True|False,
'MonitoringInterval': 123,
'MonitoringRoleArn': 'string',
'PerformanceInsightsEnabled': True|False,
'PerformanceInsightsKMSKeyId': 'string',
'PerformanceInsightsRetentionPeriod': 123,
'ServerlessV2ScalingConfiguration': {
'MinCapacity': 123.0,
'MaxCapacity': 123.0
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Contains the result of a successful invocation of the DescribeDBClusters action.
DBClusters (list) --
Contains a list of DB clusters for the user.
(dict) --
Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
For an Amazon Aurora DB cluster, this data type is used as a response element in the operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , FailoverDBCluster , ModifyDBCluster , PromoteReadReplicaDBCluster , RestoreDBClusterFromS3 , RestoreDBClusterFromSnapshot , RestoreDBClusterToPointInTime , StartDBCluster , and StopDBCluster .
For a Multi-AZ DB cluster, this data type is used as a response element in the operations CreateDBCluster , DeleteDBCluster , DescribeDBClusters , FailoverDBCluster , ModifyDBCluster , RebootDBCluster , RestoreDBClusterFromSnapshot , and RestoreDBClusterToPointInTime .
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
AllocatedStorage (integer) --
For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
AvailabilityZones (list) --
Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.
BackupRetentionPeriod (integer) --
Specifies the number of days for which automatic DB snapshots are retained.
CharacterSetName (string) --
If present, specifies the name of the character set that this cluster is associated with.
DatabaseName (string) --
Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.
DBClusterIdentifier (string) --
Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
DBClusterParameterGroup (string) --
Specifies the name of the DB cluster parameter group for the DB cluster.
DBSubnetGroup (string) --
Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
Status (string) --
Specifies the current state of this DB cluster.
AutomaticRestartTime (datetime) --
The time when a stopped DB cluster is restarted automatically.
PercentProgress (string) --
Specifies the progress of the operation as a percentage.
EarliestRestorableTime (datetime) --
The earliest time to which a database can be restored with point-in-time restore.
Endpoint (string) --
Specifies the connection endpoint for the primary instance of the DB cluster.
ReaderEndpoint (string) --
The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.
If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
CustomEndpoints (list) --
Identifies all custom endpoints associated with the cluster.
MultiAZ (boolean) --
Specifies whether the DB cluster has instances in multiple Availability Zones.
Engine (string) --
The name of the database engine to be used for this DB cluster.
EngineVersion (string) --
Indicates the database engine version.
LatestRestorableTime (datetime) --
Specifies the latest time to which a database can be restored with point-in-time restore.
Port (integer) --
Specifies the port that the database engine is listening on.
MasterUsername (string) --
Contains the master username for the DB cluster.
DBClusterOptionGroupMemberships (list) --
Provides the list of option group memberships for this DB cluster.
(dict) --
Contains status information for a DB cluster option group.
DBClusterOptionGroupName (string) --
Specifies the name of the DB cluster option group.
Status (string) --
Specifies the status of the DB cluster option group.
PreferredBackupWindow (string) --
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
ReplicationSourceIdentifier (string) --
Contains the identifier of the source DB cluster if this DB cluster is a read replica.
ReadReplicaIdentifiers (list) --
Contains one or more identifiers of the read replicas associated with this DB cluster.
DBClusterMembers (list) --
Provides the list of instances that make up the DB cluster.
(dict) --
Contains information about an instance that is part of a DB cluster.
DBInstanceIdentifier (string) --
Specifies the instance identifier for this member of the DB cluster.
IsClusterWriter (boolean) --
Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
DBClusterParameterGroupStatus (string) --
Specifies the status of the DB cluster parameter group for this member of the DB cluster.
PromotionTier (integer) --
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .
VpcSecurityGroups (list) --
Provides a list of VPC security groups that the DB cluster belongs to.
(dict) --
This data type is used as a response element for queries on VPC security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The membership status of the VPC security group.
Currently, the only valid status is active .
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
StorageEncrypted (boolean) --
Specifies whether the DB cluster is encrypted.
KmsKeyId (string) --
If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
DbClusterResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for the DB cluster.
AssociatedRoles (list) --
Provides a list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.
(dict) --
Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB cluster.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
Status (string) --
Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other Amazon Web Services on your behalf.PENDING - the IAM role ARN is being associated with the DB cluster.INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other Amazon Web Services on your behalf.FeatureName (string) --
The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion .
IAMDatabaseAuthenticationEnabled (boolean) --
A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
CloneGroupId (string) --
Identifies the clone group to which the DB cluster is associated.
ClusterCreateTime (datetime) --
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
EarliestBacktrackTime (datetime) --
The earliest time to which a DB cluster can be backtracked.
BacktrackWindow (integer) --
The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.
BacktrackConsumedChangeRecords (integer) --
The number of change records stored for Backtrack.
EnabledCloudwatchLogsExports (list) --
A list of log types that this DB cluster is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.
Capacity (integer) --
The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 (zero) when the cluster is paused.
For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide .
EngineMode (string) --
The DB engine mode of the DB cluster, either provisioned , serverless , parallelquery , global , or multimaster .
For more information, see CreateDBCluster .
ScalingConfigurationInfo (dict) --
Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.
For more information, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide .
MinCapacity (integer) --
The minimum capacity for an Aurora DB cluster in serverless DB engine mode.
MaxCapacity (integer) --
The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
AutoPause (boolean) --
A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.
When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes.
SecondsUntilAutoPause (integer) --
The remaining amount of time, in seconds, before the Aurora DB cluster in serverless mode is paused. A DB cluster can be paused only when it's idle (it has no connections).
TimeoutAction (string) --
The action that occurs when Aurora times out while attempting to change the capacity of an Aurora Serverless v1 cluster. The value is either ForceApplyCapacityChange or RollbackCapacityChange .
ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.
RollbackCapacityChangeignores the capacity change if a scaling point isn't found in the timeout period.
SecondsBeforeTimeout (integer) --
The number of seconds before scaling times out. What happens when an attempted scaling action times out is determined by the TimeoutAction setting.
DeletionProtection (boolean) --
Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
HttpEndpointEnabled (boolean) --
A value that indicates whether the HTTP endpoint for an Aurora Serverless v1 DB cluster is enabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide .
ActivityStreamMode (string) --
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.
ActivityStreamStatus (string) --
The status of the database activity stream.
ActivityStreamKmsKeyId (string) --
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
ActivityStreamKinesisStreamName (string) --
The name of the Amazon Kinesis data stream used for the database activity stream.
CopyTagsToSnapshot (boolean) --
Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.
CrossAccountClone (boolean) --
Specifies whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
DomainMemberships (list) --
The Active Directory Domain membership records associated with the DB cluster.
(dict) --
An Active Directory Domain membership record associated with the DB instance or cluster.
Domain (string) --
The identifier of the Active Directory Domain.
Status (string) --
The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.
FQDN (string) --
The fully qualified domain name of the Active Directory Domain.
IAMRoleName (string) --
The name of the IAM role to be used when making API calls to the Directory Service.
TagList (list) --
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
GlobalWriteForwardingStatus (string) --
Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.
GlobalWriteForwardingRequested (boolean) --
Specifies whether you have requested to enable write forwarding for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.
PendingModifiedValues (dict) --
A value that specifies that changes to the DB cluster are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
PendingCloudwatchLogsExports (dict) --
A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.
LogTypesToEnable (list) --
Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.
LogTypesToDisable (list) --
Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.
DBClusterIdentifier (string) --
The DBClusterIdentifier value for the DB cluster.
MasterUserPassword (string) --
The master credentials for the DB cluster.
IAMDatabaseAuthenticationEnabled (boolean) --
A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
EngineVersion (string) --
The database engine version.
DBClusterInstanceClass (string) --
The name of the compute and memory capacity class of the DB instance.
This setting is only for non-Aurora Multi-AZ DB clusters.
StorageType (string) --
The storage type associated with the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
Iops (integer) --
The Provisioned IOPS (I/O operations per second) value.
This setting is only for non-Aurora Multi-AZ DB clusters.
PubliclyAccessible (boolean) --
Specifies the accessibility options for the DB instance.
When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance .
This setting is only for non-Aurora Multi-AZ DB clusters.
AutoMinorVersionUpgrade (boolean) --
A value that indicates that minor version patches are applied automatically.
This setting is only for non-Aurora Multi-AZ DB clusters.
MonitoringInterval (integer) --
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
MonitoringRoleArn (string) --
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
This setting is only for non-Aurora Multi-AZ DB clusters.
PerformanceInsightsEnabled (boolean) --
True if Performance Insights is enabled for the DB cluster, and otherwise false.
This setting is only for non-Aurora Multi-AZ DB clusters.
PerformanceInsightsKMSKeyId (string) --
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
This setting is only for non-Aurora Multi-AZ DB clusters.
PerformanceInsightsRetentionPeriod (integer) --
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
For example, the following values are valid:
This setting is only for non-Aurora Multi-AZ DB clusters.
ServerlessV2ScalingConfiguration (dict) --
Shows the scaling configuration for an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide .
MinCapacity (float) --
The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.
MaxCapacity (float) --
The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128.
NextToken (string) --
A token to resume pagination.
RDS.Paginator.DescribeDBEngineVersions¶paginator = client.get_paginator('describe_db_engine_versions')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from RDS.Client.describe_db_engine_versions().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Engine='string',
EngineVersion='string',
DBParameterGroupFamily='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DefaultOnly=True|False,
ListSupportedCharacterSets=True|False,
ListSupportedTimezones=True|False,
IncludeAll=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The database engine to return.
Valid Values:
aurora (for MySQL 5.6-compatible Aurora)aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)aurora-postgresqlmariadbmysqloracle-eeoracle-ee-cdboracle-se2oracle-se2-cdbpostgressqlserver-eesqlserver-sesqlserver-exsqlserver-webThe database engine version to return.
Example: 5.1.49
The name of a specific DB parameter group family to return details for.
Constraints:
A filter that specifies one or more DB engine versions to describe.
Supported filters:
db-parameter-group-family - Accepts parameter groups family names. The results list only includes information about the DB engine versions for these parameter group families.engine - Accepts engine names. The results list only includes information about the DB engine versions for these engines.engine-mode - Accepts DB engine modes. The results list only includes information about the DB engine versions for these engine modes. Valid DB engine modes are the following:globalmultimasterparallelqueryprovisionedserverlessengine-version - Accepts engine versions. The results list only includes information about the DB engine versions for these engine versions.status - Accepts engine version statuses. The results list only includes information about the DB engine versions for these statuses. Valid statuses are the following:availabledeprecatedA filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
A value that indicates whether to list the supported character sets for each engine version.
If this parameter is enabled and the requested engine supports the CharacterSetName parameter for CreateDBInstance , the response includes a list of supported character sets for each engine version.
For RDS Custom, the default is not to list supported character sets. If you set ListSupportedCharacterSets to true , RDS Custom returns no results.
A value that indicates whether to list the supported time zones for each engine version.
If this parameter is enabled and the requested engine supports the TimeZone parameter for CreateDBInstance , the response includes a list of supported time zones for each engine version.
For RDS Custom, the default is not to list supported time zones. If you set ListSupportedTimezones to true , RDS Custom returns no results.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'DBEngineVersions': [
{
'Engine': 'string',
'EngineVersion': 'string',
'DBParameterGroupFamily': 'string',
'DBEngineDescription': 'string',
'DBEngineVersionDescription': 'string',
'DefaultCharacterSet': {
'CharacterSetName': 'string',
'CharacterSetDescription': 'string'
},
'SupportedCharacterSets': [
{
'CharacterSetName': 'string',
'CharacterSetDescription': 'string'
},
],
'SupportedNcharCharacterSets': [
{
'CharacterSetName': 'string',
'CharacterSetDescription': 'string'
},
],
'ValidUpgradeTarget': [
{
'Engine': 'string',
'EngineVersion': 'string',
'Description': 'string',
'AutoUpgrade': True|False,
'IsMajorVersionUpgrade': True|False,
'SupportedEngineModes': [
'string',
],
'SupportsParallelQuery': True|False,
'SupportsGlobalDatabases': True|False,
'SupportsBabelfish': True|False
},
],
'SupportedTimezones': [
{
'TimezoneName': 'string'
},
],
'ExportableLogTypes': [
'string',
],
'SupportsLogExportsToCloudwatchLogs': True|False,
'SupportsReadReplica': True|False,
'SupportedEngineModes': [
'string',
],
'SupportedFeatureNames': [
'string',
],
'Status': 'string',
'SupportsParallelQuery': True|False,
'SupportsGlobalDatabases': True|False,
'MajorEngineVersion': 'string',
'DatabaseInstallationFilesS3BucketName': 'string',
'DatabaseInstallationFilesS3Prefix': 'string',
'DBEngineVersionArn': 'string',
'KMSKeyId': 'string',
'CreateTime': datetime(2015, 1, 1),
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'SupportsBabelfish': True|False
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Contains the result of a successful invocation of the DescribeDBEngineVersions action.
DBEngineVersions (list) --
A list of DBEngineVersion elements.
(dict) --
This data type is used as a response element in the action DescribeDBEngineVersions .
Engine (string) --
The name of the database engine.
EngineVersion (string) --
The version number of the database engine.
DBParameterGroupFamily (string) --
The name of the DB parameter group family for the database engine.
DBEngineDescription (string) --
The description of the database engine.
DBEngineVersionDescription (string) --
The description of the database engine version.
DefaultCharacterSet (dict) --
The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API isn't specified.
CharacterSetName (string) --
The name of the character set.
CharacterSetDescription (string) --
The description of the character set.
SupportedCharacterSets (list) --
A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance operation.
(dict) --
This data type is used as a response element in the action DescribeDBEngineVersions .
CharacterSetName (string) --
The name of the character set.
CharacterSetDescription (string) --
The description of the character set.
SupportedNcharCharacterSets (list) --
A list of the character sets supported by the Oracle DB engine for the NcharCharacterSetName parameter of the CreateDBInstance operation.
(dict) --
This data type is used as a response element in the action DescribeDBEngineVersions .
CharacterSetName (string) --
The name of the character set.
CharacterSetDescription (string) --
The description of the character set.
ValidUpgradeTarget (list) --
A list of engine versions that this database engine version can be upgraded to.
(dict) --
The version of the database engine that a DB 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 a DB 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 upgrading to the target version requires upgrading the major version of the database engine.
SupportedEngineModes (list) --
A list of the supported DB engine modes for the target engine version.
SupportsParallelQuery (boolean) --
A value that indicates whether you can use Aurora parallel query with the target engine version.
SupportsGlobalDatabases (boolean) --
A value that indicates whether you can use Aurora global databases with the target engine version.
SupportsBabelfish (boolean) --
A value that indicates whether you can use Babelfish for Aurora PostgreSQL with the target engine version.
SupportedTimezones (list) --
A list of the time zones supported by this engine for the Timezone parameter of the CreateDBInstance action.
(dict) --
A time zone associated with a DBInstance or a DBSnapshot . This data type is an element in the response to the DescribeDBInstances , the DescribeDBSnapshots , and the DescribeDBEngineVersions actions.
TimezoneName (string) --
The name of the time zone.
ExportableLogTypes (list) --
The types of logs that the database engine has available for export to CloudWatch Logs.
SupportsLogExportsToCloudwatchLogs (boolean) --
A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.
SupportsReadReplica (boolean) --
Indicates whether the database engine version supports read replicas.
SupportedEngineModes (list) --
A list of the supported DB engine modes.
SupportedFeatureNames (list) --
A list of features supported by the DB engine.
The supported features vary by DB engine and DB engine version.
To determine the supported features for a specific DB engine and DB engine version using the CLI, use the following command:
aws rds describe-db-engine-versions --engine <engine_name> --engine-version <engine_version>
For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, use the following command:
aws rds describe-db-engine-versions --engine postgres --engine-version 13.3
The supported features are listed under SupportedFeatureNames in the output.
Status (string) --
The status of the DB engine version, either available or deprecated .
SupportsParallelQuery (boolean) --
A value that indicates whether you can use Aurora parallel query with a specific DB engine version.
SupportsGlobalDatabases (boolean) --
A value that indicates whether you can use Aurora global databases with a specific DB engine version.
MajorEngineVersion (string) --
The major engine version of the CEV.
DatabaseInstallationFilesS3BucketName (string) --
The name of the Amazon S3 bucket that contains your database installation files.
DatabaseInstallationFilesS3Prefix (string) --
The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.
DBEngineVersionArn (string) --
The ARN of the custom engine version.
KMSKeyId (string) --
The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.
CreateTime (datetime) --
The creation time of the DB engine version.
TagList (list) --
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
SupportsBabelfish (boolean) --
A value that indicates whether the engine version supports Babelfish for Aurora PostgreSQL.
NextToken (string) --
A token to resume pagination.
RDS.Paginator.DescribeDBInstanceAutomatedBackups¶paginator = client.get_paginator('describe_db_instance_automated_backups')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from RDS.Client.describe_db_instance_automated_backups().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DbiResourceId='string',
DBInstanceIdentifier='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
DBInstanceAutomatedBackupsArn='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A filter that specifies which resources to return based on status.
Supported filters are the following:
statusactive - automated backups for current instancesretained - automated backups for deleted instances and after backup replication is stoppedcreating - automated backups that are waiting for the first automated snapshot to be availabledb-instance-id - Accepts DB instance identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance automated backups identified by these ARNs.dbi-resource-id - Accepts DB resource identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance resources identified by these ARNs.Returns all resources by default. The status for each resource is specified in the response.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
The Amazon Resource Name (ARN) of the replicated automated backups, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE .
This setting doesn't apply to RDS Custom.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'DBInstanceAutomatedBackups': [
{
'DBInstanceArn': 'string',
'DbiResourceId': 'string',
'Region': 'string',
'DBInstanceIdentifier': 'string',
'RestoreWindow': {
'EarliestTime': datetime(2015, 1, 1),
'LatestTime': datetime(2015, 1, 1)
},
'AllocatedStorage': 123,
'Status': 'string',
'Port': 123,
'AvailabilityZone': 'string',
'VpcId': 'string',
'InstanceCreateTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'LicenseModel': 'string',
'Iops': 123,
'OptionGroupName': 'string',
'TdeCredentialArn': 'string',
'Encrypted': True|False,
'StorageType': 'string',
'KmsKeyId': 'string',
'Timezone': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'BackupRetentionPeriod': 123,
'DBInstanceAutomatedBackupsArn': 'string',
'DBInstanceAutomatedBackupsReplications': [
{
'DBInstanceAutomatedBackupsArn': 'string'
},
],
'BackupTarget': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Contains the result of a successful invocation of the DescribeDBInstanceAutomatedBackups action.
DBInstanceAutomatedBackups (list) --
A list of DBInstanceAutomatedBackup instances.
(dict) --
An automated backup of a DB instance. It consists of system backups, transaction logs, and the database instance properties that existed at the time you deleted the source instance.
DBInstanceArn (string) --
The Amazon Resource Name (ARN) for the automated backups.
DbiResourceId (string) --
The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
Region (string) --
The Amazon Web Services Region associated with the automated backup.
DBInstanceIdentifier (string) --
The customer id of the instance that is/was associated with the automated backup.
RestoreWindow (dict) --
Earliest and latest time an instance can be restored to.
EarliestTime (datetime) --
The earliest time you can restore an instance to.
LatestTime (datetime) --
The latest time you can restore an instance to.
AllocatedStorage (integer) --
Specifies the allocated storage size in gibibytes (GiB).
Status (string) --
Provides a list of status information for an automated backup:
active - automated backups for current instancesretained - automated backups for deleted instancescreating - automated backups that are waiting for the first automated snapshot to be available.Port (integer) --
The port number that the automated backup used for connections.
Default: Inherits from the source DB instance
Valid Values: 1150-65535
AvailabilityZone (string) --
The Availability Zone that the automated backup was created in. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones .
VpcId (string) --
Provides the VPC ID associated with the DB instance
InstanceCreateTime (datetime) --
Provides the date and time that the DB instance was created.
MasterUsername (string) --
The license model of an automated backup.
Engine (string) --
The name of the database engine for this automated backup.
EngineVersion (string) --
The version of the database engine for the automated backup.
LicenseModel (string) --
License model information for the automated backup.
Iops (integer) --
The IOPS (I/O operations per second) value for the automated backup.
OptionGroupName (string) --
The option group the automated backup is associated with. If omitted, the default option group for the engine specified is used.
TdeCredentialArn (string) --
The ARN from the key store with which the automated backup is associated for TDE encryption.
Encrypted (boolean) --
Specifies whether the automated backup is encrypted.
StorageType (string) --
Specifies the storage type associated with the automated backup.
KmsKeyId (string) --
The Amazon Web Services KMS key ID for an automated backup.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
Timezone (string) --
The time zone of the automated backup. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.
IAMDatabaseAuthenticationEnabled (boolean) --
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
BackupRetentionPeriod (integer) --
The retention period for the automated backups.
DBInstanceAutomatedBackupsArn (string) --
The Amazon Resource Name (ARN) for the replicated automated backups.
DBInstanceAutomatedBackupsReplications (list) --
The list of replications to different Amazon Web Services Regions associated with the automated backup.
(dict) --
Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties.
DBInstanceAutomatedBackupsArn (string) --
The Amazon Resource Name (ARN) of the replicated automated backups.
BackupTarget (string) --
Specifies where automated backups are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
NextToken (string) --
A token to resume pagination.
RDS.Paginator.DescribeDBInstances¶paginator = client.get_paginator('describe_db_instances')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from RDS.Client.describe_db_instances().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DBInstanceIdentifier='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The user-supplied instance identifier. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case-sensitive.
Constraints:
A filter that specifies one or more DB instances to describe.
Supported filters:
db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB instances associated with the DB clusters identified by these ARNs.db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list only includes information about the DB instances identified by these ARNs.dbi-resource-id - Accepts DB instance resource identifiers. The results list will only include information about the DB instances identified by these DB instance resource identifiers.domain - Accepts Active Directory directory IDs. The results list only includes information about the DB instances associated with these domains.engine - Accepts engine names. The results list only includes information about the DB instances for these engines.A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'DBInstances': [
{
'DBInstanceIdentifier': 'string',
'DBInstanceClass': 'string',
'Engine': 'string',
'DBInstanceStatus': 'string',
'AutomaticRestartTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'DBName': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123,
'HostedZoneId': 'string'
},
'AllocatedStorage': 123,
'InstanceCreateTime': datetime(2015, 1, 1),
'PreferredBackupWindow': 'string',
'BackupRetentionPeriod': 123,
'DBSecurityGroups': [
{
'DBSecurityGroupName': 'string',
'Status': 'string'
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'DBParameterGroups': [
{
'DBParameterGroupName': 'string',
'ParameterApplyStatus': 'string'
},
],
'AvailabilityZone': 'string',
'DBSubnetGroup': {
'DBSubnetGroupName': 'string',
'DBSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetOutpost': {
'Arn': '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',
]
},
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
],
'IAMDatabaseAuthenticationEnabled': True|False,
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1)
},
'LatestRestorableTime': datetime(2015, 1, 1),
'MultiAZ': True|False,
'EngineVersion': 'string',
'AutoMinorVersionUpgrade': True|False,
'ReadReplicaSourceDBInstanceIdentifier': 'string',
'ReadReplicaDBInstanceIdentifiers': [
'string',
],
'ReadReplicaDBClusterIdentifiers': [
'string',
],
'ReplicaMode': 'open-read-only'|'mounted',
'LicenseModel': 'string',
'Iops': 123,
'OptionGroupMemberships': [
{
'OptionGroupName': 'string',
'Status': 'string'
},
],
'CharacterSetName': 'string',
'NcharCharacterSetName': 'string',
'SecondaryAvailabilityZone': 'string',
'PubliclyAccessible': True|False,
'StatusInfos': [
{
'StatusType': 'string',
'Normal': True|False,
'Status': 'string',
'Message': 'string'
},
],
'StorageType': 'string',
'TdeCredentialArn': 'string',
'DbInstancePort': 123,
'DBClusterIdentifier': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbiResourceId': 'string',
'CACertificateIdentifier': 'string',
'DomainMemberships': [
{
'Domain': 'string',
'Status': 'string',
'FQDN': 'string',
'IAMRoleName': 'string'
},
],
'CopyTagsToSnapshot': True|False,
'MonitoringInterval': 123,
'EnhancedMonitoringResourceArn': 'string',
'MonitoringRoleArn': 'string',
'PromotionTier': 123,
'DBInstanceArn': 'string',
'Timezone': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'PerformanceInsightsEnabled': True|False,
'PerformanceInsightsKMSKeyId': 'string',
'PerformanceInsightsRetentionPeriod': 123,
'EnabledCloudwatchLogsExports': [
'string',
],
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
],
'DeletionProtection': True|False,
'AssociatedRoles': [
{
'RoleArn': 'string',
'FeatureName': 'string',
'Status': 'string'
},
],
'ListenerEndpoint': {
'Address': 'string',
'Port': 123,
'HostedZoneId': 'string'
},
'MaxAllocatedStorage': 123,
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'DBInstanceAutomatedBackupsReplications': [
{
'DBInstanceAutomatedBackupsArn': 'string'
},
],
'CustomerOwnedIpEnabled': True|False,
'AwsBackupRecoveryPointArn': 'string',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamEngineNativeAuditFieldsIncluded': True|False,
'AutomationMode': 'full'|'all-paused',
'ResumeFullAutomationModeTime': datetime(2015, 1, 1),
'CustomIamInstanceProfile': 'string',
'BackupTarget': 'string',
'NetworkType': 'string',
'ActivityStreamPolicyStatus': 'locked'|'unlocked'|'locking-policy'|'unlocking-policy'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Contains the result of a successful invocation of the DescribeDBInstances action.
DBInstances (list) --
A list of DBInstance instances.
(dict) --
Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations CreateDBInstance , CreateDBInstanceReadReplica , DeleteDBInstance , DescribeDBInstances , ModifyDBInstance , PromoteReadReplica , RebootDBInstance , RestoreDBInstanceFromDBSnapshot , RestoreDBInstanceFromS3 , RestoreDBInstanceToPointInTime , StartDBInstance , and StopDBInstance .
DBInstanceIdentifier (string) --
Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
DBInstanceClass (string) --
Contains the name of the compute and memory capacity class of the DB instance.
Engine (string) --
The name of the database engine to be used for this DB instance.
DBInstanceStatus (string) --
Specifies the current state of this database.
For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.
AutomaticRestartTime (datetime) --
The time when a stopped DB instance is restarted automatically.
MasterUsername (string) --
Contains the master username for the DB instance.
DBName (string) --
The meaning of this parameter differs according to the database engine you use.
MySQL, MariaDB, SQL Server, PostgreSQL
Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
Type: String
Oracle
Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
Endpoint (dict) --
Specifies the connection endpoint.
Note
The endpoint might not be shown for instances whose status is creating .
Address (string) --
Specifies the DNS address of the DB 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.
AllocatedStorage (integer) --
Specifies the allocated storage size specified in gibibytes (GiB).
InstanceCreateTime (datetime) --
Provides the date and time the DB 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 DB snapshots are retained.
DBSecurityGroups (list) --
A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
(dict) --
This data type is used as a response element in the following actions:
ModifyDBInstanceRebootDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceToPointInTimeDBSecurityGroupName (string) --
The name of the DB security group.
Status (string) --
The status of the DB security group.
VpcSecurityGroups (list) --
Provides a list of VPC security group elements that the DB instance belongs to.
(dict) --
This data type is used as a response element for queries on VPC security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The membership status of the VPC security group.
Currently, the only valid status is active .
DBParameterGroups (list) --
Provides the list of DB parameter groups applied to this DB instance.
(dict) --
The status of the DB parameter group.
This data type is used as a response element in the following actions:
CreateDBInstanceCreateDBInstanceReadReplicaDeleteDBInstanceModifyDBInstanceRebootDBInstanceRestoreDBInstanceFromDBSnapshotDBParameterGroupName (string) --
The name of the DB parameter group.
ParameterApplyStatus (string) --
The status of parameter updates.
AvailabilityZone (string) --
Specifies the name of the Availability Zone the DB instance is located in.
DBSubnetGroup (dict) --
Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
DBSubnetGroupName (string) --
The name of the DB subnet group.
DBSubnetGroupDescription (string) --
Provides the description of the DB subnet group.
VpcId (string) --
Provides the VpcId of the DB subnet group.
SubnetGroupStatus (string) --
Provides the status of the DB subnet group.
Subnets (list) --
Contains a list of Subnet elements.
(dict) --
This data type is used as a response element for the DescribeDBSubnetGroups operation.
SubnetIdentifier (string) --
The identifier of the subnet.
SubnetAvailabilityZone (dict) --
Contains Availability Zone information.
This data type is used as an element in the OrderableDBInstanceOption data type.
Name (string) --
The name of the Availability Zone.
SubnetOutpost (dict) --
If the subnet is associated with an Outpost, this value specifies the Outpost.
For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
Arn (string) --
The Amazon Resource Name (ARN) of the Outpost.
SubnetStatus (string) --
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:
IPV4DUALA DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
PendingModifiedValues (dict) --
A value that specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
DBInstanceClass (string) --
The name of the compute and memory capacity class for the DB instance.
AllocatedStorage (integer) --
The allocated storage size for the DB instance specified in gibibytes (GiB).
MasterUserPassword (string) --
The master credentials for the DB instance.
Port (integer) --
The port for the DB instance.
BackupRetentionPeriod (integer) --
The number of days for which automated backups are retained.
MultiAZ (boolean) --
A value that indicates that the Single-AZ DB instance will change to a Multi-AZ deployment.
EngineVersion (string) --
The database engine version.
LicenseModel (string) --
The license model for the DB instance.
Valid values: license-included | bring-your-own-license | general-public-license
Iops (integer) --
The Provisioned IOPS value for the DB instance.
DBInstanceIdentifier (string) --
The database identifier for the DB instance.
StorageType (string) --
The storage type of the DB instance.
CACertificateIdentifier (string) --
The identifier of the CA certificate for the DB instance.
DBSubnetGroupName (string) --
The DB subnet group for the DB instance.
PendingCloudwatchLogsExports (dict) --
A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.
LogTypesToEnable (list) --
Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.
LogTypesToDisable (list) --
Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.
ProcessorFeatures (list) --
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
(dict) --
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstanceModifyDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceFromS3RestoreDBInstanceToPointInTimeYou can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstancesDescribeDBSnapshotsDescribeValidDBInstanceModificationsIf you call DescribeDBInstances , ProcessorFeature returns non-null values only if the following conditions are met:
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
Name (string) --
The name of the processor feature. Valid names are coreCount and threadsPerCore .
Value (string) --
The value of a processor feature name.
IAMDatabaseAuthenticationEnabled (boolean) --
Whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
AutomationMode (string) --
The automation mode of the RDS Custom DB instance: full or all-paused . If full , the DB instance automates monitoring and instance recovery. If all-paused , the instance pauses automation for the duration set by --resume-full-automation-mode-minutes .
ResumeFullAutomationModeTime (datetime) --
The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
LatestRestorableTime (datetime) --
Specifies the latest time to which a database can be restored with point-in-time restore.
MultiAZ (boolean) --
Specifies if the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom.
EngineVersion (string) --
Indicates the database engine version.
AutoMinorVersionUpgrade (boolean) --
A value that indicates that minor version patches are applied automatically.
ReadReplicaSourceDBInstanceIdentifier (string) --
Contains the identifier of the source DB instance if this DB instance is a read replica.
ReadReplicaDBInstanceIdentifiers (list) --
Contains one or more identifiers of the read replicas associated with this DB instance.
ReadReplicaDBClusterIdentifiers (list) --
Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn't contain information about cross-Region Aurora read replicas.
Note
Currently, each RDS DB instance can have only one Aurora read replica.
ReplicaMode (string) --
The open mode of an Oracle read replica. The default is open-read-only . For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide .
Note
This attribute is only supported in RDS for Oracle.
LicenseModel (string) --
License model information for this DB instance. This setting doesn't apply to RDS Custom.
Iops (integer) --
Specifies the Provisioned IOPS (I/O operations per second) value.
OptionGroupMemberships (list) --
Provides the list of option group memberships for this DB instance.
(dict) --
Provides information on the option groups the DB instance is a member of.
OptionGroupName (string) --
The name of the option group that the instance belongs to.
Status (string) --
The status of the DB instance's option group membership. Valid values are: in-sync , pending-apply , pending-removal , pending-maintenance-apply , pending-maintenance-removal , applying , removing , and failed .
CharacterSetName (string) --
If present, specifies the name of the character set that this instance is associated with.
NcharCharacterSetName (string) --
The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.
SecondaryAvailabilityZone (string) --
If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
PubliclyAccessible (boolean) --
Specifies the accessibility options for the DB instance.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance .
StatusInfos (list) --
The status of a read replica. If the instance isn't a read replica, this is blank.
(dict) --
Provides a list of status information for a DB instance.
StatusType (string) --
This value is currently "read replication."
Normal (boolean) --
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 DB instance. For a StatusType of read replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.
Message (string) --
Details of the error if there is an error for the instance. If the instance isn't in an error state, this value is blank.
StorageType (string) --
Specifies the storage type associated with DB instance.
TdeCredentialArn (string) --
The ARN from the key store with which the instance is associated for TDE encryption.
DbInstancePort (integer) --
Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.
DBClusterIdentifier (string) --
If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.
StorageEncrypted (boolean) --
Specifies whether the DB instance is encrypted.
KmsKeyId (string) --
If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
DbiResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB instance is accessed.
CACertificateIdentifier (string) --
The identifier of the CA certificate for this DB instance.
DomainMemberships (list) --
The Active Directory Domain membership records associated with the DB instance.
(dict) --
An Active Directory Domain membership record associated with the DB instance or cluster.
Domain (string) --
The identifier of the Active Directory Domain.
Status (string) --
The status of the Active Directory Domain membership for the DB instance or cluster. Values include joined, pending-join, failed, and so on.
FQDN (string) --
The fully qualified domain name of the Active Directory Domain.
IAMRoleName (string) --
The name of the IAM role to be used when making API calls to the Directory Service.
CopyTagsToSnapshot (boolean) --
Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see DBCluster .
MonitoringInterval (integer) --
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
EnhancedMonitoringResourceArn (string) --
The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
MonitoringRoleArn (string) --
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
PromotionTier (integer) --
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .
DBInstanceArn (string) --
The Amazon Resource Name (ARN) for the DB instance.
Timezone (string) --
The time zone of the DB instance. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.
IAMDatabaseAuthenticationEnabled (boolean) --
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
IAM database authentication can be enabled for the following database engines
PerformanceInsightsEnabled (boolean) --
True if Performance Insights is enabled for the DB instance, and otherwise false.
PerformanceInsightsKMSKeyId (string) --
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
PerformanceInsightsRetentionPeriod (integer) --
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
For example, the following values are valid:
EnabledCloudwatchLogsExports (list) --
A list of log types that this DB instance is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon RDS User Guide.
ProcessorFeatures (list) --
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
(dict) --
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstanceModifyDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceFromS3RestoreDBInstanceToPointInTimeYou can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstancesDescribeDBSnapshotsDescribeValidDBInstanceModificationsIf you call DescribeDBInstances , ProcessorFeature returns non-null values only if the following conditions are met:
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
Name (string) --
The name of the processor feature. Valid names are coreCount and threadsPerCore .
Value (string) --
The value of a processor feature name.
DeletionProtection (boolean) --
Indicates if the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance .
AssociatedRoles (list) --
The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
(dict) --
Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.
FeatureName (string) --
The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion .
Status (string) --
Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf.PENDING - the IAM role ARN is being associated with the DB instance.INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf.ListenerEndpoint (dict) --
Specifies the listener connection endpoint for SQL Server Always On.
Address (string) --
Specifies the DNS address of the DB 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.
MaxAllocatedStorage (integer) --
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
TagList (list) --
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
DBInstanceAutomatedBackupsReplications (list) --
The list of replicated automated backups associated with the DB instance.
(dict) --
Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties.
DBInstanceAutomatedBackupsArn (string) --
The Amazon Resource Name (ARN) of the replicated automated backups.
CustomerOwnedIpEnabled (boolean) --
Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide .
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide .
AwsBackupRecoveryPointArn (string) --
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
ActivityStreamStatus (string) --
The status of the database activity stream.
ActivityStreamKmsKeyId (string) --
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
ActivityStreamKinesisStreamName (string) --
The name of the Amazon Kinesis data stream used for the database activity stream.
ActivityStreamMode (string) --
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. RDS for Oracle always handles these events asynchronously.
ActivityStreamEngineNativeAuditFieldsIncluded (boolean) --
Indicates whether engine-native audit fields are included in the database activity stream.
AutomationMode (string) --
The automation mode of the RDS Custom DB instance: full or all paused . If full , the DB instance automates monitoring and instance recovery. If all paused , the instance pauses automation for the duration set by --resume-full-automation-mode-minutes .
ResumeFullAutomationModeTime (datetime) --
The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
CustomIamInstanceProfile (string) --
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
AWSRDSCustom .For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide .
BackupTarget (string) --
Specifies where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
NetworkType (string) --
The network type of the DB instance.
Valid values:
IPV4DUALThe network type is determined by the DBSubnetGroup specified for the DB instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide and Working with a DB instance in a VPC in the Amazon Aurora User Guide.
ActivityStreamPolicyStatus (string) --
The status of the policy state of the activity stream.
NextToken (string) --
A token to resume pagination.
RDS.Paginator.DescribeDBLogFiles¶paginator = client.get_paginator('describe_db_log_files')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from RDS.Client.describe_db_log_files().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DBInstanceIdentifier='string',
FilenameContains='string',
FileLastWritten=123,
FileSize=123,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The customer-assigned name of the DB instance that contains the log files you want to list.
Constraints:
This parameter isn't currently supported.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'DescribeDBLogFiles': [
{
'LogFileName': 'string',
'LastWritten': 123,
'Size': 123
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
The response from a call to DescribeDBLogFiles .
DescribeDBLogFiles (list) --
The DB log files returned.
(dict) --
This data type is used as a response element to DescribeDBLogFiles .
LogFileName (string) --
The name of the log file for the specified DB instance.
LastWritten (integer) --
A POSIX timestamp when the last log entry was written.
Size (integer) --
The size, in bytes, of the log file for the specified DB instance.
NextToken (string) --
A token to resume pagination.
RDS.Paginator.DescribeDBParameterGroups¶paginator = client.get_paginator('describe_db_parameter_groups')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from RDS.Client.describe_db_parameter_groups().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DBParameterGroupName='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The name of a specific DB parameter group to return details for.
Constraints:
This parameter isn't currently supported.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'DBParameterGroups': [
{
'DBParameterGroupName': 'string',
'DBParameterGroupFamily': 'string',
'Description': 'string',
'DBParameterGroupArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Contains the result of a successful invocation of the DescribeDBParameterGroups action.
DBParameterGroups (list) --
A list of DBParameterGroup instances.
(dict) --
Contains the details of an Amazon RDS DB parameter group.
This data type is used as a response element in the DescribeDBParameterGroups action.
DBParameterGroupName (string) --
The name of the DB parameter group.
DBParameterGroupFamily (string) --
The name of the DB parameter group family that this DB parameter group is compatible with.
Description (string) --
Provides the customer-specified description for this DB parameter group.
DBParameterGroupArn (string) --
The Amazon Resource Name (ARN) for the DB parameter group.
NextToken (string) --
A token to resume pagination.
RDS.Paginator.DescribeDBParameters¶paginator = client.get_paginator('describe_db_parameters')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from RDS.Client.describe_db_parameters().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DBParameterGroupName='string',
Source='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of a specific DB parameter group to return details for.
Constraints:
The parameter types to return.
Default: All parameter types returned
Valid Values: user | system | engine-default
This parameter isn't currently supported.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Parameters': [
{
'ParameterName': 'string',
'ParameterValue': 'string',
'Description': 'string',
'Source': 'string',
'ApplyType': 'string',
'DataType': 'string',
'AllowedValues': 'string',
'IsModifiable': True|False,
'MinimumEngineVersion': 'string',
'ApplyMethod': 'immediate'|'pending-reboot',
'SupportedEngineModes': [
'string',
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Contains the result of a successful invocation of the DescribeDBParameters action.
Parameters (list) --
A list of Parameter values.
(dict) --
This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions.
This data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions.
ParameterName (string) --
Specifies the name of the parameter.
ParameterValue (string) --
Specifies the value of the parameter.
Description (string) --
Provides a description of the parameter.
Source (string) --
Indicates the source of the parameter value.
ApplyType (string) --
Specifies the engine specific parameters type.
DataType (string) --
Specifies the valid data type for the parameter.
AllowedValues (string) --
Specifies the valid range of values for the parameter.
IsModifiable (boolean) --
Indicates whether (true ) or not (false ) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
MinimumEngineVersion (string) --
The earliest engine version to which the parameter can apply.
ApplyMethod (string) --
Indicates when to apply parameter updates.
SupportedEngineModes (list) --
The valid DB engine modes.
NextToken (string) --
A token to resume pagination.
RDS.Paginator.DescribeDBProxies¶paginator = client.get_paginator('describe_db_proxies')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from RDS.Client.describe_db_proxies().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DBProxyName='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
This parameter is not currently supported.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'DBProxies': [
{
'DBProxyName': 'string',
'DBProxyArn': 'string',
'Status': 'available'|'modifying'|'incompatible-network'|'insufficient-resource-limits'|'creating'|'deleting'|'suspended'|'suspending'|'reactivating',
'EngineFamily': 'string',
'VpcId': 'string',
'VpcSecurityGroupIds': [
'string',
],
'VpcSubnetIds': [
'string',
],
'Auth': [
{
'Description': 'string',
'UserName': 'string',
'AuthScheme': 'SECRETS',
'SecretArn': 'string',
'IAMAuth': 'DISABLED'|'REQUIRED'
},
],
'RoleArn': 'string',
'Endpoint': 'string',
'RequireTLS': True|False,
'IdleClientTimeout': 123,
'DebugLogging': True|False,
'CreatedDate': datetime(2015, 1, 1),
'UpdatedDate': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
DBProxies (list) --
A return value representing an arbitrary number of DBProxy data structures.
(dict) --
The data structure representing a proxy managed by the RDS Proxy.
This data type is used as a response element in the DescribeDBProxies action.
DBProxyName (string) --
The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.
DBProxyArn (string) --
The Amazon Resource Name (ARN) for the proxy.
Status (string) --
The current status of this proxy. A status of available means the proxy is ready to handle requests. Other values indicate that you must wait for the proxy to be ready, or take some action to resolve an issue.
EngineFamily (string) --
The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. MYSQL supports Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases. POSTGRESQL supports Aurora PostgreSQL and RDS for PostgreSQL databases.
VpcId (string) --
Provides the VPC ID of the DB proxy.
VpcSecurityGroupIds (list) --
Provides a list of VPC security groups that the proxy belongs to.
VpcSubnetIds (list) --
The EC2 subnet IDs for the proxy.
Auth (list) --
One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster.
(dict) --
Returns the details of authentication used by a proxy to log in as a specific database user.
Description (string) --
A user-specified description about the authentication used by a proxy to log in as a specific database user.
UserName (string) --
The name of the database user to which the proxy connects.
AuthScheme (string) --
The type of authentication that the proxy uses for connections from the proxy to the underlying database.
SecretArn (string) --
The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager.
IAMAuth (string) --
Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy.
RoleArn (string) --
The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager.
Endpoint (string) --
The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.
RequireTLS (boolean) --
Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
IdleClientTimeout (integer) --
The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection. The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by later connection requests.
Default: 1800 (30 minutes)
Constraints: 1 to 28,800
DebugLogging (boolean) --
Whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.
CreatedDate (datetime) --
The date and time when the proxy was first created.
UpdatedDate (datetime) --
The date and time when the proxy was last updated.
NextToken (string) --
A token to resume pagination.
RDS.Paginator.DescribeDBProxyEndpoints¶paginator = client.get_paginator('describe_db_proxy_endpoints')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from RDS.Client.describe_db_proxy_endpoints().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DBProxyName='string',
DBProxyEndpointName='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
This parameter is not currently supported.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'DBProxyEndpoints': [
{
'DBProxyEndpointName': 'string',
'DBProxyEndpointArn': 'string',
'DBProxyName': 'string',
'Status': 'available'|'modifying'|'incompatible-network'|'insufficient-resource-limits'|'creating'|'deleting',
'VpcId': 'string',
'VpcSecurityGroupIds': [
'string',
],
'VpcSubnetIds': [
'string',
],
'Endpoint': 'string',
'CreatedDate': datetime(2015, 1, 1),
'TargetRole': 'READ_WRITE'|'READ_ONLY',
'IsDefault': True|False
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
DBProxyEndpoints (list) --
The list of ProxyEndpoint objects returned by the API operation.
(dict) --
The data structure representing an endpoint associated with a DB proxy. RDS automatically creates one endpoint for each DB proxy. For Aurora DB clusters, you can associate additional endpoints with the same DB proxy. These endpoints can be read/write or read-only. They can also reside in different VPCs than the associated DB proxy.
This data type is used as a response element in the DescribeDBProxyEndpoints operation.
DBProxyEndpointName (string) --
The name for the DB proxy endpoint. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.
DBProxyEndpointArn (string) --
The Amazon Resource Name (ARN) for the DB proxy endpoint.
DBProxyName (string) --
The identifier for the DB proxy that is associated with this DB proxy endpoint.
Status (string) --
The current status of this DB proxy endpoint. A status of available means the endpoint is ready to handle requests. Other values indicate that you must wait for the endpoint to be ready, or take some action to resolve an issue.
VpcId (string) --
Provides the VPC ID of the DB proxy endpoint.
VpcSecurityGroupIds (list) --
Provides a list of VPC security groups that the DB proxy endpoint belongs to.
VpcSubnetIds (list) --
The EC2 subnet IDs for the DB proxy endpoint.
Endpoint (string) --
The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.
CreatedDate (datetime) --
The date and time when the DB proxy endpoint was first created.
TargetRole (string) --
A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
IsDefault (boolean) --
A value that indicates whether this endpoint is the default endpoint for the associated DB proxy. Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be either read/write or read-only.
NextToken (string) --
A token to resume pagination.
RDS.Paginator.DescribeDBProxyTargetGroups¶paginator = client.get_paginator('describe_db_proxy_target_groups')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from RDS.Client.describe_db_proxy_target_groups().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DBProxyName='string',
TargetGroupName='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The identifier of the DBProxy associated with the target group.
DBProxyTargetGroup to describe.This parameter is not currently supported.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'TargetGroups': [
{
'DBProxyName': 'string',
'TargetGroupName': 'string',
'TargetGroupArn': 'string',
'IsDefault': True|False,
'Status': 'string',
'ConnectionPoolConfig': {
'MaxConnectionsPercent': 123,
'MaxIdleConnectionsPercent': 123,
'ConnectionBorrowTimeout': 123,
'SessionPinningFilters': [
'string',
],
'InitQuery': 'string'
},
'CreatedDate': datetime(2015, 1, 1),
'UpdatedDate': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
TargetGroups (list) --
An arbitrary number of DBProxyTargetGroup objects, containing details of the corresponding target groups.
(dict) --
Represents a set of RDS DB instances, Aurora DB clusters, or both that a proxy can connect to. Currently, each target group is associated with exactly one RDS DB instance or Aurora DB cluster.
This data type is used as a response element in the DescribeDBProxyTargetGroups action.
DBProxyName (string) --
The identifier for the RDS proxy associated with this target group.
TargetGroupName (string) --
The identifier for the target group. This name must be unique for all target groups owned by your Amazon Web Services account in the specified Amazon Web Services Region.
TargetGroupArn (string) --
The Amazon Resource Name (ARN) representing the target group.
IsDefault (boolean) --
Whether this target group is the first one used for connection requests by the associated proxy. Because each proxy is currently associated with a single target group, currently this setting is always true .
Status (string) --
The current status of this target group. A status of available means the target group is correctly associated with a database. Other values indicate that you must wait for the target group to be ready, or take some action to resolve an issue.
ConnectionPoolConfig (dict) --
The settings that determine the size and behavior of the connection pool for the target group.
MaxConnectionsPercent (integer) --
The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.
MaxIdleConnectionsPercent (integer) --
Controls how actively the proxy closes idle database connections in the connection pool. The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group. With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.
ConnectionBorrowTimeout (integer) --
The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the proxy has opened its maximum number of connections and all connections are busy with client sessions.
SessionPinningFilters (list) --
Each item in the list represents a class of SQL operations that normally cause all later statements in a session using a proxy to be pinned to the same underlying database connection. Including an item in the list exempts that class of SQL operations from the pinning behavior. Currently, the only allowed value is EXCLUDE_VARIABLE_SETS .
InitQuery (string) --
One or more SQL statements for the proxy to run when opening each new database connection. Typically used with SET statements to make sure that each connection has identical settings such as time zone and character set. This setting is empty by default. For multiple statements, use semicolons as the separator. You can also include multiple variables in a single SET statement, such as SET x=1, y=2 .
CreatedDate (datetime) --
The date and time when the target group was first created.
UpdatedDate (datetime) --
The date and time when the target group was last updated.
NextToken (string) --
A token to resume pagination.
RDS.Paginator.DescribeDBProxyTargets¶paginator = client.get_paginator('describe_db_proxy_targets')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from RDS.Client.describe_db_proxy_targets().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DBProxyName='string',
TargetGroupName='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The identifier of the DBProxyTarget to describe.
DBProxyTargetGroup to describe.This parameter is not currently supported.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Targets': [
{
'TargetArn': 'string',
'Endpoint': 'string',
'TrackedClusterId': 'string',
'RdsResourceId': 'string',
'Port': 123,
'Type': 'RDS_INSTANCE'|'RDS_SERVERLESS_ENDPOINT'|'TRACKED_CLUSTER',
'Role': 'READ_WRITE'|'READ_ONLY'|'UNKNOWN',
'TargetHealth': {
'State': 'REGISTERING'|'AVAILABLE'|'UNAVAILABLE',
'Reason': 'UNREACHABLE'|'CONNECTION_FAILED'|'AUTH_FAILURE'|'PENDING_PROXY_CAPACITY'|'INVALID_REPLICATION_STATE',
'Description': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Targets (list) --
An arbitrary number of DBProxyTarget objects, containing details of the corresponding targets.
(dict) --
Contains the details for an RDS Proxy target. It represents an RDS DB instance or Aurora DB cluster that the proxy can connect to. One or more targets are associated with an RDS Proxy target group.
This data type is used as a response element in the DescribeDBProxyTargets action.
TargetArn (string) --
The Amazon Resource Name (ARN) for the RDS DB instance or Aurora DB cluster.
Endpoint (string) --
The writer endpoint for the RDS DB instance or Aurora DB cluster.
TrackedClusterId (string) --
The DB cluster identifier when the target represents an Aurora DB cluster. This field is blank when the target represents an RDS DB instance.
RdsResourceId (string) --
The identifier representing the target. It can be the instance identifier for an RDS DB instance, or the cluster identifier for an Aurora DB cluster.
Port (integer) --
The port that the RDS Proxy uses to connect to the target RDS DB instance or Aurora DB cluster.
Type (string) --
Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents.
Role (string) --
A value that indicates whether the target of the proxy can be used for read/write or read-only operations.
TargetHealth (dict) --
Information about the connection health of the RDS Proxy target.
State (string) --
The current state of the connection health lifecycle for the RDS Proxy target. The following is a typical lifecycle example for the states of an RDS Proxy target:
registering>unavailable>available>unavailable>available
Reason (string) --
The reason for the current health State of the RDS Proxy target.
Description (string) --
A description of the health of the RDS Proxy target. If the State is AVAILABLE , a description is not included.
NextToken (string) --
A token to resume pagination.
RDS.Paginator.DescribeDBSecurityGroups¶paginator = client.get_paginator('describe_db_security_groups')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from RDS.Client.describe_db_security_groups().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DBSecurityGroupName='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
This parameter isn't currently supported.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'DBSecurityGroups': [
{
'OwnerId': 'string',
'DBSecurityGroupName': 'string',
'DBSecurityGroupDescription': 'string',
'VpcId': 'string',
'EC2SecurityGroups': [
{
'Status': 'string',
'EC2SecurityGroupName': 'string',
'EC2SecurityGroupId': 'string',
'EC2SecurityGroupOwnerId': 'string'
},
],
'IPRanges': [
{
'Status': 'string',
'CIDRIP': 'string'
},
],
'DBSecurityGroupArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Contains the result of a successful invocation of the DescribeDBSecurityGroups action.
DBSecurityGroups (list) --
A list of DBSecurityGroup instances.
(dict) --
Contains the details for an Amazon RDS DB security group.
This data type is used as a response element in the DescribeDBSecurityGroups action.
OwnerId (string) --
Provides the Amazon Web Services ID of the owner of a specific DB security group.
DBSecurityGroupName (string) --
Specifies the name of the DB security group.
DBSecurityGroupDescription (string) --
Provides the description of the DB security group.
VpcId (string) --
Provides the VpcId of the DB security group.
EC2SecurityGroups (list) --
Contains a list of EC2SecurityGroup elements.
(dict) --
This data type is used as a response element in the following actions:
AuthorizeDBSecurityGroupIngressDescribeDBSecurityGroupsRevokeDBSecurityGroupIngressStatus (string) --
Provides the status of the EC2 security group. Status can be "authorizing", "authorized", "revoking", and "revoked".
EC2SecurityGroupName (string) --
Specifies the name of the EC2 security group.
EC2SecurityGroupId (string) --
Specifies the id of the EC2 security group.
EC2SecurityGroupOwnerId (string) --
Specifies the Amazon Web Services ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.
IPRanges (list) --
Contains a list of IPRange elements.
(dict) --
This data type is used as a response element in the DescribeDBSecurityGroups action.
Status (string) --
Specifies the status of the IP range. Status can be "authorizing", "authorized", "revoking", and "revoked".
CIDRIP (string) --
Specifies the IP range.
DBSecurityGroupArn (string) --
The Amazon Resource Name (ARN) for the DB security group.
NextToken (string) --
A token to resume pagination.
RDS.Paginator.DescribeDBSnapshots¶paginator = client.get_paginator('describe_db_snapshots')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from RDS.Client.describe_db_snapshots().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DBInstanceIdentifier='string',
DBSnapshotIdentifier='string',
SnapshotType='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
IncludeShared=True|False,
IncludePublic=True|False,
DbiResourceId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The ID of the DB instance to retrieve the list of DB snapshots for. This parameter isn't case-sensitive.
Constraints:
A specific DB snapshot identifier to describe. This value is stored as a lowercase string.
Constraints:
SnapshotType parameter must also be specified.The type of snapshots to be returned. You can specify one of the following values:
automated - Return all DB snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.manual - Return all DB snapshots that have been taken by my Amazon Web Services account.shared - Return all manual DB snapshots that have been shared to my Amazon Web Services account.public - Return all DB snapshots that have been marked as public.awsbackup - Return the DB snapshots managed by the Amazon Web Services Backup service. For information about Amazon Web Services Backup, see the ` Amazon Web Services Backup Developer Guide. https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html`__ The awsbackup type does not apply to Aurora.If you don't specify a SnapshotType value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by enabling the IncludeShared parameter. You can include public snapshots with these results by enabling the IncludePublic parameter.
The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated . The IncludePublic parameter doesn't apply when SnapshotType is set to shared . The IncludeShared parameter doesn't apply when SnapshotType is set to public .
A filter that specifies one or more DB snapshots to describe.
Supported filters:
db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).db-snapshot-id - Accepts DB snapshot identifiers.dbi-resource-id - Accepts identifiers of source DB instances.snapshot-type - Accepts types of DB snapshots.engine - Accepts names of database engines.A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
A value that indicates whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.
You can give an Amazon Web Services account permission to restore a manual DB snapshot from another Amazon Web Services account by using the ModifyDBSnapshotAttribute API action.
This setting doesn't apply to RDS Custom.
A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.
You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.
This setting doesn't apply to RDS Custom.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'DBSnapshots': [
{
'DBSnapshotIdentifier': 'string',
'DBInstanceIdentifier': 'string',
'SnapshotCreateTime': datetime(2015, 1, 1),
'Engine': 'string',
'AllocatedStorage': 123,
'Status': 'string',
'Port': 123,
'AvailabilityZone': 'string',
'VpcId': 'string',
'InstanceCreateTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'EngineVersion': 'string',
'LicenseModel': 'string',
'SnapshotType': 'string',
'Iops': 123,
'OptionGroupName': 'string',
'PercentProgress': 123,
'SourceRegion': 'string',
'SourceDBSnapshotIdentifier': 'string',
'StorageType': 'string',
'TdeCredentialArn': 'string',
'Encrypted': True|False,
'KmsKeyId': 'string',
'DBSnapshotArn': 'string',
'Timezone': 'string',
'IAMDatabaseAuthenticationEnabled': True|False,
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
],
'DbiResourceId': 'string',
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'OriginalSnapshotCreateTime': datetime(2015, 1, 1),
'SnapshotTarget': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Contains the result of a successful invocation of the DescribeDBSnapshots action.
DBSnapshots (list) --
A list of DBSnapshot instances.
(dict) --
Contains the details of an Amazon RDS DB snapshot.
This data type is used as a response element in the DescribeDBSnapshots action.
DBSnapshotIdentifier (string) --
Specifies the identifier for the DB snapshot.
DBInstanceIdentifier (string) --
Specifies the DB instance identifier of the DB instance this DB snapshot was created from.
SnapshotCreateTime (datetime) --
Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied.
Engine (string) --
Specifies the name of the database engine.
AllocatedStorage (integer) --
Specifies the allocated storage size in gibibytes (GiB).
Status (string) --
Specifies the status of this DB snapshot.
Port (integer) --
Specifies the port that the database engine was listening on at the time of the snapshot.
AvailabilityZone (string) --
Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
VpcId (string) --
Provides the VPC ID associated with the DB snapshot.
InstanceCreateTime (datetime) --
Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.
MasterUsername (string) --
Provides the master username for the DB snapshot.
EngineVersion (string) --
Specifies the version of the database engine.
LicenseModel (string) --
License model information for the restored DB instance.
SnapshotType (string) --
Provides the type of the DB snapshot.
Iops (integer) --
Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
OptionGroupName (string) --
Provides the option group name for the DB snapshot.
PercentProgress (integer) --
The percentage of the estimated data that has been transferred.
SourceRegion (string) --
The Amazon Web Services Region that the DB snapshot was created in or copied from.
SourceDBSnapshotIdentifier (string) --
The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has a value in the case of a cross-account or cross-Region copy.
StorageType (string) --
Specifies the storage type associated with DB snapshot.
TdeCredentialArn (string) --
The ARN from the key store with which to associate the instance for TDE encryption.
Encrypted (boolean) --
Specifies whether the DB snapshot is encrypted.
KmsKeyId (string) --
If Encrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
DBSnapshotArn (string) --
The Amazon Resource Name (ARN) for the DB snapshot.
Timezone (string) --
The time zone of the DB snapshot. In most cases, the Timezone element is empty. Timezone content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.
IAMDatabaseAuthenticationEnabled (boolean) --
True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
ProcessorFeatures (list) --
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.
(dict) --
Contains the processor features of a DB instance class.
To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
CreateDBInstanceModifyDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceFromS3RestoreDBInstanceToPointInTimeYou can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.
In addition, you can use the following actions for DB instance class processor information:
DescribeDBInstancesDescribeDBSnapshotsDescribeValidDBInstanceModificationsIf you call DescribeDBInstances , ProcessorFeature returns non-null values only if the following conditions are met:
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
Name (string) --
The name of the processor feature. Valid names are coreCount and threadsPerCore .
Value (string) --
The value of a processor feature name.
DbiResourceId (string) --
The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.
TagList (list) --
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
OriginalSnapshotCreateTime (datetime) --
Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied.
SnapshotTarget (string) --
Specifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
NextToken (string) --
A token to resume pagination.
RDS.Paginator.DescribeDBSubnetGroups¶paginator = client.get_paginator('describe_db_subnet_groups')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from RDS.Client.describe_db_subnet_groups().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DBSubnetGroupName='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
This parameter isn't currently supported.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'DBSubnetGroups': [
{
'DBSubnetGroupName': 'string',
'DBSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetOutpost': {
'Arn': 'string'
},
'SubnetStatus': 'string'
},
],
'DBSubnetGroupArn': 'string',
'SupportedNetworkTypes': [
'string',
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Contains the result of a successful invocation of the DescribeDBSubnetGroups action.
DBSubnetGroups (list) --
A list of DBSubnetGroup instances.
(dict) --
Contains the details of an Amazon RDS DB subnet group.
This data type is used as a response element in the DescribeDBSubnetGroups action.
DBSubnetGroupName (string) --
The name of the DB subnet group.
DBSubnetGroupDescription (string) --
Provides the description of the DB subnet group.
VpcId (string) --
Provides the VpcId of the DB subnet group.
SubnetGroupStatus (string) --
Provides the status of the DB subnet group.
Subnets (list) --
Contains a list of Subnet elements.
(dict) --
This data type is used as a response element for the DescribeDBSubnetGroups operation.
SubnetIdentifier (string) --
The identifier of the subnet.
SubnetAvailabilityZone (dict) --
Contains Availability Zone information.
This data type is used as an element in the OrderableDBInstanceOption data type.
Name (string) --
The name of the Availability Zone.
SubnetOutpost (dict) --
If the subnet is associated with an Outpost, this value specifies the Outpost.
For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
Arn (string) --
The Amazon Resource Name (ARN) of the Outpost.
SubnetStatus (string) --
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:
IPV4DUALA DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
NextToken (string) --
A token to resume pagination.
RDS.Paginator.DescribeEngineDefaultClusterParameters¶paginator = client.get_paginator('describe_engine_default_cluster_parameters')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from RDS.Client.describe_engine_default_cluster_parameters().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DBParameterGroupFamily='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of the DB cluster parameter group family to return engine parameter information for.
This parameter isn't currently supported.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'EngineDefaults': {
'DBParameterGroupFamily': 'string',
'Marker': 'string',
'Parameters': [
{
'ParameterName': 'string',
'ParameterValue': 'string',
'Description': 'string',
'Source': 'string',
'ApplyType': 'string',
'DataType': 'string',
'AllowedValues': 'string',
'IsModifiable': True|False,
'MinimumEngineVersion': 'string',
'ApplyMethod': 'immediate'|'pending-reboot',
'SupportedEngineModes': [
'string',
]
},
]
},
'NextToken': 'string'
}
Response Structure
(dict) --
EngineDefaults (dict) --
Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.
DBParameterGroupFamily (string) --
Specifies the name of the DB parameter group family that the engine default parameters apply to.
Marker (string) --
An optional pagination token provided by a previous EngineDefaults request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
Parameters (list) --
Contains a list of engine default parameters.
(dict) --
This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions.
This data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions.
ParameterName (string) --
Specifies the name of the parameter.
ParameterValue (string) --
Specifies the value of the parameter.
Description (string) --
Provides a description of the parameter.
Source (string) --
Indicates the source of the parameter value.
ApplyType (string) --
Specifies the engine specific parameters type.
DataType (string) --
Specifies the valid data type for the parameter.
AllowedValues (string) --
Specifies the valid range of values for the parameter.
IsModifiable (boolean) --
Indicates whether (true ) or not (false ) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
MinimumEngineVersion (string) --
The earliest engine version to which the parameter can apply.
ApplyMethod (string) --
Indicates when to apply parameter updates.
SupportedEngineModes (list) --
The valid DB engine modes.
NextToken (string) --
A token to resume pagination.
RDS.Paginator.DescribeEngineDefaultParameters¶paginator = client.get_paginator('describe_engine_default_parameters')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from RDS.Client.describe_engine_default_parameters().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DBParameterGroupFamily='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of the DB parameter group family.
Valid Values:
aurora5.6aurora-mysql5.7aurora-mysql8.0aurora-postgresql10aurora-postgresql11aurora-postgresql12aurora-postgresql13mariadb10.2mariadb10.3mariadb10.4mariadb10.5mariadb10.6mysql5.7mysql8.0postgres10postgres11postgres12postgres13postgres14sqlserver-ee-11.0sqlserver-ee-12.0sqlserver-ee-13.0sqlserver-ee-14.0sqlserver-ee-15.0sqlserver-ex-11.0sqlserver-ex-12.0sqlserver-ex-13.0sqlserver-ex-14.0sqlserver-ex-15.0sqlserver-se-11.0sqlserver-se-12.0sqlserver-se-13.0sqlserver-se-14.0sqlserver-se-15.0sqlserver-web-11.0sqlserver-web-12.0sqlserver-web-13.0sqlserver-web-14.0sqlserver-web-15.0This parameter isn't currently supported.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'EngineDefaults': {
'DBParameterGroupFamily': 'string',
'Marker': 'string',
'Parameters': [
{
'ParameterName': 'string',
'ParameterValue': 'string',
'Description': 'string',
'Source': 'string',
'ApplyType': 'string',
'DataType': 'string',
'AllowedValues': 'string',
'IsModifiable': True|False,
'MinimumEngineVersion': 'string',
'ApplyMethod': 'immediate'|'pending-reboot',
'SupportedEngineModes': [
'string',
]
},
]
},
'NextToken': 'string'
}
Response Structure
(dict) --
EngineDefaults (dict) --
Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.
DBParameterGroupFamily (string) --
Specifies the name of the DB parameter group family that the engine default parameters apply to.
Marker (string) --
An optional pagination token provided by a previous EngineDefaults request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
Parameters (list) --
Contains a list of engine default parameters.
(dict) --
This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions.
This data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions.
ParameterName (string) --
Specifies the name of the parameter.
ParameterValue (string) --
Specifies the value of the parameter.
Description (string) --
Provides a description of the parameter.
Source (string) --
Indicates the source of the parameter value.
ApplyType (string) --
Specifies the engine specific parameters type.
DataType (string) --
Specifies the valid data type for the parameter.
AllowedValues (string) --
Specifies the valid range of values for the parameter.
IsModifiable (boolean) --
Indicates whether (true ) or not (false ) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
MinimumEngineVersion (string) --
The earliest engine version to which the parameter can apply.
ApplyMethod (string) --
Indicates when to apply parameter updates.
SupportedEngineModes (list) --
The valid DB engine modes.
NextToken (string) --
A token to resume pagination.
RDS.Paginator.DescribeEventSubscriptions¶paginator = client.get_paginator('describe_event_subscriptions')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from RDS.Client.describe_event_subscriptions().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
SubscriptionName='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
This parameter isn't currently supported.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'EventSubscriptionsList': [
{
'CustomerAwsId': 'string',
'CustSubscriptionId': 'string',
'SnsTopicArn': 'string',
'Status': 'string',
'SubscriptionCreationTime': 'string',
'SourceType': 'string',
'SourceIdsList': [
'string',
],
'EventCategoriesList': [
'string',
],
'Enabled': True|False,
'EventSubscriptionArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Data returned by the DescribeEventSubscriptions action.
EventSubscriptionsList (list) --
A list of EventSubscriptions data types.
(dict) --
Contains the results of a successful invocation of the DescribeEventSubscriptions action.
CustomerAwsId (string) --
The Amazon Web Services customer account associated with the RDS event notification subscription.
CustSubscriptionId (string) --
The RDS event notification subscription Id.
SnsTopicArn (string) --
The topic ARN of the RDS event notification subscription.
Status (string) --
The status of the RDS event notification subscription.
Constraints:
Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist
The status "no-permission" indicates that RDS no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.
SubscriptionCreationTime (string) --
The time the RDS event notification subscription was created.
SourceType (string) --
The source type for the RDS event notification subscription.
SourceIdsList (list) --
A list of source IDs for the RDS event notification subscription.
EventCategoriesList (list) --
A list of event categories for the RDS event notification subscription.
Enabled (boolean) --
A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.
EventSubscriptionArn (string) --
The Amazon Resource Name (ARN) for the event subscription.
NextToken (string) --
A token to resume pagination.
RDS.Paginator.DescribeEvents¶paginator = client.get_paginator('describe_events')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from RDS.Client.describe_events().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
SourceIdentifier='string',
SourceType='db-instance'|'db-parameter-group'|'db-security-group'|'db-snapshot'|'db-cluster'|'db-cluster-snapshot'|'custom-engine-version'|'db-proxy',
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
Duration=123,
EventCategories=[
'string',
],
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.
Constraints:
SourceIdentifier is supplied, SourceType must also be provided.DBInstanceIdentifier value must be supplied.DBClusterIdentifier value must be supplied.DBParameterGroupName value must be supplied.DBSecurityGroupName value must be supplied.DBSnapshotIdentifier value must be supplied.DBClusterSnapshotIdentifier value must be supplied.DBProxyName value must be supplied.The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z
The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z
The number of minutes to retrieve events for.
Default: 60
A list of event categories that trigger notifications for a event notification subscription.
This parameter isn't currently supported.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Events': [
{
'SourceIdentifier': 'string',
'SourceType': 'db-instance'|'db-parameter-group'|'db-security-group'|'db-snapshot'|'db-cluster'|'db-cluster-snapshot'|'custom-engine-version'|'db-proxy',
'Message': 'string',
'EventCategories': [
'string',
],
'Date': datetime(2015, 1, 1),
'SourceArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Contains the result of a successful invocation of the DescribeEvents action.
Events (list) --
A list of Event instances.
(dict) --
This data type is used as a response element in the DescribeEvents action.
SourceIdentifier (string) --
Provides the identifier for the source of the event.
SourceType (string) --
Specifies the source type for this event.
Message (string) --
Provides the text of this event.
EventCategories (list) --
Specifies the category for the event.
Date (datetime) --
Specifies the date and time of the event.
SourceArn (string) --
The Amazon Resource Name (ARN) for the event.
NextToken (string) --
A token to resume pagination.
RDS.Paginator.DescribeExportTasks¶paginator = client.get_paginator('describe_export_tasks')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from RDS.Client.describe_export_tasks().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ExportTaskIdentifier='string',
SourceArn='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Filters specify one or more snapshot exports to describe. The filters are specified as name-value pairs that define what to include in the output. Filter names and values are case-sensitive.
Supported filters include the following:
export-task-identifier - An identifier for the snapshot export task.s3-bucket - The Amazon S3 bucket the snapshot is exported to.source-arn - The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3status - The status of the export task. Must be lowercase. Valid statuses are the following:canceledcancelingcompletefailedin_progressstartingA filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ExportTasks': [
{
'ExportTaskIdentifier': 'string',
'SourceArn': 'string',
'ExportOnly': [
'string',
],
'SnapshotTime': datetime(2015, 1, 1),
'TaskStartTime': datetime(2015, 1, 1),
'TaskEndTime': datetime(2015, 1, 1),
'S3Bucket': 'string',
'S3Prefix': 'string',
'IamRoleArn': 'string',
'KmsKeyId': 'string',
'Status': 'string',
'PercentProgress': 123,
'TotalExtractedDataInGB': 123,
'FailureCause': 'string',
'WarningMessage': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ExportTasks (list) --
Information about an export of a snapshot to Amazon S3.
(dict) --
Contains the details of a snapshot export to Amazon S3.
This data type is used as a response element in the DescribeExportTasks action.
ExportTaskIdentifier (string) --
A unique identifier for the snapshot export task. This ID isn't an identifier for the Amazon S3 bucket where the snapshot is exported to.
SourceArn (string) --
The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.
ExportOnly (list) --
The data exported from the snapshot. Valid values are the following:
database - Export all the data from a specified database.database.table table-name - Export a table of the snapshot. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.database.schema schema-name - Export a database schema of the snapshot. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.database.schema.table table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.SnapshotTime (datetime) --
The time that the snapshot was created.
TaskStartTime (datetime) --
The time that the snapshot export task started.
TaskEndTime (datetime) --
The time that the snapshot export task completed.
S3Bucket (string) --
The Amazon S3 bucket that the snapshot is exported to.
S3Prefix (string) --
The Amazon S3 bucket prefix that is the file name and path of the exported snapshot.
IamRoleArn (string) --
The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot.
KmsKeyId (string) --
The key identifier of the Amazon Web Services KMS key that is used to encrypt the snapshot when it's exported to Amazon S3. The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the snapshot export must have encryption and decryption permissions to use this KMS key.
Status (string) --
The progress status of the export task.
PercentProgress (integer) --
The progress of the snapshot export task as a percentage.
TotalExtractedDataInGB (integer) --
The total amount of data exported, in gigabytes.
FailureCause (string) --
The reason the export failed, if it failed.
WarningMessage (string) --
A warning about the snapshot export task.
NextToken (string) --
A token to resume pagination.
RDS.Paginator.DescribeGlobalClusters¶paginator = client.get_paginator('describe_global_clusters')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from RDS.Client.describe_global_clusters().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
GlobalClusterIdentifier='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.
Constraints:
This parameter isn't currently supported.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'GlobalClusters': [
{
'GlobalClusterIdentifier': 'string',
'GlobalClusterResourceId': 'string',
'GlobalClusterArn': 'string',
'Status': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'DatabaseName': 'string',
'StorageEncrypted': True|False,
'DeletionProtection': True|False,
'GlobalClusterMembers': [
{
'DBClusterArn': 'string',
'Readers': [
'string',
],
'IsWriter': True|False,
'GlobalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'unknown'
},
],
'FailoverState': {
'Status': 'pending'|'failing-over'|'cancelling',
'FromDbClusterArn': 'string',
'ToDbClusterArn': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
GlobalClusters (list) --
The list of global clusters returned by this request.
(dict) --
A data type representing an Aurora global database.
GlobalClusterIdentifier (string) --
Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster.
GlobalClusterResourceId (string) --
The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB cluster is accessed.
GlobalClusterArn (string) --
The Amazon Resource Name (ARN) for the global database cluster.
Status (string) --
Specifies the current state of this global database cluster.
Engine (string) --
The Aurora database engine used by the global database cluster.
EngineVersion (string) --
Indicates the database engine version.
DatabaseName (string) --
The default database name within the new global database cluster.
StorageEncrypted (boolean) --
The storage encryption setting for the global database cluster.
DeletionProtection (boolean) --
The deletion protection setting for the new global database cluster.
GlobalClusterMembers (list) --
The list of cluster IDs for secondary clusters within the global database cluster. Currently limited to 1 item.
(dict) --
A data structure with information about any primary and secondary clusters associated with an Aurora global database.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for each Aurora cluster.
Readers (list) --
The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global database.
IsWriter (boolean) --
Specifies whether the Aurora cluster is the primary cluster (that is, has read-write capability) for the Aurora global database with which it is associated.
GlobalWriteForwardingStatus (string) --
Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.
FailoverState (dict) --
A data object containing all properties for the current state of an in-process or pending failover process for this Aurora global database. This object is empty unless the FailoverGlobalCluster API operation has been called on this Aurora global database ( GlobalCluster ).
Status (string) --
The current status of the Aurora global database ( GlobalCluster ). Possible values are as follows:
GlobalCluster 's primary DB cluster and the specified secondary DB cluster are being verified before the failover process can start.FromDbClusterArn (string) --
The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being demoted, and which is associated with this state.
ToDbClusterArn (string) --
The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being promoted, and which is associated with this state.
NextToken (string) --
A token to resume pagination.
RDS.Paginator.DescribeOptionGroupOptions¶paginator = client.get_paginator('describe_option_group_options')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from RDS.Client.describe_option_group_options().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
EngineName='string',
MajorEngineVersion='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
A required parameter. Options available for the given engine name are described.
Valid Values:
mariadbmysqloracle-eeoracle-ee-cdboracle-se2oracle-se2-cdbpostgressqlserver-eesqlserver-sesqlserver-exsqlserver-webThis parameter isn't currently supported.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'OptionGroupOptions': [
{
'Name': 'string',
'Description': 'string',
'EngineName': 'string',
'MajorEngineVersion': 'string',
'MinimumRequiredMinorEngineVersion': 'string',
'PortRequired': True|False,
'DefaultPort': 123,
'OptionsDependedOn': [
'string',
],
'OptionsConflictsWith': [
'string',
],
'Persistent': True|False,
'Permanent': True|False,
'RequiresAutoMinorEngineVersionUpgrade': True|False,
'VpcOnly': True|False,
'SupportsOptionVersionDowngrade': True|False,
'OptionGroupOptionSettings': [
{
'SettingName': 'string',
'SettingDescription': 'string',
'DefaultValue': 'string',
'ApplyType': 'string',
'AllowedValues': 'string',
'IsModifiable': True|False,
'IsRequired': True|False,
'MinimumEngineVersionPerAllowedValue': [
{
'AllowedValue': 'string',
'MinimumEngineVersion': 'string'
},
]
},
],
'OptionGroupOptionVersions': [
{
'Version': 'string',
'IsDefault': True|False
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
OptionGroupOptions (list) --
List of available option group options.
(dict) --
Available option.
Name (string) --
The name of the option.
Description (string) --
The description of the option.
EngineName (string) --
The name of the engine that this option can be applied to.
MajorEngineVersion (string) --
Indicates the major engine version that the option is available for.
MinimumRequiredMinorEngineVersion (string) --
The minimum required engine version for the option to be applied.
PortRequired (boolean) --
Specifies whether the option requires a port.
DefaultPort (integer) --
If the option requires a port, specifies the default port for the option.
OptionsDependedOn (list) --
The options that are prerequisites for this option.
OptionsConflictsWith (list) --
The options that conflict with this option.
Persistent (boolean) --
Persistent options can't be removed from an option group while DB instances are associated with the option group. If you disassociate all DB instances from the option group, your can remove the persistent option from the option group.
Permanent (boolean) --
Permanent options can never be removed from an option group. An option group containing a permanent option can't be removed from a DB instance.
RequiresAutoMinorEngineVersionUpgrade (boolean) --
If true, you must enable the Auto Minor Version Upgrade setting for your DB instance before you can use this option. You can enable Auto Minor Version Upgrade when you first create your DB instance, or by modifying your DB instance later.
VpcOnly (boolean) --
If true, you can only use this option with a DB instance that is in a VPC.
SupportsOptionVersionDowngrade (boolean) --
If true, you can change the option to an earlier version of the option. This only applies to options that have different versions available.
OptionGroupOptionSettings (list) --
The option settings that are available (and the default value) for each option in an option group.
(dict) --
Option group option settings are used to display settings available for each option with their default values and other information. These values are used with the DescribeOptionGroupOptions action.
SettingName (string) --
The name of the option group option.
SettingDescription (string) --
The description of the option group option.
DefaultValue (string) --
The default value for the option group option.
ApplyType (string) --
The DB engine specific parameter type for the option group option.
AllowedValues (string) --
Indicates the acceptable values for the option group option.
IsModifiable (boolean) --
Boolean value where true indicates that this option group option can be changed from the default value.
IsRequired (boolean) --
Boolean value where true indicates that a value must be specified for this option setting of the option group option.
MinimumEngineVersionPerAllowedValue (list) --
The minimum DB engine version required for the corresponding allowed value for this option setting.
(dict) --
The minimum DB engine version required for each corresponding allowed value for an option setting.
AllowedValue (string) --
The allowed value for an option setting.
MinimumEngineVersion (string) --
The minimum DB engine version required for the allowed value.
OptionGroupOptionVersions (list) --
The versions that are available for the option.
(dict) --
The version for an option. Option group option versions are returned by the DescribeOptionGroupOptions action.
Version (string) --
The version of the option.
IsDefault (boolean) --
True if the version is the default version of the option, and otherwise false.
NextToken (string) --
A token to resume pagination.
RDS.Paginator.DescribeOptionGroups¶paginator = client.get_paginator('describe_option_groups')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from RDS.Client.describe_option_groups().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
OptionGroupName='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
EngineName='string',
MajorEngineVersion='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
This parameter isn't currently supported.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
Filters the list of option groups to only include groups associated with a specific database engine.
Valid Values:
mariadbmysqloracle-eeoracle-ee-cdboracle-se2oracle-se2-cdbpostgressqlserver-eesqlserver-sesqlserver-exsqlserver-webA dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'OptionGroupsList': [
{
'OptionGroupName': 'string',
'OptionGroupDescription': 'string',
'EngineName': 'string',
'MajorEngineVersion': 'string',
'Options': [
{
'OptionName': 'string',
'OptionDescription': 'string',
'Persistent': True|False,
'Permanent': True|False,
'Port': 123,
'OptionVersion': 'string',
'OptionSettings': [
{
'Name': 'string',
'Value': 'string',
'DefaultValue': 'string',
'Description': 'string',
'ApplyType': 'string',
'DataType': 'string',
'AllowedValues': 'string',
'IsModifiable': True|False,
'IsCollection': True|False
},
],
'DBSecurityGroupMemberships': [
{
'DBSecurityGroupName': 'string',
'Status': 'string'
},
],
'VpcSecurityGroupMemberships': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
]
},
],
'AllowsVpcAndNonVpcInstanceMemberships': True|False,
'VpcId': 'string',
'OptionGroupArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
List of option groups.
OptionGroupsList (list) --
List of option groups.
(dict) --
OptionGroupName (string) --
Specifies the name of the option group.
OptionGroupDescription (string) --
Provides a description of the option group.
EngineName (string) --
Indicates the name of the engine that this option group can be applied to.
MajorEngineVersion (string) --
Indicates the major engine version associated with this option group.
Options (list) --
Indicates what options are available in the option group.
(dict) --
Option details.
OptionName (string) --
The name of the option.
OptionDescription (string) --
The description of the option.
Persistent (boolean) --
Indicate if this option is persistent.
Permanent (boolean) --
Indicate if this option is permanent.
Port (integer) --
If required, the port configured for this option to use.
OptionVersion (string) --
The version of the option.
OptionSettings (list) --
The option settings for this option.
(dict) --
Option settings are the actual settings being applied or configured for that option. It is used when you modify an option group or describe option groups. For example, the NATIVE_NETWORK_ENCRYPTION option has a setting called SQLNET.ENCRYPTION_SERVER that can have several different values.
Name (string) --
The name of the option that has settings that you can set.
Value (string) --
The current value of the option setting.
DefaultValue (string) --
The default value of the option setting.
Description (string) --
The description of the option setting.
ApplyType (string) --
The DB engine specific parameter type.
DataType (string) --
The data type of the option setting.
AllowedValues (string) --
The allowed values of the option setting.
IsModifiable (boolean) --
A Boolean value that, when true, indicates the option setting can be modified from the default.
IsCollection (boolean) --
Indicates if the option setting is part of a collection.
DBSecurityGroupMemberships (list) --
If the option requires access to a port, then this DB security group allows access to the port.
(dict) --
This data type is used as a response element in the following actions:
ModifyDBInstanceRebootDBInstanceRestoreDBInstanceFromDBSnapshotRestoreDBInstanceToPointInTimeDBSecurityGroupName (string) --
The name of the DB security group.
Status (string) --
The status of the DB security group.
VpcSecurityGroupMemberships (list) --
If the option requires access to a port, then this VPC security group allows access to the port.
(dict) --
This data type is used as a response element for queries on VPC security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The membership status of the VPC security group.
Currently, the only valid status is active .
AllowsVpcAndNonVpcInstanceMemberships (boolean) --
Indicates whether this option group can be applied to both VPC and non-VPC instances. The value true indicates the option group can be applied to both VPC and non-VPC instances.
VpcId (string) --
If AllowsVpcAndNonVpcInstanceMemberships is false , this field is blank. If AllowsVpcAndNonVpcInstanceMemberships is true and this field is blank, then this option group can be applied to both VPC and non-VPC instances. If this field contains a value, then this option group can only be applied to instances that are in the VPC indicated by this field.
OptionGroupArn (string) --
The Amazon Resource Name (ARN) for the option group.
NextToken (string) --
A token to resume pagination.
RDS.Paginator.DescribeOrderableDBInstanceOptions¶paginator = client.get_paginator('describe_orderable_db_instance_options')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from RDS.Client.describe_orderable_db_instance_options().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Engine='string',
EngineVersion='string',
DBInstanceClass='string',
LicenseModel='string',
AvailabilityZoneGroup='string',
Vpc=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of the engine to retrieve DB instance options for.
Valid Values:
aurora (for MySQL 5.6-compatible Aurora)aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)aurora-postgresqlmariadbmysqloracle-eeoracle-ee-cdboracle-se2oracle-se2-cdbpostgressqlserver-eesqlserver-sesqlserver-exsqlserver-webThe license model filter value. Specify this parameter to show only the available offerings matching the specified license model.
RDS Custom supports only the BYOL licensing model.
The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available offerings for the Local Zones in the group.
Omit this parameter to show the available offerings in the specified Amazon Web Services Region.
This setting doesn't apply to RDS Custom.
A value that indicates whether to show only VPC or non-VPC offerings. RDS Custom supports only VPC offerings.
RDS Custom supports only VPC offerings. If you describe non-VPC offerings for RDS Custom, the output shows VPC offerings.
This parameter isn't currently supported.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'OrderableDBInstanceOptions': [
{
'Engine': 'string',
'EngineVersion': 'string',
'DBInstanceClass': 'string',
'LicenseModel': 'string',
'AvailabilityZoneGroup': 'string',
'AvailabilityZones': [
{
'Name': 'string'
},
],
'MultiAZCapable': True|False,
'ReadReplicaCapable': True|False,
'Vpc': True|False,
'SupportsStorageEncryption': True|False,
'StorageType': 'string',
'SupportsIops': True|False,
'SupportsEnhancedMonitoring': True|False,
'SupportsIAMDatabaseAuthentication': True|False,
'SupportsPerformanceInsights': True|False,
'MinStorageSize': 123,
'MaxStorageSize': 123,
'MinIopsPerDbInstance': 123,
'MaxIopsPerDbInstance': 123,
'MinIopsPerGib': 123.0,
'MaxIopsPerGib': 123.0,
'AvailableProcessorFeatures': [
{
'Name': 'string',
'DefaultValue': 'string',
'AllowedValues': 'string'
},
],
'SupportedEngineModes': [
'string',
],
'SupportsStorageAutoscaling': True|False,
'SupportsKerberosAuthentication': True|False,
'OutpostCapable': True|False,
'SupportedActivityStreamModes': [
'string',
],
'SupportsGlobalDatabases': True|False,
'SupportsClusters': True|False,
'SupportedNetworkTypes': [
'string',
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions action.
OrderableDBInstanceOptions (list) --
An OrderableDBInstanceOption structure containing information about orderable options for the DB instance.
(dict) --
Contains a list of available options for a DB instance.
This data type is used as a response element in the DescribeOrderableDBInstanceOptions action.
Engine (string) --
The engine type of a DB instance.
EngineVersion (string) --
The engine version of a DB instance.
DBInstanceClass (string) --
The DB instance class for a DB instance.
LicenseModel (string) --
The license model for a DB instance.
AvailabilityZoneGroup (string) --
The Availability Zone group for a DB instance.
AvailabilityZones (list) --
A list of Availability Zones for a DB instance.
(dict) --
Contains Availability Zone information.
This data type is used as an element in the OrderableDBInstanceOption data type.
Name (string) --
The name of the Availability Zone.
MultiAZCapable (boolean) --
Indicates whether a DB instance is Multi-AZ capable.
ReadReplicaCapable (boolean) --
Indicates whether a DB instance can have a read replica.
Vpc (boolean) --
Indicates whether a DB instance is in a VPC.
SupportsStorageEncryption (boolean) --
Indicates whether a DB instance supports encrypted storage.
StorageType (string) --
Indicates the storage type for a DB instance.
SupportsIops (boolean) --
Indicates whether a DB instance supports provisioned IOPS.
SupportsEnhancedMonitoring (boolean) --
Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.
SupportsIAMDatabaseAuthentication (boolean) --
Indicates whether a DB instance supports IAM database authentication.
SupportsPerformanceInsights (boolean) --
True if a DB instance supports Performance Insights, otherwise false.
MinStorageSize (integer) --
Minimum storage size for a DB instance.
MaxStorageSize (integer) --
Maximum storage size for a DB instance.
MinIopsPerDbInstance (integer) --
Minimum total provisioned IOPS for a DB instance.
MaxIopsPerDbInstance (integer) --
Maximum total provisioned IOPS for a DB instance.
MinIopsPerGib (float) --
Minimum provisioned IOPS per GiB for a DB instance.
MaxIopsPerGib (float) --
Maximum provisioned IOPS per GiB for a DB instance.
AvailableProcessorFeatures (list) --
A list of the available processor features for the DB instance class of a DB instance.
(dict) --
Contains the available processor feature information for the DB instance class of a DB instance.
For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
Name (string) --
The name of the processor feature. Valid names are coreCount and threadsPerCore .
DefaultValue (string) --
The default value for the processor feature of the DB instance class.
AllowedValues (string) --
The allowed values for the processor feature of the DB instance class.
SupportedEngineModes (list) --
A list of the supported DB engine modes.
SupportsStorageAutoscaling (boolean) --
Whether Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class.
SupportsKerberosAuthentication (boolean) --
Whether a DB instance supports Kerberos Authentication.
OutpostCapable (boolean) --
Whether a DB instance supports RDS on Outposts.
For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
SupportedActivityStreamModes (list) --
The list of supported modes for Database Activity Streams. Aurora PostgreSQL returns the value [sync, async] . Aurora MySQL and RDS for Oracle return [async] only. If Database Activity Streams isn't supported, the return value is an empty list.
SupportsGlobalDatabases (boolean) --
A value that indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes.
SupportsClusters (boolean) --
Whether DB instances can be configured as a Multi-AZ DB cluster.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
SupportedNetworkTypes (list) --
The network types supported by the DB instance (IPV4 or DUAL ).
A DB instance can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL ).
For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide.
NextToken (string) --
A token to resume pagination.
RDS.Paginator.DescribePendingMaintenanceActions¶paginator = client.get_paginator('describe_pending_maintenance_actions')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from RDS.Client.describe_pending_maintenance_actions().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ResourceIdentifier='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A filter that specifies one or more resources to return pending maintenance actions for.
Supported filters:
db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes pending maintenance actions for the DB clusters identified by these ARNs.db-instance-id - Accepts DB instance identifiers and DB instance ARNs. The results list only includes pending maintenance actions for the DB instances identified by these ARNs.A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'PendingMaintenanceActions': [
{
'ResourceIdentifier': 'string',
'PendingMaintenanceActionDetails': [
{
'Action': 'string',
'AutoAppliedAfterDate': datetime(2015, 1, 1),
'ForcedApplyDate': datetime(2015, 1, 1),
'OptInStatus': 'string',
'CurrentApplyDate': datetime(2015, 1, 1),
'Description': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Data returned from the DescribePendingMaintenanceActions action.
PendingMaintenanceActions (list) --
A list of the pending maintenance actions for the resource.
(dict) --
Describes the pending maintenance actions for a resource.
ResourceIdentifier (string) --
The ARN of the resource that has pending maintenance actions.
PendingMaintenanceActionDetails (list) --
A list that provides details about the pending maintenance actions for the resource.
(dict) --
Provides information about a pending maintenance action for a resource.
Action (string) --
The type of pending maintenance action that is available for the resource. Valid actions are system-update , db-upgrade , hardware-maintenance , and ca-certificate-rotation .
AutoAppliedAfterDate (datetime) --
The date of the maintenance window when the action is applied. The maintenance action is applied to the resource during its first maintenance window after this date.
ForcedApplyDate (datetime) --
The date when the maintenance action is automatically applied.
On this date, the maintenance action is applied to the resource as soon as possible, regardless of the maintenance window for the resource. There might be a delay of one or more days from this date before the maintenance action is applied.
OptInStatus (string) --
Indicates the type of opt-in request that has been received for the resource.
CurrentApplyDate (datetime) --
The effective date when the pending maintenance action is applied to the resource. This date takes into account opt-in requests received from the ApplyPendingMaintenanceAction API, the AutoAppliedAfterDate , and the ForcedApplyDate . This value is blank if an opt-in request has not been received and nothing has been specified as AutoAppliedAfterDate or ForcedApplyDate .
Description (string) --
A description providing more detail about the maintenance action.
NextToken (string) --
A token to resume pagination.
RDS.Paginator.DescribeReservedDBInstances¶paginator = client.get_paginator('describe_reserved_db_instances')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from RDS.Client.describe_reserved_db_instances().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ReservedDBInstanceId='string',
ReservedDBInstancesOfferingId='string',
DBInstanceClass='string',
Duration='string',
ProductDescription='string',
OfferingType='string',
MultiAZ=True|False,
LeaseId='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.
Valid Values: 1 | 3 | 31536000 | 94608000
The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.
Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"
The lease identifier filter value. Specify this parameter to show only the reservation that matches the specified lease ID.
Note
Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.
This parameter isn't currently supported.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ReservedDBInstances': [
{
'ReservedDBInstanceId': 'string',
'ReservedDBInstancesOfferingId': 'string',
'DBInstanceClass': 'string',
'StartTime': datetime(2015, 1, 1),
'Duration': 123,
'FixedPrice': 123.0,
'UsagePrice': 123.0,
'CurrencyCode': 'string',
'DBInstanceCount': 123,
'ProductDescription': 'string',
'OfferingType': 'string',
'MultiAZ': True|False,
'State': 'string',
'RecurringCharges': [
{
'RecurringChargeAmount': 123.0,
'RecurringChargeFrequency': 'string'
},
],
'ReservedDBInstanceArn': 'string',
'LeaseId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Contains the result of a successful invocation of the DescribeReservedDBInstances action.
ReservedDBInstances (list) --
A list of reserved DB instances.
(dict) --
This data type is used as a response element in the DescribeReservedDBInstances and PurchaseReservedDBInstancesOffering actions.
ReservedDBInstanceId (string) --
The unique identifier for the reservation.
ReservedDBInstancesOfferingId (string) --
The offering identifier.
DBInstanceClass (string) --
The DB instance class for the reserved DB instance.
StartTime (datetime) --
The time the reservation started.
Duration (integer) --
The duration of the reservation in seconds.
FixedPrice (float) --
The fixed price charged for this reserved DB instance.
UsagePrice (float) --
The hourly price charged for this reserved DB instance.
CurrencyCode (string) --
The currency code for the reserved DB instance.
DBInstanceCount (integer) --
The number of reserved DB instances.
ProductDescription (string) --
The description of the reserved DB instance.
OfferingType (string) --
The offering type of this reserved DB instance.
MultiAZ (boolean) --
Indicates if the reservation applies to Multi-AZ deployments.
State (string) --
The state of the reserved DB instance.
RecurringCharges (list) --
The recurring price charged to run this reserved DB instance.
(dict) --
This data type is used as a response element in the DescribeReservedDBInstances and DescribeReservedDBInstancesOfferings actions.
RecurringChargeAmount (float) --
The amount of the recurring charge.
RecurringChargeFrequency (string) --
The frequency of the recurring charge.
ReservedDBInstanceArn (string) --
The Amazon Resource Name (ARN) for the reserved DB instance.
LeaseId (string) --
The unique identifier for the lease associated with the reserved DB instance.
Note
Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.
NextToken (string) --
A token to resume pagination.
RDS.Paginator.DescribeReservedDBInstancesOfferings¶paginator = client.get_paginator('describe_reserved_db_instances_offerings')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from RDS.Client.describe_reserved_db_instances_offerings().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ReservedDBInstancesOfferingId='string',
DBInstanceClass='string',
Duration='string',
ProductDescription='string',
OfferingType='string',
MultiAZ=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier.
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.
Valid Values: 1 | 3 | 31536000 | 94608000
Product description filter value. Specify this parameter to show only the available offerings that contain the specified product description.
Note
The results show offerings that partially match the filter value.
The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.
Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"
This parameter isn't currently supported.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ReservedDBInstancesOfferings': [
{
'ReservedDBInstancesOfferingId': 'string',
'DBInstanceClass': 'string',
'Duration': 123,
'FixedPrice': 123.0,
'UsagePrice': 123.0,
'CurrencyCode': 'string',
'ProductDescription': 'string',
'OfferingType': 'string',
'MultiAZ': True|False,
'RecurringCharges': [
{
'RecurringChargeAmount': 123.0,
'RecurringChargeFrequency': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings action.
ReservedDBInstancesOfferings (list) --
A list of reserved DB instance offerings.
(dict) --
This data type is used as a response element in the DescribeReservedDBInstancesOfferings action.
ReservedDBInstancesOfferingId (string) --
The offering identifier.
DBInstanceClass (string) --
The DB instance class for the reserved DB instance.
Duration (integer) --
The duration of the offering in seconds.
FixedPrice (float) --
The fixed price charged for this offering.
UsagePrice (float) --
The hourly price charged for this offering.
CurrencyCode (string) --
The currency code for the reserved DB instance offering.
ProductDescription (string) --
The database engine used by the offering.
OfferingType (string) --
The offering type.
MultiAZ (boolean) --
Indicates if the offering applies to Multi-AZ deployments.
RecurringCharges (list) --
The recurring price charged to run this reserved DB instance.
(dict) --
This data type is used as a response element in the DescribeReservedDBInstances and DescribeReservedDBInstancesOfferings actions.
RecurringChargeAmount (float) --
The amount of the recurring charge.
RecurringChargeFrequency (string) --
The frequency of the recurring charge.
NextToken (string) --
A token to resume pagination.
RDS.Paginator.DescribeSourceRegions¶paginator = client.get_paginator('describe_source_regions')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from RDS.Client.describe_source_regions().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
RegionName='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The source Amazon Web Services Region name. For example, us-east-1 .
Constraints:
This parameter isn't currently supported.
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'SourceRegions': [
{
'RegionName': 'string',
'Endpoint': 'string',
'Status': 'string',
'SupportsDBInstanceAutomatedBackupsReplication': True|False
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Contains the result of a successful invocation of the DescribeSourceRegions action.
SourceRegions (list) --
A list of SourceRegion instances that contains each source Amazon Web Services Region that the current Amazon Web Services Region can get a read replica or a DB snapshot from.
(dict) --
Contains an Amazon Web Services Region name as the result of a successful call to the DescribeSourceRegions action.
RegionName (string) --
The name of the source Amazon Web Services Region.
Endpoint (string) --
The endpoint for the source Amazon Web Services Region endpoint.
Status (string) --
The status of the source Amazon Web Services Region.
SupportsDBInstanceAutomatedBackupsReplication (boolean) --
Whether the source Amazon Web Services Region supports replicating automated backups to the current Amazon Web Services Region.
NextToken (string) --
A token to resume pagination.
RDS.Paginator.DownloadDBLogFilePortion¶paginator = client.get_paginator('download_db_log_file_portion')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from RDS.Client.download_db_log_file_portion().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DBInstanceIdentifier='string',
LogFileName='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The customer-assigned name of the DB instance that contains the log files you want to list.
Constraints:
[REQUIRED]
The name of the log file to be downloaded.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'LogFileData': 'string',
'AdditionalDataPending': True|False,
'NextToken': 'string'
}
Response Structure
(dict) --
This data type is used as a response element to DownloadDBLogFilePortion .
LogFileData (string) --
Entries from the specified log file.
AdditionalDataPending (boolean) --
Boolean value that if true, indicates there is more data to be downloaded.
NextToken (string) --
A token to resume pagination.
The available waiters are:
RDS.Waiter.DBClusterAvailableRDS.Waiter.DBClusterDeletedRDS.Waiter.DBClusterSnapshotAvailableRDS.Waiter.DBClusterSnapshotDeletedRDS.Waiter.DBInstanceAvailableRDS.Waiter.DBInstanceDeletedRDS.Waiter.DBSnapshotAvailableRDS.Waiter.DBSnapshotCompletedRDS.Waiter.DBSnapshotDeletedRDS.Waiter.DBClusterAvailable¶waiter = client.get_waiter('db_cluster_available')
wait(**kwargs)¶Polls RDS.Client.describe_db_clusters() every 30 seconds until a successful state is reached. An error is returned after 60 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
DBClusterIdentifier='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string',
IncludeShared=True|False,
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.
Constraints:
A filter that specifies one or more DB clusters to describe.
Supported filters:
clone-group-id - Accepts clone group identifiers. The results list only includes information about the DB clusters associated with these clone groups.db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB clusters identified by these ARNs.domain - Accepts Active Directory directory IDs. The results list only includes information about the DB clusters associated with these domains.engine - Accepts engine names. The results list only includes information about the DB clusters for these engines.A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
DescribeDBClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 30
The maximum number of attempts to be made. Default: 60
None
RDS.Waiter.DBClusterDeleted¶waiter = client.get_waiter('db_cluster_deleted')
wait(**kwargs)¶Polls RDS.Client.describe_db_clusters() every 30 seconds until a successful state is reached. An error is returned after 60 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
DBClusterIdentifier='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string',
IncludeShared=True|False,
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.
Constraints:
A filter that specifies one or more DB clusters to describe.
Supported filters:
clone-group-id - Accepts clone group identifiers. The results list only includes information about the DB clusters associated with these clone groups.db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB clusters identified by these ARNs.domain - Accepts Active Directory directory IDs. The results list only includes information about the DB clusters associated with these domains.engine - Accepts engine names. The results list only includes information about the DB clusters for these engines.A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
DescribeDBClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 30
The maximum number of attempts to be made. Default: 60
None
RDS.Waiter.DBClusterSnapshotAvailable¶waiter = client.get_waiter('db_cluster_snapshot_available')
wait(**kwargs)¶Polls RDS.Client.describe_db_cluster_snapshots() every 30 seconds until a successful state is reached. An error is returned after 60 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
DBClusterIdentifier='string',
DBClusterSnapshotIdentifier='string',
SnapshotType='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string',
IncludeShared=True|False,
IncludePublic=True|False,
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter isn't case-sensitive.
Constraints:
A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with the DBClusterIdentifier parameter. This value is stored as a lowercase string.
Constraints:
SnapshotType parameter must also be specified.The type of DB cluster snapshots to be returned. You can specify one of the following values:
automated - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.manual - Return all DB cluster snapshots that have been taken by my Amazon Web Services account.shared - Return all manual DB cluster snapshots that have been shared to my Amazon Web Services account.public - Return all DB cluster snapshots that have been marked as public.If you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by enabling the IncludeShared parameter. You can include public DB cluster snapshots with these results by enabling the IncludePublic parameter.
The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated . The IncludePublic parameter doesn't apply when SnapshotType is set to shared . The IncludeShared parameter doesn't apply when SnapshotType is set to public .
A filter that specifies one or more DB cluster snapshots to describe.
Supported filters:
db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs).db-cluster-snapshot-id - Accepts DB cluster snapshot identifiers.snapshot-type - Accepts types of DB cluster snapshots.engine - Accepts names of database engines.A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .A value that indicates whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.
You can give an Amazon Web Services account permission to restore a manual DB cluster snapshot from another Amazon Web Services account by the ModifyDBClusterSnapshotAttribute API action.
A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.
You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 30
The maximum number of attempts to be made. Default: 60
None
RDS.Waiter.DBClusterSnapshotDeleted¶waiter = client.get_waiter('db_cluster_snapshot_deleted')
wait(**kwargs)¶Polls RDS.Client.describe_db_cluster_snapshots() every 30 seconds until a successful state is reached. An error is returned after 60 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
DBClusterIdentifier='string',
DBClusterSnapshotIdentifier='string',
SnapshotType='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string',
IncludeShared=True|False,
IncludePublic=True|False,
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter isn't case-sensitive.
Constraints:
A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with the DBClusterIdentifier parameter. This value is stored as a lowercase string.
Constraints:
SnapshotType parameter must also be specified.The type of DB cluster snapshots to be returned. You can specify one of the following values:
automated - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.manual - Return all DB cluster snapshots that have been taken by my Amazon Web Services account.shared - Return all manual DB cluster snapshots that have been shared to my Amazon Web Services account.public - Return all DB cluster snapshots that have been marked as public.If you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by enabling the IncludeShared parameter. You can include public DB cluster snapshots with these results by enabling the IncludePublic parameter.
The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated . The IncludePublic parameter doesn't apply when SnapshotType is set to shared . The IncludeShared parameter doesn't apply when SnapshotType is set to public .
A filter that specifies one or more DB cluster snapshots to describe.
Supported filters:
db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs).db-cluster-snapshot-id - Accepts DB cluster snapshot identifiers.snapshot-type - Accepts types of DB cluster snapshots.engine - Accepts names of database engines.A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .A value that indicates whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.
You can give an Amazon Web Services account permission to restore a manual DB cluster snapshot from another Amazon Web Services account by the ModifyDBClusterSnapshotAttribute API action.
A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.
You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 30
The maximum number of attempts to be made. Default: 60
None
RDS.Waiter.DBInstanceAvailable¶waiter = client.get_waiter('db_instance_available')
wait(**kwargs)¶Polls RDS.Client.describe_db_instances() every 30 seconds until a successful state is reached. An error is returned after 60 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
DBInstanceIdentifier='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
The user-supplied instance identifier. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case-sensitive.
Constraints:
A filter that specifies one or more DB instances to describe.
Supported filters:
db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB instances associated with the DB clusters identified by these ARNs.db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list only includes information about the DB instances identified by these ARNs.dbi-resource-id - Accepts DB instance resource identifiers. The results list will only include information about the DB instances identified by these DB instance resource identifiers.domain - Accepts Active Directory directory IDs. The results list only includes information about the DB instances associated with these domains.engine - Accepts engine names. The results list only includes information about the DB instances for these engines.A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
DescribeDBInstances request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 30
The maximum number of attempts to be made. Default: 60
None
RDS.Waiter.DBInstanceDeleted¶waiter = client.get_waiter('db_instance_deleted')
wait(**kwargs)¶Polls RDS.Client.describe_db_instances() every 30 seconds until a successful state is reached. An error is returned after 60 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
DBInstanceIdentifier='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
The user-supplied instance identifier. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case-sensitive.
Constraints:
A filter that specifies one or more DB instances to describe.
Supported filters:
db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB instances associated with the DB clusters identified by these ARNs.db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list only includes information about the DB instances identified by these ARNs.dbi-resource-id - Accepts DB instance resource identifiers. The results list will only include information about the DB instances identified by these DB instance resource identifiers.domain - Accepts Active Directory directory IDs. The results list only includes information about the DB instances associated with these domains.engine - Accepts engine names. The results list only includes information about the DB instances for these engines.A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
DescribeDBInstances request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 30
The maximum number of attempts to be made. Default: 60
None
RDS.Waiter.DBSnapshotAvailable¶waiter = client.get_waiter('db_snapshot_available')
wait(**kwargs)¶Polls RDS.Client.describe_db_snapshots() every 30 seconds until a successful state is reached. An error is returned after 60 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
DBInstanceIdentifier='string',
DBSnapshotIdentifier='string',
SnapshotType='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string',
IncludeShared=True|False,
IncludePublic=True|False,
DbiResourceId='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
The ID of the DB instance to retrieve the list of DB snapshots for. This parameter isn't case-sensitive.
Constraints:
A specific DB snapshot identifier to describe. This value is stored as a lowercase string.
Constraints:
SnapshotType parameter must also be specified.The type of snapshots to be returned. You can specify one of the following values:
automated - Return all DB snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.manual - Return all DB snapshots that have been taken by my Amazon Web Services account.shared - Return all manual DB snapshots that have been shared to my Amazon Web Services account.public - Return all DB snapshots that have been marked as public.awsbackup - Return the DB snapshots managed by the Amazon Web Services Backup service. For information about Amazon Web Services Backup, see the ` Amazon Web Services Backup Developer Guide. https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html`__ The awsbackup type does not apply to Aurora.If you don't specify a SnapshotType value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by enabling the IncludeShared parameter. You can include public snapshots with these results by enabling the IncludePublic parameter.
The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated . The IncludePublic parameter doesn't apply when SnapshotType is set to shared . The IncludeShared parameter doesn't apply when SnapshotType is set to public .
A filter that specifies one or more DB snapshots to describe.
Supported filters:
db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).db-snapshot-id - Accepts DB snapshot identifiers.dbi-resource-id - Accepts identifiers of source DB instances.snapshot-type - Accepts types of DB snapshots.engine - Accepts names of database engines.A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
DescribeDBSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .A value that indicates whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.
You can give an Amazon Web Services account permission to restore a manual DB snapshot from another Amazon Web Services account by using the ModifyDBSnapshotAttribute API action.
This setting doesn't apply to RDS Custom.
A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.
You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.
This setting doesn't apply to RDS Custom.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 30
The maximum number of attempts to be made. Default: 60
None
RDS.Waiter.DBSnapshotCompleted¶waiter = client.get_waiter('db_snapshot_completed')
wait(**kwargs)¶Polls RDS.Client.describe_db_snapshots() every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
DBInstanceIdentifier='string',
DBSnapshotIdentifier='string',
SnapshotType='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string',
IncludeShared=True|False,
IncludePublic=True|False,
DbiResourceId='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
The ID of the DB instance to retrieve the list of DB snapshots for. This parameter isn't case-sensitive.
Constraints:
A specific DB snapshot identifier to describe. This value is stored as a lowercase string.
Constraints:
SnapshotType parameter must also be specified.The type of snapshots to be returned. You can specify one of the following values:
automated - Return all DB snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.manual - Return all DB snapshots that have been taken by my Amazon Web Services account.shared - Return all manual DB snapshots that have been shared to my Amazon Web Services account.public - Return all DB snapshots that have been marked as public.awsbackup - Return the DB snapshots managed by the Amazon Web Services Backup service. For information about Amazon Web Services Backup, see the ` Amazon Web Services Backup Developer Guide. https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html`__ The awsbackup type does not apply to Aurora.If you don't specify a SnapshotType value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by enabling the IncludeShared parameter. You can include public snapshots with these results by enabling the IncludePublic parameter.
The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated . The IncludePublic parameter doesn't apply when SnapshotType is set to shared . The IncludeShared parameter doesn't apply when SnapshotType is set to public .
A filter that specifies one or more DB snapshots to describe.
Supported filters:
db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).db-snapshot-id - Accepts DB snapshot identifiers.dbi-resource-id - Accepts identifiers of source DB instances.snapshot-type - Accepts types of DB snapshots.engine - Accepts names of database engines.A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
DescribeDBSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .A value that indicates whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.
You can give an Amazon Web Services account permission to restore a manual DB snapshot from another Amazon Web Services account by using the ModifyDBSnapshotAttribute API action.
This setting doesn't apply to RDS Custom.
A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.
You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.
This setting doesn't apply to RDS Custom.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 15
The maximum number of attempts to be made. Default: 40
None
RDS.Waiter.DBSnapshotDeleted¶waiter = client.get_waiter('db_snapshot_deleted')
wait(**kwargs)¶Polls RDS.Client.describe_db_snapshots() every 30 seconds until a successful state is reached. An error is returned after 60 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
DBInstanceIdentifier='string',
DBSnapshotIdentifier='string',
SnapshotType='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string',
IncludeShared=True|False,
IncludePublic=True|False,
DbiResourceId='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
The ID of the DB instance to retrieve the list of DB snapshots for. This parameter isn't case-sensitive.
Constraints:
A specific DB snapshot identifier to describe. This value is stored as a lowercase string.
Constraints:
SnapshotType parameter must also be specified.The type of snapshots to be returned. You can specify one of the following values:
automated - Return all DB snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account.manual - Return all DB snapshots that have been taken by my Amazon Web Services account.shared - Return all manual DB snapshots that have been shared to my Amazon Web Services account.public - Return all DB snapshots that have been marked as public.awsbackup - Return the DB snapshots managed by the Amazon Web Services Backup service. For information about Amazon Web Services Backup, see the ` Amazon Web Services Backup Developer Guide. https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html`__ The awsbackup type does not apply to Aurora.If you don't specify a SnapshotType value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by enabling the IncludeShared parameter. You can include public snapshots with these results by enabling the IncludePublic parameter.
The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated . The IncludePublic parameter doesn't apply when SnapshotType is set to shared . The IncludeShared parameter doesn't apply when SnapshotType is set to public .
A filter that specifies one or more DB snapshots to describe.
Supported filters:
db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).db-snapshot-id - Accepts DB snapshot identifiers.dbi-resource-id - Accepts identifiers of source DB instances.snapshot-type - Accepts types of DB snapshots.engine - Accepts names of database engines.A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribePendingMaintenanceActionsThe name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
DescribeDBSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .A value that indicates whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included.
You can give an Amazon Web Services account permission to restore a manual DB snapshot from another Amazon Web Services account by using the ModifyDBSnapshotAttribute API action.
This setting doesn't apply to RDS Custom.
A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.
You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.
This setting doesn't apply to RDS Custom.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 30
The maximum number of attempts to be made. Default: 60
None