Table of Contents
A low-level client representing Amazon Relational Database Service (RDS):
import boto3
client = boto3.client('rds')
These are the available methods:
Associates an Identity and Access Management (IAM) role from an Amazon Aurora DB cluster. For more information, see Authorizing Amazon Aurora MySQL to Access Other AWS Services on Your Behalf in the Amazon Aurora User Guide .
Note
This action only applies to Aurora DB clusters.
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
Associates an AWS 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 .
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 the list of supported feature names, see DBEngineVersion .
None
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:
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 AWS 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.
Examples
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:
{
'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
Examples
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': {
'...': '...',
},
}
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:
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. The maintenance action is applied to the resource on this date regardless of the maintenance window for the resource.
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.
Examples
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:
{
'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 AWS 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.
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 AWS 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:
Status (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 AWS 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.
Examples
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:
{
'ResponseMetadata': {
'...': '...',
},
}
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 only applies to Aurora 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:
Check if an operation can be paginated.
Copies the specified DB cluster parameter group.
Note
This action only applies to Aurora DB clusters.
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) --
Provides the name of the DB cluster parameter group.
DBParameterGroupFamily (string) --
Provides 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.
Examples
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:
{
'ResponseMetadata': {
'...': '...',
},
}
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 AWS Region. In that case, the AWS Region where you call the CopyDBClusterSnapshot action is the destination AWS Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another AWS Region, you must provide the following values:
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process .
Note
If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source AWS Region.
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 DB cluster snapshots from one AWS Region to another, see Copying a Snapshot in the Amazon Aurora User Guide.
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.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 AWS 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 AWS AWS KMS key ID for an encrypted DB cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
If you copy an encrypted DB cluster snapshot from your AWS account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption 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 AWS account, then you must specify a value for KmsKeyId .
To copy an encrypted DB cluster snapshot to another AWS Region, you must set KmsKeyId to the KMS key ID you want to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region.
If you copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.
The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action in the AWS Region that contains the source DB cluster snapshot to copy. The PreSignedUrl parameter must be used when copying an encrypted DB cluster snapshot from another AWS Region. Don't specify PreSignedUrl when you are copying an encrypted DB cluster snapshot in the same AWS Region.
The pre-signed URL must be a valid request for the CopyDBSClusterSnapshot API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values:
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process .
Note
If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source AWS 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',
'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
}
}
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.
AllocatedStorage (integer) --
Specifies the allocated storage size in gibibytes (GiB).
Status (string) --
Specifies the status of this DB cluster snapshot.
Port (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 the 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 AWS KMS key identifier for the encrypted DB cluster snapshot.
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 AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
Examples
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:
{
'ResponseMetadata': {
'...': '...',
},
}
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) --
Provides the name of the DB parameter group.
DBParameterGroupFamily (string) --
Provides 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.
Examples
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:
{
'ResponseMetadata': {
'...': '...',
},
}
Copies the specified DB snapshot. The source DB snapshot must be in the "available" state.
You can copy a snapshot from one AWS Region to another. In that case, the AWS Region where you call the CopyDBSnapshot action is the destination AWS Region for the DB snapshot copy.
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',
SourceRegion='string'
)
[REQUIRED]
The identifier for the source DB snapshot.
If the source snapshot is in the same AWS 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 AWS 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 AWS Region, and must match the SourceDBSnapshotIdentifier in the PreSignedUrl parameter.
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 AWS KMS key ID for an encrypted DB snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
If you copy an encrypted DB snapshot from your AWS account, you can specify a value for this parameter to encrypt the copy with a new KMS encryption key. If you don't specify a value for this parameter, then the copy of the DB snapshot is encrypted with the same KMS key as the source DB snapshot.
If you copy an encrypted DB snapshot that is shared from another AWS account, then you must specify a value for this parameter.
If you specify this parameter when you copy an unencrypted snapshot, the copy is encrypted.
If you copy an encrypted snapshot to a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS 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}_.:/=+\-]*)$").
The URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API action in the source AWS Region that contains the source DB snapshot to copy.
You must specify this parameter when you copy an encrypted DB snapshot from another AWS Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are copying an encrypted DB snapshot in the same AWS Region.
The presigned URL must be a valid request for the CopyDBSnapshot API action that can be executed in the source AWS Region that contains the encrypted DB snapshot to be copied. The presigned URL request must contain the following parameter values:
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process .
Note
If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source AWS 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 AWS 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 AWS Regions. 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'
}
}
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) --
Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
Engine (string) --
Specifies the name of the database engine.
AllocatedStorage (integer) --
Specifies the allocated storage size in 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 when the snapshot was taken, in Universal Coordinated Time (UTC).
MasterUsername (string) --
Provides the master username for the DB snapshot.
EngineVersion (string) --
Specifies the version of the database engine.
LicenseModel (string) --
License model information for the restored DB instance.
SnapshotType (string) --
Provides the type of the DB snapshot.
Iops (integer) --
Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
OptionGroupName (string) --
Provides the option group name for the DB snapshot.
PercentProgress (integer) --
The percentage of the estimated data that has been transferred.
SourceRegion (string) --
The AWS 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 value in case of cross-customer or cross-region copy.
StorageType (string) --
Specifies the storage type associated with DB snapshot.
TdeCredentialArn (string) --
The ARN from the key store with which to associate the instance for TDE encryption.
Encrypted (boolean) --
Specifies whether the DB snapshot is encrypted.
KmsKeyId (string) --
If Encrypted is true, the AWS KMS key identifier for the encrypted DB snapshot.
DBSnapshotArn (string) --
The Amazon Resource Name (ARN) for the DB snapshot.
Timezone (string) --
The time zone of the DB snapshot. In most cases, the Timezone element is empty. Timezone content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.
IAMDatabaseAuthenticationEnabled (boolean) --
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, 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:
You 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:
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 AWS Region.
Examples
This example copies a DB snapshot.
response = client.copy_db_snapshot(
SourceDBSnapshotIdentifier='mydbsnapshot',
TargetDBSnapshotIdentifier='mydbsnapshot-copy',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
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 or ARN for the source option 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 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:
DBSecurityGroupName (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 status of the VPC security group.
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.
Examples
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:
{
'ResponseMetadata': {
'...': '...',
},
}
Creates a custom Availability Zone (AZ).
A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster.
For more information about RDS on VMware, see the ` RDS on VMware User Guide. https://docs.aws.amazon.com/AmazonRDS/latest/RDSonVMwareUserGuide/rds-on-vmware.html`__
See also: AWS API Documentation
Request Syntax
response = client.create_custom_availability_zone(
CustomAvailabilityZoneName='string',
ExistingVpnId='string',
NewVpnTunnelName='string',
VpnTunnelOriginatorIP='string'
)
[REQUIRED]
The name of the custom Availability Zone (AZ).
The name of a new VPN tunnel between the Amazon RDS website and the VMware vSphere cluster.
Specify this parameter only if ExistingVpnId isn't specified.
The IP address of network traffic from your on-premises data center. A custom AZ receives the network traffic.
Specify this parameter only if ExistingVpnId isn't specified.
dict
Response Syntax
{
'CustomAvailabilityZone': {
'CustomAvailabilityZoneId': 'string',
'CustomAvailabilityZoneName': 'string',
'CustomAvailabilityZoneStatus': 'string',
'VpnDetails': {
'VpnId': 'string',
'VpnTunnelOriginatorIP': 'string',
'VpnGatewayIp': 'string',
'VpnPSK': 'string',
'VpnName': 'string',
'VpnState': 'string'
}
}
}
Response Structure
(dict) --
CustomAvailabilityZone (dict) --
A custom Availability Zone (AZ) is an on-premises AZ that is integrated with a VMware vSphere cluster.
For more information about RDS on VMware, see the ` RDS on VMware User Guide. https://docs.aws.amazon.com/AmazonRDS/latest/RDSonVMwareUserGuide/rds-on-vmware.html`__
CustomAvailabilityZoneId (string) --
The identifier of the custom AZ.
Amazon RDS generates a unique identifier when a custom AZ is created.
CustomAvailabilityZoneName (string) --
The name of the custom AZ.
CustomAvailabilityZoneStatus (string) --
The status of the custom AZ.
VpnDetails (dict) --
Information about the virtual private network (VPN) between the VMware vSphere cluster and the AWS website.
VpnId (string) --
The ID of the VPN.
VpnTunnelOriginatorIP (string) --
The IP address of network traffic from your on-premises data center. A custom AZ receives the network traffic.
VpnGatewayIp (string) --
The IP address of network traffic from AWS to your on-premises data center.
VpnPSK (string) --
The preshared key (PSK) for the VPN.
VpnName (string) --
The name of the VPN.
VpnState (string) --
The state of the VPN.
Creates a new Amazon Aurora DB cluster.
You can use the ReplicationSourceIdentifier parameter to create the DB cluster as a Read Replica of another DB cluster or Amazon RDS MySQL DB instance. For cross-region replication where the DB cluster identified by ReplicationSourceIdentifier is encrypted, you must also specify the PreSignedUrl parameter.
For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.
Note
This action only applies to Aurora DB clusters.
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'
},
DeletionProtection=True|False,
GlobalClusterIdentifier='string',
EnableHttpEndpoint=True|False,
CopyTagsToSnapshot=True|False,
SourceRegion='string'
)
A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide .
The number of days for which automated backups are retained.
Default: 1
Constraints:
[REQUIRED]
The DB cluster identifier. This parameter is stored as a lowercase string.
Constraints:
Example: my-cluster1
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:
A list of EC2 VPC security groups to associate with this DB cluster.
A DB subnet group to associate with this DB cluster.
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example: mySubnetgroup
[REQUIRED]
The name of the database engine to be used for this DB cluster.
Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql
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 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"Aurora MySQL
Example: 5.6.10a , 5.6.mysql_aurora.1.19.2 , 5.7.12 , 5.7.mysql_aurora.2.04.5
Aurora PostgreSQL
Example: 9.6.3 , 10.7
The port number on which the instances in the DB cluster accept connections.
Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql.
The name of the master user for the DB cluster.
Constraints:
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 DB cluster should be associated with the specified option group.
Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.
The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
Constraints:
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
Tags to assign to the DB cluster.
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 AWS KMS key identifier for an encrypted DB cluster.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
If an encryption key isn't specified in KmsKeyId :
AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
If you create a Read Replica of an encrypted DB cluster in another AWS Region, you must set KmsKeyId to a KMS key ID that is valid in the destination AWS Region. This key is used to encrypt the Read Replica in that AWS Region.
A URL that contains a Signature Version 4 signed request for the CreateDBCluster action to be called in the source AWS Region where the DB cluster is replicated from. You only need to specify PreSignedUrl when you are performing cross-region replication from an encrypted DB cluster.
The pre-signed URL must be a valid request for the CreateDBCluster API action that can be executed in the source AWS Region that contains the encrypted DB cluster to be copied.
The pre-signed URL request must contain the following parameter values:
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process .
Note
If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source AWS Region.
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 AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Default: 0
Constraints:
The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide .
For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
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.
The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange .
ForceApplyCapacityChange sets 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 from finding a scaling point might be dropped.
For more information, see Autoscaling for Aurora Serverless in the Amazon Aurora User Guide .
A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide .
dict
Response Syntax
{
'DBCluster': {
'AllocatedStorage': 123,
'AvailabilityZones': [
'string',
],
'BackupRetentionPeriod': 123,
'CharacterSetName': 'string',
'DatabaseName': 'string',
'DBClusterIdentifier': 'string',
'DBClusterParameterGroup': 'string',
'DBSubnetGroup': 'string',
'Status': 'string',
'PercentProgress': 'string',
'EarliestRestorableTime': datetime(2015, 1, 1),
'Endpoint': 'string',
'ReaderEndpoint': 'string',
'CustomEndpoints': [
'string',
],
'MultiAZ': True|False,
'Engine': 'string',
'EngineVersion': 'string',
'LatestRestorableTime': datetime(2015, 1, 1),
'Port': 123,
'MasterUsername': 'string',
'DBClusterOptionGroupMemberships': [
{
'DBClusterOptionGroupName': 'string',
'Status': 'string'
},
],
'PreferredBackupWindow': 'string',
'PreferredMaintenanceWindow': 'string',
'ReplicationSourceIdentifier': 'string',
'ReadReplicaIdentifiers': [
'string',
],
'DBClusterMembers': [
{
'DBInstanceIdentifier': 'string',
'IsClusterWriter': True|False,
'DBClusterParameterGroupStatus': 'string',
'PromotionTier': 123
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'HostedZoneId': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbClusterResourceId': 'string',
'DBClusterArn': 'string',
'AssociatedRoles': [
{
'RoleArn': 'string',
'Status': 'string',
'FeatureName': 'string'
},
],
'IAMDatabaseAuthenticationEnabled': True|False,
'CloneGroupId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'EarliestBacktrackTime': datetime(2015, 1, 1),
'BacktrackWindow': 123,
'BacktrackConsumedChangeRecords': 123,
'EnabledCloudwatchLogsExports': [
'string',
],
'Capacity': 123,
'EngineMode': 'string',
'ScalingConfigurationInfo': {
'MinCapacity': 123,
'MaxCapacity': 123,
'AutoPause': True|False,
'SecondsUntilAutoPause': 123,
'TimeoutAction': 'string'
},
'DeletionProtection': True|False,
'HttpEndpointEnabled': True|False,
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'CopyTagsToSnapshot': True|False,
'CrossAccountClone': True|False
}
}
Response Structure
(dict) --
DBCluster (dict) --
Contains the details of an Amazon Aurora DB cluster.
This data type is used as a response element in the DescribeDBClusters , StopDBCluster , and StartDBCluster actions.
AllocatedStorage (integer) --
For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size 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.
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) --
Provides the name of the database engine to be used for this DB cluster.
EngineVersion (string) --
Indicates the database engine version.
LatestRestorableTime (datetime) --
Specifies the latest time to which a database can be restored with point-in-time restore.
Port (integer) --
Specifies the port that the database engine is listening on.
MasterUsername (string) --
Contains the master username for the DB cluster.
DBClusterOptionGroupMemberships (list) --
Provides the list of option group memberships for this DB cluster.
(dict) --
Contains status information for a DB cluster option group.
DBClusterOptionGroupName (string) --
Specifies the name of the DB cluster option group.
Status (string) --
Specifies the status of the DB cluster option group.
PreferredBackupWindow (string) --
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
ReplicationSourceIdentifier (string) --
Contains the identifier of the source DB cluster if this DB cluster is a Read Replica.
ReadReplicaIdentifiers (list) --
Contains one or more identifiers of the Read Replicas associated with this DB cluster.
DBClusterMembers (list) --
Provides the list of instances that make up the DB cluster.
(dict) --
Contains information about an instance that is part of a DB cluster.
DBInstanceIdentifier (string) --
Specifies the instance identifier for this member of the DB cluster.
IsClusterWriter (boolean) --
Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
DBClusterParameterGroupStatus (string) --
Specifies the status of the DB cluster parameter group for this member of the DB cluster.
PromotionTier (integer) --
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .
VpcSecurityGroups (list) --
Provides a list of VPC security groups that the DB cluster belongs to.
(dict) --
This data type is used as a response element for queries on VPC security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The status of the VPC security group.
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
StorageEncrypted (boolean) --
Specifies whether the DB cluster is encrypted.
KmsKeyId (string) --
If StorageEncrypted is enabled, the AWS KMS key identifier for the encrypted DB cluster.
DbClusterResourceId (string) --
The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for the DB cluster.
AssociatedRoles (list) --
Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.
(dict) --
Describes an AWS Identity and Access Management (IAM) role that is associated with a DB cluster.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
Status (string) --
Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:
FeatureName (string) --
The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion .
IAMDatabaseAuthenticationEnabled (boolean) --
A value that indicates whether the mapping of AWS 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 DB cluster. The capacity is 0 (zero) when the cluster is paused.
For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide .
EngineMode (string) --
The DB engine mode of the DB cluster, either provisioned , serverless , parallelquery , global , or multimaster .
ScalingConfigurationInfo (dict) --
Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.
For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide .
MinCapacity (integer) --
The maximum capacity for the Aurora DB cluster in serverless DB engine mode.
MaxCapacity (integer) --
The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
AutoPause (boolean) --
A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.
When the value is set to false for an Aurora Serverless 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 timeout action of a call to ModifyCurrentDBClusterCapacity , either ForceApplyCapacityChange or RollbackCapacityChange .
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 DB cluster is enabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless 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 AWS KMS key identifier used for encrypting messages in the database activity stream.
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 AWS account.
Examples
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:
{
'ResponseMetadata': {
'...': '...',
},
}
Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.
Note
This action only applies 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. Only relevant 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:
For 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 , modifying .
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.
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 DB cluster, you need to reboot the DB instances in 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 action 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.
Note
This action only applies to Aurora DB clusters.
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 PostgreSQL
Example: aurora-postgresql9.6
[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) --
Provides the name of the DB cluster parameter group.
DBParameterGroupFamily (string) --
Provides 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.
Examples
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:
{
'ResponseMetadata': {
'...': '...',
},
}
Creates a snapshot of 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 DB clusters.
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',
'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
}
}
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.
AllocatedStorage (integer) --
Specifies the allocated storage size in gibibytes (GiB).
Status (string) --
Specifies the status of this DB cluster snapshot.
Port (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 the 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 AWS KMS key identifier for the encrypted DB cluster snapshot.
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 AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
Examples
This example creates a DB cluster snapshot.
response = client.create_db_cluster_snapshot(
DBClusterIdentifier='mydbcluster',
DBClusterSnapshotIdentifier='mydbclustersnapshot',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Creates a new DB instance.
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',
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
)
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, the default "postgres" database 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:
SQL Server
Not applicable. Must be null.
Amazon Aurora
The name of the database to create when the primary instance of the DB cluster is created. If this parameter isn't specified, no database is created in the DB instance.
Constraints:
[REQUIRED]
The DB instance identifier. This parameter is stored as a lowercase string.
Constraints:
Example: mydbinstance
The amount of storage (in gibibytes) 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.
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.m4.large . Not all DB instance classes are available in all AWS 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.
[REQUIRED]
The name of the database engine to be used for this instance.
Not every database engine is available for every AWS Region.
Valid Values:
The name for the master user.
Amazon Aurora
Not applicable. The name for the master user is managed by the DB cluster.
MariaDB
Constraints:
Microsoft SQL Server
Constraints:
MySQL
Constraints:
Oracle
Constraints:
PostgreSQL
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.
Default: The default DB security group for the database engine.
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 AWS Regions and Availability Zones, see Regions and Availability Zones .
Default: A random, system-chosen Availability Zone in the endpoint's AWS 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 AWS Region as the current endpoint.
Note
If you're creating a DB instance in an RDS on VMware environment, specify the identifier of the custom Availability Zone to create the DB instance in.
For more information about RDS on VMware, see the ` RDS on VMware User Guide. https://docs.aws.amazon.com/AmazonRDS/latest/RDSonVMwareUserGuide/rds-on-vmware.html`__
A DB subnet group to associate with this DB instance.
If there is no DB subnet group, then it is a non-VPC DB instance.
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 AWS 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.
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. For more information, see The 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.
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Instance Maintenance Window in the Amazon RDS User Guide .
Constraints:
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 for 1434 , 3389 , 47001 , 49152 , and 49152 through 49156 .
Amazon Aurora
Default: 3306
Valid Values: 1150-65535
Type: Integer
The version number of the database engine to use.
For a list of valid engine versions, use the DescribeDBEngineVersions action.
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 AWS 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.
MariaDB
See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide.
Microsoft SQL Server
See Version and Feature Support on Amazon RDS in the Amazon RDS User Guide.
MySQL
See MySQL on Amazon RDS Versions in the Amazon RDS User Guide.
Oracle
See Oracle Database Engine Release Notes in the Amazon RDS User Guide.
PostgreSQL
See Supported PostgreSQL Database Versions in the Amazon RDS User Guide.
License model information for this DB instance.
Valid values: license-included | bring-your-own-license | general-public-license
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.
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, and that option group can't be removed from a DB instance once it is associated with a DB instance
For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.
Amazon Aurora
Not applicable. The character set is managed by the DB cluster. For more information, see CreateDBCluster .
A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, it is an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. When the DB instance isn't publicly accessible, it is an internal 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}_.:/=+\-]*)$").
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
A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.
Amazon Aurora
Not applicable. The encryption for DB instances is managed by the DB cluster.
The AWS KMS key identifier for an encrypted DB instance.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.
Amazon Aurora
Not applicable. The 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 will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
The Active Directory directory ID to create the DB instance in. Currently, only Microsoft SQL Server and Oracle DB instances can be created in an Active Directory Domain.
For Microsoft SQL Server DB instances, Amazon RDS can use Windows Authentication to authenticate users that connect to the DB instance. For more information, see Using Windows Authentication with an Amazon RDS DB Instance Running Microsoft SQL Server in the Amazon RDS User Guide .
For Oracle DB instance, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB instance. For more information, see Using Kerberos Authentication with Amazon RDS for Oracle in the Amazon RDS User Guide .
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 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.
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 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 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 .
Default: 1
Valid Values: 0 - 15
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
You can enable IAM database authentication for the following database engines:
Amazon Aurora
Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.
MySQL
PostgreSQL
For more information, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
A value that indicates whether to enable Performance Insights for the DB instance.
For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide .
The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
If you do not specify a value for PerformanceInsightsKMSKeyId , then Amazon RDS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Relational Database Service 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:
You 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:
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 is disabled. 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.
dict
Response Syntax
{
'DBInstance': {
'DBInstanceIdentifier': 'string',
'DBInstanceClass': 'string',
'Engine': 'string',
'DBInstanceStatus': 'string',
'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'
},
'SubnetStatus': 'string'
},
],
'DBSubnetGroupArn': 'string'
},
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'DBInstanceClass': 'string',
'AllocatedStorage': 123,
'MasterUserPassword': 'string',
'Port': 123,
'BackupRetentionPeriod': 123,
'MultiAZ': True|False,
'EngineVersion': 'string',
'LicenseModel': 'string',
'Iops': 123,
'DBInstanceIdentifier': 'string',
'StorageType': 'string',
'CACertificateIdentifier': 'string',
'DBSubnetGroupName': 'string',
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
},
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
]
},
'LatestRestorableTime': datetime(2015, 1, 1),
'MultiAZ': True|False,
'EngineVersion': 'string',
'AutoMinorVersionUpgrade': True|False,
'ReadReplicaSourceDBInstanceIdentifier': 'string',
'ReadReplicaDBInstanceIdentifiers': [
'string',
],
'ReadReplicaDBClusterIdentifiers': [
'string',
],
'LicenseModel': 'string',
'Iops': 123,
'OptionGroupMemberships': [
{
'OptionGroupName': 'string',
'Status': 'string'
},
],
'CharacterSetName': '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
}
}
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 DescribeDBInstances action.
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) --
Provides the name of the database engine to be used for this DB instance.
DBInstanceStatus (string) --
Specifies the current state of this database.
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.
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.
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:
DBSecurityGroupName (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 status of the VPC security group.
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:
DBParameterGroupName (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 in the DescribeDBSubnetGroups action.
SubnetIdentifier (string) --
Specifies 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.
SubnetStatus (string) --
Specifies the status of the subnet.
DBSubnetGroupArn (string) --
The Amazon Resource Name (ARN) for the DB subnet group.
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
PendingModifiedValues (dict) --
Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
DBInstanceClass (string) --
Contains the new DBInstanceClass for the DB instance that will be applied or is currently being applied.
AllocatedStorage (integer) --
Contains the new AllocatedStorage size for the DB instance that will be applied or is currently being applied.
MasterUserPassword (string) --
Contains the pending or currently-in-progress change of the master credentials for the DB instance.
Port (integer) --
Specifies the pending port for the DB instance.
BackupRetentionPeriod (integer) --
Specifies the pending number of days for which automated backups are retained.
MultiAZ (boolean) --
Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.
EngineVersion (string) --
Indicates 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) --
Specifies the new Provisioned IOPS value for the DB instance that will be applied or is currently being applied.
DBInstanceIdentifier (string) --
Contains the new DBInstanceIdentifier for the DB instance that will be applied or is currently being applied.
StorageType (string) --
Specifies the storage type to be associated with the DB instance.
CACertificateIdentifier (string) --
Specifies the identifier of the CA certificate for the DB instance.
DBSubnetGroupName (string) --
The new 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:
You 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:
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.
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.
EngineVersion (string) --
Indicates the database engine version.
AutoMinorVersionUpgrade (boolean) --
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 MySQL DB instance, the Aurora MySQL DB cluster for the Aurora Read Replica is shown. This output does not contain information about cross region Aurora Read Replicas.
Note
Currently, each RDS DB instance can have only one Aurora Read Replica.
LicenseModel (string) --
License model information for this DB instance.
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.
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. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
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 AWS KMS key identifier for the encrypted DB instance.
DbiResourceId (string) --
The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS 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.
Domain (string) --
The identifier of the Active Directory Domain.
Status (string) --
The status of the DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).
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 AWS 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 AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
PerformanceInsightsRetentionPeriod (integer) --
The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
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:
You 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:
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 AWS Identity and Access Management (IAM) roles associated with the DB instance.
(dict) --
Describes an AWS 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 AWS Identity and Access Management (IAM) role. For the list of 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:
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 to which Amazon RDS can automatically scale the storage of the DB instance.
Examples
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:
{
'ResponseMetadata': {
'...': '...',
},
}
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, or PostgreSQL. For more information, see Working with Read Replicas in the Amazon RDS User Guide .
Amazon Aurora doesn't support this action. You must call the CreateDBInstance action 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 following.
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',
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 AWS 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 AWS 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.
A value that indicates whether minor engine upgrades are applied automatically to the Read Replica during the maintenance window.
Default: Inherits from the source DB instance
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.
Note
Currently, specifying a parameter group for this operation is only supported for Oracle DB instances.
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}_.:/=+\-]*)$").
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: mySubnetgroup
A list of EC2 VPC security groups to associate with the Read Replica.
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.
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.
The AWS KMS key ID for an encrypted Read Replica. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
If you create an encrypted Read Replica in the same AWS Region as the source DB instance, then you do not have to specify a value for this parameter. The Read Replica is encrypted with the same KMS key as the source DB instance.
If you create an encrypted Read Replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region.
You can't create an encrypted Read Replica from an unencrypted DB instance.
The URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API action in the source AWS Region that contains the source DB instance.
You must specify this parameter when you create an encrypted Read Replica from another AWS Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are creating an encrypted Read Replica in the same AWS Region.
The presigned URL must be a valid request for the CreateDBInstanceReadReplica API action that can be executed in the source AWS Region that contains the encrypted source DB instance. The presigned URL request must contain the following parameter values:
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process .
Note
If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source AWS Region.
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 AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For information about the supported DB engines, see CreateDBInstance .
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
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 .
The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
If you do not specify a value for PerformanceInsightsKMSKeyId , then Amazon RDS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
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 .
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:
You 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:
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 Active Directory directory ID to create the DB instance in.
For Oracle DB instances, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB instance. For more information, see Using Kerberos Authentication with Amazon RDS for Oracle in the Amazon RDS User Guide .
dict
Response Syntax
{
'DBInstance': {
'DBInstanceIdentifier': 'string',
'DBInstanceClass': 'string',
'Engine': 'string',
'DBInstanceStatus': 'string',
'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'
},
'SubnetStatus': 'string'
},
],
'DBSubnetGroupArn': 'string'
},
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'DBInstanceClass': 'string',
'AllocatedStorage': 123,
'MasterUserPassword': 'string',
'Port': 123,
'BackupRetentionPeriod': 123,
'MultiAZ': True|False,
'EngineVersion': 'string',
'LicenseModel': 'string',
'Iops': 123,
'DBInstanceIdentifier': 'string',
'StorageType': 'string',
'CACertificateIdentifier': 'string',
'DBSubnetGroupName': 'string',
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
},
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
]
},
'LatestRestorableTime': datetime(2015, 1, 1),
'MultiAZ': True|False,
'EngineVersion': 'string',
'AutoMinorVersionUpgrade': True|False,
'ReadReplicaSourceDBInstanceIdentifier': 'string',
'ReadReplicaDBInstanceIdentifiers': [
'string',
],
'ReadReplicaDBClusterIdentifiers': [
'string',
],
'LicenseModel': 'string',
'Iops': 123,
'OptionGroupMemberships': [
{
'OptionGroupName': 'string',
'Status': 'string'
},
],
'CharacterSetName': '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
}
}
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 DescribeDBInstances action.
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) --
Provides the name of the database engine to be used for this DB instance.
DBInstanceStatus (string) --
Specifies the current state of this database.
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.
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.
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:
DBSecurityGroupName (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 status of the VPC security group.
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:
DBParameterGroupName (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 in the DescribeDBSubnetGroups action.
SubnetIdentifier (string) --
Specifies 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.
SubnetStatus (string) --
Specifies the status of the subnet.
DBSubnetGroupArn (string) --
The Amazon Resource Name (ARN) for the DB subnet group.
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
PendingModifiedValues (dict) --
Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
DBInstanceClass (string) --
Contains the new DBInstanceClass for the DB instance that will be applied or is currently being applied.
AllocatedStorage (integer) --
Contains the new AllocatedStorage size for the DB instance that will be applied or is currently being applied.
MasterUserPassword (string) --
Contains the pending or currently-in-progress change of the master credentials for the DB instance.
Port (integer) --
Specifies the pending port for the DB instance.
BackupRetentionPeriod (integer) --
Specifies the pending number of days for which automated backups are retained.
MultiAZ (boolean) --
Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.
EngineVersion (string) --
Indicates 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) --
Specifies the new Provisioned IOPS value for the DB instance that will be applied or is currently being applied.
DBInstanceIdentifier (string) --
Contains the new DBInstanceIdentifier for the DB instance that will be applied or is currently being applied.
StorageType (string) --
Specifies the storage type to be associated with the DB instance.
CACertificateIdentifier (string) --
Specifies the identifier of the CA certificate for the DB instance.
DBSubnetGroupName (string) --
The new 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:
You 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:
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.
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.
EngineVersion (string) --
Indicates the database engine version.
AutoMinorVersionUpgrade (boolean) --
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 MySQL DB instance, the Aurora MySQL DB cluster for the Aurora Read Replica is shown. This output does not contain information about cross region Aurora Read Replicas.
Note
Currently, each RDS DB instance can have only one Aurora Read Replica.
LicenseModel (string) --
License model information for this DB instance.
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.
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. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
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 AWS KMS key identifier for the encrypted DB instance.
DbiResourceId (string) --
The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS 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.
Domain (string) --
The identifier of the Active Directory Domain.
Status (string) --
The status of the DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).
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 AWS 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 AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
PerformanceInsightsRetentionPeriod (integer) --
The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
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:
You 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:
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 AWS Identity and Access Management (IAM) roles associated with the DB instance.
(dict) --
Describes an AWS 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 AWS Identity and Access Management (IAM) role. For the list of 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:
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 to which Amazon RDS can automatically scale the storage of the DB instance.
Examples
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:
{
'ResponseMetadata': {
'...': '...',
},
}
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.
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, use the following command:
aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily"
Note
The output contains duplicates.
[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) --
Provides the name of the DB parameter group.
DBParameterGroupFamily (string) --
Provides 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.
Examples
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:
{
'ResponseMetadata': {
'...': '...',
},
}
Note
This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.
Creates a new DB proxy.
See also: AWS API Documentation
Request Syntax
response = client.create_db_proxy(
DBProxyName='string',
EngineFamily='MYSQL',
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 AWS account in the specified AWS 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. Currently, this value is always MYSQL . The engine family applies to both RDS MySQL and Aurora MySQL.
[REQUIRED]
The authorization mechanism that the proxy uses.
Note
This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.
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 AWS 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 AWS 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',
'EngineFamily': '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 AWS account in the specified AWS 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) --
Currently, this value is always MYSQL . The engine family applies to both RDS MySQL and Aurora MySQL.
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) --
Note
This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.
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 AWS 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 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.
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 AWS 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:
Status (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 AWS 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.
Examples
This example creates a DB security group.
response = client.create_db_security_group(
DBSecurityGroupDescription='My DB security group',
DBSecurityGroupName='mydbsecuritygroup',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Creates a DBSnapshot. The source DBInstance must be in "available" 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'
}
}
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) --
Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
Engine (string) --
Specifies the name of the database engine.
AllocatedStorage (integer) --
Specifies the allocated storage size in 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 when the snapshot was taken, in Universal Coordinated Time (UTC).
MasterUsername (string) --
Provides the master username for the DB snapshot.
EngineVersion (string) --
Specifies the version of the database engine.
LicenseModel (string) --
License model information for the restored DB instance.
SnapshotType (string) --
Provides the type of the DB snapshot.
Iops (integer) --
Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
OptionGroupName (string) --
Provides the option group name for the DB snapshot.
PercentProgress (integer) --
The percentage of the estimated data that has been transferred.
SourceRegion (string) --
The AWS 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 value in case of cross-customer or cross-region copy.
StorageType (string) --
Specifies the storage type associated with DB snapshot.
TdeCredentialArn (string) --
The ARN from the key store with which to associate the instance for TDE encryption.
Encrypted (boolean) --
Specifies whether the DB snapshot is encrypted.
KmsKeyId (string) --
If Encrypted is true, the AWS KMS key identifier for the encrypted DB snapshot.
DBSnapshotArn (string) --
The Amazon Resource Name (ARN) for the DB snapshot.
Timezone (string) --
The time zone of the DB snapshot. In most cases, the Timezone element is empty. Timezone content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.
IAMDatabaseAuthenticationEnabled (boolean) --
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, 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:
You 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:
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 AWS Region.
Examples
This example creates a DB snapshot.
response = client.create_db_snapshot(
DBInstanceIdentifier='mymysqlinstance',
DBSnapshotIdentifier='mydbsnapshot',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS 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: Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. Must not be default.
Example: mySubnetgroup
[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'
},
'SubnetStatus': 'string'
},
],
'DBSubnetGroupArn': '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 in the DescribeDBSubnetGroups action.
SubnetIdentifier (string) --
Specifies 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.
SubnetStatus (string) --
Specifies the status of the subnet.
DBSubnetGroupArn (string) --
The Amazon Resource Name (ARN) for the DB subnet group.
Examples
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:
{
'ResponseMetadata': {
'...': '...',
},
}
Creates an RDS event notification subscription. This action requires a topic ARN (Amazon Resource Name) 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) you want to be notified of, provide a list of RDS sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events 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 SourceIdentifier = myDBInstance1, you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your RDS sources. If you do not specify either the SourceType nor the SourceIdentifier, 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 would set this parameter to db-instance. 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
A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.
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:
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 AWS 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.
Examples
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:
{
'ResponseMetadata': {
'...': '...',
},
}
Creates an Aurora global database spread across multiple regions. The global database contains a single primary cluster with read-write capability, and a read-only secondary cluster that receives data from the primary cluster through high-speed replication performed by the Aurora storage subsystem.
You can create a global database that is initially empty, and then add a primary cluster and a secondary cluster to it. Or you can specify an existing Aurora cluster during the create operation, and this cluster becomes the primary cluster of the global database.
Note
This action only applies 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
},
]
}
}
Response Structure
(dict) --
GlobalCluster (dict) --
A data type representing an Aurora global database.
GlobalClusterIdentifier (string) --
Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster.
GlobalClusterResourceId (string) --
The AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
GlobalClusterArn (string) --
The Amazon Resource Name (ARN) for the global database cluster.
Status (string) --
Specifies the current state of this global database cluster.
Engine (string) --
The Aurora database engine used by the global database cluster.
EngineVersion (string) --
Indicates the database engine version.
DatabaseName (string) --
The default database name within the new global database cluster.
StorageEncrypted (boolean) --
The storage encryption setting for the global database cluster.
DeletionProtection (boolean) --
The deletion protection setting for the new global database cluster.
GlobalClusterMembers (list) --
The list of cluster IDs for secondary clusters within the global database cluster. Currently limited to 1 item.
(dict) --
A data structure with information about any primary and secondary clusters associated with an Aurora global database.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for each Aurora cluster.
Readers (list) --
The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global database.
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.
Creates a new option group. You can create up to 20 option groups.
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.
[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:
DBSecurityGroupName (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 status of the VPC security group.
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.
Examples
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:
{
'ResponseMetadata': {
'...': '...',
},
}
Deletes a custom Availability Zone (AZ).
A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster.
For more information about RDS on VMware, see the ` RDS on VMware User Guide. https://docs.aws.amazon.com/AmazonRDS/latest/RDSonVMwareUserGuide/rds-on-vmware.html`__
See also: AWS API Documentation
Request Syntax
response = client.delete_custom_availability_zone(
CustomAvailabilityZoneId='string'
)
[REQUIRED]
The custom AZ identifier.
{
'CustomAvailabilityZone': {
'CustomAvailabilityZoneId': 'string',
'CustomAvailabilityZoneName': 'string',
'CustomAvailabilityZoneStatus': 'string',
'VpnDetails': {
'VpnId': 'string',
'VpnTunnelOriginatorIP': 'string',
'VpnGatewayIp': 'string',
'VpnPSK': 'string',
'VpnName': 'string',
'VpnState': 'string'
}
}
}
Response Structure
A custom Availability Zone (AZ) is an on-premises AZ that is integrated with a VMware vSphere cluster.
For more information about RDS on VMware, see the ` RDS on VMware User Guide. https://docs.aws.amazon.com/AmazonRDS/latest/RDSonVMwareUserGuide/rds-on-vmware.html`__
The identifier of the custom AZ.
Amazon RDS generates a unique identifier when a custom AZ is created.
The name of the custom AZ.
The status of the custom AZ.
Information about the virtual private network (VPN) between the VMware vSphere cluster and the AWS website.
The ID of the VPN.
The IP address of network traffic from your on-premises data center. A custom AZ receives the network traffic.
The IP address of network traffic from AWS to your on-premises data center.
The preshared key (PSK) for the VPN.
The name of the VPN.
The state of the VPN.
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.
Note
This action only applies to Aurora DB clusters.
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',
'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'
},
'DeletionProtection': True|False,
'HttpEndpointEnabled': True|False,
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'CopyTagsToSnapshot': True|False,
'CrossAccountClone': True|False
}
}
Response Structure
(dict) --
DBCluster (dict) --
Contains the details of an Amazon Aurora DB cluster.
This data type is used as a response element in the DescribeDBClusters , StopDBCluster , and StartDBCluster actions.
AllocatedStorage (integer) --
For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size 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.
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) --
Provides the name of the database engine to be used for this DB cluster.
EngineVersion (string) --
Indicates the database engine version.
LatestRestorableTime (datetime) --
Specifies the latest time to which a database can be restored with point-in-time restore.
Port (integer) --
Specifies the port that the database engine is listening on.
MasterUsername (string) --
Contains the master username for the DB cluster.
DBClusterOptionGroupMemberships (list) --
Provides the list of option group memberships for this DB cluster.
(dict) --
Contains status information for a DB cluster option group.
DBClusterOptionGroupName (string) --
Specifies the name of the DB cluster option group.
Status (string) --
Specifies the status of the DB cluster option group.
PreferredBackupWindow (string) --
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
ReplicationSourceIdentifier (string) --
Contains the identifier of the source DB cluster if this DB cluster is a Read Replica.
ReadReplicaIdentifiers (list) --
Contains one or more identifiers of the Read Replicas associated with this DB cluster.
DBClusterMembers (list) --
Provides the list of instances that make up the DB cluster.
(dict) --
Contains information about an instance that is part of a DB cluster.
DBInstanceIdentifier (string) --
Specifies the instance identifier for this member of the DB cluster.
IsClusterWriter (boolean) --
Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
DBClusterParameterGroupStatus (string) --
Specifies the status of the DB cluster parameter group for this member of the DB cluster.
PromotionTier (integer) --
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .
VpcSecurityGroups (list) --
Provides a list of VPC security groups that the DB cluster belongs to.
(dict) --
This data type is used as a response element for queries on VPC security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The status of the VPC security group.
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
StorageEncrypted (boolean) --
Specifies whether the DB cluster is encrypted.
KmsKeyId (string) --
If StorageEncrypted is enabled, the AWS KMS key identifier for the encrypted DB cluster.
DbClusterResourceId (string) --
The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for the DB cluster.
AssociatedRoles (list) --
Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.
(dict) --
Describes an AWS Identity and Access Management (IAM) role that is associated with a DB cluster.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
Status (string) --
Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:
FeatureName (string) --
The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion .
IAMDatabaseAuthenticationEnabled (boolean) --
A value that indicates whether the mapping of AWS 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 DB cluster. The capacity is 0 (zero) when the cluster is paused.
For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide .
EngineMode (string) --
The DB engine mode of the DB cluster, either provisioned , serverless , parallelquery , global , or multimaster .
ScalingConfigurationInfo (dict) --
Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.
For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide .
MinCapacity (integer) --
The maximum capacity for the Aurora DB cluster in serverless DB engine mode.
MaxCapacity (integer) --
The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
AutoPause (boolean) --
A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.
When the value is set to false for an Aurora Serverless 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 timeout action of a call to ModifyCurrentDBClusterCapacity , either ForceApplyCapacityChange or RollbackCapacityChange .
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 DB cluster is enabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless 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 AWS KMS key identifier used for encrypting messages in the database activity stream.
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 AWS account.
Examples
This example deletes the specified DB cluster.
response = client.delete_db_cluster(
DBClusterIdentifier='mydbcluster',
SkipFinalSnapshot=True,
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
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:
For 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 , modifying .
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.
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.
Note
This action only applies to Aurora DB clusters.
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:
Examples
This example deletes the specified DB cluster parameter group.
response = client.delete_db_cluster_parameter_group(
DBClusterParameterGroupName='mydbclusterparametergroup',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
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.
Note
This action only applies to Aurora DB clusters.
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',
'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
}
}
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.
Specifies the allocated storage size in gibibytes (GiB).
Specifies the status of this DB cluster snapshot.
Specifies 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 the 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 AWS KMS key identifier for the encrypted DB cluster snapshot.
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 AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
Examples
This example deletes the specified DB cluster snapshot.
response = client.delete_db_cluster_snapshot(
DBClusterSnapshotIdentifier='mydbclustersnapshot',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
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.
Note that 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 the DB instance is deleted. If skip is specified, no DB snapshot is created. If skip isn't specified, a DB snapshot is created before the DB instance is deleted. By default, skip isn't specified, and the DB snapshot is created.
Note that when a DB instance is in a failure state and has a status of 'failed', 'incompatible-restore', or 'incompatible-network', it can only be deleted when skip is specified.
Specify skip when deleting a Read Replica.
Note
The FinalDBSnapshotIdentifier parameter must be specified if skip isn't specified.
The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot parameter is disabled.
Note
Specifying this parameter and also specifying to skip final DB snapshot creation in SkipFinalShapshot results in an error.
Constraints:
dict
Response Syntax
{
'DBInstance': {
'DBInstanceIdentifier': 'string',
'DBInstanceClass': 'string',
'Engine': 'string',
'DBInstanceStatus': 'string',
'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'
},
'SubnetStatus': 'string'
},
],
'DBSubnetGroupArn': 'string'
},
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'DBInstanceClass': 'string',
'AllocatedStorage': 123,
'MasterUserPassword': 'string',
'Port': 123,
'BackupRetentionPeriod': 123,
'MultiAZ': True|False,
'EngineVersion': 'string',
'LicenseModel': 'string',
'Iops': 123,
'DBInstanceIdentifier': 'string',
'StorageType': 'string',
'CACertificateIdentifier': 'string',
'DBSubnetGroupName': 'string',
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
},
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
]
},
'LatestRestorableTime': datetime(2015, 1, 1),
'MultiAZ': True|False,
'EngineVersion': 'string',
'AutoMinorVersionUpgrade': True|False,
'ReadReplicaSourceDBInstanceIdentifier': 'string',
'ReadReplicaDBInstanceIdentifiers': [
'string',
],
'ReadReplicaDBClusterIdentifiers': [
'string',
],
'LicenseModel': 'string',
'Iops': 123,
'OptionGroupMemberships': [
{
'OptionGroupName': 'string',
'Status': 'string'
},
],
'CharacterSetName': '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
}
}
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 DescribeDBInstances action.
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) --
Provides the name of the database engine to be used for this DB instance.
DBInstanceStatus (string) --
Specifies the current state of this database.
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.
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.
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:
DBSecurityGroupName (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 status of the VPC security group.
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:
DBParameterGroupName (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 in the DescribeDBSubnetGroups action.
SubnetIdentifier (string) --
Specifies 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.
SubnetStatus (string) --
Specifies the status of the subnet.
DBSubnetGroupArn (string) --
The Amazon Resource Name (ARN) for the DB subnet group.
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
PendingModifiedValues (dict) --
Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
DBInstanceClass (string) --
Contains the new DBInstanceClass for the DB instance that will be applied or is currently being applied.
AllocatedStorage (integer) --
Contains the new AllocatedStorage size for the DB instance that will be applied or is currently being applied.
MasterUserPassword (string) --
Contains the pending or currently-in-progress change of the master credentials for the DB instance.
Port (integer) --
Specifies the pending port for the DB instance.
BackupRetentionPeriod (integer) --
Specifies the pending number of days for which automated backups are retained.
MultiAZ (boolean) --
Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.
EngineVersion (string) --
Indicates 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) --
Specifies the new Provisioned IOPS value for the DB instance that will be applied or is currently being applied.
DBInstanceIdentifier (string) --
Contains the new DBInstanceIdentifier for the DB instance that will be applied or is currently being applied.
StorageType (string) --
Specifies the storage type to be associated with the DB instance.
CACertificateIdentifier (string) --
Specifies the identifier of the CA certificate for the DB instance.
DBSubnetGroupName (string) --
The new 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:
You 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:
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.
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.
EngineVersion (string) --
Indicates the database engine version.
AutoMinorVersionUpgrade (boolean) --
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 MySQL DB instance, the Aurora MySQL DB cluster for the Aurora Read Replica is shown. This output does not contain information about cross region Aurora Read Replicas.
Note
Currently, each RDS DB instance can have only one Aurora Read Replica.
LicenseModel (string) --
License model information for this DB instance.
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.
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. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
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 AWS KMS key identifier for the encrypted DB instance.
DbiResourceId (string) --
The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS 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.
Domain (string) --
The identifier of the Active Directory Domain.
Status (string) --
The status of the DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).
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 AWS 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 AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
PerformanceInsightsRetentionPeriod (integer) --
The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
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:
You 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:
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 AWS Identity and Access Management (IAM) roles associated with the DB instance.
(dict) --
Describes an AWS 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 AWS Identity and Access Management (IAM) role. For the list of 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:
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 to which Amazon RDS can automatically scale the storage of the DB instance.
Examples
This example deletes the specified DB instance.
response = client.delete_db_instance(
DBInstanceIdentifier='mymysqlinstance',
SkipFinalSnapshot=True,
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Deletes automated backups based on the source instance's DbiResourceId value or the restorable instance's resource ID.
See also: AWS API Documentation
Request Syntax
response = client.delete_db_instance_automated_backup(
DbiResourceId='string'
)
[REQUIRED]
The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region.
{
'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
}
}
Response Structure
An automated backup of a DB instance. It 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 backup.
The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region.
The AWS 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:
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 AWS 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 AWS KMS key ID for an automated backup. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption 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 AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
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:
Examples
The following example deletes a DB parameter group.
response = client.delete_db_parameter_group(
DBParameterGroupName='mydbparamgroup3',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Note
This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.
Deletes an existing 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',
'EngineFamily': '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 AWS account in the specified AWS 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.
Currently, this value is always MYSQL . The engine family applies to both RDS MySQL and Aurora MySQL.
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.
Note
This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.
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 AWS 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 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.
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:
Examples
The following example deletes a DB security group.
response = client.delete_db_security_group(
DBSecurityGroupName='mysecgroup',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
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'
}
}
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.
Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
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 when the snapshot was taken, in Universal Coordinated Time (UTC).
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 AWS 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 value in case of cross-customer 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 AWS KMS key identifier for the encrypted DB snapshot.
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 AWS 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:
You 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:
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 AWS Region.
Examples
This example deletes the specified DB snapshot.
response = client.delete_db_snapshot(
DBSnapshotIdentifier='mydbsnapshot',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
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:
Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
Example: mySubnetgroup
Examples
This example deletes the specified DB subnetgroup.
response = client.delete_db_subnet_group(
DBSubnetGroupName='mydbsubnetgroup',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
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 AWS 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.
Examples
This example deletes the specified DB event subscription.
response = client.delete_event_subscription(
SubscriptionName='myeventsubscription',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
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
},
]
}
}
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 AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
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.
Deletes the installation medium for a DB engine that requires an on-premises customer provided license, such as Microsoft SQL Server.
See also: AWS API Documentation
Request Syntax
response = client.delete_installation_media(
InstallationMediaId='string'
)
[REQUIRED]
The installation medium ID.
{
'InstallationMediaId': 'string',
'CustomAvailabilityZoneId': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'EngineInstallationMediaPath': 'string',
'OSInstallationMediaPath': 'string',
'Status': 'string',
'FailureCause': {
'Message': 'string'
}
}
Response Structure
Contains the installation media for a DB engine that requires an on-premises customer provided license, such as Microsoft SQL Server.
The installation medium ID.
The custom Availability Zone (AZ) that contains the installation media.
The DB engine.
The engine version of the DB engine.
The path to the installation medium for the DB engine.
The path to the installation medium for the operating system associated with the DB engine.
The status of the installation medium.
If an installation media failure occurred, the cause of the failure.
The reason that an installation media import failed.
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.
Examples
This example deletes the specified option group.
response = client.delete_option_group(
OptionGroupName='mydboptiongroup',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Note
This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.
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 .
One or more DB instance identifiers.
One or more DB cluster identifiers.
dict
Response Syntax
{}
Response Structure
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 AWS account.
The following are account quotas:
For more information, see Limits in the Amazon RDS User Guide and Limits in the Amazon Aurora User Guide .
The name of the Amazon RDS quota for this AWS 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': {
'...': '...',
},
}
Lists the set of CA certificates provided by Amazon RDS for this AWS 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:
The 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.
dict
Response Syntax
{
'Certificates': [
{
'CertificateIdentifier': 'string',
'CertificateType': 'string',
'Thumbprint': 'string',
'ValidFrom': datetime(2015, 1, 1),
'ValidTill': datetime(2015, 1, 1),
'CertificateArn': 'string'
},
],
'Marker': 'string'
}
Response Structure
(dict) --
Data returned by the DescribeCertificates action.
Certificates (list) --
The list of Certificate objects for the AWS account.
(dict) --
A CA certificate for an AWS 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.
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 .
Examples
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': {
'...': '...',
},
}
Returns information about custom Availability Zones (AZs).
A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster.
For more information about RDS on VMware, see the ` RDS on VMware User Guide. https://docs.aws.amazon.com/AmazonRDS/latest/RDSonVMwareUserGuide/rds-on-vmware.html`__
See also: AWS API Documentation
Request Syntax
response = client.describe_custom_availability_zones(
CustomAvailabilityZoneId='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
A filter that specifies one or more custom AZs to describe.
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:
The 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.
dict
Response Syntax
{
'Marker': 'string',
'CustomAvailabilityZones': [
{
'CustomAvailabilityZoneId': 'string',
'CustomAvailabilityZoneName': 'string',
'CustomAvailabilityZoneStatus': 'string',
'VpnDetails': {
'VpnId': 'string',
'VpnTunnelOriginatorIP': 'string',
'VpnGatewayIp': 'string',
'VpnPSK': 'string',
'VpnName': 'string',
'VpnState': 'string'
}
},
]
}
Response Structure
(dict) --
Marker (string) --
An optional pagination token provided by a previous DescribeCustomAvailabilityZones request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
CustomAvailabilityZones (list) --
The list of CustomAvailabilityZone objects for the AWS account.
(dict) --
A custom Availability Zone (AZ) is an on-premises AZ that is integrated with a VMware vSphere cluster.
For more information about RDS on VMware, see the ` RDS on VMware User Guide. https://docs.aws.amazon.com/AmazonRDS/latest/RDSonVMwareUserGuide/rds-on-vmware.html`__
CustomAvailabilityZoneId (string) --
The identifier of the custom AZ.
Amazon RDS generates a unique identifier when a custom AZ is created.
CustomAvailabilityZoneName (string) --
The name of the custom AZ.
CustomAvailabilityZoneStatus (string) --
The status of the custom AZ.
VpnDetails (dict) --
Information about the virtual private network (VPN) between the VMware vSphere cluster and the AWS website.
VpnId (string) --
The ID of the VPN.
VpnTunnelOriginatorIP (string) --
The IP address of network traffic from your on-premises data center. A custom AZ receives the network traffic.
VpnGatewayIp (string) --
The IP address of network traffic from AWS to your on-premises data center.
VpnPSK (string) --
The preshared key (PSK) for the VPN.
VpnName (string) --
The name of the VPN.
VpnState (string) --
The state of the VPN.
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 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:
The 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:
The 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.
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 subsequent 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:
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 , 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:
The 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.
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:
For 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 , modifying .
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.
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.
Note
This action only applies to Aurora DB clusters.
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:
The 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.
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) --
Provides the name of the DB cluster parameter group.
DBParameterGroupFamily (string) --
Provides 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.
Examples
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': {
'...': '...',
},
}
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.
Note
This action only applies to Aurora DB clusters.
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:
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:
The 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.
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 .
Examples
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': {
'...': '...',
},
}
Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.
When sharing snapshots with other AWS accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the AWS 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 AWS accounts.
To add or remove access for an AWS 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.
Note
This action only applies to Aurora DB clusters.
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 AWS 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 AWS 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 AWS 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 AWS 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 AWS account to copy or restore.
Examples
This example lists attributes for the specified DB cluster snapshot.
response = client.describe_db_cluster_snapshot_attributes(
DBClusterSnapshotIdentifier='mydbclustersnapshot',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Returns information about DB cluster snapshots. This API action 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_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:
The type of DB cluster snapshots to be returned. You can specify one of the following values:
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:
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:
The 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.
A value that indicates whether to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore. By default, these snapshots are not included.
You can give an AWS account permission to restore a manual DB cluster snapshot from another AWS 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 AWS 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',
'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
},
]
}
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.
AllocatedStorage (integer) --
Specifies the allocated storage size in gibibytes (GiB).
Status (string) --
Specifies the status of this DB cluster snapshot.
Port (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 the 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 AWS KMS key identifier for the encrypted DB cluster snapshot.
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 AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
Examples
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': {
'...': '...',
},
}
Returns information about provisioned Aurora DB clusters. This API supports pagination.
For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.
Note
This action only applies to Aurora DB clusters.
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:
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:
The 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.
dict
Response Syntax
{
'Marker': 'string',
'DBClusters': [
{
'AllocatedStorage': 123,
'AvailabilityZones': [
'string',
],
'BackupRetentionPeriod': 123,
'CharacterSetName': 'string',
'DatabaseName': 'string',
'DBClusterIdentifier': 'string',
'DBClusterParameterGroup': 'string',
'DBSubnetGroup': 'string',
'Status': 'string',
'PercentProgress': 'string',
'EarliestRestorableTime': datetime(2015, 1, 1),
'Endpoint': 'string',
'ReaderEndpoint': 'string',
'CustomEndpoints': [
'string',
],
'MultiAZ': True|False,
'Engine': 'string',
'EngineVersion': 'string',
'LatestRestorableTime': datetime(2015, 1, 1),
'Port': 123,
'MasterUsername': 'string',
'DBClusterOptionGroupMemberships': [
{
'DBClusterOptionGroupName': 'string',
'Status': 'string'
},
],
'PreferredBackupWindow': 'string',
'PreferredMaintenanceWindow': 'string',
'ReplicationSourceIdentifier': 'string',
'ReadReplicaIdentifiers': [
'string',
],
'DBClusterMembers': [
{
'DBInstanceIdentifier': 'string',
'IsClusterWriter': True|False,
'DBClusterParameterGroupStatus': 'string',
'PromotionTier': 123
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'HostedZoneId': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbClusterResourceId': 'string',
'DBClusterArn': 'string',
'AssociatedRoles': [
{
'RoleArn': 'string',
'Status': 'string',
'FeatureName': 'string'
},
],
'IAMDatabaseAuthenticationEnabled': True|False,
'CloneGroupId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'EarliestBacktrackTime': datetime(2015, 1, 1),
'BacktrackWindow': 123,
'BacktrackConsumedChangeRecords': 123,
'EnabledCloudwatchLogsExports': [
'string',
],
'Capacity': 123,
'EngineMode': 'string',
'ScalingConfigurationInfo': {
'MinCapacity': 123,
'MaxCapacity': 123,
'AutoPause': True|False,
'SecondsUntilAutoPause': 123,
'TimeoutAction': 'string'
},
'DeletionProtection': True|False,
'HttpEndpointEnabled': True|False,
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'CopyTagsToSnapshot': True|False,
'CrossAccountClone': True|False
},
]
}
Response Structure
(dict) --
Contains the result of a successful invocation of the DescribeDBClusters action.
Marker (string) --
A pagination token that can be used in a subsequent DescribeDBClusters request.
DBClusters (list) --
Contains a list of DB clusters for the user.
(dict) --
Contains the details of an Amazon Aurora DB cluster.
This data type is used as a response element in the DescribeDBClusters , StopDBCluster , and StartDBCluster actions.
AllocatedStorage (integer) --
For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size 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.
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) --
Provides the name of the database engine to be used for this DB cluster.
EngineVersion (string) --
Indicates the database engine version.
LatestRestorableTime (datetime) --
Specifies the latest time to which a database can be restored with point-in-time restore.
Port (integer) --
Specifies the port that the database engine is listening on.
MasterUsername (string) --
Contains the master username for the DB cluster.
DBClusterOptionGroupMemberships (list) --
Provides the list of option group memberships for this DB cluster.
(dict) --
Contains status information for a DB cluster option group.
DBClusterOptionGroupName (string) --
Specifies the name of the DB cluster option group.
Status (string) --
Specifies the status of the DB cluster option group.
PreferredBackupWindow (string) --
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
ReplicationSourceIdentifier (string) --
Contains the identifier of the source DB cluster if this DB cluster is a Read Replica.
ReadReplicaIdentifiers (list) --
Contains one or more identifiers of the Read Replicas associated with this DB cluster.
DBClusterMembers (list) --
Provides the list of instances that make up the DB cluster.
(dict) --
Contains information about an instance that is part of a DB cluster.
DBInstanceIdentifier (string) --
Specifies the instance identifier for this member of the DB cluster.
IsClusterWriter (boolean) --
Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
DBClusterParameterGroupStatus (string) --
Specifies the status of the DB cluster parameter group for this member of the DB cluster.
PromotionTier (integer) --
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .
VpcSecurityGroups (list) --
Provides a list of VPC security groups that the DB cluster belongs to.
(dict) --
This data type is used as a response element for queries on VPC security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The status of the VPC security group.
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
StorageEncrypted (boolean) --
Specifies whether the DB cluster is encrypted.
KmsKeyId (string) --
If StorageEncrypted is enabled, the AWS KMS key identifier for the encrypted DB cluster.
DbClusterResourceId (string) --
The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for the DB cluster.
AssociatedRoles (list) --
Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.
(dict) --
Describes an AWS Identity and Access Management (IAM) role that is associated with a DB cluster.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
Status (string) --
Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:
FeatureName (string) --
The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion .
IAMDatabaseAuthenticationEnabled (boolean) --
A value that indicates whether the mapping of AWS 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 DB cluster. The capacity is 0 (zero) when the cluster is paused.
For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide .
EngineMode (string) --
The DB engine mode of the DB cluster, either provisioned , serverless , parallelquery , global , or multimaster .
ScalingConfigurationInfo (dict) --
Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.
For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide .
MinCapacity (integer) --
The maximum capacity for the Aurora DB cluster in serverless DB engine mode.
MaxCapacity (integer) --
The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
AutoPause (boolean) --
A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.
When the value is set to false for an Aurora Serverless 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 timeout action of a call to ModifyCurrentDBClusterCapacity , either ForceApplyCapacityChange or RollbackCapacityChange .
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 DB cluster is enabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless 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 AWS KMS key identifier used for encrypting messages in the database activity stream.
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 AWS account.
Examples
This example lists settings for the specified DB cluster.
response = client.describe_db_clusters(
DBClusterIdentifier='mynewdbcluster',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
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 version to return.
Example: 5.1.49
The name of a specific DB parameter group family 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:
The 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.
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.
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.
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'
},
],
'ValidUpgradeTarget': [
{
'Engine': 'string',
'EngineVersion': 'string',
'Description': 'string',
'AutoUpgrade': True|False,
'IsMajorVersionUpgrade': True|False
},
],
'SupportedTimezones': [
{
'TimezoneName': 'string'
},
],
'ExportableLogTypes': [
'string',
],
'SupportsLogExportsToCloudwatchLogs': True|False,
'SupportsReadReplica': True|False,
'SupportedEngineModes': [
'string',
],
'SupportedFeatureNames': [
'string',
],
'Status': 'string'
},
]
}
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 action.
(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 a database engine is upgraded to a major 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. Supported feature names include the following.
Status (string) --
The status of the DB engine version, either available or deprecated .
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': {
'...': '...',
},
}
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'
)
A filter that specifies which resources to return based on status.
Supported filters are the following:
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:
The name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
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
},
]
}
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 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 backup.
DbiResourceId (string) --
The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region.
Region (string) --
The AWS 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:
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 AWS 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 AWS KMS key ID for an automated backup. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption 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 AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
Returns information about provisioned RDS instances. This API supports pagination.
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:
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:
The 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.
dict
Response Syntax
{
'Marker': 'string',
'DBInstances': [
{
'DBInstanceIdentifier': 'string',
'DBInstanceClass': 'string',
'Engine': 'string',
'DBInstanceStatus': 'string',
'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'
},
'SubnetStatus': 'string'
},
],
'DBSubnetGroupArn': 'string'
},
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'DBInstanceClass': 'string',
'AllocatedStorage': 123,
'MasterUserPassword': 'string',
'Port': 123,
'BackupRetentionPeriod': 123,
'MultiAZ': True|False,
'EngineVersion': 'string',
'LicenseModel': 'string',
'Iops': 123,
'DBInstanceIdentifier': 'string',
'StorageType': 'string',
'CACertificateIdentifier': 'string',
'DBSubnetGroupName': 'string',
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
},
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
]
},
'LatestRestorableTime': datetime(2015, 1, 1),
'MultiAZ': True|False,
'EngineVersion': 'string',
'AutoMinorVersionUpgrade': True|False,
'ReadReplicaSourceDBInstanceIdentifier': 'string',
'ReadReplicaDBInstanceIdentifiers': [
'string',
],
'ReadReplicaDBClusterIdentifiers': [
'string',
],
'LicenseModel': 'string',
'Iops': 123,
'OptionGroupMemberships': [
{
'OptionGroupName': 'string',
'Status': 'string'
},
],
'CharacterSetName': '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
},
]
}
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 DescribeDBInstances action.
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) --
Provides the name of the database engine to be used for this DB instance.
DBInstanceStatus (string) --
Specifies the current state of this database.
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.
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.
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:
DBSecurityGroupName (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 status of the VPC security group.
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:
DBParameterGroupName (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 in the DescribeDBSubnetGroups action.
SubnetIdentifier (string) --
Specifies 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.
SubnetStatus (string) --
Specifies the status of the subnet.
DBSubnetGroupArn (string) --
The Amazon Resource Name (ARN) for the DB subnet group.
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
PendingModifiedValues (dict) --
Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
DBInstanceClass (string) --
Contains the new DBInstanceClass for the DB instance that will be applied or is currently being applied.
AllocatedStorage (integer) --
Contains the new AllocatedStorage size for the DB instance that will be applied or is currently being applied.
MasterUserPassword (string) --
Contains the pending or currently-in-progress change of the master credentials for the DB instance.
Port (integer) --
Specifies the pending port for the DB instance.
BackupRetentionPeriod (integer) --
Specifies the pending number of days for which automated backups are retained.
MultiAZ (boolean) --
Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.
EngineVersion (string) --
Indicates 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) --
Specifies the new Provisioned IOPS value for the DB instance that will be applied or is currently being applied.
DBInstanceIdentifier (string) --
Contains the new DBInstanceIdentifier for the DB instance that will be applied or is currently being applied.
StorageType (string) --
Specifies the storage type to be associated with the DB instance.
CACertificateIdentifier (string) --
Specifies the identifier of the CA certificate for the DB instance.
DBSubnetGroupName (string) --
The new 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:
You 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:
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.
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.
EngineVersion (string) --
Indicates the database engine version.
AutoMinorVersionUpgrade (boolean) --
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 MySQL DB instance, the Aurora MySQL DB cluster for the Aurora Read Replica is shown. This output does not contain information about cross region Aurora Read Replicas.
Note
Currently, each RDS DB instance can have only one Aurora Read Replica.
LicenseModel (string) --
License model information for this DB instance.
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.
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. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
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 AWS KMS key identifier for the encrypted DB instance.
DbiResourceId (string) --
The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS 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.
Domain (string) --
The identifier of the Active Directory Domain.
Status (string) --
The status of the DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).
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 AWS 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 AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
PerformanceInsightsRetentionPeriod (integer) --
The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
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:
You 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:
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 AWS Identity and Access Management (IAM) roles associated with the DB instance.
(dict) --
Describes an AWS 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 AWS Identity and Access Management (IAM) role. For the list of 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:
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 to which Amazon RDS can automatically scale the storage of the DB instance.
Examples
This example lists settings for the specified DB instance.
response = client.describe_db_instances(
DBInstanceIdentifier='mymysqlinstance',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Returns a list of DB log files for the DB instance.
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:
The 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 subsequent DescribeDBLogFiles request.
Examples
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': {
'...': '...',
},
}
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:
The 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.
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) --
Provides the name of the DB parameter group.
DBParameterGroupFamily (string) --
Provides 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.
Examples
This example lists information about the specified DB parameter group.
response = client.describe_db_parameter_groups(
DBParameterGroupName='mymysqlparametergroup',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
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:
The 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.
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 .
Examples
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': {
'...': '...',
},
}
Note
This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.
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:
The 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 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',
'EngineFamily': '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) --
Note
This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.
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 AWS account in the specified AWS 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) --
Currently, this value is always MYSQL . The engine family applies to both RDS MySQL and Aurora MySQL.
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) --
Note
This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.
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 AWS 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 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 .
Note
This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.
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.
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:
The 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 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) --
Note
This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.
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 AWS account in the specified AWS 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. For Aurora MySQL, it 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. A high value enables the proxy to leave a high percentage of idle connections open. A low value causes the proxy to close idle client connections and return the underlying database connections to the connection pool. For Aurora MySQL, it is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.
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 .
Note
This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.
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.
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:
The 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 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'
},
],
'Marker': 'string'
}
Response Structure
(dict) --
Targets (list) --
An arbitrary number of DBProxyTarget objects, containing details of the corresponding targets.
(dict) --
Note
This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.
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
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.
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 .
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:
The 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.
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 AWS 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:
Status (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 AWS 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.
Examples
This example lists settings for the specified security group.
response = client.describe_db_security_groups(
DBSecurityGroupName='mydbsecuritygroup',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Returns a list of DB snapshot attribute names and values for a manual DB snapshot.
When sharing snapshots with other AWS accounts, DescribeDBSnapshotAttributes returns the restore attribute and a list of IDs for the AWS 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 AWS accounts.
To add or remove access for an AWS 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 AWS 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 AWS 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 AWS 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 AWS 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 AWS account to copy or restore.
Examples
This example lists attributes for the specified DB snapshot.
response = client.describe_db_snapshot_attributes(
DBSnapshotIdentifier='mydbsnapshot',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
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 can't be used in conjunction with DBSnapshotIdentifier . This parameter isn't case-sensitive.
Constraints:
A specific DB snapshot identifier to describe. This parameter can't be used in conjunction with DBInstanceIdentifier . This value is stored as a lowercase string.
Constraints:
The type of snapshots to be returned. You can specify one of the following values:
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:
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:
The 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.
A value that indicates whether to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore. By default, these snapshots are not included.
You can give an AWS account permission to restore a manual DB snapshot from another AWS account by using the ModifyDBSnapshotAttribute API action.
A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account. By default, the public snapshots are not included.
You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.
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'
},
]
}
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) --
Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
Engine (string) --
Specifies the name of the database engine.
AllocatedStorage (integer) --
Specifies the allocated storage size in 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 when the snapshot was taken, in Universal Coordinated Time (UTC).
MasterUsername (string) --
Provides the master username for the DB snapshot.
EngineVersion (string) --
Specifies the version of the database engine.
LicenseModel (string) --
License model information for the restored DB instance.
SnapshotType (string) --
Provides the type of the DB snapshot.
Iops (integer) --
Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
OptionGroupName (string) --
Provides the option group name for the DB snapshot.
PercentProgress (integer) --
The percentage of the estimated data that has been transferred.
SourceRegion (string) --
The AWS 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 value in case of cross-customer or cross-region copy.
StorageType (string) --
Specifies the storage type associated with DB snapshot.
TdeCredentialArn (string) --
The ARN from the key store with which to associate the instance for TDE encryption.
Encrypted (boolean) --
Specifies whether the DB snapshot is encrypted.
KmsKeyId (string) --
If Encrypted is true, the AWS KMS key identifier for the encrypted DB snapshot.
DBSnapshotArn (string) --
The Amazon Resource Name (ARN) for the DB snapshot.
Timezone (string) --
The time zone of the DB snapshot. In most cases, the Timezone element is empty. Timezone content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.
IAMDatabaseAuthenticationEnabled (boolean) --
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, 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:
You 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:
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 AWS Region.
Examples
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': {
'...': '...',
},
}
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:
The 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.
dict
Response Syntax
{
'Marker': 'string',
'DBSubnetGroups': [
{
'DBSubnetGroupName': 'string',
'DBSubnetGroupDescription': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string'
},
'SubnetStatus': 'string'
},
],
'DBSubnetGroupArn': '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 in the DescribeDBSubnetGroups action.
SubnetIdentifier (string) --
Specifies 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.
SubnetStatus (string) --
Specifies the status of the subnet.
DBSubnetGroupArn (string) --
The Amazon Resource Name (ARN) for the DB subnet group.
Examples
This example lists information about the specified DB subnet group.
response = client.describe_db_subnet_groups(
DBSubnetGroupName='mydbsubnetgroup',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
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:
The 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.
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:
{
'ResponseMetadata': {
'...': '...',
},
}
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.
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:
The 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.
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:
{
'ResponseMetadata': {
'...': '...',
},
}
Displays a list of categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in the Events topic in the Amazon RDS User Guide.
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.
Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
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:
The 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 action.
EventCategoriesMapList (list) --
A list of EventCategoriesMap data types.
(dict) --
Contains the results of a successful invocation of the DescribeEventCategories action.
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': {
'...': '...',
},
}
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:
The 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.
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 AWS 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.
Examples
This example lists information for the specified DB event notification subscription.
response = client.describe_event_subscriptions(
SubscriptionName='mymysqleventsubscription',
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
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',
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:
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:
The 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.
dict
Response Syntax
{
'Marker': 'string',
'Events': [
{
'SourceIdentifier': 'string',
'SourceType': 'db-instance'|'db-parameter-group'|'db-security-group'|'db-snapshot'|'db-cluster'|'db-cluster-snapshot',
'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': {
'...': '...',
},
}
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:
A filter that specifies one or more global DB clusters to describe.
Supported filters:
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:
The 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.
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
},
]
},
]
}
Response Structure
(dict) --
Marker (string) --
An optional pagination token provided by a previous DescribeGlobalClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
GlobalClusters (list) --
The list of global clusters returned by this request.
(dict) --
A data type representing an Aurora global database.
GlobalClusterIdentifier (string) --
Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster.
GlobalClusterResourceId (string) --
The AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
GlobalClusterArn (string) --
The Amazon Resource Name (ARN) for the global database cluster.
Status (string) --
Specifies the current state of this global database cluster.
Engine (string) --
The Aurora database engine used by the global database cluster.
EngineVersion (string) --
Indicates the database engine version.
DatabaseName (string) --
The default database name within the new global database cluster.
StorageEncrypted (boolean) --
The storage encryption setting for the global database cluster.
DeletionProtection (boolean) --
The deletion protection setting for the new global database cluster.
GlobalClusterMembers (list) --
The list of cluster IDs for secondary clusters within the global database cluster. Currently limited to 1 item.
(dict) --
A data structure with information about any primary and secondary clusters associated with an Aurora global database.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for each Aurora cluster.
Readers (list) --
The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global database.
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.
Describes the available installation media for a DB engine that requires an on-premises customer provided license, such as Microsoft SQL Server.
See also: AWS API Documentation
Request Syntax
response = client.describe_installation_media(
InstallationMediaId='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
A filter that specifies one or more installation media to describe. Supported filters include the following:
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:
The name of the filter. Filter names are case-sensitive.
One or more filter values. Filter values are case-sensitive.
dict
Response Syntax
{
'Marker': 'string',
'InstallationMedia': [
{
'InstallationMediaId': 'string',
'CustomAvailabilityZoneId': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'EngineInstallationMediaPath': 'string',
'OSInstallationMediaPath': 'string',
'Status': 'string',
'FailureCause': {
'Message': 'string'
}
},
]
}
Response Structure
(dict) --
Marker (string) --
An optional pagination token provided by a previous DescribeInstallationMedia request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
InstallationMedia (list) --
The list of InstallationMedia objects for the AWS account.
(dict) --
Contains the installation media for a DB engine that requires an on-premises customer provided license, such as Microsoft SQL Server.
InstallationMediaId (string) --
The installation medium ID.
CustomAvailabilityZoneId (string) --
The custom Availability Zone (AZ) that contains the installation media.
Engine (string) --
The DB engine.
EngineVersion (string) --
The engine version of the DB engine.
EngineInstallationMediaPath (string) --
The path to the installation medium for the DB engine.
OSInstallationMediaPath (string) --
The path to the installation medium for the operating system associated with the DB engine.
Status (string) --
The status of the installation medium.
FailureCause (dict) --
If an installation media failure occurred, the cause of the failure.
Message (string) --
The reason that an installation media import failed.
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.
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:
The 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.
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': {
'...': '...',
},
}
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:
The 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.
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'
},
],
'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:
DBSecurityGroupName (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 status of the VPC security group.
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 .
Examples
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': {
'...': '...',
},
}
Returns a list of orderable DB instance options for the specified engine.
See also: AWS API Documentation
Request Syntax
response = client.describe_orderable_db_instance_options(
Engine='string',
EngineVersion='string',
DBInstanceClass='string',
LicenseModel='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.
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:
The 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.
dict
Response Syntax
{
'OrderableDBInstanceOptions': [
{
'Engine': 'string',
'EngineVersion': 'string',
'DBInstanceClass': 'string',
'LicenseModel': '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
},
],
'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.
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 or not Amazon RDS can automatically scale storage for DB instances that use the specified instance class.
SupportsKerberosAuthentication (boolean) --
Whether a DB instance supports Kerberos Authentication.
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': {
'...': '...',
},
}
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:
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:
The 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.
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. The maintenance action is applied to the resource on this date regardless of the maintenance window for the resource.
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 .
Examples
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': {
'...': '...',
},
}
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
AWS 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:
The 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.
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
AWS Support might request the lease ID for an issue related to a reserved DB instance.
Examples
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': {
'...': '...',
},
}
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:
The 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.
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.
Examples
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': {
'...': '...',
},
}
Returns a list of the source AWS Regions where the current AWS Region can create a Read Replica or copy a DB snapshot 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 AWS 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.
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:
The 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'
},
]
}
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 AWS Region that the current AWS Region can get a Read Replica or a DB snapshot from.
(dict) --
Contains an AWS Region name as the result of a successful call to the DescribeSourceRegions action.
RegionName (string) --
The name of the source AWS Region.
Endpoint (string) --
The endpoint for the source AWS Region endpoint.
Status (string) --
The status of the source AWS 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': {
'...': '...',
},
}
You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance .
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. 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.
Downloads all or a portion of the specified log file, up to 1 MB in size.
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 subsequent DownloadDBLogFilePortion request.
AdditionalDataPending (boolean) --
Boolean value that if true, indicates there is more data to be downloaded.
Examples
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': {
'...': '...',
},
}
Forces a failover for a DB cluster.
A failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary instance (the cluster writer).
Amazon Aurora will automatically fail over to an Aurora Replica, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a primary instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.
For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.
Note
This action only applies to Aurora DB clusters.
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 instance to promote to the primary instance.
You must specify the instance identifier for an Aurora Replica in the DB cluster. For example, mydbcluster-replica1 .
dict
Response Syntax
{
'DBCluster': {
'AllocatedStorage': 123,
'AvailabilityZones': [
'string',
],
'BackupRetentionPeriod': 123,
'CharacterSetName': 'string',
'DatabaseName': 'string',
'DBClusterIdentifier': 'string',
'DBClusterParameterGroup': 'string',
'DBSubnetGroup': 'string',
'Status': 'string',
'PercentProgress': 'string',
'EarliestRestorableTime': datetime(2015, 1, 1),
'Endpoint': 'string',
'ReaderEndpoint': 'string',
'CustomEndpoints': [
'string',
],
'MultiAZ': True|False,
'Engine': 'string',
'EngineVersion': 'string',
'LatestRestorableTime': datetime(2015, 1, 1),
'Port': 123,
'MasterUsername': 'string',
'DBClusterOptionGroupMemberships': [
{
'DBClusterOptionGroupName': 'string',
'Status': 'string'
},
],
'PreferredBackupWindow': 'string',
'PreferredMaintenanceWindow': 'string',
'ReplicationSourceIdentifier': 'string',
'ReadReplicaIdentifiers': [
'string',
],
'DBClusterMembers': [
{
'DBInstanceIdentifier': 'string',
'IsClusterWriter': True|False,
'DBClusterParameterGroupStatus': 'string',
'PromotionTier': 123
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'HostedZoneId': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbClusterResourceId': 'string',
'DBClusterArn': 'string',
'AssociatedRoles': [
{
'RoleArn': 'string',
'Status': 'string',
'FeatureName': 'string'
},
],
'IAMDatabaseAuthenticationEnabled': True|False,
'CloneGroupId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'EarliestBacktrackTime': datetime(2015, 1, 1),
'BacktrackWindow': 123,
'BacktrackConsumedChangeRecords': 123,
'EnabledCloudwatchLogsExports': [
'string',
],
'Capacity': 123,
'EngineMode': 'string',
'ScalingConfigurationInfo': {
'MinCapacity': 123,
'MaxCapacity': 123,
'AutoPause': True|False,
'SecondsUntilAutoPause': 123,
'TimeoutAction': 'string'
},
'DeletionProtection': True|False,
'HttpEndpointEnabled': True|False,
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'CopyTagsToSnapshot': True|False,
'CrossAccountClone': True|False
}
}
Response Structure
(dict) --
DBCluster (dict) --
Contains the details of an Amazon Aurora DB cluster.
This data type is used as a response element in the DescribeDBClusters , StopDBCluster , and StartDBCluster actions.
AllocatedStorage (integer) --
For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size 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.
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) --
Provides the name of the database engine to be used for this DB cluster.
EngineVersion (string) --
Indicates the database engine version.
LatestRestorableTime (datetime) --
Specifies the latest time to which a database can be restored with point-in-time restore.
Port (integer) --
Specifies the port that the database engine is listening on.
MasterUsername (string) --
Contains the master username for the DB cluster.
DBClusterOptionGroupMemberships (list) --
Provides the list of option group memberships for this DB cluster.
(dict) --
Contains status information for a DB cluster option group.
DBClusterOptionGroupName (string) --
Specifies the name of the DB cluster option group.
Status (string) --
Specifies the status of the DB cluster option group.
PreferredBackupWindow (string) --
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
ReplicationSourceIdentifier (string) --
Contains the identifier of the source DB cluster if this DB cluster is a Read Replica.
ReadReplicaIdentifiers (list) --
Contains one or more identifiers of the Read Replicas associated with this DB cluster.
DBClusterMembers (list) --
Provides the list of instances that make up the DB cluster.
(dict) --
Contains information about an instance that is part of a DB cluster.
DBInstanceIdentifier (string) --
Specifies the instance identifier for this member of the DB cluster.
IsClusterWriter (boolean) --
Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
DBClusterParameterGroupStatus (string) --
Specifies the status of the DB cluster parameter group for this member of the DB cluster.
PromotionTier (integer) --
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .
VpcSecurityGroups (list) --
Provides a list of VPC security groups that the DB cluster belongs to.
(dict) --
This data type is used as a response element for queries on VPC security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The status of the VPC security group.
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
StorageEncrypted (boolean) --
Specifies whether the DB cluster is encrypted.
KmsKeyId (string) --
If StorageEncrypted is enabled, the AWS KMS key identifier for the encrypted DB cluster.
DbClusterResourceId (string) --
The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for the DB cluster.
AssociatedRoles (list) --
Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.
(dict) --
Describes an AWS Identity and Access Management (IAM) role that is associated with a DB cluster.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
Status (string) --
Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:
FeatureName (string) --
The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion .
IAMDatabaseAuthenticationEnabled (boolean) --
A value that indicates whether the mapping of AWS 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 DB cluster. The capacity is 0 (zero) when the cluster is paused.
For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide .
EngineMode (string) --
The DB engine mode of the DB cluster, either provisioned , serverless , parallelquery , global , or multimaster .
ScalingConfigurationInfo (dict) --
Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.
For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide .
MinCapacity (integer) --
The maximum capacity for the Aurora DB cluster in serverless DB engine mode.
MaxCapacity (integer) --
The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
AutoPause (boolean) --
A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.
When the value is set to false for an Aurora Serverless 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 timeout action of a call to ModifyCurrentDBClusterCapacity , either ForceApplyCapacityChange or RollbackCapacityChange .
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 DB cluster is enabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless 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 AWS KMS key identifier used for encrypting messages in the database activity stream.
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 AWS account.
Examples
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:
{
'ResponseMetadata': {
'...': '...',
},
}
Generates an auth token used to connect to a db with IAM credentials.
A presigned url which can be used as an auth token.
Generate a presigned url given a client, its method, and arguments
The presigned url
Create a paginator for an operation.
Returns an object that can wait for some condition.
Imports the installation media for a DB engine that requires an on-premises customer provided license, such as SQL Server.
See also: AWS API Documentation
Request Syntax
response = client.import_installation_media(
CustomAvailabilityZoneId='string',
Engine='string',
EngineVersion='string',
EngineInstallationMediaPath='string',
OSInstallationMediaPath='string'
)
[REQUIRED]
The identifier of the custom Availability Zone (AZ) to import the installation media to.
[REQUIRED]
The name of the database engine to be used for this instance.
The list only includes supported DB engines that require an on-premises customer provided license.
Valid Values:
[REQUIRED]
The version number of the database engine to use.
For a list of valid engine versions, call DescribeDBEngineVersions .
The following are the database engines and links to information about the major and minor versions. The list only includes DB engines that require an on-premises customer provided license.
Microsoft SQL Server
See Version and Feature Support on Amazon RDS in the Amazon RDS User Guide.
[REQUIRED]
The path to the installation medium for the specified DB engine.
Example: SQLServerISO/en_sql_server_2016_enterprise_x64_dvd_8701793.iso
[REQUIRED]
The path to the installation medium for the operating system associated with the specified DB engine.
Example: WindowsISO/en_windows_server_2016_x64_dvd_9327751.iso
dict
Response Syntax
{
'InstallationMediaId': 'string',
'CustomAvailabilityZoneId': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'EngineInstallationMediaPath': 'string',
'OSInstallationMediaPath': 'string',
'Status': 'string',
'FailureCause': {
'Message': 'string'
}
}
Response Structure
(dict) --
Contains the installation media for a DB engine that requires an on-premises customer provided license, such as Microsoft SQL Server.
InstallationMediaId (string) --
The installation medium ID.
CustomAvailabilityZoneId (string) --
The custom Availability Zone (AZ) that contains the installation media.
Engine (string) --
The DB engine.
EngineVersion (string) --
The engine version of the DB engine.
EngineInstallationMediaPath (string) --
The path to the installation medium for the DB engine.
OSInstallationMediaPath (string) --
The path to the installation medium for the operating system associated with the DB engine.
Status (string) --
The status of the installation medium.
FailureCause (dict) --
If an installation media failure occurred, the cause of the failure.
Message (string) --
The reason that an installation media import failed.
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:
The 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}_.:/=+\-]*)$").
Examples
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': {
'...': '...',
},
}
Set the capacity of an Aurora Serverless DB cluster to a specific value.
Aurora Serverless 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 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, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide .
Warning
If you call ModifyCurrentDBClusterCapacity with the default TimeoutAction , connections that prevent Aurora Serverless from finding a scaling point might be dropped. For more information about scaling points, see Autoscaling for Aurora Serverless 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_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 DB cluster, it automatically resumes.
Constraints:
The amount of time, in seconds, that Aurora Serverless tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.
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.RollbackCapacityChange ignores 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 .
Modify a setting for an Amazon Aurora DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.
Note
This action only applies to Aurora DB clusters.
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',
ScalingConfiguration={
'MinCapacity': 123,
'MaxCapacity': 123,
'AutoPause': True|False,
'SecondsUntilAutoPause': 123,
'TimeoutAction': 'string'
},
DeletionProtection=True|False,
EnableHttpEndpoint=True|False,
CopyTagsToSnapshot=True|False
)
[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.
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
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.
The number of days for which automated backups are retained. You must specify a minimum value of 1.
Default: 1
Constraints:
A list of VPC security groups that the DB cluster will belong to.
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.
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.
A value that indicates that the DB cluster should be associated with the specified option group. Changing this parameter doesn't result in an outage except in the following case, and the change is applied during the next maintenance window unless the ApplyImmediately is enabled for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.
Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.
The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
Constraints:
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Default: 0
Constraints:
The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.
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 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 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"
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.
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 aren't applied during the next maintenance window but instead are applied immediately.
Default: The existing name setting
Constraints:
The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.
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.
The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange .
ForceApplyCapacityChange sets 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 from finding a scaling point might be dropped.
For more information, see Autoscaling for Aurora Serverless in the Amazon Aurora User Guide .
A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide .
dict
Response Syntax
{
'DBCluster': {
'AllocatedStorage': 123,
'AvailabilityZones': [
'string',
],
'BackupRetentionPeriod': 123,
'CharacterSetName': 'string',
'DatabaseName': 'string',
'DBClusterIdentifier': 'string',
'DBClusterParameterGroup': 'string',
'DBSubnetGroup': 'string',
'Status': 'string',
'PercentProgress': 'string',
'EarliestRestorableTime': datetime(2015, 1, 1),
'Endpoint': 'string',
'ReaderEndpoint': 'string',
'CustomEndpoints': [
'string',
],
'MultiAZ': True|False,
'Engine': 'string',
'EngineVersion': 'string',
'LatestRestorableTime': datetime(2015, 1, 1),
'Port': 123,
'MasterUsername': 'string',
'DBClusterOptionGroupMemberships': [
{
'DBClusterOptionGroupName': 'string',
'Status': 'string'
},
],
'PreferredBackupWindow': 'string',
'PreferredMaintenanceWindow': 'string',
'ReplicationSourceIdentifier': 'string',
'ReadReplicaIdentifiers': [
'string',
],
'DBClusterMembers': [
{
'DBInstanceIdentifier': 'string',
'IsClusterWriter': True|False,
'DBClusterParameterGroupStatus': 'string',
'PromotionTier': 123
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'HostedZoneId': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbClusterResourceId': 'string',
'DBClusterArn': 'string',
'AssociatedRoles': [
{
'RoleArn': 'string',
'Status': 'string',
'FeatureName': 'string'
},
],
'IAMDatabaseAuthenticationEnabled': True|False,
'CloneGroupId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'EarliestBacktrackTime': datetime(2015, 1, 1),
'BacktrackWindow': 123,
'BacktrackConsumedChangeRecords': 123,
'EnabledCloudwatchLogsExports': [
'string',
],
'Capacity': 123,
'EngineMode': 'string',
'ScalingConfigurationInfo': {
'MinCapacity': 123,
'MaxCapacity': 123,
'AutoPause': True|False,
'SecondsUntilAutoPause': 123,
'TimeoutAction': 'string'
},
'DeletionProtection': True|False,
'HttpEndpointEnabled': True|False,
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'CopyTagsToSnapshot': True|False,
'CrossAccountClone': True|False
}
}
Response Structure
(dict) --
DBCluster (dict) --
Contains the details of an Amazon Aurora DB cluster.
This data type is used as a response element in the DescribeDBClusters , StopDBCluster , and StartDBCluster actions.
AllocatedStorage (integer) --
For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size 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.
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) --
Provides the name of the database engine to be used for this DB cluster.
EngineVersion (string) --
Indicates the database engine version.
LatestRestorableTime (datetime) --
Specifies the latest time to which a database can be restored with point-in-time restore.
Port (integer) --
Specifies the port that the database engine is listening on.
MasterUsername (string) --
Contains the master username for the DB cluster.
DBClusterOptionGroupMemberships (list) --
Provides the list of option group memberships for this DB cluster.
(dict) --
Contains status information for a DB cluster option group.
DBClusterOptionGroupName (string) --
Specifies the name of the DB cluster option group.
Status (string) --
Specifies the status of the DB cluster option group.
PreferredBackupWindow (string) --
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
ReplicationSourceIdentifier (string) --
Contains the identifier of the source DB cluster if this DB cluster is a Read Replica.
ReadReplicaIdentifiers (list) --
Contains one or more identifiers of the Read Replicas associated with this DB cluster.
DBClusterMembers (list) --
Provides the list of instances that make up the DB cluster.
(dict) --
Contains information about an instance that is part of a DB cluster.
DBInstanceIdentifier (string) --
Specifies the instance identifier for this member of the DB cluster.
IsClusterWriter (boolean) --
Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
DBClusterParameterGroupStatus (string) --
Specifies the status of the DB cluster parameter group for this member of the DB cluster.
PromotionTier (integer) --
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .
VpcSecurityGroups (list) --
Provides a list of VPC security groups that the DB cluster belongs to.
(dict) --
This data type is used as a response element for queries on VPC security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The status of the VPC security group.
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
StorageEncrypted (boolean) --
Specifies whether the DB cluster is encrypted.
KmsKeyId (string) --
If StorageEncrypted is enabled, the AWS KMS key identifier for the encrypted DB cluster.
DbClusterResourceId (string) --
The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for the DB cluster.
AssociatedRoles (list) --
Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.
(dict) --
Describes an AWS Identity and Access Management (IAM) role that is associated with a DB cluster.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
Status (string) --
Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:
FeatureName (string) --
The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion .
IAMDatabaseAuthenticationEnabled (boolean) --
A value that indicates whether the mapping of AWS 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 DB cluster. The capacity is 0 (zero) when the cluster is paused.
For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide .
EngineMode (string) --
The DB engine mode of the DB cluster, either provisioned , serverless , parallelquery , global , or multimaster .
ScalingConfigurationInfo (dict) --
Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.
For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide .
MinCapacity (integer) --
The maximum capacity for the Aurora DB cluster in serverless DB engine mode.
MaxCapacity (integer) --
The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
AutoPause (boolean) --
A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.
When the value is set to false for an Aurora Serverless 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 timeout action of a call to ModifyCurrentDBClusterCapacity , either ForceApplyCapacityChange or RollbackCapacityChange .
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 DB cluster is enabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless 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 AWS KMS key identifier used for encrypting messages in the database activity stream.
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 AWS account.
Examples
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:
{
'ResponseMetadata': {
'...': '...',
},
}
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.
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:
For 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 , modifying .
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.
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.
For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.
Note
Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB cluster associated with the parameter group before the change can 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 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 action 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 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.
Note
This action only applies to Aurora DB clusters.
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.
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.
Examples
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': {
'...': '...',
},
}
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 AWS accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the AWS 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 AWS accounts. Do not add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all AWS accounts. If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized AWS account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.
To view which AWS accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot public or private, use the DescribeDBClusterSnapshotAttributes API action.
Note
This action only applies to Aurora DB clusters.
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 AWS accounts to copy or restore a manual DB cluster snapshot, set this value to restore .
A list of DB cluster snapshot attributes to add to the attribute specified by AttributeName .
To authorize other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more AWS account IDs, or all to make the manual DB cluster snapshot restorable by any AWS 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 AWS accounts.
A list of DB cluster snapshot attributes to remove from the attribute specified by AttributeName .
To remove authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more AWS account identifiers, or all to remove authorization for any AWS account to copy or restore the DB cluster snapshot. If you specify all , an AWS 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 AWS 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 AWS 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 AWS 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 AWS 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 AWS account to copy or restore.
Examples
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:
{
'ResponseMetadata': {
'...': '...',
},
}
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
)
[REQUIRED]
The DB instance identifier. This value is stored as a lowercase string.
Constraints:
The new amount of storage (in gibibytes) 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.m4.large . Not all DB instance classes are available in all AWS 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.
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.
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 Updating the VPC for a DB Instance 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 .
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetGroup
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.
Constraints:
A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.
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.
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 actions 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 isn't applied during the next maintenance window.
Default: Uses existing setting
Constraints: The DB parameter group must be in the same DB parameter group family as this 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.
Changing this parameter can result in an outage if you change from 0 to a non-zero value or from a non-zero value to 0. 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.
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.
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
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 eanbled 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.
For information about valid engine versions, see CreateDBInstance , or call DescribeDBEngineVersions .
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.
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.
The license model for the DB instance.
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
Indicates that the DB instance should be associated with the specified option group. Changing this parameter doesn't result in an outage except in the following case and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.
Permanent options, 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
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.
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 Active Directory directory ID to move the DB instance to. Specify none to remove the instance from its current domain. The domain must be created prior to this operation. Currently, only Microsoft SQL Server and Oracle DB instances can be created in an Active Directory Domain.
For Microsoft SQL Server DB instances, Amazon RDS can use Windows Authentication to authenticate users that connect to the DB instance. For more information, see Using Windows Authentication with an Amazon RDS DB Instance Running Microsoft SQL Server in the Amazon RDS User Guide .
For Oracle DB instances, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB instance. For more information, see Using Kerberos Authentication with Amazon RDS for Oracle in the Amazon RDS User Guide .
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. The default is 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
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.
Your database will restart when you change the DBPortNumber value regardless of the value of the ApplyImmediately parameter.
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 for 1434 , 3389 , 47001 , 49152 , and 49152 through 49156 .
Amazon Aurora
Default: 3306
Valid Values: 1150-65535
A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, it is an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. When the DB instance isn't publicly accessible, it is an internal instance with a DNS name that resolves to a private IP address.
PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a public subnet and PubliclyAccessible must 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, 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.
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 .
Default: 1
Valid Values: 0 - 15
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For information about the supported DB engines, see CreateDBInstance .
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
A value that indicates whether to enable Performance Insights for the DB instance.
For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide .
The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
If you do not specify a value for PerformanceInsightsKMSKeyId , then Amazon RDS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
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.
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.
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:
You 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:
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.
dict
Response Syntax
{
'DBInstance': {
'DBInstanceIdentifier': 'string',
'DBInstanceClass': 'string',
'Engine': 'string',
'DBInstanceStatus': 'string',
'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'
},
'SubnetStatus': 'string'
},
],
'DBSubnetGroupArn': 'string'
},
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'DBInstanceClass': 'string',
'AllocatedStorage': 123,
'MasterUserPassword': 'string',
'Port': 123,
'BackupRetentionPeriod': 123,
'MultiAZ': True|False,
'EngineVersion': 'string',
'LicenseModel': 'string',
'Iops': 123,
'DBInstanceIdentifier': 'string',
'StorageType': 'string',
'CACertificateIdentifier': 'string',
'DBSubnetGroupName': 'string',
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
},
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
]
},
'LatestRestorableTime': datetime(2015, 1, 1),
'MultiAZ': True|False,
'EngineVersion': 'string',
'AutoMinorVersionUpgrade': True|False,
'ReadReplicaSourceDBInstanceIdentifier': 'string',
'ReadReplicaDBInstanceIdentifiers': [
'string',
],
'ReadReplicaDBClusterIdentifiers': [
'string',
],
'LicenseModel': 'string',
'Iops': 123,
'OptionGroupMemberships': [
{
'OptionGroupName': 'string',
'Status': 'string'
},
],
'CharacterSetName': '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
}
}
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 DescribeDBInstances action.
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) --
Provides the name of the database engine to be used for this DB instance.
DBInstanceStatus (string) --
Specifies the current state of this database.
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.
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.
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:
DBSecurityGroupName (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 status of the VPC security group.
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:
DBParameterGroupName (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 in the DescribeDBSubnetGroups action.
SubnetIdentifier (string) --
Specifies 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.
SubnetStatus (string) --
Specifies the status of the subnet.
DBSubnetGroupArn (string) --
The Amazon Resource Name (ARN) for the DB subnet group.
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
PendingModifiedValues (dict) --
Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
DBInstanceClass (string) --
Contains the new DBInstanceClass for the DB instance that will be applied or is currently being applied.
AllocatedStorage (integer) --
Contains the new AllocatedStorage size for the DB instance that will be applied or is currently being applied.
MasterUserPassword (string) --
Contains the pending or currently-in-progress change of the master credentials for the DB instance.
Port (integer) --
Specifies the pending port for the DB instance.
BackupRetentionPeriod (integer) --
Specifies the pending number of days for which automated backups are retained.
MultiAZ (boolean) --
Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.
EngineVersion (string) --
Indicates 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) --
Specifies the new Provisioned IOPS value for the DB instance that will be applied or is currently being applied.
DBInstanceIdentifier (string) --
Contains the new DBInstanceIdentifier for the DB instance that will be applied or is currently being applied.
StorageType (string) --
Specifies the storage type to be associated with the DB instance.
CACertificateIdentifier (string) --
Specifies the identifier of the CA certificate for the DB instance.
DBSubnetGroupName (string) --
The new 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:
You 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:
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.
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.
EngineVersion (string) --
Indicates the database engine version.
AutoMinorVersionUpgrade (boolean) --
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 MySQL DB instance, the Aurora MySQL DB cluster for the Aurora Read Replica is shown. This output does not contain information about cross region Aurora Read Replicas.
Note
Currently, each RDS DB instance can have only one Aurora Read Replica.
LicenseModel (string) --
License model information for this DB instance.
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.
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. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
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 AWS KMS key identifier for the encrypted DB instance.
DbiResourceId (string) --
The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS 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.
Domain (string) --
The identifier of the Active Directory Domain.
Status (string) --
The status of the DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).
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 AWS 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 AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
PerformanceInsightsRetentionPeriod (integer) --
The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
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:
You 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:
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 AWS Identity and Access Management (IAM) roles associated with the DB instance.
(dict) --
Describes an AWS 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 AWS Identity and Access Management (IAM) role. For the list of 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:
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 to which Amazon RDS can automatically scale the storage of the DB instance.
Examples
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:
{
'ResponseMetadata': {
'...': '...',
},
}
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.
Note
Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance associated with the parameter group before the change can take effect.
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:
[REQUIRED]
An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters can be modified in a single request.
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, and changes are applied when you reboot the DB instance without failover.
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) --
Provides the name of the DB parameter group.
Examples
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': {
'...': '...',
},
}
Note
This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.
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.
The new authentication settings for the DBProxy .
Note
This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.
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 AWS 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',
'EngineFamily': '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 AWS account in the specified AWS 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) --
Currently, this value is always MYSQL . The engine family applies to both RDS MySQL and Aurora MySQL.
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) --
Note
This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.
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 AWS 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 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.
Note
This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.
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 new target group to assign to the proxy.
[REQUIRED]
The name of the new proxy to which to assign the target group.
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. For Aurora MySQL, it 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. A high value enables the proxy to leave a high percentage of idle connections open. A low value causes the proxy to close idle client connections and return the underlying database connections to the connection pool. For Aurora MySQL, it 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: 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
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 AWS account in the specified AWS 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. For Aurora MySQL, it 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. A high value enables the proxy to leave a high percentage of idle connections open. A low value causes the proxy to close idle client connections and return the underlying database connections to the connection pool. For Aurora MySQL, it is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.
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.
Updates a manual DB snapshot, which can be encrypted or not encrypted, with a new engine version.
Amazon RDS supports upgrading DB snapshots for MySQL, Oracle, and PostgreSQL.
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
Oracle
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'
}
}
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) --
Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
Engine (string) --
Specifies the name of the database engine.
AllocatedStorage (integer) --
Specifies the allocated storage size in 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 when the snapshot was taken, in Universal Coordinated Time (UTC).
MasterUsername (string) --
Provides the master username for the DB snapshot.
EngineVersion (string) --
Specifies the version of the database engine.
LicenseModel (string) --
License model information for the restored DB instance.
SnapshotType (string) --
Provides the type of the DB snapshot.
Iops (integer) --
Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
OptionGroupName (string) --
Provides the option group name for the DB snapshot.
PercentProgress (integer) --
The percentage of the estimated data that has been transferred.
SourceRegion (string) --
The AWS 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 value in case of cross-customer or cross-region copy.
StorageType (string) --
Specifies the storage type associated with DB snapshot.
TdeCredentialArn (string) --
The ARN from the key store with which to associate the instance for TDE encryption.
Encrypted (boolean) --
Specifies whether the DB snapshot is encrypted.
KmsKeyId (string) --
If Encrypted is true, the AWS KMS key identifier for the encrypted DB snapshot.
DBSnapshotArn (string) --
The Amazon Resource Name (ARN) for the DB snapshot.
Timezone (string) --
The time zone of the DB snapshot. In most cases, the Timezone element is empty. Timezone content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.
IAMDatabaseAuthenticationEnabled (boolean) --
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, 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:
You 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:
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 AWS Region.
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 AWS accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the AWS 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 AWS accounts. Do not add the all value for any manual DB snapshots that contain private information that you don't want available to all AWS accounts. If the manual DB snapshot is encrypted, it can be shared, but only by specifying a list of authorized AWS account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.
To view which AWS accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API action.
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 AWS accounts to copy or restore a manual DB snapshot, set this value to restore .
A list of DB snapshot attributes to add to the attribute specified by AttributeName .
To authorize other AWS accounts to copy or restore a manual snapshot, set this list to include one or more AWS account IDs, or all to make the manual DB snapshot restorable by any AWS account. Do not add the all value for any manual DB snapshots that contain private information that you don't want available to all AWS accounts.
A list of DB snapshot attributes to remove from the attribute specified by AttributeName .
To remove authorization for other AWS accounts to copy or restore a manual snapshot, set this list to include one or more AWS account identifiers, or all to remove authorization for any AWS account to copy or restore the DB snapshot. If you specify all , an AWS 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 AWS 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 AWS 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 AWS 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 AWS 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 AWS account to copy or restore.
Examples
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:
{
'ResponseMetadata': {
'...': '...',
},
}
Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS 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: mySubnetgroup
[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'
},
'SubnetStatus': 'string'
},
],
'DBSubnetGroupArn': '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 in the DescribeDBSubnetGroups action.
SubnetIdentifier (string) --
Specifies 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.
SubnetStatus (string) --
Specifies the status of the subnet.
DBSubnetGroupArn (string) --
The Amazon Resource Name (ARN) for the DB subnet group.
Examples
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:
{
'ResponseMetadata': {
'...': '...',
},
}
Modifies an existing RDS event notification subscription. Note that 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 SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.
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. If this value isn't specified, all events are returned.
Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.
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 AWS 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.
Examples
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:
{
'ResponseMetadata': {
'...': '...',
},
}
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
)
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
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
},
]
}
}
Response Structure
(dict) --
GlobalCluster (dict) --
A data type representing an Aurora global database.
GlobalClusterIdentifier (string) --
Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster.
GlobalClusterResourceId (string) --
The AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
GlobalClusterArn (string) --
The Amazon Resource Name (ARN) for the global database cluster.
Status (string) --
Specifies the current state of this global database cluster.
Engine (string) --
The Aurora database engine used by the global database cluster.
EngineVersion (string) --
Indicates the database engine version.
DatabaseName (string) --
The default database name within the new global database cluster.
StorageEncrypted (boolean) --
The storage encryption setting for the global database cluster.
DeletionProtection (boolean) --
The deletion protection setting for the new global database cluster.
GlobalClusterMembers (list) --
The list of cluster IDs for secondary clusters within the global database cluster. Currently limited to 1 item.
(dict) --
A data structure with information about any primary and secondary clusters associated with an Aurora global database.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for each Aurora cluster.
Readers (list) --
The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global database.
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.
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:
DBSecurityGroupName (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 status of the VPC security group.
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.
Examples
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:
{
'ResponseMetadata': {
'...': '...',
},
}
Promotes a Read Replica DB instance to a standalone DB instance.
Note
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 AWS Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.
Constraints:
dict
Response Syntax
{
'DBInstance': {
'DBInstanceIdentifier': 'string',
'DBInstanceClass': 'string',
'Engine': 'string',
'DBInstanceStatus': 'string',
'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'
},
'SubnetStatus': 'string'
},
],
'DBSubnetGroupArn': 'string'
},
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'DBInstanceClass': 'string',
'AllocatedStorage': 123,
'MasterUserPassword': 'string',
'Port': 123,
'BackupRetentionPeriod': 123,
'MultiAZ': True|False,
'EngineVersion': 'string',
'LicenseModel': 'string',
'Iops': 123,
'DBInstanceIdentifier': 'string',
'StorageType': 'string',
'CACertificateIdentifier': 'string',
'DBSubnetGroupName': 'string',
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
},
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
]
},
'LatestRestorableTime': datetime(2015, 1, 1),
'MultiAZ': True|False,
'EngineVersion': 'string',
'AutoMinorVersionUpgrade': True|False,
'ReadReplicaSourceDBInstanceIdentifier': 'string',
'ReadReplicaDBInstanceIdentifiers': [
'string',
],
'ReadReplicaDBClusterIdentifiers': [
'string',
],
'LicenseModel': 'string',
'Iops': 123,
'OptionGroupMemberships': [
{
'OptionGroupName': 'string',
'Status': 'string'
},
],
'CharacterSetName': '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
}
}
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 DescribeDBInstances action.
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) --
Provides the name of the database engine to be used for this DB instance.
DBInstanceStatus (string) --
Specifies the current state of this database.
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.
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.
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:
DBSecurityGroupName (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 status of the VPC security group.
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:
DBParameterGroupName (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 in the DescribeDBSubnetGroups action.
SubnetIdentifier (string) --
Specifies 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.
SubnetStatus (string) --
Specifies the status of the subnet.
DBSubnetGroupArn (string) --
The Amazon Resource Name (ARN) for the DB subnet group.
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
PendingModifiedValues (dict) --
Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
DBInstanceClass (string) --
Contains the new DBInstanceClass for the DB instance that will be applied or is currently being applied.
AllocatedStorage (integer) --
Contains the new AllocatedStorage size for the DB instance that will be applied or is currently being applied.
MasterUserPassword (string) --
Contains the pending or currently-in-progress change of the master credentials for the DB instance.
Port (integer) --
Specifies the pending port for the DB instance.
BackupRetentionPeriod (integer) --
Specifies the pending number of days for which automated backups are retained.
MultiAZ (boolean) --
Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.
EngineVersion (string) --
Indicates 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) --
Specifies the new Provisioned IOPS value for the DB instance that will be applied or is currently being applied.
DBInstanceIdentifier (string) --
Contains the new DBInstanceIdentifier for the DB instance that will be applied or is currently being applied.
StorageType (string) --
Specifies the storage type to be associated with the DB instance.
CACertificateIdentifier (string) --
Specifies the identifier of the CA certificate for the DB instance.
DBSubnetGroupName (string) --
The new 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:
You 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:
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.
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.
EngineVersion (string) --
Indicates the database engine version.
AutoMinorVersionUpgrade (boolean) --
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 MySQL DB instance, the Aurora MySQL DB cluster for the Aurora Read Replica is shown. This output does not contain information about cross region Aurora Read Replicas.
Note
Currently, each RDS DB instance can have only one Aurora Read Replica.
LicenseModel (string) --
License model information for this DB instance.
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.
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. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
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 AWS KMS key identifier for the encrypted DB instance.
DbiResourceId (string) --
The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS 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.
Domain (string) --
The identifier of the Active Directory Domain.
Status (string) --
The status of the DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).
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 AWS 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 AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
PerformanceInsightsRetentionPeriod (integer) --
The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
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:
You 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:
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 AWS Identity and Access Management (IAM) roles associated with the DB instance.
(dict) --
Describes an AWS 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 AWS Identity and Access Management (IAM) role. For the list of 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:
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 to which Amazon RDS can automatically scale the storage of the DB instance.
Examples
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:
{
'ResponseMetadata': {
'...': '...',
},
}
Promotes a Read Replica DB cluster to a standalone DB cluster.
Note
This action only applies to Aurora DB clusters.
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',
'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'
},
'DeletionProtection': True|False,
'HttpEndpointEnabled': True|False,
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'CopyTagsToSnapshot': True|False,
'CrossAccountClone': True|False
}
}
Response Structure
Contains the details of an Amazon Aurora DB cluster.
This data type is used as a response element in the DescribeDBClusters , StopDBCluster , and StartDBCluster actions.
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.
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.
Provides 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 status of the VPC security group.
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 AWS KMS key identifier for the encrypted DB cluster.
The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
The Amazon Resource Name (ARN) for the DB cluster.
Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.
Describes an AWS 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:
The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion .
A value that indicates whether the mapping of AWS 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 DB cluster. The capacity is 0 (zero) when the cluster is paused.
For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide .
The DB engine mode of the DB cluster, either provisioned , serverless , parallelquery , global , or multimaster .
Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.
For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide .
The maximum capacity for the 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 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 timeout action of a call to ModifyCurrentDBClusterCapacity , either ForceApplyCapacityChange or RollbackCapacityChange .
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 DB cluster is enabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless 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 AWS KMS key identifier used for encrypting messages in the database activity stream.
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 AWS account.
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
AWS Support might request the lease ID for an issue related to a reserved DB instance.
Examples
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:
{
'ResponseMetadata': {
'...': '...',
},
}
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.
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',
'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'
},
'SubnetStatus': 'string'
},
],
'DBSubnetGroupArn': 'string'
},
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'DBInstanceClass': 'string',
'AllocatedStorage': 123,
'MasterUserPassword': 'string',
'Port': 123,
'BackupRetentionPeriod': 123,
'MultiAZ': True|False,
'EngineVersion': 'string',
'LicenseModel': 'string',
'Iops': 123,
'DBInstanceIdentifier': 'string',
'StorageType': 'string',
'CACertificateIdentifier': 'string',
'DBSubnetGroupName': 'string',
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
},
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
]
},
'LatestRestorableTime': datetime(2015, 1, 1),
'MultiAZ': True|False,
'EngineVersion': 'string',
'AutoMinorVersionUpgrade': True|False,
'ReadReplicaSourceDBInstanceIdentifier': 'string',
'ReadReplicaDBInstanceIdentifiers': [
'string',
],
'ReadReplicaDBClusterIdentifiers': [
'string',
],
'LicenseModel': 'string',
'Iops': 123,
'OptionGroupMemberships': [
{
'OptionGroupName': 'string',
'Status': 'string'
},
],
'CharacterSetName': '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
}
}
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 DescribeDBInstances action.
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) --
Provides the name of the database engine to be used for this DB instance.
DBInstanceStatus (string) --
Specifies the current state of this database.
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.
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.
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:
DBSecurityGroupName (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 status of the VPC security group.
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:
DBParameterGroupName (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 in the DescribeDBSubnetGroups action.
SubnetIdentifier (string) --
Specifies 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.
SubnetStatus (string) --
Specifies the status of the subnet.
DBSubnetGroupArn (string) --
The Amazon Resource Name (ARN) for the DB subnet group.
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
PendingModifiedValues (dict) --
Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
DBInstanceClass (string) --
Contains the new DBInstanceClass for the DB instance that will be applied or is currently being applied.
AllocatedStorage (integer) --
Contains the new AllocatedStorage size for the DB instance that will be applied or is currently being applied.
MasterUserPassword (string) --
Contains the pending or currently-in-progress change of the master credentials for the DB instance.
Port (integer) --
Specifies the pending port for the DB instance.
BackupRetentionPeriod (integer) --
Specifies the pending number of days for which automated backups are retained.
MultiAZ (boolean) --
Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.
EngineVersion (string) --
Indicates 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) --
Specifies the new Provisioned IOPS value for the DB instance that will be applied or is currently being applied.
DBInstanceIdentifier (string) --
Contains the new DBInstanceIdentifier for the DB instance that will be applied or is currently being applied.
StorageType (string) --
Specifies the storage type to be associated with the DB instance.
CACertificateIdentifier (string) --
Specifies the identifier of the CA certificate for the DB instance.
DBSubnetGroupName (string) --
The new 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:
You 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:
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.
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.
EngineVersion (string) --
Indicates the database engine version.
AutoMinorVersionUpgrade (boolean) --
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 MySQL DB instance, the Aurora MySQL DB cluster for the Aurora Read Replica is shown. This output does not contain information about cross region Aurora Read Replicas.
Note
Currently, each RDS DB instance can have only one Aurora Read Replica.
LicenseModel (string) --
License model information for this DB instance.
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.
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. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
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 AWS KMS key identifier for the encrypted DB instance.
DbiResourceId (string) --
The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS 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.
Domain (string) --
The identifier of the Active Directory Domain.
Status (string) --
The status of the DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).
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 AWS 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 AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
PerformanceInsightsRetentionPeriod (integer) --
The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
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:
You 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:
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 AWS Identity and Access Management (IAM) roles associated with the DB instance.
(dict) --
Describes an AWS 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 AWS Identity and Access Management (IAM) role. For the list of 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:
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 to which Amazon RDS can automatically scale the storage of the DB instance.
Examples
This example reboots the specified DB instance without forcing a failover.
response = client.reboot_db_instance(
DBInstanceIdentifier='mymysqlinstance',
ForceFailover=False,
)
print(response)
Expected Output:
{
'ResponseMetadata': {
'...': '...',
},
}
Note
This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.
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 .
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'
},
]
}
Response Structure
(dict) --
DBProxyTargets (list) --
One or more DBProxyTarget objects that are created when you register targets with a target group.
(dict) --
Note
This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.
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
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.
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
},
]
}
}
Response Structure
(dict) --
GlobalCluster (dict) --
A data type representing an Aurora global database.
GlobalClusterIdentifier (string) --
Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster.
GlobalClusterResourceId (string) --
The AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
GlobalClusterArn (string) --
The Amazon Resource Name (ARN) for the global database cluster.
Status (string) --
Specifies the current state of this global database cluster.
Engine (string) --
The Aurora database engine used by the global database cluster.
EngineVersion (string) --
Indicates the database engine version.
DatabaseName (string) --
The default database name within the new global database cluster.
StorageEncrypted (boolean) --
The storage encryption setting for the global database cluster.
DeletionProtection (boolean) --
The deletion protection setting for the new global database cluster.
GlobalClusterMembers (list) --
The list of cluster IDs for secondary clusters within the global database cluster. Currently limited to 1 item.
(dict) --
A data structure with information about any primary and secondary clusters associated with an Aurora global database.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for each Aurora cluster.
Readers (list) --
The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global database.
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.
Disassociates an AWS Identity and Access Management (IAM) role from an Amazon Aurora DB cluster. For more information, see Authorizing Amazon Aurora MySQL to Access Other AWS Services on Your Behalf in the Amazon Aurora User Guide .
Note
This action only applies to Aurora DB clusters.
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
Disassociates an AWS 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 the list of supported feature names, see DBEngineVersion .
None
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 AWS 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.
Examples
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:
{
'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
Examples
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': {
'...': '...',
},
}
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, 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.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.
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.
Examples
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': {
'...': '...',
},
}
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:
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) --
Provides the name of the DB parameter group.
Examples
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': {
'...': '...',
},
}
Creates an Amazon Aurora DB cluster from data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in Migrating Data to an Amazon Aurora MySQL DB Cluster in the Amazon Aurora User Guide .
Note
This action only applies to Aurora DB clusters.
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
)
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 is 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: mySubnetgroup
[REQUIRED]
The name of the database engine to be used for the restored DB cluster.
Valid Values: aurora , aurora-postgresql
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 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"Aurora MySQL
Example: 5.6.10a , 5.6.mysql_aurora.1.19.2 , 5.7.12 , 5.7.mysql_aurora.2.04.5
Aurora PostgreSQL
Example: 9.6.3 , 10.7
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 AWS Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.
Constraints:
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
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 AWS KMS key identifier for an encrypted DB cluster.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KM encryption key.
If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
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 version 5.5 and 5.6 are supported.
Example: 5.6.22
[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 AWS 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.
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. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide .
dict
Response Syntax
{
'DBCluster': {
'AllocatedStorage': 123,
'AvailabilityZones': [
'string',
],
'BackupRetentionPeriod': 123,
'CharacterSetName': 'string',
'DatabaseName': 'string',
'DBClusterIdentifier': 'string',
'DBClusterParameterGroup': 'string',
'DBSubnetGroup': 'string',
'Status': 'string',
'PercentProgress': 'string',
'EarliestRestorableTime': datetime(2015, 1, 1),
'Endpoint': 'string',
'ReaderEndpoint': 'string',
'CustomEndpoints': [
'string',
],
'MultiAZ': True|False,
'Engine': 'string',
'EngineVersion': 'string',
'LatestRestorableTime': datetime(2015, 1, 1),
'Port': 123,
'MasterUsername': 'string',
'DBClusterOptionGroupMemberships': [
{
'DBClusterOptionGroupName': 'string',
'Status': 'string'
},
],
'PreferredBackupWindow': 'string',
'PreferredMaintenanceWindow': 'string',
'ReplicationSourceIdentifier': 'string',
'ReadReplicaIdentifiers': [
'string',
],
'DBClusterMembers': [
{
'DBInstanceIdentifier': 'string',
'IsClusterWriter': True|False,
'DBClusterParameterGroupStatus': 'string',
'PromotionTier': 123
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'HostedZoneId': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbClusterResourceId': 'string',
'DBClusterArn': 'string',
'AssociatedRoles': [
{
'RoleArn': 'string',
'Status': 'string',
'FeatureName': 'string'
},
],
'IAMDatabaseAuthenticationEnabled': True|False,
'CloneGroupId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'EarliestBacktrackTime': datetime(2015, 1, 1),
'BacktrackWindow': 123,
'BacktrackConsumedChangeRecords': 123,
'EnabledCloudwatchLogsExports': [
'string',
],
'Capacity': 123,
'EngineMode': 'string',
'ScalingConfigurationInfo': {
'MinCapacity': 123,
'MaxCapacity': 123,
'AutoPause': True|False,
'SecondsUntilAutoPause': 123,
'TimeoutAction': 'string'
},
'DeletionProtection': True|False,
'HttpEndpointEnabled': True|False,
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'CopyTagsToSnapshot': True|False,
'CrossAccountClone': True|False
}
}
Response Structure
(dict) --
DBCluster (dict) --
Contains the details of an Amazon Aurora DB cluster.
This data type is used as a response element in the DescribeDBClusters , StopDBCluster , and StartDBCluster actions.
AllocatedStorage (integer) --
For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size 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.
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) --
Provides the name of the database engine to be used for this DB cluster.
EngineVersion (string) --
Indicates the database engine version.
LatestRestorableTime (datetime) --
Specifies the latest time to which a database can be restored with point-in-time restore.
Port (integer) --
Specifies the port that the database engine is listening on.
MasterUsername (string) --
Contains the master username for the DB cluster.
DBClusterOptionGroupMemberships (list) --
Provides the list of option group memberships for this DB cluster.
(dict) --
Contains status information for a DB cluster option group.
DBClusterOptionGroupName (string) --
Specifies the name of the DB cluster option group.
Status (string) --
Specifies the status of the DB cluster option group.
PreferredBackupWindow (string) --
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
ReplicationSourceIdentifier (string) --
Contains the identifier of the source DB cluster if this DB cluster is a Read Replica.
ReadReplicaIdentifiers (list) --
Contains one or more identifiers of the Read Replicas associated with this DB cluster.
DBClusterMembers (list) --
Provides the list of instances that make up the DB cluster.
(dict) --
Contains information about an instance that is part of a DB cluster.
DBInstanceIdentifier (string) --
Specifies the instance identifier for this member of the DB cluster.
IsClusterWriter (boolean) --
Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
DBClusterParameterGroupStatus (string) --
Specifies the status of the DB cluster parameter group for this member of the DB cluster.
PromotionTier (integer) --
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .
VpcSecurityGroups (list) --
Provides a list of VPC security groups that the DB cluster belongs to.
(dict) --
This data type is used as a response element for queries on VPC security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The status of the VPC security group.
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
StorageEncrypted (boolean) --
Specifies whether the DB cluster is encrypted.
KmsKeyId (string) --
If StorageEncrypted is enabled, the AWS KMS key identifier for the encrypted DB cluster.
DbClusterResourceId (string) --
The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for the DB cluster.
AssociatedRoles (list) --
Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.
(dict) --
Describes an AWS Identity and Access Management (IAM) role that is associated with a DB cluster.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
Status (string) --
Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:
FeatureName (string) --
The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion .
IAMDatabaseAuthenticationEnabled (boolean) --
A value that indicates whether the mapping of AWS 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 DB cluster. The capacity is 0 (zero) when the cluster is paused.
For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide .
EngineMode (string) --
The DB engine mode of the DB cluster, either provisioned , serverless , parallelquery , global , or multimaster .
ScalingConfigurationInfo (dict) --
Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.
For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide .
MinCapacity (integer) --
The maximum capacity for the Aurora DB cluster in serverless DB engine mode.
MaxCapacity (integer) --
The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
AutoPause (boolean) --
A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.
When the value is set to false for an Aurora Serverless 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 timeout action of a call to ModifyCurrentDBClusterCapacity , either ForceApplyCapacityChange or RollbackCapacityChange .
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 DB cluster is enabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless 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 AWS KMS key identifier used for encrypting messages in the database activity stream.
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 AWS account.
Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster. If you don't specify a security group, the new DB cluster is associated with the default security group.
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.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'
},
DBClusterParameterGroupName='string',
DeletionProtection=True|False,
CopyTagsToSnapshot=True|False
)
Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
[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
[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:
[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
The version of the database engine to use for the new DB cluster.
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 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"
Note
If you aren't using the default engine version, then you must specify the engine version.
Aurora MySQL
Example: 5.6.10a , 5.6.mysql_aurora.1.19.2 , 5.7.12 , 5.7.mysql_aurora.2.04.5
Aurora PostgreSQL
Example: 9.6.3 , 10.7
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.
The name of the DB subnet group to use for the new DB cluster.
Constraints: If supplied, must match the name of an existing DB subnet group.
Example: mySubnetgroup
A list of VPC security groups that the new DB cluster will belong to.
The tags to be assigned to the restored DB cluster.
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 AWS KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
If you don't specify a value for the KmsKeyId parameter, then the following occurs:
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Default: 0
Constraints:
The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide .
For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.
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.
The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange .
ForceApplyCapacityChange sets 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 from finding a scaling point might be dropped.
For more information, see Autoscaling for Aurora Serverless in the Amazon Aurora User Guide .
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:
dict
Response Syntax
{
'DBCluster': {
'AllocatedStorage': 123,
'AvailabilityZones': [
'string',
],
'BackupRetentionPeriod': 123,
'CharacterSetName': 'string',
'DatabaseName': 'string',
'DBClusterIdentifier': 'string',
'DBClusterParameterGroup': 'string',
'DBSubnetGroup': 'string',
'Status': 'string',
'PercentProgress': 'string',
'EarliestRestorableTime': datetime(2015, 1, 1),
'Endpoint': 'string',
'ReaderEndpoint': 'string',
'CustomEndpoints': [
'string',
],
'MultiAZ': True|False,
'Engine': 'string',
'EngineVersion': 'string',
'LatestRestorableTime': datetime(2015, 1, 1),
'Port': 123,
'MasterUsername': 'string',
'DBClusterOptionGroupMemberships': [
{
'DBClusterOptionGroupName': 'string',
'Status': 'string'
},
],
'PreferredBackupWindow': 'string',
'PreferredMaintenanceWindow': 'string',
'ReplicationSourceIdentifier': 'string',
'ReadReplicaIdentifiers': [
'string',
],
'DBClusterMembers': [
{
'DBInstanceIdentifier': 'string',
'IsClusterWriter': True|False,
'DBClusterParameterGroupStatus': 'string',
'PromotionTier': 123
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'HostedZoneId': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbClusterResourceId': 'string',
'DBClusterArn': 'string',
'AssociatedRoles': [
{
'RoleArn': 'string',
'Status': 'string',
'FeatureName': 'string'
},
],
'IAMDatabaseAuthenticationEnabled': True|False,
'CloneGroupId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'EarliestBacktrackTime': datetime(2015, 1, 1),
'BacktrackWindow': 123,
'BacktrackConsumedChangeRecords': 123,
'EnabledCloudwatchLogsExports': [
'string',
],
'Capacity': 123,
'EngineMode': 'string',
'ScalingConfigurationInfo': {
'MinCapacity': 123,
'MaxCapacity': 123,
'AutoPause': True|False,
'SecondsUntilAutoPause': 123,
'TimeoutAction': 'string'
},
'DeletionProtection': True|False,
'HttpEndpointEnabled': True|False,
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'CopyTagsToSnapshot': True|False,
'CrossAccountClone': True|False
}
}
Response Structure
(dict) --
DBCluster (dict) --
Contains the details of an Amazon Aurora DB cluster.
This data type is used as a response element in the DescribeDBClusters , StopDBCluster , and StartDBCluster actions.
AllocatedStorage (integer) --
For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size 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.
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) --
Provides the name of the database engine to be used for this DB cluster.
EngineVersion (string) --
Indicates the database engine version.
LatestRestorableTime (datetime) --
Specifies the latest time to which a database can be restored with point-in-time restore.
Port (integer) --
Specifies the port that the database engine is listening on.
MasterUsername (string) --
Contains the master username for the DB cluster.
DBClusterOptionGroupMemberships (list) --
Provides the list of option group memberships for this DB cluster.
(dict) --
Contains status information for a DB cluster option group.
DBClusterOptionGroupName (string) --
Specifies the name of the DB cluster option group.
Status (string) --
Specifies the status of the DB cluster option group.
PreferredBackupWindow (string) --
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
ReplicationSourceIdentifier (string) --
Contains the identifier of the source DB cluster if this DB cluster is a Read Replica.
ReadReplicaIdentifiers (list) --
Contains one or more identifiers of the Read Replicas associated with this DB cluster.
DBClusterMembers (list) --
Provides the list of instances that make up the DB cluster.
(dict) --
Contains information about an instance that is part of a DB cluster.
DBInstanceIdentifier (string) --
Specifies the instance identifier for this member of the DB cluster.
IsClusterWriter (boolean) --
Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
DBClusterParameterGroupStatus (string) --
Specifies the status of the DB cluster parameter group for this member of the DB cluster.
PromotionTier (integer) --
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .
VpcSecurityGroups (list) --
Provides a list of VPC security groups that the DB cluster belongs to.
(dict) --
This data type is used as a response element for queries on VPC security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The status of the VPC security group.
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
StorageEncrypted (boolean) --
Specifies whether the DB cluster is encrypted.
KmsKeyId (string) --
If StorageEncrypted is enabled, the AWS KMS key identifier for the encrypted DB cluster.
DbClusterResourceId (string) --
The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for the DB cluster.
AssociatedRoles (list) --
Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.
(dict) --
Describes an AWS Identity and Access Management (IAM) role that is associated with a DB cluster.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
Status (string) --
Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:
FeatureName (string) --
The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion .
IAMDatabaseAuthenticationEnabled (boolean) --
A value that indicates whether the mapping of AWS 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 DB cluster. The capacity is 0 (zero) when the cluster is paused.
For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide .
EngineMode (string) --
The DB engine mode of the DB cluster, either provisioned , serverless , parallelquery , global , or multimaster .
ScalingConfigurationInfo (dict) --
Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.
For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide .
MinCapacity (integer) --
The maximum capacity for the Aurora DB cluster in serverless DB engine mode.
MaxCapacity (integer) --
The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
AutoPause (boolean) --
A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.
When the value is set to false for an Aurora Serverless 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 timeout action of a call to ModifyCurrentDBClusterCapacity , either ForceApplyCapacityChange or RollbackCapacityChange .
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 DB cluster is enabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless 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 AWS KMS key identifier used for encrypting messages in the database activity stream.
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 AWS account.
Examples
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:
{
'ResponseMetadata': {
'...': '...',
},
}
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
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, 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.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
)
[REQUIRED]
The name of the new DB cluster to be created.
Constraints:
The type of restore to be performed. You can specify one of the following values:
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.
[REQUIRED]
The identifier of the source DB cluster from which to restore.
Constraints:
The date and time to restore the DB cluster to.
Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
Constraints:
Example: 2015-03-07T23:45:00Z
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.
The port number on which the new DB cluster accepts connections.
Constraints: A value from 1150-65535 .
Default: The default port for the engine.
The DB subnet group name to use for the new DB cluster.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetgroup
A list of VPC security groups that the new DB cluster belongs to.
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 AWS KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different than the KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key identified by the KmsKeyId parameter.
If you don't specify a value for the KmsKeyId parameter, then the following occurs:
If DBClusterIdentifier refers to a DB cluster that isn't encrypted, then the restore request is rejected.
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
The target backtrack window, in seconds. To disable backtracking, set this value to 0.
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. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide .
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:
dict
Response Syntax
{
'DBCluster': {
'AllocatedStorage': 123,
'AvailabilityZones': [
'string',
],
'BackupRetentionPeriod': 123,
'CharacterSetName': 'string',
'DatabaseName': 'string',
'DBClusterIdentifier': 'string',
'DBClusterParameterGroup': 'string',
'DBSubnetGroup': 'string',
'Status': 'string',
'PercentProgress': 'string',
'EarliestRestorableTime': datetime(2015, 1, 1),
'Endpoint': 'string',
'ReaderEndpoint': 'string',
'CustomEndpoints': [
'string',
],
'MultiAZ': True|False,
'Engine': 'string',
'EngineVersion': 'string',
'LatestRestorableTime': datetime(2015, 1, 1),
'Port': 123,
'MasterUsername': 'string',
'DBClusterOptionGroupMemberships': [
{
'DBClusterOptionGroupName': 'string',
'Status': 'string'
},
],
'PreferredBackupWindow': 'string',
'PreferredMaintenanceWindow': 'string',
'ReplicationSourceIdentifier': 'string',
'ReadReplicaIdentifiers': [
'string',
],
'DBClusterMembers': [
{
'DBInstanceIdentifier': 'string',
'IsClusterWriter': True|False,
'DBClusterParameterGroupStatus': 'string',
'PromotionTier': 123
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'HostedZoneId': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbClusterResourceId': 'string',
'DBClusterArn': 'string',
'AssociatedRoles': [
{
'RoleArn': 'string',
'Status': 'string',
'FeatureName': 'string'
},
],
'IAMDatabaseAuthenticationEnabled': True|False,
'CloneGroupId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'EarliestBacktrackTime': datetime(2015, 1, 1),
'BacktrackWindow': 123,
'BacktrackConsumedChangeRecords': 123,
'EnabledCloudwatchLogsExports': [
'string',
],
'Capacity': 123,
'EngineMode': 'string',
'ScalingConfigurationInfo': {
'MinCapacity': 123,
'MaxCapacity': 123,
'AutoPause': True|False,
'SecondsUntilAutoPause': 123,
'TimeoutAction': 'string'
},
'DeletionProtection': True|False,
'HttpEndpointEnabled': True|False,
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'CopyTagsToSnapshot': True|False,
'CrossAccountClone': True|False
}
}
Response Structure
(dict) --
DBCluster (dict) --
Contains the details of an Amazon Aurora DB cluster.
This data type is used as a response element in the DescribeDBClusters , StopDBCluster , and StartDBCluster actions.
AllocatedStorage (integer) --
For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size 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.
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) --
Provides the name of the database engine to be used for this DB cluster.
EngineVersion (string) --
Indicates the database engine version.
LatestRestorableTime (datetime) --
Specifies the latest time to which a database can be restored with point-in-time restore.
Port (integer) --
Specifies the port that the database engine is listening on.
MasterUsername (string) --
Contains the master username for the DB cluster.
DBClusterOptionGroupMemberships (list) --
Provides the list of option group memberships for this DB cluster.
(dict) --
Contains status information for a DB cluster option group.
DBClusterOptionGroupName (string) --
Specifies the name of the DB cluster option group.
Status (string) --
Specifies the status of the DB cluster option group.
PreferredBackupWindow (string) --
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
ReplicationSourceIdentifier (string) --
Contains the identifier of the source DB cluster if this DB cluster is a Read Replica.
ReadReplicaIdentifiers (list) --
Contains one or more identifiers of the Read Replicas associated with this DB cluster.
DBClusterMembers (list) --
Provides the list of instances that make up the DB cluster.
(dict) --
Contains information about an instance that is part of a DB cluster.
DBInstanceIdentifier (string) --
Specifies the instance identifier for this member of the DB cluster.
IsClusterWriter (boolean) --
Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
DBClusterParameterGroupStatus (string) --
Specifies the status of the DB cluster parameter group for this member of the DB cluster.
PromotionTier (integer) --
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .
VpcSecurityGroups (list) --
Provides a list of VPC security groups that the DB cluster belongs to.
(dict) --
This data type is used as a response element for queries on VPC security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The status of the VPC security group.
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
StorageEncrypted (boolean) --
Specifies whether the DB cluster is encrypted.
KmsKeyId (string) --
If StorageEncrypted is enabled, the AWS KMS key identifier for the encrypted DB cluster.
DbClusterResourceId (string) --
The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for the DB cluster.
AssociatedRoles (list) --
Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.
(dict) --
Describes an AWS Identity and Access Management (IAM) role that is associated with a DB cluster.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
Status (string) --
Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:
FeatureName (string) --
The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion .
IAMDatabaseAuthenticationEnabled (boolean) --
A value that indicates whether the mapping of AWS 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 DB cluster. The capacity is 0 (zero) when the cluster is paused.
For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide .
EngineMode (string) --
The DB engine mode of the DB cluster, either provisioned , serverless , parallelquery , global , or multimaster .
ScalingConfigurationInfo (dict) --
Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.
For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide .
MinCapacity (integer) --
The maximum capacity for the Aurora DB cluster in serverless DB engine mode.
MaxCapacity (integer) --
The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
AutoPause (boolean) --
A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.
When the value is set to false for an Aurora Serverless 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 timeout action of a call to ModifyCurrentDBClusterCapacity , either ForceApplyCapacityChange or RollbackCapacityChange .
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 DB cluster is enabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless 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 AWS KMS key identifier used for encrypting messages in the database activity stream.
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 AWS account.
Examples
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:
{
'ResponseMetadata': {
'...': '...',
},
}
Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with the most of original configuration with the default security 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 AZ deployment and not a single-AZ deployment.
If your intent is 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. Once 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 will 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
)
[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:
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 AWS 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: mySubnetgroup
A value that indicates whether the DB instance is a Multi-AZ deployment.
Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
License model information for the restored DB instance.
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 doesn't apply to the MySQL, PostgreSQL, or MariaDB engines.
The database engine to use for the new instance.
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:
Specifies 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 once it is associated with a 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}_.:/=+\-]*)$").
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
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, only Microsoft SQL Server and Oracle DB instances can be created in an Active Directory Domain.
For Microsoft SQL Server DB instances, Amazon RDS can use Windows Authentication to authenticate users that connect to the DB instance. For more information, see Using Windows Authentication with an Amazon RDS DB Instance Running Microsoft SQL Server in the Amazon RDS User Guide .
For Oracle DB instances, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB instance. For more information, see Using Kerberos Authentication with Amazon RDS for Oracle in the Amazon RDS User Guide .
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For information about the supported DB engines, see CreateDBInstance .
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 Aurora 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:
You 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:
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 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.
Constraints:
dict
Response Syntax
{
'DBInstance': {
'DBInstanceIdentifier': 'string',
'DBInstanceClass': 'string',
'Engine': 'string',
'DBInstanceStatus': 'string',
'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'
},
'SubnetStatus': 'string'
},
],
'DBSubnetGroupArn': 'string'
},
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'DBInstanceClass': 'string',
'AllocatedStorage': 123,
'MasterUserPassword': 'string',
'Port': 123,
'BackupRetentionPeriod': 123,
'MultiAZ': True|False,
'EngineVersion': 'string',
'LicenseModel': 'string',
'Iops': 123,
'DBInstanceIdentifier': 'string',
'StorageType': 'string',
'CACertificateIdentifier': 'string',
'DBSubnetGroupName': 'string',
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
},
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
]
},
'LatestRestorableTime': datetime(2015, 1, 1),
'MultiAZ': True|False,
'EngineVersion': 'string',
'AutoMinorVersionUpgrade': True|False,
'ReadReplicaSourceDBInstanceIdentifier': 'string',
'ReadReplicaDBInstanceIdentifiers': [
'string',
],
'ReadReplicaDBClusterIdentifiers': [
'string',
],
'LicenseModel': 'string',
'Iops': 123,
'OptionGroupMemberships': [
{
'OptionGroupName': 'string',
'Status': 'string'
},
],
'CharacterSetName': '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
}
}
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 DescribeDBInstances action.
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) --
Provides the name of the database engine to be used for this DB instance.
DBInstanceStatus (string) --
Specifies the current state of this database.
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.
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.
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:
DBSecurityGroupName (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 status of the VPC security group.
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:
DBParameterGroupName (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 in the DescribeDBSubnetGroups action.
SubnetIdentifier (string) --
Specifies 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.
SubnetStatus (string) --
Specifies the status of the subnet.
DBSubnetGroupArn (string) --
The Amazon Resource Name (ARN) for the DB subnet group.
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
PendingModifiedValues (dict) --
Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
DBInstanceClass (string) --
Contains the new DBInstanceClass for the DB instance that will be applied or is currently being applied.
AllocatedStorage (integer) --
Contains the new AllocatedStorage size for the DB instance that will be applied or is currently being applied.
MasterUserPassword (string) --
Contains the pending or currently-in-progress change of the master credentials for the DB instance.
Port (integer) --
Specifies the pending port for the DB instance.
BackupRetentionPeriod (integer) --
Specifies the pending number of days for which automated backups are retained.
MultiAZ (boolean) --
Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.
EngineVersion (string) --
Indicates 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) --
Specifies the new Provisioned IOPS value for the DB instance that will be applied or is currently being applied.
DBInstanceIdentifier (string) --
Contains the new DBInstanceIdentifier for the DB instance that will be applied or is currently being applied.
StorageType (string) --
Specifies the storage type to be associated with the DB instance.
CACertificateIdentifier (string) --
Specifies the identifier of the CA certificate for the DB instance.
DBSubnetGroupName (string) --
The new 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:
You 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:
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.
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.
EngineVersion (string) --
Indicates the database engine version.
AutoMinorVersionUpgrade (boolean) --
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 MySQL DB instance, the Aurora MySQL DB cluster for the Aurora Read Replica is shown. This output does not contain information about cross region Aurora Read Replicas.
Note
Currently, each RDS DB instance can have only one Aurora Read Replica.
LicenseModel (string) --
License model information for this DB instance.
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.
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. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
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 AWS KMS key identifier for the encrypted DB instance.
DbiResourceId (string) --
The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS 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.
Domain (string) --
The identifier of the Active Directory Domain.
Status (string) --
The status of the DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).
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 AWS 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 AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
PerformanceInsightsRetentionPeriod (integer) --
The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
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:
You 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:
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 AWS Identity and Access Management (IAM) roles associated with the DB instance.
(dict) --
Describes an AWS 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 AWS Identity and Access Management (IAM) role. For the list of 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:
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 to which Amazon RDS can automatically scale the storage of the DB instance.
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.
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
)
[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 AWS 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 AWS 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 AWS 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 AWS Region as the current endpoint.
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:
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.
The time range each day during which automated backups are created if automated backups are enabled. For more information, see The Backup Window in the Amazon RDS User Guide.
Constraints:
The port number on which the database accepts connections.
Type: Integer
Valid Values: 1150 -65535
Default: 3306
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 AWS KMS key identifier for an encrypted DB instance.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.
If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
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 AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For information about the supported DB engines, see CreateDBInstance .
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 engine version of your source database.
Valid Values: 5.6
[REQUIRED]
The name of your Amazon S3 bucket that contains your database backup file.
[REQUIRED]
An AWS 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 Relational Database Service User Guide .
The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), the KMS key identifier, or the KMS key alias for the KMS encryption key.
If you do not specify a value for PerformanceInsightsKMSKeyId , then Amazon RDS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.
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:
You 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:
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.
dict
Response Syntax
{
'DBInstance': {
'DBInstanceIdentifier': 'string',
'DBInstanceClass': 'string',
'Engine': 'string',
'DBInstanceStatus': 'string',
'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'
},
'SubnetStatus': 'string'
},
],
'DBSubnetGroupArn': 'string'
},
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'DBInstanceClass': 'string',
'AllocatedStorage': 123,
'MasterUserPassword': 'string',
'Port': 123,
'BackupRetentionPeriod': 123,
'MultiAZ': True|False,
'EngineVersion': 'string',
'LicenseModel': 'string',
'Iops': 123,
'DBInstanceIdentifier': 'string',
'StorageType': 'string',
'CACertificateIdentifier': 'string',
'DBSubnetGroupName': 'string',
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
},
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
]
},
'LatestRestorableTime': datetime(2015, 1, 1),
'MultiAZ': True|False,
'EngineVersion': 'string',
'AutoMinorVersionUpgrade': True|False,
'ReadReplicaSourceDBInstanceIdentifier': 'string',
'ReadReplicaDBInstanceIdentifiers': [
'string',
],
'ReadReplicaDBClusterIdentifiers': [
'string',
],
'LicenseModel': 'string',
'Iops': 123,
'OptionGroupMemberships': [
{
'OptionGroupName': 'string',
'Status': 'string'
},
],
'CharacterSetName': '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
}
}
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 DescribeDBInstances action.
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) --
Provides the name of the database engine to be used for this DB instance.
DBInstanceStatus (string) --
Specifies the current state of this database.
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.
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.
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:
DBSecurityGroupName (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 status of the VPC security group.
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:
DBParameterGroupName (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 in the DescribeDBSubnetGroups action.
SubnetIdentifier (string) --
Specifies 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.
SubnetStatus (string) --
Specifies the status of the subnet.
DBSubnetGroupArn (string) --
The Amazon Resource Name (ARN) for the DB subnet group.
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
PendingModifiedValues (dict) --
Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
DBInstanceClass (string) --
Contains the new DBInstanceClass for the DB instance that will be applied or is currently being applied.
AllocatedStorage (integer) --
Contains the new AllocatedStorage size for the DB instance that will be applied or is currently being applied.
MasterUserPassword (string) --
Contains the pending or currently-in-progress change of the master credentials for the DB instance.
Port (integer) --
Specifies the pending port for the DB instance.
BackupRetentionPeriod (integer) --
Specifies the pending number of days for which automated backups are retained.
MultiAZ (boolean) --
Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.
EngineVersion (string) --
Indicates 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) --
Specifies the new Provisioned IOPS value for the DB instance that will be applied or is currently being applied.
DBInstanceIdentifier (string) --
Contains the new DBInstanceIdentifier for the DB instance that will be applied or is currently being applied.
StorageType (string) --
Specifies the storage type to be associated with the DB instance.
CACertificateIdentifier (string) --
Specifies the identifier of the CA certificate for the DB instance.
DBSubnetGroupName (string) --
The new 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:
You 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:
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.
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.
EngineVersion (string) --
Indicates the database engine version.
AutoMinorVersionUpgrade (boolean) --
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 MySQL DB instance, the Aurora MySQL DB cluster for the Aurora Read Replica is shown. This output does not contain information about cross region Aurora Read Replicas.
Note
Currently, each RDS DB instance can have only one Aurora Read Replica.
LicenseModel (string) --
License model information for this DB instance.
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.
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. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
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 AWS KMS key identifier for the encrypted DB instance.
DbiResourceId (string) --
The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS 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.
Domain (string) --
The identifier of the Active Directory Domain.
Status (string) --
The status of the DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).
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 AWS 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 AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
PerformanceInsightsRetentionPeriod (integer) --
The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
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:
You 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:
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 AWS Identity and Access Management (IAM) roles associated with the DB instance.
(dict) --
Describes an AWS 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 AWS Identity and Access Management (IAM) role. For the list of 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:
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 to which Amazon RDS can automatically scale the storage of the DB instance.
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'
)
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:
Example: 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 AWS 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: mySubnetgroup
A value that indicates whether the DB instance is a Multi-AZ deployment.
Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
License model information for the restored DB instance.
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 used for the MySQL or MariaDB engines.
The database engine to use for the new instance.
Default: The same as source
Constraint: Must be compatible with the engine of the source
Valid Values:
The 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 once it is associated with a 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}_.:/=+\-]*)$").
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
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, only Microsoft SQL Server and Oracle DB instances can be created in an Active Directory Domain.
For Microsoft SQL Server DB instances, Amazon RDS can use Windows Authentication to authenticate users that connect to the DB instance. For more information, see Using Windows Authentication with an Amazon RDS DB Instance Running Microsoft SQL Server in the Amazon RDS User Guide .
For Oracle DB instances, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB instance. For more information, see Using Kerberos Authentication with Amazon RDS for Oracle in the Amazon RDS User Guide .
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For information about the supported DB engines, see CreateDBInstance .
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 .
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:
You 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:
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 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.
Constraints:
dict
Response Syntax
{
'DBInstance': {
'DBInstanceIdentifier': 'string',
'DBInstanceClass': 'string',
'Engine': 'string',
'DBInstanceStatus': 'string',
'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'
},
'SubnetStatus': 'string'
},
],
'DBSubnetGroupArn': 'string'
},
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'DBInstanceClass': 'string',
'AllocatedStorage': 123,
'MasterUserPassword': 'string',
'Port': 123,
'BackupRetentionPeriod': 123,
'MultiAZ': True|False,
'EngineVersion': 'string',
'LicenseModel': 'string',
'Iops': 123,
'DBInstanceIdentifier': 'string',
'StorageType': 'string',
'CACertificateIdentifier': 'string',
'DBSubnetGroupName': 'string',
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
},
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
]
},
'LatestRestorableTime': datetime(2015, 1, 1),
'MultiAZ': True|False,
'EngineVersion': 'string',
'AutoMinorVersionUpgrade': True|False,
'ReadReplicaSourceDBInstanceIdentifier': 'string',
'ReadReplicaDBInstanceIdentifiers': [
'string',
],
'ReadReplicaDBClusterIdentifiers': [
'string',
],
'LicenseModel': 'string',
'Iops': 123,
'OptionGroupMemberships': [
{
'OptionGroupName': 'string',
'Status': 'string'
},
],
'CharacterSetName': '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
}
}
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 DescribeDBInstances action.
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) --
Provides the name of the database engine to be used for this DB instance.
DBInstanceStatus (string) --
Specifies the current state of this database.
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.
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.
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:
DBSecurityGroupName (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 status of the VPC security group.
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:
DBParameterGroupName (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 in the DescribeDBSubnetGroups action.
SubnetIdentifier (string) --
Specifies 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.
SubnetStatus (string) --
Specifies the status of the subnet.
DBSubnetGroupArn (string) --
The Amazon Resource Name (ARN) for the DB subnet group.
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
PendingModifiedValues (dict) --
Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
DBInstanceClass (string) --
Contains the new DBInstanceClass for the DB instance that will be applied or is currently being applied.
AllocatedStorage (integer) --
Contains the new AllocatedStorage size for the DB instance that will be applied or is currently being applied.
MasterUserPassword (string) --
Contains the pending or currently-in-progress change of the master credentials for the DB instance.
Port (integer) --
Specifies the pending port for the DB instance.
BackupRetentionPeriod (integer) --
Specifies the pending number of days for which automated backups are retained.
MultiAZ (boolean) --
Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.
EngineVersion (string) --
Indicates 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) --
Specifies the new Provisioned IOPS value for the DB instance that will be applied or is currently being applied.
DBInstanceIdentifier (string) --
Contains the new DBInstanceIdentifier for the DB instance that will be applied or is currently being applied.
StorageType (string) --
Specifies the storage type to be associated with the DB instance.
CACertificateIdentifier (string) --
Specifies the identifier of the CA certificate for the DB instance.
DBSubnetGroupName (string) --
The new 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:
You 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:
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.
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.
EngineVersion (string) --
Indicates the database engine version.
AutoMinorVersionUpgrade (boolean) --
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 MySQL DB instance, the Aurora MySQL DB cluster for the Aurora Read Replica is shown. This output does not contain information about cross region Aurora Read Replicas.
Note
Currently, each RDS DB instance can have only one Aurora Read Replica.
LicenseModel (string) --
License model information for this DB instance.
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.
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. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
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 AWS KMS key identifier for the encrypted DB instance.
DbiResourceId (string) --
The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS 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.
Domain (string) --
The identifier of the Active Directory Domain.
Status (string) --
The status of the DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).
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 AWS 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 AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
PerformanceInsightsRetentionPeriod (integer) --
The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
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:
You 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:
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 AWS Identity and Access Management (IAM) roles associated with the DB instance.
(dict) --
Describes an AWS 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 AWS Identity and Access Management (IAM) role. For the list of 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:
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 to which Amazon RDS can automatically scale the storage of the DB instance.
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.
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 AWS 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:
Status (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 AWS 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.
Examples
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:
{
'ResponseMetadata': {
'...': '...',
},
}
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
)
[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 AWS KMS key identifier for encrypting messages in the database activity stream. The key identifier can be either a key ID, a key ARN, or a key alias.
dict
Response Syntax
{
'KmsKeyId': 'string',
'KinesisStreamName': 'string',
'Status': 'stopped'|'starting'|'started'|'stopping',
'Mode': 'sync'|'async',
'ApplyImmediately': True|False
}
Response Structure
(dict) --
KmsKeyId (string) --
The AWS 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.
Starts an Amazon Aurora DB cluster that was stopped using the AWS console, the stop-db-cluster AWS CLI command, or the StopDBCluster action.
For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.
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',
'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'
},
'DeletionProtection': True|False,
'HttpEndpointEnabled': True|False,
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'CopyTagsToSnapshot': True|False,
'CrossAccountClone': True|False
}
}
Response Structure
Contains the details of an Amazon Aurora DB cluster.
This data type is used as a response element in the DescribeDBClusters , StopDBCluster , and StartDBCluster actions.
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.
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.
Provides 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 status of the VPC security group.
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 AWS KMS key identifier for the encrypted DB cluster.
The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
The Amazon Resource Name (ARN) for the DB cluster.
Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.
Describes an AWS 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:
The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion .
A value that indicates whether the mapping of AWS 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 DB cluster. The capacity is 0 (zero) when the cluster is paused.
For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide .
The DB engine mode of the DB cluster, either provisioned , serverless , parallelquery , global , or multimaster .
Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.
For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide .
The maximum capacity for the 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 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 timeout action of a call to ModifyCurrentDBClusterCapacity , either ForceApplyCapacityChange or RollbackCapacityChange .
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 DB cluster is enabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless 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 AWS KMS key identifier used for encrypting messages in the database activity stream.
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 AWS account.
Starts an Amazon RDS DB instance that was stopped using the AWS console, the stop-db-instance AWS 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 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',
'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'
},
'SubnetStatus': 'string'
},
],
'DBSubnetGroupArn': 'string'
},
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'DBInstanceClass': 'string',
'AllocatedStorage': 123,
'MasterUserPassword': 'string',
'Port': 123,
'BackupRetentionPeriod': 123,
'MultiAZ': True|False,
'EngineVersion': 'string',
'LicenseModel': 'string',
'Iops': 123,
'DBInstanceIdentifier': 'string',
'StorageType': 'string',
'CACertificateIdentifier': 'string',
'DBSubnetGroupName': 'string',
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
},
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
]
},
'LatestRestorableTime': datetime(2015, 1, 1),
'MultiAZ': True|False,
'EngineVersion': 'string',
'AutoMinorVersionUpgrade': True|False,
'ReadReplicaSourceDBInstanceIdentifier': 'string',
'ReadReplicaDBInstanceIdentifiers': [
'string',
],
'ReadReplicaDBClusterIdentifiers': [
'string',
],
'LicenseModel': 'string',
'Iops': 123,
'OptionGroupMemberships': [
{
'OptionGroupName': 'string',
'Status': 'string'
},
],
'CharacterSetName': '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
}
}
Response Structure
Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the DescribeDBInstances action.
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.
Provides the name of the database engine to be used for this DB instance.
Specifies the current state of this database.
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.
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.
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:
The 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 status of the VPC security group.
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:
The 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 in the DescribeDBSubnetGroups action.
Specifies 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.
Specifies the status of the subnet.
The Amazon Resource Name (ARN) for the DB subnet group.
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
Contains the new DBInstanceClass for the DB instance that will be applied or is currently being applied.
Contains the new AllocatedStorage size for the DB instance that will be applied or is currently being applied.
Contains the pending or currently-in-progress change of the master credentials for the DB instance.
Specifies the pending port for the DB instance.
Specifies the pending number of days for which automated backups are retained.
Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.
Indicates the database engine version.
The license model for the DB instance.
Valid values: license-included | bring-your-own-license | general-public-license
Specifies the new Provisioned IOPS value for the DB instance that will be applied or is currently being applied.
Contains the new DBInstanceIdentifier for the DB instance that will be applied or is currently being applied.
Specifies the storage type to be associated with the DB instance.
Specifies the identifier of the CA certificate for the DB instance.
The new 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:
You 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:
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.
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.
Indicates the database engine version.
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 MySQL DB instance, the Aurora MySQL DB cluster for the Aurora Read Replica is shown. This output does not contain information about cross region Aurora Read Replicas.
Note
Currently, each RDS DB instance can have only one Aurora Read Replica.
License model information for this DB instance.
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.
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. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
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 AWS KMS key identifier for the encrypted DB instance.
The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS 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.
The identifier of the Active Directory Domain.
The status of the DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).
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 AWS 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 AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
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:
You 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:
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 AWS Identity and Access Management (IAM) roles associated with the DB instance.
Describes an AWS 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 AWS Identity and Access Management (IAM) role. For the list of 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:
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 to which Amazon RDS can automatically scale the storage of the DB instance.
Stops a database activity stream that was started using the AWS console, the start-activity-stream AWS 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 AWS KMS key identifier used for encrypting messages in the database activity stream.
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.
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',
'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'
},
'DeletionProtection': True|False,
'HttpEndpointEnabled': True|False,
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'CopyTagsToSnapshot': True|False,
'CrossAccountClone': True|False
}
}
Response Structure
Contains the details of an Amazon Aurora DB cluster.
This data type is used as a response element in the DescribeDBClusters , StopDBCluster , and StartDBCluster actions.
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.
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.
Provides 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 status of the VPC security group.
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 AWS KMS key identifier for the encrypted DB cluster.
The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
The Amazon Resource Name (ARN) for the DB cluster.
Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.
Describes an AWS 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:
The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion .
A value that indicates whether the mapping of AWS 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 DB cluster. The capacity is 0 (zero) when the cluster is paused.
For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide .
The DB engine mode of the DB cluster, either provisioned , serverless , parallelquery , global , or multimaster .
Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.
For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide .
The maximum capacity for the 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 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 timeout action of a call to ModifyCurrentDBClusterCapacity , either ForceApplyCapacityChange or RollbackCapacityChange .
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 DB cluster is enabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless 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 AWS KMS key identifier used for encrypting messages in the database activity stream.
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 AWS account.
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 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',
'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'
},
'SubnetStatus': 'string'
},
],
'DBSubnetGroupArn': 'string'
},
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'DBInstanceClass': 'string',
'AllocatedStorage': 123,
'MasterUserPassword': 'string',
'Port': 123,
'BackupRetentionPeriod': 123,
'MultiAZ': True|False,
'EngineVersion': 'string',
'LicenseModel': 'string',
'Iops': 123,
'DBInstanceIdentifier': 'string',
'StorageType': 'string',
'CACertificateIdentifier': 'string',
'DBSubnetGroupName': 'string',
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
},
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
]
},
'LatestRestorableTime': datetime(2015, 1, 1),
'MultiAZ': True|False,
'EngineVersion': 'string',
'AutoMinorVersionUpgrade': True|False,
'ReadReplicaSourceDBInstanceIdentifier': 'string',
'ReadReplicaDBInstanceIdentifiers': [
'string',
],
'ReadReplicaDBClusterIdentifiers': [
'string',
],
'LicenseModel': 'string',
'Iops': 123,
'OptionGroupMemberships': [
{
'OptionGroupName': 'string',
'Status': 'string'
},
],
'CharacterSetName': '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
}
}
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 DescribeDBInstances action.
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) --
Provides the name of the database engine to be used for this DB instance.
DBInstanceStatus (string) --
Specifies the current state of this database.
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.
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.
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:
DBSecurityGroupName (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 status of the VPC security group.
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:
DBParameterGroupName (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 in the DescribeDBSubnetGroups action.
SubnetIdentifier (string) --
Specifies 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.
SubnetStatus (string) --
Specifies the status of the subnet.
DBSubnetGroupArn (string) --
The Amazon Resource Name (ARN) for the DB subnet group.
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
PendingModifiedValues (dict) --
Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
DBInstanceClass (string) --
Contains the new DBInstanceClass for the DB instance that will be applied or is currently being applied.
AllocatedStorage (integer) --
Contains the new AllocatedStorage size for the DB instance that will be applied or is currently being applied.
MasterUserPassword (string) --
Contains the pending or currently-in-progress change of the master credentials for the DB instance.
Port (integer) --
Specifies the pending port for the DB instance.
BackupRetentionPeriod (integer) --
Specifies the pending number of days for which automated backups are retained.
MultiAZ (boolean) --
Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.
EngineVersion (string) --
Indicates 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) --
Specifies the new Provisioned IOPS value for the DB instance that will be applied or is currently being applied.
DBInstanceIdentifier (string) --
Contains the new DBInstanceIdentifier for the DB instance that will be applied or is currently being applied.
StorageType (string) --
Specifies the storage type to be associated with the DB instance.
CACertificateIdentifier (string) --
Specifies the identifier of the CA certificate for the DB instance.
DBSubnetGroupName (string) --
The new 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:
You 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:
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.
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.
EngineVersion (string) --
Indicates the database engine version.
AutoMinorVersionUpgrade (boolean) --
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 MySQL DB instance, the Aurora MySQL DB cluster for the Aurora Read Replica is shown. This output does not contain information about cross region Aurora Read Replicas.
Note
Currently, each RDS DB instance can have only one Aurora Read Replica.
LicenseModel (string) --
License model information for this DB instance.
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.
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. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
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 AWS KMS key identifier for the encrypted DB instance.
DbiResourceId (string) --
The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS 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.
Domain (string) --
The identifier of the Active Directory Domain.
Status (string) --
The status of the DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).
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 AWS 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 AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
PerformanceInsightsRetentionPeriod (integer) --
The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
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:
You 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:
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 AWS Identity and Access Management (IAM) roles associated with the DB instance.
(dict) --
Describes an AWS 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 AWS Identity and Access Management (IAM) role. For the list of 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:
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 to which Amazon RDS can automatically scale the storage of the DB instance.
The available paginators are:
paginator = client.get_paginator('describe_certificates')
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:
The 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'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Data returned by the DescribeCertificates action.
Certificates (list) --
The list of Certificate objects for the AWS account.
(dict) --
A CA certificate for an AWS 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.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('describe_custom_availability_zones')
Creates an iterator that will paginate through responses from RDS.Client.describe_custom_availability_zones().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
CustomAvailabilityZoneId='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A filter that specifies one or more custom AZs to describe.
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:
The 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
{
'CustomAvailabilityZones': [
{
'CustomAvailabilityZoneId': 'string',
'CustomAvailabilityZoneName': 'string',
'CustomAvailabilityZoneStatus': 'string',
'VpnDetails': {
'VpnId': 'string',
'VpnTunnelOriginatorIP': 'string',
'VpnGatewayIp': 'string',
'VpnPSK': 'string',
'VpnName': 'string',
'VpnState': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
CustomAvailabilityZones (list) --
The list of CustomAvailabilityZone objects for the AWS account.
(dict) --
A custom Availability Zone (AZ) is an on-premises AZ that is integrated with a VMware vSphere cluster.
For more information about RDS on VMware, see the ` RDS on VMware User Guide. https://docs.aws.amazon.com/AmazonRDS/latest/RDSonVMwareUserGuide/rds-on-vmware.html`__
CustomAvailabilityZoneId (string) --
The identifier of the custom AZ.
Amazon RDS generates a unique identifier when a custom AZ is created.
CustomAvailabilityZoneName (string) --
The name of the custom AZ.
CustomAvailabilityZoneStatus (string) --
The status of the custom AZ.
VpnDetails (dict) --
Information about the virtual private network (VPN) between the VMware vSphere cluster and the AWS website.
VpnId (string) --
The ID of the VPN.
VpnTunnelOriginatorIP (string) --
The IP address of network traffic from your on-premises data center. A custom AZ receives the network traffic.
VpnGatewayIp (string) --
The IP address of network traffic from AWS to your on-premises data center.
VpnPSK (string) --
The preshared key (PSK) for the VPN.
VpnName (string) --
The name of the VPN.
VpnState (string) --
The state of the VPN.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('describe_db_cluster_backtracks')
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:
The 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:
The 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:
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('describe_db_cluster_endpoints')
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 , 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:
The 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:
For 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 , modifying .
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.
paginator = client.get_paginator('describe_db_cluster_parameter_groups')
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:
The 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) --
Provides the name of the DB cluster parameter group.
DBParameterGroupFamily (string) --
Provides 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.
paginator = client.get_paginator('describe_db_cluster_parameters')
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:
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:
The 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.
paginator = client.get_paginator('describe_db_cluster_snapshots')
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:
The type of DB cluster snapshots to be returned. You can specify one of the following values:
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:
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:
The 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 AWS accounts that this AWS account has been given permission to copy or restore. By default, these snapshots are not included.
You can give an AWS account permission to restore a manual DB cluster snapshot from another AWS 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 AWS 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',
'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
},
],
'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.
AllocatedStorage (integer) --
Specifies the allocated storage size in gibibytes (GiB).
Status (string) --
Specifies the status of this DB cluster snapshot.
Port (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 the 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 AWS KMS key identifier for the encrypted DB cluster snapshot.
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 AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('describe_db_clusters')
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:
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:
The 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',
'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'
},
'DeletionProtection': True|False,
'HttpEndpointEnabled': True|False,
'ActivityStreamMode': 'sync'|'async',
'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping',
'ActivityStreamKmsKeyId': 'string',
'ActivityStreamKinesisStreamName': 'string',
'CopyTagsToSnapshot': True|False,
'CrossAccountClone': True|False
},
],
'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.
This data type is used as a response element in the DescribeDBClusters , StopDBCluster , and StartDBCluster actions.
AllocatedStorage (integer) --
For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size 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.
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) --
Provides the name of the database engine to be used for this DB cluster.
EngineVersion (string) --
Indicates the database engine version.
LatestRestorableTime (datetime) --
Specifies the latest time to which a database can be restored with point-in-time restore.
Port (integer) --
Specifies the port that the database engine is listening on.
MasterUsername (string) --
Contains the master username for the DB cluster.
DBClusterOptionGroupMemberships (list) --
Provides the list of option group memberships for this DB cluster.
(dict) --
Contains status information for a DB cluster option group.
DBClusterOptionGroupName (string) --
Specifies the name of the DB cluster option group.
Status (string) --
Specifies the status of the DB cluster option group.
PreferredBackupWindow (string) --
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
ReplicationSourceIdentifier (string) --
Contains the identifier of the source DB cluster if this DB cluster is a Read Replica.
ReadReplicaIdentifiers (list) --
Contains one or more identifiers of the Read Replicas associated with this DB cluster.
DBClusterMembers (list) --
Provides the list of instances that make up the DB cluster.
(dict) --
Contains information about an instance that is part of a DB cluster.
DBInstanceIdentifier (string) --
Specifies the instance identifier for this member of the DB cluster.
IsClusterWriter (boolean) --
Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
DBClusterParameterGroupStatus (string) --
Specifies the status of the DB cluster parameter group for this member of the DB cluster.
PromotionTier (integer) --
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide .
VpcSecurityGroups (list) --
Provides a list of VPC security groups that the DB cluster belongs to.
(dict) --
This data type is used as a response element for queries on VPC security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The status of the VPC security group.
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
StorageEncrypted (boolean) --
Specifies whether the DB cluster is encrypted.
KmsKeyId (string) --
If StorageEncrypted is enabled, the AWS KMS key identifier for the encrypted DB cluster.
DbClusterResourceId (string) --
The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for the DB cluster.
AssociatedRoles (list) --
Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.
(dict) --
Describes an AWS Identity and Access Management (IAM) role that is associated with a DB cluster.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
Status (string) --
Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:
FeatureName (string) --
The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion .
IAMDatabaseAuthenticationEnabled (boolean) --
A value that indicates whether the mapping of AWS 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 DB cluster. The capacity is 0 (zero) when the cluster is paused.
For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide .
EngineMode (string) --
The DB engine mode of the DB cluster, either provisioned , serverless , parallelquery , global , or multimaster .
ScalingConfigurationInfo (dict) --
Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.
For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide .
MinCapacity (integer) --
The maximum capacity for the Aurora DB cluster in serverless DB engine mode.
MaxCapacity (integer) --
The maximum capacity for an Aurora DB cluster in serverless DB engine mode.
AutoPause (boolean) --
A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.
When the value is set to false for an Aurora Serverless 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 timeout action of a call to ModifyCurrentDBClusterCapacity , either ForceApplyCapacityChange or RollbackCapacityChange .
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 DB cluster is enabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless 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 AWS KMS key identifier used for encrypting messages in the database activity stream.
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 AWS account.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('describe_db_engine_versions')
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 version to return.
Example: 5.1.49
The name of a specific DB parameter group family 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:
The 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.
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.
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'
},
],
'ValidUpgradeTarget': [
{
'Engine': 'string',
'EngineVersion': 'string',
'Description': 'string',
'AutoUpgrade': True|False,
'IsMajorVersionUpgrade': True|False
},
],
'SupportedTimezones': [
{
'TimezoneName': 'string'
},
],
'ExportableLogTypes': [
'string',
],
'SupportsLogExportsToCloudwatchLogs': True|False,
'SupportsReadReplica': True|False,
'SupportedEngineModes': [
'string',
],
'SupportedFeatureNames': [
'string',
],
'Status': 'string'
},
],
'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 action.
(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 a database engine is upgraded to a major 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. Supported feature names include the following.
Status (string) --
The status of the DB engine version, either available or deprecated .
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('describe_db_instance_automated_backups')
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',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A filter that specifies which resources to return based on status.
Supported filters are the following:
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:
The 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
{
'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
},
],
'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 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 backup.
DbiResourceId (string) --
The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region.
Region (string) --
The AWS 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:
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 AWS 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 AWS KMS key ID for an automated backup. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption 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 AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('describe_db_instances')
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:
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:
The 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',
'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'
},
'SubnetStatus': 'string'
},
],
'DBSubnetGroupArn': 'string'
},
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'DBInstanceClass': 'string',
'AllocatedStorage': 123,
'MasterUserPassword': 'string',
'Port': 123,
'BackupRetentionPeriod': 123,
'MultiAZ': True|False,
'EngineVersion': 'string',
'LicenseModel': 'string',
'Iops': 123,
'DBInstanceIdentifier': 'string',
'StorageType': 'string',
'CACertificateIdentifier': 'string',
'DBSubnetGroupName': 'string',
'PendingCloudwatchLogsExports': {
'LogTypesToEnable': [
'string',
],
'LogTypesToDisable': [
'string',
]
},
'ProcessorFeatures': [
{
'Name': 'string',
'Value': 'string'
},
]
},
'LatestRestorableTime': datetime(2015, 1, 1),
'MultiAZ': True|False,
'EngineVersion': 'string',
'AutoMinorVersionUpgrade': True|False,
'ReadReplicaSourceDBInstanceIdentifier': 'string',
'ReadReplicaDBInstanceIdentifiers': [
'string',
],
'ReadReplicaDBClusterIdentifiers': [
'string',
],
'LicenseModel': 'string',
'Iops': 123,
'OptionGroupMemberships': [
{
'OptionGroupName': 'string',
'Status': 'string'
},
],
'CharacterSetName': '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
},
],
'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 DescribeDBInstances action.
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) --
Provides the name of the database engine to be used for this DB instance.
DBInstanceStatus (string) --
Specifies the current state of this database.
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.
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.
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:
DBSecurityGroupName (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 status of the VPC security group.
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:
DBParameterGroupName (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 in the DescribeDBSubnetGroups action.
SubnetIdentifier (string) --
Specifies 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.
SubnetStatus (string) --
Specifies the status of the subnet.
DBSubnetGroupArn (string) --
The Amazon Resource Name (ARN) for the DB subnet group.
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
PendingModifiedValues (dict) --
Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
DBInstanceClass (string) --
Contains the new DBInstanceClass for the DB instance that will be applied or is currently being applied.
AllocatedStorage (integer) --
Contains the new AllocatedStorage size for the DB instance that will be applied or is currently being applied.
MasterUserPassword (string) --
Contains the pending or currently-in-progress change of the master credentials for the DB instance.
Port (integer) --
Specifies the pending port for the DB instance.
BackupRetentionPeriod (integer) --
Specifies the pending number of days for which automated backups are retained.
MultiAZ (boolean) --
Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.
EngineVersion (string) --
Indicates 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) --
Specifies the new Provisioned IOPS value for the DB instance that will be applied or is currently being applied.
DBInstanceIdentifier (string) --
Contains the new DBInstanceIdentifier for the DB instance that will be applied or is currently being applied.
StorageType (string) --
Specifies the storage type to be associated with the DB instance.
CACertificateIdentifier (string) --
Specifies the identifier of the CA certificate for the DB instance.
DBSubnetGroupName (string) --
The new 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:
You 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:
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.
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.
EngineVersion (string) --
Indicates the database engine version.
AutoMinorVersionUpgrade (boolean) --
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 MySQL DB instance, the Aurora MySQL DB cluster for the Aurora Read Replica is shown. This output does not contain information about cross region Aurora Read Replicas.
Note
Currently, each RDS DB instance can have only one Aurora Read Replica.
LicenseModel (string) --
License model information for this DB instance.
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.
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. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
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 AWS KMS key identifier for the encrypted DB instance.
DbiResourceId (string) --
The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS 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.
Domain (string) --
The identifier of the Active Directory Domain.
Status (string) --
The status of the DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).
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 AWS 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 AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
PerformanceInsightsRetentionPeriod (integer) --
The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
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:
You 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:
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 AWS Identity and Access Management (IAM) roles associated with the DB instance.
(dict) --
Describes an AWS 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 AWS Identity and Access Management (IAM) role. For the list of 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:
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 to which Amazon RDS can automatically scale the storage of the DB instance.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('describe_db_log_files')
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:
The 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.
paginator = client.get_paginator('describe_db_parameter_groups')
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:
The 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) --
Provides the name of the DB parameter group.
DBParameterGroupFamily (string) --
Provides 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.
paginator = client.get_paginator('describe_db_parameters')
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:
The 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.
paginator = client.get_paginator('describe_db_proxies')
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:
The 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',
'EngineFamily': '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) --
Note
This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.
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 AWS account in the specified AWS 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) --
Currently, this value is always MYSQL . The engine family applies to both RDS MySQL and Aurora MySQL.
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) --
Note
This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.
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 AWS 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 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.
paginator = client.get_paginator('describe_db_proxy_target_groups')
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.
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:
The 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) --
Note
This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.
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 AWS account in the specified AWS 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. For Aurora MySQL, it 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. A high value enables the proxy to leave a high percentage of idle connections open. A low value causes the proxy to close idle client connections and return the underlying database connections to the connection pool. For Aurora MySQL, it is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.
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.
paginator = client.get_paginator('describe_db_proxy_targets')
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.
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:
The 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'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Targets (list) --
An arbitrary number of DBProxyTarget objects, containing details of the corresponding targets.
(dict) --
Note
This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.
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
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.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('describe_db_security_groups')
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:
The 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 AWS 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:
Status (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 AWS 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.
paginator = client.get_paginator('describe_db_snapshots')
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 can't be used in conjunction with DBSnapshotIdentifier . This parameter isn't case-sensitive.
Constraints:
A specific DB snapshot identifier to describe. This parameter can't be used in conjunction with DBInstanceIdentifier . This value is stored as a lowercase string.
Constraints:
The type of snapshots to be returned. You can specify one of the following values:
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:
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:
The 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 AWS accounts that this AWS account has been given permission to copy or restore. By default, these snapshots are not included.
You can give an AWS account permission to restore a manual DB snapshot from another AWS account by using the ModifyDBSnapshotAttribute API action.
A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account. By default, the public snapshots are not included.
You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.
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'
},
],
'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) --
Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
Engine (string) --
Specifies the name of the database engine.
AllocatedStorage (integer) --
Specifies the allocated storage size in 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 when the snapshot was taken, in Universal Coordinated Time (UTC).
MasterUsername (string) --
Provides the master username for the DB snapshot.
EngineVersion (string) --
Specifies the version of the database engine.
LicenseModel (string) --
License model information for the restored DB instance.
SnapshotType (string) --
Provides the type of the DB snapshot.
Iops (integer) --
Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
OptionGroupName (string) --
Provides the option group name for the DB snapshot.
PercentProgress (integer) --
The percentage of the estimated data that has been transferred.
SourceRegion (string) --
The AWS 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 value in case of cross-customer or cross-region copy.
StorageType (string) --
Specifies the storage type associated with DB snapshot.
TdeCredentialArn (string) --
The ARN from the key store with which to associate the instance for TDE encryption.
Encrypted (boolean) --
Specifies whether the DB snapshot is encrypted.
KmsKeyId (string) --
If Encrypted is true, the AWS KMS key identifier for the encrypted DB snapshot.
DBSnapshotArn (string) --
The Amazon Resource Name (ARN) for the DB snapshot.
Timezone (string) --
The time zone of the DB snapshot. In most cases, the Timezone element is empty. Timezone content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.
IAMDatabaseAuthenticationEnabled (boolean) --
True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, 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:
You 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:
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 AWS Region.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('describe_db_subnet_groups')
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:
The 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'
},
'SubnetStatus': 'string'
},
],
'DBSubnetGroupArn': '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 in the DescribeDBSubnetGroups action.
SubnetIdentifier (string) --
Specifies 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.
SubnetStatus (string) --
Specifies the status of the subnet.
DBSubnetGroupArn (string) --
The Amazon Resource Name (ARN) for the DB subnet group.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('describe_engine_default_cluster_parameters')
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:
The 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.
paginator = client.get_paginator('describe_engine_default_parameters')
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.
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:
The 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.
paginator = client.get_paginator('describe_event_subscriptions')
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:
The 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 AWS 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.
paginator = client.get_paginator('describe_events')
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',
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:
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:
The 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',
'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.
paginator = client.get_paginator('describe_global_clusters')
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:
A filter that specifies one or more global DB clusters to describe.
Supported filters:
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:
The 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
},
]
},
],
'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 AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
GlobalClusterArn (string) --
The Amazon Resource Name (ARN) for the global database cluster.
Status (string) --
Specifies the current state of this global database cluster.
Engine (string) --
The Aurora database engine used by the global database cluster.
EngineVersion (string) --
Indicates the database engine version.
DatabaseName (string) --
The default database name within the new global database cluster.
StorageEncrypted (boolean) --
The storage encryption setting for the global database cluster.
DeletionProtection (boolean) --
The deletion protection setting for the new global database cluster.
GlobalClusterMembers (list) --
The list of cluster IDs for secondary clusters within the global database cluster. Currently limited to 1 item.
(dict) --
A data structure with information about any primary and secondary clusters associated with an Aurora global database.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for each Aurora cluster.
Readers (list) --
The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global database.
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.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('describe_installation_media')
Creates an iterator that will paginate through responses from RDS.Client.describe_installation_media().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
InstallationMediaId='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A filter that specifies one or more installation media to describe. Supported filters include the following:
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:
The 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
{
'InstallationMedia': [
{
'InstallationMediaId': 'string',
'CustomAvailabilityZoneId': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'EngineInstallationMediaPath': 'string',
'OSInstallationMediaPath': 'string',
'Status': 'string',
'FailureCause': {
'Message': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
InstallationMedia (list) --
The list of InstallationMedia objects for the AWS account.
(dict) --
Contains the installation media for a DB engine that requires an on-premises customer provided license, such as Microsoft SQL Server.
InstallationMediaId (string) --
The installation medium ID.
CustomAvailabilityZoneId (string) --
The custom Availability Zone (AZ) that contains the installation media.
Engine (string) --
The DB engine.
EngineVersion (string) --
The engine version of the DB engine.
EngineInstallationMediaPath (string) --
The path to the installation medium for the DB engine.
OSInstallationMediaPath (string) --
The path to the installation medium for the operating system associated with the DB engine.
Status (string) --
The status of the installation medium.
FailureCause (dict) --
If an installation media failure occurred, the cause of the failure.
Message (string) --
The reason that an installation media import failed.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('describe_option_group_options')
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.
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:
The 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.
paginator = client.get_paginator('describe_option_groups')
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:
The 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
{
'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:
DBSecurityGroupName (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 status of the VPC security group.
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.
paginator = client.get_paginator('describe_orderable_db_instance_options')
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',
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.
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:
The 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',
'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
},
],
'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.
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 or not Amazon RDS can automatically scale storage for DB instances that use the specified instance class.
SupportsKerberosAuthentication (boolean) --
Whether a DB instance supports Kerberos Authentication.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('describe_pending_maintenance_actions')
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:
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:
The 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. The maintenance action is applied to the resource on this date regardless of the maintenance window for the resource.
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.
paginator = client.get_paginator('describe_reserved_db_instances')
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
AWS 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:
The 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
AWS Support might request the lease ID for an issue related to a reserved DB instance.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('describe_reserved_db_instances_offerings')
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:
The 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.
paginator = client.get_paginator('describe_source_regions')
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 AWS 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:
The 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'
},
],
'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 AWS Region that the current AWS Region can get a Read Replica or a DB snapshot from.
(dict) --
Contains an AWS Region name as the result of a successful call to the DescribeSourceRegions action.
RegionName (string) --
The name of the source AWS Region.
Endpoint (string) --
The endpoint for the source AWS Region endpoint.
Status (string) --
The status of the source AWS Region.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('download_db_log_file_portion')
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:
waiter = client.get_waiter('db_cluster_snapshot_available')
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:
The type of DB cluster snapshots to be returned. You can specify one of the following values:
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:
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:
The 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.
A value that indicates whether to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore. By default, these snapshots are not included.
You can give an AWS account permission to restore a manual DB cluster snapshot from another AWS 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 AWS 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
waiter = client.get_waiter('db_cluster_snapshot_deleted')
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:
The type of DB cluster snapshots to be returned. You can specify one of the following values:
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:
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:
The 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.
A value that indicates whether to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore. By default, these snapshots are not included.
You can give an AWS account permission to restore a manual DB cluster snapshot from another AWS 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 AWS 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
waiter = client.get_waiter('db_instance_available')
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:
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:
The 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.
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
waiter = client.get_waiter('db_instance_deleted')
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:
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:
The 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.
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
waiter = client.get_waiter('db_snapshot_available')
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 can't be used in conjunction with DBSnapshotIdentifier . This parameter isn't case-sensitive.
Constraints:
A specific DB snapshot identifier to describe. This parameter can't be used in conjunction with DBInstanceIdentifier . This value is stored as a lowercase string.
Constraints:
The type of snapshots to be returned. You can specify one of the following values:
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:
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:
The 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.
A value that indicates whether to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore. By default, these snapshots are not included.
You can give an AWS account permission to restore a manual DB snapshot from another AWS account by using the ModifyDBSnapshotAttribute API action.
A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account. By default, the public snapshots are not included.
You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.
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
waiter = client.get_waiter('db_snapshot_completed')
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 can't be used in conjunction with DBSnapshotIdentifier . This parameter isn't case-sensitive.
Constraints:
A specific DB snapshot identifier to describe. This parameter can't be used in conjunction with DBInstanceIdentifier . This value is stored as a lowercase string.
Constraints:
The type of snapshots to be returned. You can specify one of the following values:
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:
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:
The 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.
A value that indicates whether to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore. By default, these snapshots are not included.
You can give an AWS account permission to restore a manual DB snapshot from another AWS account by using the ModifyDBSnapshotAttribute API action.
A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account. By default, the public snapshots are not included.
You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.
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
waiter = client.get_waiter('db_snapshot_deleted')
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 can't be used in conjunction with DBSnapshotIdentifier . This parameter isn't case-sensitive.
Constraints:
A specific DB snapshot identifier to describe. This parameter can't be used in conjunction with DBInstanceIdentifier . This value is stored as a lowercase string.
Constraints:
The type of snapshots to be returned. You can specify one of the following values:
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:
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:
The 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.
A value that indicates whether to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore. By default, these snapshots are not included.
You can give an AWS account permission to restore a manual DB snapshot from another AWS account by using the ModifyDBSnapshotAttribute API action.
A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account. By default, the public snapshots are not included.
You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.
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