RDS *** Client ====== class RDS.Client A low-level client representing Amazon Relational Database Service (RDS) Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. It provides cost-efficient, resizeable capacity for an industry-standard relational database and manages common database administration tasks, freeing up developers to focus on what makes their applications and businesses unique. Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, Oracle, Db2, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS is flexible: you can scale your DB instance's compute resources and storage capacity to meet your application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for the resources you use. This interface reference for Amazon RDS contains documentation for a programming or command line interface you can use to manage Amazon RDS. Amazon RDS is asynchronous, which means that some interfaces might require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. The reference structure is as follows, and we list following some related topics from the user guide. **Amazon RDS API Reference** * For the alphabetical list of API actions, see API Actions. * For the alphabetical list of data types, see Data Types. * For a list of common query parameters, see Common Parameters. * For descriptions of the error codes, see Common Errors. **Amazon RDS User Guide** * For a summary of the Amazon RDS interfaces, see Available RDS Interfaces. * For more information about how to use the Query API, see Using the Query API. import boto3 client = boto3.client('rds') These are the available methods: * add_role_to_db_cluster * add_role_to_db_instance * add_source_identifier_to_subscription * add_tags_to_resource * apply_pending_maintenance_action * authorize_db_security_group_ingress * backtrack_db_cluster * can_paginate * cancel_export_task * close * copy_db_cluster_parameter_group * copy_db_cluster_snapshot * copy_db_parameter_group * copy_db_snapshot * copy_option_group * create_blue_green_deployment * create_custom_db_engine_version * create_db_cluster * create_db_cluster_endpoint * create_db_cluster_parameter_group * create_db_cluster_snapshot * create_db_instance * create_db_instance_read_replica * create_db_parameter_group * create_db_proxy * create_db_proxy_endpoint * create_db_security_group * create_db_shard_group * create_db_snapshot * create_db_subnet_group * create_event_subscription * create_global_cluster * create_integration * create_option_group * create_tenant_database * delete_blue_green_deployment * delete_custom_db_engine_version * delete_db_cluster * delete_db_cluster_automated_backup * delete_db_cluster_endpoint * delete_db_cluster_parameter_group * delete_db_cluster_snapshot * delete_db_instance * delete_db_instance_automated_backup * delete_db_parameter_group * delete_db_proxy * delete_db_proxy_endpoint * delete_db_security_group * delete_db_shard_group * delete_db_snapshot * delete_db_subnet_group * delete_event_subscription * delete_global_cluster * delete_integration * delete_option_group * delete_tenant_database * deregister_db_proxy_targets * describe_account_attributes * describe_blue_green_deployments * describe_certificates * describe_db_cluster_automated_backups * describe_db_cluster_backtracks * describe_db_cluster_endpoints * describe_db_cluster_parameter_groups * describe_db_cluster_parameters * describe_db_cluster_snapshot_attributes * describe_db_cluster_snapshots * describe_db_clusters * describe_db_engine_versions * describe_db_instance_automated_backups * describe_db_instances * describe_db_log_files * describe_db_major_engine_versions * describe_db_parameter_groups * describe_db_parameters * describe_db_proxies * describe_db_proxy_endpoints * describe_db_proxy_target_groups * describe_db_proxy_targets * describe_db_recommendations * describe_db_security_groups * describe_db_shard_groups * describe_db_snapshot_attributes * describe_db_snapshot_tenant_databases * describe_db_snapshots * describe_db_subnet_groups * describe_engine_default_cluster_parameters * describe_engine_default_parameters * describe_event_categories * describe_event_subscriptions * describe_events * describe_export_tasks * describe_global_clusters * describe_integrations * describe_option_group_options * describe_option_groups * describe_orderable_db_instance_options * describe_pending_maintenance_actions * describe_reserved_db_instances * describe_reserved_db_instances_offerings * describe_source_regions * describe_tenant_databases * describe_valid_db_instance_modifications * disable_http_endpoint * download_db_log_file_portion * enable_http_endpoint * failover_db_cluster * failover_global_cluster * generate_db_auth_token * get_paginator * get_waiter * list_tags_for_resource * modify_activity_stream * modify_certificates * modify_current_db_cluster_capacity * modify_custom_db_engine_version * modify_db_cluster * modify_db_cluster_endpoint * modify_db_cluster_parameter_group * modify_db_cluster_snapshot_attribute * modify_db_instance * modify_db_parameter_group * modify_db_proxy * modify_db_proxy_endpoint * modify_db_proxy_target_group * modify_db_recommendation * modify_db_shard_group * modify_db_snapshot * modify_db_snapshot_attribute * modify_db_subnet_group * modify_event_subscription * modify_global_cluster * modify_integration * modify_option_group * modify_tenant_database * promote_read_replica * promote_read_replica_db_cluster * purchase_reserved_db_instances_offering * reboot_db_cluster * reboot_db_instance * reboot_db_shard_group * register_db_proxy_targets * remove_from_global_cluster * remove_role_from_db_cluster * remove_role_from_db_instance * remove_source_identifier_from_subscription * remove_tags_from_resource * reset_db_cluster_parameter_group * reset_db_parameter_group * restore_db_cluster_from_s3 * restore_db_cluster_from_snapshot * restore_db_cluster_to_point_in_time * restore_db_instance_from_db_snapshot * restore_db_instance_from_s3 * restore_db_instance_to_point_in_time * revoke_db_security_group_ingress * start_activity_stream * start_db_cluster * start_db_instance * start_db_instance_automated_backups_replication * start_export_task * stop_activity_stream * stop_db_cluster * stop_db_instance * stop_db_instance_automated_backups_replication * switchover_blue_green_deployment * switchover_global_cluster * switchover_read_replica Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * DescribeBlueGreenDeployments * DescribeCertificates * DescribeDBClusterAutomatedBackups * DescribeDBClusterBacktracks * DescribeDBClusterEndpoints * DescribeDBClusterParameterGroups * DescribeDBClusterParameters * DescribeDBClusterSnapshots * DescribeDBClusters * DescribeDBEngineVersions * DescribeDBInstanceAutomatedBackups * DescribeDBInstances * DescribeDBLogFiles * DescribeDBMajorEngineVersions * DescribeDBParameterGroups * DescribeDBParameters * DescribeDBProxies * DescribeDBProxyEndpoints * DescribeDBProxyTargetGroups * DescribeDBProxyTargets * DescribeDBRecommendations * DescribeDBSecurityGroups * DescribeDBSnapshotTenantDatabases * DescribeDBSnapshots * DescribeDBSubnetGroups * DescribeEngineDefaultClusterParameters * DescribeEngineDefaultParameters * DescribeEventSubscriptions * DescribeEvents * DescribeExportTasks * DescribeGlobalClusters * DescribeIntegrations * DescribeOptionGroupOptions * DescribeOptionGroups * DescribeOrderableDBInstanceOptions * DescribePendingMaintenanceActions * DescribeReservedDBInstances * DescribeReservedDBInstancesOfferings * DescribeSourceRegions * DescribeTenantDatabases * DownloadDBLogFilePortion Waiters ======= Waiters are available on a client instance via the "get_waiter" method. For more detailed instructions and examples on the usage or waiters, see the waiters user guide. The available waiters are: * DBClusterAvailable * DBClusterDeleted * DBClusterSnapshotAvailable * DBClusterSnapshotDeleted * DBInstanceAvailable * DBInstanceDeleted * DBSnapshotAvailable * DBSnapshotCompleted * DBSnapshotDeleted * TenantDatabaseAvailable * TenantDatabaseDeleted RDS / Waiter / DBClusterSnapshotDeleted DBClusterSnapshotDeleted ************************ class RDS.Waiter.DBClusterSnapshotDeleted waiter = client.get_waiter('db_cluster_snapshot_deleted') wait(**kwargs) Polls "RDS.Client.describe_db_cluster_snapshots()" every 30 seconds until a successful state is reached. An error is raised 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, DbClusterResourceId='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **DBClusterIdentifier** (*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: * If supplied, must match the identifier of an existing DBCluster. * **DBClusterSnapshotIdentifier** (*string*) -- 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: * If supplied, must match the identifier of an existing DBClusterSnapshot. * If this identifier is for an automated snapshot, the "SnapshotType" parameter must also be specified. * **SnapshotType** (*string*) -- The type of DB cluster snapshots to be returned. You can specify one of the following values: * "automated" - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account. * "manual" - Return all DB cluster snapshots that have been taken by my Amazon Web Services account. * "shared" - Return all manual DB cluster snapshots that have been shared to my Amazon Web Services account. * "public" - Return all DB cluster snapshots that have been marked as public. If you don't specify a "SnapshotType" value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by enabling the "IncludeShared" parameter. You can include public DB cluster snapshots with these results by enabling the "IncludePublic" parameter. The "IncludeShared" and "IncludePublic" parameters don't apply for "SnapshotType" values of "manual" or "automated". The "IncludePublic" parameter doesn't apply when "SnapshotType" is set to "shared". The "IncludeShared" parameter doesn't apply when "SnapshotType" is set to "public". * **Filters** (*list*) -- A filter that specifies one or more DB cluster snapshots to describe. Supported filters: * "db-cluster-id" - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). * "db-cluster-snapshot-id" - Accepts DB cluster snapshot identifiers. * "snapshot-type" - Accepts types of DB cluster snapshots. * "engine" - Accepts names of database engines. * *(dict) --* 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: * "DescribeDBClusterBacktracks" * "DescribeDBClusterEndpoints" * "DescribeDBClusters" * "DescribeDBInstances" * "DescribeDBRecommendations" * "DescribeDBShardGroups" * "DescribePendingMaintenanceActions" * **Name** *(string) --* **[REQUIRED]** The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* **[REQUIRED]** One or more filter values. Filter values are case- sensitive. * *(string) --* * **MaxRecords** (*integer*) -- 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. * **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". * **IncludeShared** (*boolean*) -- Specifies whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included. You can give an Amazon Web Services account permission to restore a manual DB cluster snapshot from another Amazon Web Services account by the "ModifyDBClusterSnapshotAttribute" API action. * **IncludePublic** (*boolean*) -- Specifies whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included. You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action. * **DbClusterResourceId** (*string*) -- A specific DB cluster resource ID to describe. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 30 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 60 Returns: None RDS / Waiter / DBSnapshotAvailable DBSnapshotAvailable ******************* class RDS.Waiter.DBSnapshotAvailable waiter = client.get_waiter('db_snapshot_available') wait(**kwargs) Polls "RDS.Client.describe_db_snapshots()" every 30 seconds until a successful state is reached. An error is raised 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 } ) Parameters: * **DBInstanceIdentifier** (*string*) -- The ID of the DB instance to retrieve the list of DB snapshots for. This parameter isn't case-sensitive. Constraints: * If supplied, must match the identifier of an existing DBInstance. * **DBSnapshotIdentifier** (*string*) -- A specific DB snapshot identifier to describe. This value is stored as a lowercase string. Constraints: * If supplied, must match the identifier of an existing DBSnapshot. * If this identifier is for an automated snapshot, the "SnapshotType" parameter must also be specified. * **SnapshotType** (*string*) -- The type of snapshots to be returned. You can specify one of the following values: * "automated" - Return all DB snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account. * "manual" - Return all DB snapshots that have been taken by my Amazon Web Services account. * "shared" - Return all manual DB snapshots that have been shared to my Amazon Web Services account. * "public" - Return all DB snapshots that have been marked as public. * "awsbackup" - Return the DB snapshots managed by the Amazon Web Services Backup service. For information about Amazon Web Services Backup, see the Amazon Web Services Backup Developer Guide. The "awsbackup" type does not apply to Aurora. If you don't specify a "SnapshotType" value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by enabling the "IncludeShared" parameter. You can include public snapshots with these results by enabling the "IncludePublic" parameter. The "IncludeShared" and "IncludePublic" parameters don't apply for "SnapshotType" values of "manual" or "automated". The "IncludePublic" parameter doesn't apply when "SnapshotType" is set to "shared". The "IncludeShared" parameter doesn't apply when "SnapshotType" is set to "public". * **Filters** (*list*) -- A filter that specifies one or more DB snapshots to describe. Supported filters: * "db-instance-id" - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). * "db-snapshot-id" - Accepts DB snapshot identifiers. * "dbi-resource-id" - Accepts identifiers of source DB instances. * "snapshot-type" - Accepts types of DB snapshots. * "engine" - Accepts names of database engines. * *(dict) --* 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: * "DescribeDBClusterBacktracks" * "DescribeDBClusterEndpoints" * "DescribeDBClusters" * "DescribeDBInstances" * "DescribeDBRecommendations" * "DescribeDBShardGroups" * "DescribePendingMaintenanceActions" * **Name** *(string) --* **[REQUIRED]** The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* **[REQUIRED]** One or more filter values. Filter values are case- sensitive. * *(string) --* * **MaxRecords** (*integer*) -- 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. * **Marker** (*string*) -- An optional pagination token provided by a previous "DescribeDBSnapshots" request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by "MaxRecords". * **IncludeShared** (*boolean*) -- Specifies whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included. You can give an Amazon Web Services account permission to restore a manual DB snapshot from another Amazon Web Services account by using the "ModifyDBSnapshotAttribute" API action. This setting doesn't apply to RDS Custom. * **IncludePublic** (*boolean*) -- Specifies whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included. You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API. This setting doesn't apply to RDS Custom. * **DbiResourceId** (*string*) -- A specific DB resource ID to describe. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 30 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 60 Returns: None RDS / Waiter / TenantDatabaseDeleted TenantDatabaseDeleted ********************* class RDS.Waiter.TenantDatabaseDeleted waiter = client.get_waiter('tenant_database_deleted') wait(**kwargs) Polls "RDS.Client.describe_tenant_databases()" every 30 seconds until a successful state is reached. An error is raised after 60 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( DBInstanceIdentifier='string', TenantDBName='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], Marker='string', MaxRecords=123, WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **DBInstanceIdentifier** (*string*) -- The user-supplied DB instance identifier, which must match the identifier of an existing instance owned by the Amazon Web Services account. This parameter isn't case-sensitive. * **TenantDBName** (*string*) -- The user-supplied tenant database name, which must match the name of an existing tenant database on the specified DB instance owned by your Amazon Web Services account. This parameter isn’t case- sensitive. * **Filters** (*list*) -- A filter that specifies one or more database tenants to describe. Supported filters: * "tenant-db-name" - Tenant database names. The results list only includes information about the tenant databases that match these tenant DB names. * "tenant-database-resource-id" - Tenant database resource identifiers. * "dbi-resource-id" - DB instance resource identifiers. The results list only includes information about the tenants contained within the DB instances identified by these resource identifiers. * *(dict) --* 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: * "DescribeDBClusterBacktracks" * "DescribeDBClusterEndpoints" * "DescribeDBClusters" * "DescribeDBInstances" * "DescribeDBRecommendations" * "DescribeDBShardGroups" * "DescribePendingMaintenanceActions" * **Name** *(string) --* **[REQUIRED]** The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* **[REQUIRED]** One or more filter values. Filter values are case- sensitive. * *(string) --* * **Marker** (*string*) -- An optional pagination token provided by a previous "DescribeTenantDatabases" request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by "MaxRecords". * **MaxRecords** (*integer*) -- 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. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 30 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 60 Returns: None RDS / Waiter / DBClusterSnapshotAvailable DBClusterSnapshotAvailable ************************** class RDS.Waiter.DBClusterSnapshotAvailable waiter = client.get_waiter('db_cluster_snapshot_available') wait(**kwargs) Polls "RDS.Client.describe_db_cluster_snapshots()" every 30 seconds until a successful state is reached. An error is raised 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, DbClusterResourceId='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **DBClusterIdentifier** (*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: * If supplied, must match the identifier of an existing DBCluster. * **DBClusterSnapshotIdentifier** (*string*) -- 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: * If supplied, must match the identifier of an existing DBClusterSnapshot. * If this identifier is for an automated snapshot, the "SnapshotType" parameter must also be specified. * **SnapshotType** (*string*) -- The type of DB cluster snapshots to be returned. You can specify one of the following values: * "automated" - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account. * "manual" - Return all DB cluster snapshots that have been taken by my Amazon Web Services account. * "shared" - Return all manual DB cluster snapshots that have been shared to my Amazon Web Services account. * "public" - Return all DB cluster snapshots that have been marked as public. If you don't specify a "SnapshotType" value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by enabling the "IncludeShared" parameter. You can include public DB cluster snapshots with these results by enabling the "IncludePublic" parameter. The "IncludeShared" and "IncludePublic" parameters don't apply for "SnapshotType" values of "manual" or "automated". The "IncludePublic" parameter doesn't apply when "SnapshotType" is set to "shared". The "IncludeShared" parameter doesn't apply when "SnapshotType" is set to "public". * **Filters** (*list*) -- A filter that specifies one or more DB cluster snapshots to describe. Supported filters: * "db-cluster-id" - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). * "db-cluster-snapshot-id" - Accepts DB cluster snapshot identifiers. * "snapshot-type" - Accepts types of DB cluster snapshots. * "engine" - Accepts names of database engines. * *(dict) --* 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: * "DescribeDBClusterBacktracks" * "DescribeDBClusterEndpoints" * "DescribeDBClusters" * "DescribeDBInstances" * "DescribeDBRecommendations" * "DescribeDBShardGroups" * "DescribePendingMaintenanceActions" * **Name** *(string) --* **[REQUIRED]** The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* **[REQUIRED]** One or more filter values. Filter values are case- sensitive. * *(string) --* * **MaxRecords** (*integer*) -- 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. * **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". * **IncludeShared** (*boolean*) -- Specifies whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included. You can give an Amazon Web Services account permission to restore a manual DB cluster snapshot from another Amazon Web Services account by the "ModifyDBClusterSnapshotAttribute" API action. * **IncludePublic** (*boolean*) -- Specifies whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included. You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action. * **DbClusterResourceId** (*string*) -- A specific DB cluster resource ID to describe. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 30 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 60 Returns: None RDS / Waiter / TenantDatabaseAvailable TenantDatabaseAvailable *********************** class RDS.Waiter.TenantDatabaseAvailable waiter = client.get_waiter('tenant_database_available') wait(**kwargs) Polls "RDS.Client.describe_tenant_databases()" every 30 seconds until a successful state is reached. An error is raised after 60 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( DBInstanceIdentifier='string', TenantDBName='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], Marker='string', MaxRecords=123, WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **DBInstanceIdentifier** (*string*) -- The user-supplied DB instance identifier, which must match the identifier of an existing instance owned by the Amazon Web Services account. This parameter isn't case-sensitive. * **TenantDBName** (*string*) -- The user-supplied tenant database name, which must match the name of an existing tenant database on the specified DB instance owned by your Amazon Web Services account. This parameter isn’t case- sensitive. * **Filters** (*list*) -- A filter that specifies one or more database tenants to describe. Supported filters: * "tenant-db-name" - Tenant database names. The results list only includes information about the tenant databases that match these tenant DB names. * "tenant-database-resource-id" - Tenant database resource identifiers. * "dbi-resource-id" - DB instance resource identifiers. The results list only includes information about the tenants contained within the DB instances identified by these resource identifiers. * *(dict) --* 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: * "DescribeDBClusterBacktracks" * "DescribeDBClusterEndpoints" * "DescribeDBClusters" * "DescribeDBInstances" * "DescribeDBRecommendations" * "DescribeDBShardGroups" * "DescribePendingMaintenanceActions" * **Name** *(string) --* **[REQUIRED]** The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* **[REQUIRED]** One or more filter values. Filter values are case- sensitive. * *(string) --* * **Marker** (*string*) -- An optional pagination token provided by a previous "DescribeTenantDatabases" request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by "MaxRecords". * **MaxRecords** (*integer*) -- 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. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 30 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 60 Returns: None RDS / Waiter / DBSnapshotCompleted DBSnapshotCompleted ******************* class RDS.Waiter.DBSnapshotCompleted waiter = client.get_waiter('db_snapshot_completed') wait(**kwargs) Polls "RDS.Client.describe_db_snapshots()" every 15 seconds until a successful state is reached. An error is raised 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 } ) Parameters: * **DBInstanceIdentifier** (*string*) -- The ID of the DB instance to retrieve the list of DB snapshots for. This parameter isn't case-sensitive. Constraints: * If supplied, must match the identifier of an existing DBInstance. * **DBSnapshotIdentifier** (*string*) -- A specific DB snapshot identifier to describe. This value is stored as a lowercase string. Constraints: * If supplied, must match the identifier of an existing DBSnapshot. * If this identifier is for an automated snapshot, the "SnapshotType" parameter must also be specified. * **SnapshotType** (*string*) -- The type of snapshots to be returned. You can specify one of the following values: * "automated" - Return all DB snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account. * "manual" - Return all DB snapshots that have been taken by my Amazon Web Services account. * "shared" - Return all manual DB snapshots that have been shared to my Amazon Web Services account. * "public" - Return all DB snapshots that have been marked as public. * "awsbackup" - Return the DB snapshots managed by the Amazon Web Services Backup service. For information about Amazon Web Services Backup, see the Amazon Web Services Backup Developer Guide. The "awsbackup" type does not apply to Aurora. If you don't specify a "SnapshotType" value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by enabling the "IncludeShared" parameter. You can include public snapshots with these results by enabling the "IncludePublic" parameter. The "IncludeShared" and "IncludePublic" parameters don't apply for "SnapshotType" values of "manual" or "automated". The "IncludePublic" parameter doesn't apply when "SnapshotType" is set to "shared". The "IncludeShared" parameter doesn't apply when "SnapshotType" is set to "public". * **Filters** (*list*) -- A filter that specifies one or more DB snapshots to describe. Supported filters: * "db-instance-id" - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). * "db-snapshot-id" - Accepts DB snapshot identifiers. * "dbi-resource-id" - Accepts identifiers of source DB instances. * "snapshot-type" - Accepts types of DB snapshots. * "engine" - Accepts names of database engines. * *(dict) --* 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: * "DescribeDBClusterBacktracks" * "DescribeDBClusterEndpoints" * "DescribeDBClusters" * "DescribeDBInstances" * "DescribeDBRecommendations" * "DescribeDBShardGroups" * "DescribePendingMaintenanceActions" * **Name** *(string) --* **[REQUIRED]** The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* **[REQUIRED]** One or more filter values. Filter values are case- sensitive. * *(string) --* * **MaxRecords** (*integer*) -- 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. * **Marker** (*string*) -- An optional pagination token provided by a previous "DescribeDBSnapshots" request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by "MaxRecords". * **IncludeShared** (*boolean*) -- Specifies whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included. You can give an Amazon Web Services account permission to restore a manual DB snapshot from another Amazon Web Services account by using the "ModifyDBSnapshotAttribute" API action. This setting doesn't apply to RDS Custom. * **IncludePublic** (*boolean*) -- Specifies whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included. You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API. This setting doesn't apply to RDS Custom. * **DbiResourceId** (*string*) -- A specific DB resource ID to describe. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 15 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 40 Returns: None RDS / Waiter / DBInstanceDeleted DBInstanceDeleted ***************** class RDS.Waiter.DBInstanceDeleted waiter = client.get_waiter('db_instance_deleted') wait(**kwargs) Polls "RDS.Client.describe_db_instances()" every 30 seconds until a successful state is reached. An error is raised 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 } ) Parameters: * **DBInstanceIdentifier** (*string*) -- The user-supplied instance identifier or the Amazon Resource Name (ARN) of the DB instance. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case-sensitive. Constraints: * If supplied, must match the identifier of an existing DB instance. * **Filters** (*list*) -- A filter that specifies one or more DB instances to describe. Supported Filters: * "db-cluster-id" - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB instances associated with the DB clusters identified by these ARNs. * "db-instance-id" - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list only includes information about the DB instances identified by these ARNs. * "dbi-resource-id" - Accepts DB instance resource identifiers. The results list only includes information about the DB instances identified by these DB instance resource identifiers. * "domain" - Accepts Active Directory directory IDs. The results list only includes information about the DB instances associated with these domains. * "engine" - Accepts engine names. The results list only includes information about the DB instances for these engines. * *(dict) --* 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: * "DescribeDBClusterBacktracks" * "DescribeDBClusterEndpoints" * "DescribeDBClusters" * "DescribeDBInstances" * "DescribeDBRecommendations" * "DescribeDBShardGroups" * "DescribePendingMaintenanceActions" * **Name** *(string) --* **[REQUIRED]** The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* **[REQUIRED]** One or more filter values. Filter values are case- sensitive. * *(string) --* * **MaxRecords** (*integer*) -- 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. * **Marker** (*string*) -- An optional pagination token provided by a previous "DescribeDBInstances" request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by "MaxRecords". * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 30 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 60 Returns: None RDS / Waiter / DBClusterAvailable DBClusterAvailable ****************** class RDS.Waiter.DBClusterAvailable waiter = client.get_waiter('db_cluster_available') wait(**kwargs) Polls "RDS.Client.describe_db_clusters()" every 30 seconds until a successful state is reached. An error is raised after 60 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( DBClusterIdentifier='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], MaxRecords=123, Marker='string', IncludeShared=True|False, WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **DBClusterIdentifier** (*string*) -- The user-supplied DB cluster identifier or the Amazon Resource Name (ARN) of the DB cluster. If this parameter is specified, information for only the specific DB cluster is returned. This parameter isn't case-sensitive. Constraints: * If supplied, must match an existing DB cluster identifier. * **Filters** (*list*) -- A filter that specifies one or more DB clusters to describe. Supported Filters: * "clone-group-id" - Accepts clone group identifiers. The results list only includes information about the DB clusters associated with these clone groups. * "db-cluster-id" - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB clusters identified by these ARNs. * "db-cluster-resource-id" - Accepts DB cluster resource identifiers. The results list will only include information about the DB clusters identified by these DB cluster resource identifiers. * "domain" - Accepts Active Directory directory IDs. The results list only includes information about the DB clusters associated with these domains. * "engine" - Accepts engine names. The results list only includes information about the DB clusters for these engines. * *(dict) --* 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: * "DescribeDBClusterBacktracks" * "DescribeDBClusterEndpoints" * "DescribeDBClusters" * "DescribeDBInstances" * "DescribeDBRecommendations" * "DescribeDBShardGroups" * "DescribePendingMaintenanceActions" * **Name** *(string) --* **[REQUIRED]** The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* **[REQUIRED]** One or more filter values. Filter values are case- sensitive. * *(string) --* * **MaxRecords** (*integer*) -- 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 * **Marker** (*string*) -- An optional pagination token provided by a previous "DescribeDBClusters" request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by "MaxRecords". * **IncludeShared** (*boolean*) -- Specifies whether the output includes information about clusters shared from other Amazon Web Services accounts. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 30 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 60 Returns: None RDS / Waiter / DBSnapshotDeleted DBSnapshotDeleted ***************** class RDS.Waiter.DBSnapshotDeleted waiter = client.get_waiter('db_snapshot_deleted') wait(**kwargs) Polls "RDS.Client.describe_db_snapshots()" every 30 seconds until a successful state is reached. An error is raised 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 } ) Parameters: * **DBInstanceIdentifier** (*string*) -- The ID of the DB instance to retrieve the list of DB snapshots for. This parameter isn't case-sensitive. Constraints: * If supplied, must match the identifier of an existing DBInstance. * **DBSnapshotIdentifier** (*string*) -- A specific DB snapshot identifier to describe. This value is stored as a lowercase string. Constraints: * If supplied, must match the identifier of an existing DBSnapshot. * If this identifier is for an automated snapshot, the "SnapshotType" parameter must also be specified. * **SnapshotType** (*string*) -- The type of snapshots to be returned. You can specify one of the following values: * "automated" - Return all DB snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account. * "manual" - Return all DB snapshots that have been taken by my Amazon Web Services account. * "shared" - Return all manual DB snapshots that have been shared to my Amazon Web Services account. * "public" - Return all DB snapshots that have been marked as public. * "awsbackup" - Return the DB snapshots managed by the Amazon Web Services Backup service. For information about Amazon Web Services Backup, see the Amazon Web Services Backup Developer Guide. The "awsbackup" type does not apply to Aurora. If you don't specify a "SnapshotType" value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by enabling the "IncludeShared" parameter. You can include public snapshots with these results by enabling the "IncludePublic" parameter. The "IncludeShared" and "IncludePublic" parameters don't apply for "SnapshotType" values of "manual" or "automated". The "IncludePublic" parameter doesn't apply when "SnapshotType" is set to "shared". The "IncludeShared" parameter doesn't apply when "SnapshotType" is set to "public". * **Filters** (*list*) -- A filter that specifies one or more DB snapshots to describe. Supported filters: * "db-instance-id" - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). * "db-snapshot-id" - Accepts DB snapshot identifiers. * "dbi-resource-id" - Accepts identifiers of source DB instances. * "snapshot-type" - Accepts types of DB snapshots. * "engine" - Accepts names of database engines. * *(dict) --* 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: * "DescribeDBClusterBacktracks" * "DescribeDBClusterEndpoints" * "DescribeDBClusters" * "DescribeDBInstances" * "DescribeDBRecommendations" * "DescribeDBShardGroups" * "DescribePendingMaintenanceActions" * **Name** *(string) --* **[REQUIRED]** The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* **[REQUIRED]** One or more filter values. Filter values are case- sensitive. * *(string) --* * **MaxRecords** (*integer*) -- 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. * **Marker** (*string*) -- An optional pagination token provided by a previous "DescribeDBSnapshots" request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by "MaxRecords". * **IncludeShared** (*boolean*) -- Specifies whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included. You can give an Amazon Web Services account permission to restore a manual DB snapshot from another Amazon Web Services account by using the "ModifyDBSnapshotAttribute" API action. This setting doesn't apply to RDS Custom. * **IncludePublic** (*boolean*) -- Specifies whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included. You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API. This setting doesn't apply to RDS Custom. * **DbiResourceId** (*string*) -- A specific DB resource ID to describe. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 30 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 60 Returns: None RDS / Waiter / DBInstanceAvailable DBInstanceAvailable ******************* class RDS.Waiter.DBInstanceAvailable waiter = client.get_waiter('db_instance_available') wait(**kwargs) Polls "RDS.Client.describe_db_instances()" every 30 seconds until a successful state is reached. An error is raised 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 } ) Parameters: * **DBInstanceIdentifier** (*string*) -- The user-supplied instance identifier or the Amazon Resource Name (ARN) of the DB instance. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case-sensitive. Constraints: * If supplied, must match the identifier of an existing DB instance. * **Filters** (*list*) -- A filter that specifies one or more DB instances to describe. Supported Filters: * "db-cluster-id" - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB instances associated with the DB clusters identified by these ARNs. * "db-instance-id" - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list only includes information about the DB instances identified by these ARNs. * "dbi-resource-id" - Accepts DB instance resource identifiers. The results list only includes information about the DB instances identified by these DB instance resource identifiers. * "domain" - Accepts Active Directory directory IDs. The results list only includes information about the DB instances associated with these domains. * "engine" - Accepts engine names. The results list only includes information about the DB instances for these engines. * *(dict) --* 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: * "DescribeDBClusterBacktracks" * "DescribeDBClusterEndpoints" * "DescribeDBClusters" * "DescribeDBInstances" * "DescribeDBRecommendations" * "DescribeDBShardGroups" * "DescribePendingMaintenanceActions" * **Name** *(string) --* **[REQUIRED]** The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* **[REQUIRED]** One or more filter values. Filter values are case- sensitive. * *(string) --* * **MaxRecords** (*integer*) -- 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. * **Marker** (*string*) -- An optional pagination token provided by a previous "DescribeDBInstances" request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by "MaxRecords". * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 30 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 60 Returns: None RDS / Waiter / DBClusterDeleted DBClusterDeleted **************** class RDS.Waiter.DBClusterDeleted waiter = client.get_waiter('db_cluster_deleted') wait(**kwargs) Polls "RDS.Client.describe_db_clusters()" every 30 seconds until a successful state is reached. An error is raised after 60 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( DBClusterIdentifier='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], MaxRecords=123, Marker='string', IncludeShared=True|False, WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **DBClusterIdentifier** (*string*) -- The user-supplied DB cluster identifier or the Amazon Resource Name (ARN) of the DB cluster. If this parameter is specified, information for only the specific DB cluster is returned. This parameter isn't case-sensitive. Constraints: * If supplied, must match an existing DB cluster identifier. * **Filters** (*list*) -- A filter that specifies one or more DB clusters to describe. Supported Filters: * "clone-group-id" - Accepts clone group identifiers. The results list only includes information about the DB clusters associated with these clone groups. * "db-cluster-id" - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB clusters identified by these ARNs. * "db-cluster-resource-id" - Accepts DB cluster resource identifiers. The results list will only include information about the DB clusters identified by these DB cluster resource identifiers. * "domain" - Accepts Active Directory directory IDs. The results list only includes information about the DB clusters associated with these domains. * "engine" - Accepts engine names. The results list only includes information about the DB clusters for these engines. * *(dict) --* 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: * "DescribeDBClusterBacktracks" * "DescribeDBClusterEndpoints" * "DescribeDBClusters" * "DescribeDBInstances" * "DescribeDBRecommendations" * "DescribeDBShardGroups" * "DescribePendingMaintenanceActions" * **Name** *(string) --* **[REQUIRED]** The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* **[REQUIRED]** One or more filter values. Filter values are case- sensitive. * *(string) --* * **MaxRecords** (*integer*) -- 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 * **Marker** (*string*) -- An optional pagination token provided by a previous "DescribeDBClusters" request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by "MaxRecords". * **IncludeShared** (*boolean*) -- Specifies whether the output includes information about clusters shared from other Amazon Web Services accounts. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 30 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 60 Returns: None RDS / Paginator / DescribeEngineDefaultParameters DescribeEngineDefaultParameters ******************************* class RDS.Paginator.DescribeEngineDefaultParameters paginator = client.get_paginator('describe_engine_default_parameters') paginate(**kwargs) Creates an iterator that will paginate through responses from "RDS.Client.describe_engine_default_parameters()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DBParameterGroupFamily='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DBParameterGroupFamily** (*string*) -- **[REQUIRED]** The name of the DB parameter group family. Valid Values: * "aurora-mysql5.7" * "aurora-mysql8.0" * "aurora-postgresql10" * "aurora-postgresql11" * "aurora-postgresql12" * "aurora-postgresql13" * "aurora-postgresql14" * "custom-oracle-ee-19" * "custom-oracle-ee-cdb-19" * "db2-ae" * "db2-se" * "mariadb10.2" * "mariadb10.3" * "mariadb10.4" * "mariadb10.5" * "mariadb10.6" * "mysql5.7" * "mysql8.0" * "oracle-ee-19" * "oracle-ee-cdb-19" * "oracle-ee-cdb-21" * "oracle-se2-19" * "oracle-se2-cdb-19" * "oracle-se2-cdb-21" * "postgres10" * "postgres11" * "postgres12" * "postgres13" * "postgres14" * "sqlserver-ee-11.0" * "sqlserver-ee-12.0" * "sqlserver-ee-13.0" * "sqlserver-ee-14.0" * "sqlserver-ee-15.0" * "sqlserver-ex-11.0" * "sqlserver-ex-12.0" * "sqlserver-ex-13.0" * "sqlserver-ex-14.0" * "sqlserver-ex-15.0" * "sqlserver-se-11.0" * "sqlserver-se-12.0" * "sqlserver-se-13.0" * "sqlserver-se-14.0" * "sqlserver-se-15.0" * "sqlserver-web-11.0" * "sqlserver-web-12.0" * "sqlserver-web-13.0" * "sqlserver-web-14.0" * "sqlserver-web-15.0" * **Filters** (*list*) -- A filter that specifies one or more parameters to describe. The only supported filter is "parameter-name". The results list only includes information about the parameters with these names. * *(dict) --* 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: * "DescribeDBClusterBacktracks" * "DescribeDBClusterEndpoints" * "DescribeDBClusters" * "DescribeDBInstances" * "DescribeDBRecommendations" * "DescribeDBShardGroups" * "DescribePendingMaintenanceActions" * **Name** *(string) --* **[REQUIRED]** The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* **[REQUIRED]** One or more filter values. Filter values are case- sensitive. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **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) --* The name of the parameter. * **ParameterValue** *(string) --* The value of the parameter. * **Description** *(string) --* Provides a description of the parameter. * **Source** *(string) --* 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. * *(string) --* * **NextToken** *(string) --* A token to resume pagination. RDS / Paginator / DescribeReservedDBInstances DescribeReservedDBInstances *************************** class RDS.Paginator.DescribeReservedDBInstances paginator = client.get_paginator('describe_reserved_db_instances') paginate(**kwargs) Creates an iterator that will paginate through responses from "RDS.Client.describe_reserved_db_instances()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ReservedDBInstanceId='string', ReservedDBInstancesOfferingId='string', DBInstanceClass='string', Duration='string', ProductDescription='string', OfferingType='string', MultiAZ=True|False, LeaseId='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ReservedDBInstanceId** (*string*) -- The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID. * **ReservedDBInstancesOfferingId** (*string*) -- The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier. * **DBInstanceClass** (*string*) -- The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class. * **Duration** (*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" * **ProductDescription** (*string*) -- The product description filter value. Specify this parameter to show only those reservations matching the specified product description. * **OfferingType** (*string*) -- 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"" * **MultiAZ** (*boolean*) -- Specifies whether to show only those reservations that support Multi-AZ. * **LeaseId** (*string*) -- The lease identifier filter value. Specify this parameter to show only the reservation that matches the specified lease ID. Note: Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance. * **Filters** (*list*) -- This parameter isn't currently supported. * *(dict) --* 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: * "DescribeDBClusterBacktracks" * "DescribeDBClusterEndpoints" * "DescribeDBClusters" * "DescribeDBInstances" * "DescribeDBRecommendations" * "DescribeDBShardGroups" * "DescribePendingMaintenanceActions" * **Name** *(string) --* **[REQUIRED]** The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* **[REQUIRED]** One or more filter values. Filter values are case- sensitive. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **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 whether the reservation applies to Multi-AZ deployments. * **State** *(string) --* The state of the reserved DB instance. * **RecurringCharges** *(list) --* The recurring price charged to run this reserved DB instance. * *(dict) --* This data type is used as a response element in the "DescribeReservedDBInstances" and "DescribeReservedDBInstancesOfferings" actions. * **RecurringChargeAmount** *(float) --* The amount of the recurring charge. * **RecurringChargeFrequency** *(string) --* The frequency of the recurring charge. * **ReservedDBInstanceArn** *(string) --* The Amazon Resource Name (ARN) for the reserved DB instance. * **LeaseId** *(string) --* The unique identifier for the lease associated with the reserved DB instance. Note: Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance. * **NextToken** *(string) --* A token to resume pagination. RDS / Paginator / DescribeOptionGroups DescribeOptionGroups ******************** class RDS.Paginator.DescribeOptionGroups paginator = client.get_paginator('describe_option_groups') paginate(**kwargs) Creates an iterator that will paginate through responses from "RDS.Client.describe_option_groups()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( OptionGroupName='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], EngineName='string', MajorEngineVersion='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **OptionGroupName** (*string*) -- The name of the option group to describe. Can't be supplied together with EngineName or MajorEngineVersion. * **Filters** (*list*) -- This parameter isn't currently supported. * *(dict) --* 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: * "DescribeDBClusterBacktracks" * "DescribeDBClusterEndpoints" * "DescribeDBClusters" * "DescribeDBInstances" * "DescribeDBRecommendations" * "DescribeDBShardGroups" * "DescribePendingMaintenanceActions" * **Name** *(string) --* **[REQUIRED]** The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* **[REQUIRED]** One or more filter values. Filter values are case- sensitive. * *(string) --* * **EngineName** (*string*) -- A filter to only include option groups associated with this database engine. Valid Values: * "db2-ae" * "db2-se" * "mariadb" * "mysql" * "oracle-ee" * "oracle-ee-cdb" * "oracle-se2" * "oracle-se2-cdb" * "postgres" * "sqlserver-ee" * "sqlserver-se" * "sqlserver-ex" * "sqlserver-web" * **MajorEngineVersion** (*string*) -- Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **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', 'SourceOptionGroup': 'string', 'SourceAccountId': 'string', 'CopyTimestamp': datetime(2015, 1, 1) }, ], '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) --* The details of an option. * **OptionName** *(string) --* The name of the option. * **OptionDescription** *(string) --* The description of the option. * **Persistent** *(boolean) --* Indicates whether this option is persistent. * **Permanent** *(boolean) --* Indicates whether 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) --* Indicates whether the option setting can be modified from the default. * **IsCollection** *(boolean) --* Indicates whether 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: * "ModifyDBInstance" * "RebootDBInstance" * "RestoreDBInstanceFromDBSnapshot" * "RestoreDBInstanceToPointInTime" * **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 membership status of the VPC security group. Currently, the only valid status is "active". * **AllowsVpcAndNonVpcInstanceMemberships** *(boolean) --* Indicates whether this option group can be applied to both VPC and non-VPC instances. The value "true" indicates the option group can be applied to both VPC and non-VPC instances. * **VpcId** *(string) --* If **AllowsVpcAndNonVpcInstanceMemberships** is "false", this field is blank. If **AllowsVpcAndNonVpcInstanceMemberships** is "true" and this field is blank, then this option group can be applied to both VPC and non-VPC instances. If this field contains a value, then this option group can only be applied to instances that are in the VPC indicated by this field. * **OptionGroupArn** *(string) --* Specifies the Amazon Resource Name (ARN) for the option group. * **SourceOptionGroup** *(string) --* Specifies the name of the option group from which this option group is copied. * **SourceAccountId** *(string) --* Specifies the Amazon Web Services account ID for the option group from which this option group is copied. * **CopyTimestamp** *(datetime) --* Indicates when the option group was copied. * **NextToken** *(string) --* A token to resume pagination. RDS / Paginator / DescribeBlueGreenDeployments DescribeBlueGreenDeployments **************************** class RDS.Paginator.DescribeBlueGreenDeployments paginator = client.get_paginator('describe_blue_green_deployments') paginate(**kwargs) Creates an iterator that will paginate through responses from "RDS.Client.describe_blue_green_deployments()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( BlueGreenDeploymentIdentifier='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **BlueGreenDeploymentIdentifier** (*string*) -- The blue/green deployment identifier. If you specify this parameter, the response only includes information about the specific blue/green deployment. This parameter isn't case- sensitive. Constraints: * Must match an existing blue/green deployment identifier. * **Filters** (*list*) -- A filter that specifies one or more blue/green deployments to describe. Valid Values: * "blue-green-deployment-identifier" - Accepts system- generated identifiers for blue/green deployments. The results list only includes information about the blue/green deployments with the specified identifiers. * "blue-green-deployment-name" - Accepts user-supplied names for blue/green deployments. The results list only includes information about the blue/green deployments with the specified names. * "source" - Accepts source databases for a blue/green deployment. The results list only includes information about the blue/green deployments with the specified source databases. * "target" - Accepts target databases for a blue/green deployment. The results list only includes information about the blue/green deployments with the specified target databases. * *(dict) --* 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: * "DescribeDBClusterBacktracks" * "DescribeDBClusterEndpoints" * "DescribeDBClusters" * "DescribeDBInstances" * "DescribeDBRecommendations" * "DescribeDBShardGroups" * "DescribePendingMaintenanceActions" * **Name** *(string) --* **[REQUIRED]** The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* **[REQUIRED]** One or more filter values. Filter values are case- sensitive. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'BlueGreenDeployments': [ { 'BlueGreenDeploymentIdentifier': 'string', 'BlueGreenDeploymentName': 'string', 'Source': 'string', 'Target': 'string', 'SwitchoverDetails': [ { 'SourceMember': 'string', 'TargetMember': 'string', 'Status': 'string' }, ], 'Tasks': [ { 'Name': 'string', 'Status': 'string' }, ], 'Status': 'string', 'StatusDetails': 'string', 'CreateTime': datetime(2015, 1, 1), 'DeleteTime': datetime(2015, 1, 1), 'TagList': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **BlueGreenDeployments** *(list) --* A list of blue/green deployments in the current account and Amazon Web Services Region. * *(dict) --* Details about a blue/green deployment. For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the *Amazon RDS User Guide* and Using Amazon RDS Blue/Green Deployments for database updates in the *Amazon Aurora User Guide*. * **BlueGreenDeploymentIdentifier** *(string) --* The unique identifier of the blue/green deployment. * **BlueGreenDeploymentName** *(string) --* The user-supplied name of the blue/green deployment. * **Source** *(string) --* The source database for the blue/green deployment. Before switchover, the source database is the production database in the blue environment. * **Target** *(string) --* The target database for the blue/green deployment. Before switchover, the target database is the clone database in the green environment. * **SwitchoverDetails** *(list) --* The details about each source and target resource in the blue/green deployment. * *(dict) --* Contains the details about a blue/green deployment. For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the *Amazon RDS User Guide* and Using Amazon RDS Blue/Green Deployments for database updates in the *Amazon Aurora User Guide*. * **SourceMember** *(string) --* The Amazon Resource Name (ARN) of a resource in the blue environment. * **TargetMember** *(string) --* The Amazon Resource Name (ARN) of a resource in the green environment. * **Status** *(string) --* The switchover status of a resource in a blue/green deployment. Values: * "PROVISIONING" - The resource is being prepared to switch over. * "AVAILABLE" - The resource is ready to switch over. * "SWITCHOVER_IN_PROGRESS" - The resource is being switched over. * "SWITCHOVER_COMPLETED" - The resource has been switched over. * "SWITCHOVER_FAILED" - The resource attempted to switch over but failed. * "MISSING_SOURCE" - The source resource has been deleted. * "MISSING_TARGET" - The target resource has been deleted. * **Tasks** *(list) --* Either tasks to be performed or tasks that have been completed on the target database before switchover. * *(dict) --* Details about a task for a blue/green deployment. For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the *Amazon RDS User Guide* and Using Amazon RDS Blue/Green Deployments for database updates in the *Amazon Aurora User Guide*. * **Name** *(string) --* The name of the blue/green deployment task. * **Status** *(string) --* The status of the blue/green deployment task. Valid Values: * "PENDING" - The resource is being prepared for deployment. * "IN_PROGRESS" - The resource is being deployed. * "COMPLETED" - The resource has been deployed. * "FAILED" - Deployment of the resource failed. * **Status** *(string) --* The status of the blue/green deployment. Valid Values: * "PROVISIONING" - Resources are being created in the green environment. * "AVAILABLE" - Resources are available in the green environment. * "SWITCHOVER_IN_PROGRESS" - The deployment is being switched from the blue environment to the green environment. * "SWITCHOVER_COMPLETED" - Switchover from the blue environment to the green environment is complete. * "INVALID_CONFIGURATION" - Resources in the green environment are invalid, so switchover isn't possible. * "SWITCHOVER_FAILED" - Switchover was attempted but failed. * "DELETING" - The blue/green deployment is being deleted. * **StatusDetails** *(string) --* Additional information about the status of the blue/green deployment. * **CreateTime** *(datetime) --* The time when the blue/green deployment was created, in Universal Coordinated Time (UTC). * **DeleteTime** *(datetime) --* The time when the blue/green deployment was deleted, in Universal Coordinated Time (UTC). * **TagList** *(list) --* A list of tags. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **Key** *(string) --* A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **Value** *(string) --* A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white- space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **NextToken** *(string) --* A token to resume pagination. RDS / Paginator / DescribeTenantDatabases DescribeTenantDatabases *********************** class RDS.Paginator.DescribeTenantDatabases paginator = client.get_paginator('describe_tenant_databases') paginate(**kwargs) Creates an iterator that will paginate through responses from "RDS.Client.describe_tenant_databases()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DBInstanceIdentifier='string', TenantDBName='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DBInstanceIdentifier** (*string*) -- The user-supplied DB instance identifier, which must match the identifier of an existing instance owned by the Amazon Web Services account. This parameter isn't case-sensitive. * **TenantDBName** (*string*) -- The user-supplied tenant database name, which must match the name of an existing tenant database on the specified DB instance owned by your Amazon Web Services account. This parameter isn’t case- sensitive. * **Filters** (*list*) -- A filter that specifies one or more database tenants to describe. Supported filters: * "tenant-db-name" - Tenant database names. The results list only includes information about the tenant databases that match these tenant DB names. * "tenant-database-resource-id" - Tenant database resource identifiers. * "dbi-resource-id" - DB instance resource identifiers. The results list only includes information about the tenants contained within the DB instances identified by these resource identifiers. * *(dict) --* 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: * "DescribeDBClusterBacktracks" * "DescribeDBClusterEndpoints" * "DescribeDBClusters" * "DescribeDBInstances" * "DescribeDBRecommendations" * "DescribeDBShardGroups" * "DescribePendingMaintenanceActions" * **Name** *(string) --* **[REQUIRED]** The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* **[REQUIRED]** One or more filter values. Filter values are case- sensitive. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'TenantDatabases': [ { 'TenantDatabaseCreateTime': datetime(2015, 1, 1), 'DBInstanceIdentifier': 'string', 'TenantDBName': 'string', 'Status': 'string', 'MasterUsername': 'string', 'DbiResourceId': 'string', 'TenantDatabaseResourceId': 'string', 'TenantDatabaseARN': 'string', 'CharacterSetName': 'string', 'NcharCharacterSetName': 'string', 'DeletionProtection': True|False, 'PendingModifiedValues': { 'MasterUserPassword': 'string', 'TenantDBName': 'string' }, 'MasterUserSecret': { 'SecretArn': 'string', 'SecretStatus': 'string', 'KmsKeyId': 'string' }, 'TagList': [ { 'Key': 'string', 'Value': 'string' }, ] }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **TenantDatabases** *(list) --* An array of the tenant databases requested by the "DescribeTenantDatabases" operation. * *(dict) --* A tenant database in the DB instance. This data type is an element in the response to the "DescribeTenantDatabases" action. * **TenantDatabaseCreateTime** *(datetime) --* The creation time of the tenant database. * **DBInstanceIdentifier** *(string) --* The ID of the DB instance that contains the tenant database. * **TenantDBName** *(string) --* The database name of the tenant database. * **Status** *(string) --* The status of the tenant database. * **MasterUsername** *(string) --* The master username of the tenant database. * **DbiResourceId** *(string) --* The Amazon Web Services Region-unique, immutable identifier for the DB instance. * **TenantDatabaseResourceId** *(string) --* The Amazon Web Services Region-unique, immutable identifier for the tenant database. * **TenantDatabaseARN** *(string) --* The Amazon Resource Name (ARN) for the tenant database. * **CharacterSetName** *(string) --* The character set of the tenant database. * **NcharCharacterSetName** *(string) --* The "NCHAR" character set name of the tenant database. * **DeletionProtection** *(boolean) --* Specifies whether deletion protection is enabled for the DB instance. * **PendingModifiedValues** *(dict) --* Information about pending changes for a tenant database. * **MasterUserPassword** *(string) --* The master password for the tenant database. * **TenantDBName** *(string) --* The name of the tenant database. * **MasterUserSecret** *(dict) --* Contains the secret managed by RDS in Amazon Web Services Secrets Manager for the master user password. For more information, see Password management with Amazon Web Services Secrets Manager in the *Amazon RDS User Guide* and Password management with Amazon Web Services Secrets Manager in the *Amazon Aurora User Guide.* * **SecretArn** *(string) --* The Amazon Resource Name (ARN) of the secret. * **SecretStatus** *(string) --* The status of the secret. The possible status values include the following: * "creating" - The secret is being created. * "active" - The secret is available for normal use and rotation. * "rotating" - The secret is being rotated. * "impaired" - The secret can be used to access database credentials, but it can't be rotated. A secret might have this status if, for example, permissions are changed so that RDS can no longer access either the secret or the KMS key for the secret. When a secret has this status, you can correct the condition that caused the status. Alternatively, modify the DB instance to turn off automatic management of database credentials, and then modify the DB instance again to turn on automatic management of database credentials. * **KmsKeyId** *(string) --* The Amazon Web Services KMS key identifier that is used to encrypt the secret. * **TagList** *(list) --* A list of tags. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **Key** *(string) --* A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **Value** *(string) --* A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white- space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **NextToken** *(string) --* A token to resume pagination. RDS / Paginator / DescribeExportTasks DescribeExportTasks ******************* class RDS.Paginator.DescribeExportTasks paginator = client.get_paginator('describe_export_tasks') paginate(**kwargs) Creates an iterator that will paginate through responses from "RDS.Client.describe_export_tasks()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ExportTaskIdentifier='string', SourceArn='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], SourceType='SNAPSHOT'|'CLUSTER', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ExportTaskIdentifier** (*string*) -- The identifier of the snapshot or cluster export task to be described. * **SourceArn** (*string*) -- The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3. * **Filters** (*list*) -- Filters specify one or more snapshot or cluster exports to describe. The filters are specified as name-value pairs that define what to include in the output. Filter names and values are case-sensitive. Supported filters include the following: * "export-task-identifier" - An identifier for the snapshot or cluster export task. * "s3-bucket" - The Amazon S3 bucket the data is exported to. * "source-arn" - The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3. * "status" - The status of the export task. Must be lowercase. Valid statuses are the following: * "canceled" * "canceling" * "complete" * "failed" * "in_progress" * "starting" * *(dict) --* 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: * "DescribeDBClusterBacktracks" * "DescribeDBClusterEndpoints" * "DescribeDBClusters" * "DescribeDBInstances" * "DescribeDBRecommendations" * "DescribeDBShardGroups" * "DescribePendingMaintenanceActions" * **Name** *(string) --* **[REQUIRED]** The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* **[REQUIRED]** One or more filter values. Filter values are case- sensitive. * *(string) --* * **SourceType** (*string*) -- The type of source for the export. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'ExportTasks': [ { 'ExportTaskIdentifier': 'string', 'SourceArn': 'string', 'ExportOnly': [ 'string', ], 'SnapshotTime': datetime(2015, 1, 1), 'TaskStartTime': datetime(2015, 1, 1), 'TaskEndTime': datetime(2015, 1, 1), 'S3Bucket': 'string', 'S3Prefix': 'string', 'IamRoleArn': 'string', 'KmsKeyId': 'string', 'Status': 'string', 'PercentProgress': 123, 'TotalExtractedDataInGB': 123, 'FailureCause': 'string', 'WarningMessage': 'string', 'SourceType': 'SNAPSHOT'|'CLUSTER' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **ExportTasks** *(list) --* Information about an export of a snapshot or cluster to Amazon S3. * *(dict) --* Contains the details of a snapshot or cluster export to Amazon S3. This data type is used as a response element in the "DescribeExportTasks" operation. * **ExportTaskIdentifier** *(string) --* A unique identifier for the snapshot or cluster export task. This ID isn't an identifier for the Amazon S3 bucket where the data is exported. * **SourceArn** *(string) --* The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3. * **ExportOnly** *(list) --* The data exported from the snapshot or cluster. Valid Values: * "database" - Export all the data from a specified database. * "database.table" *table-name* - Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL. * "database.schema" *schema-name* - Export a database schema of the snapshot or cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL. * "database.schema.table" *table-name* - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL. * *(string) --* * **SnapshotTime** *(datetime) --* The time when the snapshot was created. * **TaskStartTime** *(datetime) --* The time when the snapshot or cluster export task started. * **TaskEndTime** *(datetime) --* The time when the snapshot or cluster export task ended. * **S3Bucket** *(string) --* The Amazon S3 bucket where the snapshot or cluster is exported to. * **S3Prefix** *(string) --* The Amazon S3 bucket prefix that is the file name and path of the exported data. * **IamRoleArn** *(string) --* The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot or cluster. * **KmsKeyId** *(string) --* The key identifier of the Amazon Web Services KMS key that is used to encrypt the data when it's exported to Amazon S3. The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the export must have encryption and decryption permissions to use this KMS key. * **Status** *(string) --* The progress status of the export task. The status can be one of the following: * "CANCELED" * "CANCELING" * "COMPLETE" * "FAILED" * "IN_PROGRESS" * "STARTING" * **PercentProgress** *(integer) --* The progress of the snapshot or cluster export task as a percentage. * **TotalExtractedDataInGB** *(integer) --* The total amount of data exported, in gigabytes. * **FailureCause** *(string) --* The reason the export failed, if it failed. * **WarningMessage** *(string) --* A warning about the snapshot or cluster export task. * **SourceType** *(string) --* The type of source for the export. * **NextToken** *(string) --* A token to resume pagination. RDS / Paginator / DescribeDBSubnetGroups DescribeDBSubnetGroups ********************** class RDS.Paginator.DescribeDBSubnetGroups paginator = client.get_paginator('describe_db_subnet_groups') paginate(**kwargs) Creates an iterator that will paginate through responses from "RDS.Client.describe_db_subnet_groups()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DBSubnetGroupName='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DBSubnetGroupName** (*string*) -- The name of the DB subnet group to return details for. * **Filters** (*list*) -- This parameter isn't currently supported. * *(dict) --* 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: * "DescribeDBClusterBacktracks" * "DescribeDBClusterEndpoints" * "DescribeDBClusters" * "DescribeDBInstances" * "DescribeDBRecommendations" * "DescribeDBShardGroups" * "DescribePendingMaintenanceActions" * **Name** *(string) --* **[REQUIRED]** The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* **[REQUIRED]** One or more filter values. Filter values are case- sensitive. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'DBSubnetGroups': [ { 'DBSubnetGroupName': 'string', 'DBSubnetGroupDescription': 'string', 'VpcId': 'string', 'SubnetGroupStatus': 'string', 'Subnets': [ { 'SubnetIdentifier': 'string', 'SubnetAvailabilityZone': { 'Name': 'string' }, 'SubnetOutpost': { 'Arn': 'string' }, 'SubnetStatus': 'string' }, ], 'DBSubnetGroupArn': 'string', 'SupportedNetworkTypes': [ 'string', ] }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* Contains the result of a successful invocation of the "DescribeDBSubnetGroups" action. * **DBSubnetGroups** *(list) --* A list of "DBSubnetGroup" instances. * *(dict) --* Contains the details of an Amazon RDS DB subnet group. This data type is used as a response element in the "DescribeDBSubnetGroups" action. * **DBSubnetGroupName** *(string) --* The name of the DB subnet group. * **DBSubnetGroupDescription** *(string) --* Provides the description of the DB subnet group. * **VpcId** *(string) --* Provides the VpcId of the DB subnet group. * **SubnetGroupStatus** *(string) --* Provides the status of the DB subnet group. * **Subnets** *(list) --* Contains a list of "Subnet" elements. The list of subnets shown here might not reflect the current state of your VPC. For the most up-to-date information, we recommend checking your VPC configuration directly. * *(dict) --* This data type is used as a response element for the "DescribeDBSubnetGroups" operation. * **SubnetIdentifier** *(string) --* The identifier of the subnet. * **SubnetAvailabilityZone** *(dict) --* Contains Availability Zone information. This data type is used as an element in the "OrderableDBInstanceOption" data type. * **Name** *(string) --* The name of the Availability Zone. * **SubnetOutpost** *(dict) --* If the subnet is associated with an Outpost, this value specifies the Outpost. For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the *Amazon RDS User Guide.* * **Arn** *(string) --* The Amazon Resource Name (ARN) of the Outpost. * **SubnetStatus** *(string) --* The status of the subnet. * **DBSubnetGroupArn** *(string) --* The Amazon Resource Name (ARN) for the DB subnet group. * **SupportedNetworkTypes** *(list) --* The network type of the DB subnet group. Valid values: * "IPV4" * "DUAL" A "DBSubnetGroup" can support only the IPv4 protocol or the IPv4 and the IPv6 protocols ( "DUAL"). For more information, see Working with a DB instance in a VPC in the *Amazon RDS User Guide.* * *(string) --* * **NextToken** *(string) --* A token to resume pagination. RDS / Paginator / DescribeDBClusterEndpoints DescribeDBClusterEndpoints ************************** class RDS.Paginator.DescribeDBClusterEndpoints paginator = client.get_paginator('describe_db_cluster_endpoints') paginate(**kwargs) Creates an iterator that will paginate through responses from "RDS.Client.describe_db_cluster_endpoints()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DBClusterIdentifier='string', DBClusterEndpointIdentifier='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DBClusterIdentifier** (*string*) -- The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string. * **DBClusterEndpointIdentifier** (*string*) -- The identifier of the endpoint to describe. This parameter is stored as a lowercase string. * **Filters** (*list*) -- 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=endp oint_type1,endpoint_type2,...". "Name" can be one of: "db- cluster-endpoint-type", "db-cluster-endpoint-custom-type", "db-cluster-endpoint-id", "db-cluster-endpoint-status". "Values" for the "db-cluster-endpoint-type" filter can be one or more of: "reader", "writer", "custom". "Values" for the "db-cluster-endpoint-custom-type" filter can be one or more of: "reader", "any". "Values" for the "db-cluster- endpoint-status" filter can be one or more of: "available", "creating", "deleting", "inactive", "modifying". * *(dict) --* 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: * "DescribeDBClusterBacktracks" * "DescribeDBClusterEndpoints" * "DescribeDBClusters" * "DescribeDBInstances" * "DescribeDBRecommendations" * "DescribeDBShardGroups" * "DescribePendingMaintenanceActions" * **Name** *(string) --* **[REQUIRED]** The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* **[REQUIRED]** One or more filter values. Filter values are case- sensitive. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **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: * "CreateDBClusterEndpoint" * "DescribeDBClusterEndpoints" * "ModifyDBClusterEndpoint" * "DeleteDBClusterEndpoint" 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", "inactive", "modifying". The "inactive" state applies to an endpoint that can't be used for a certain kind of cluster, such as a "writer" endpoint for a read-only secondary cluster in a global database. * **EndpointType** *(string) --* The type of the endpoint. One of: "READER", "WRITER", "CUSTOM". * **CustomEndpointType** *(string) --* The type associated with a custom endpoint. One of: "READER", "WRITER", "ANY". * **StaticMembers** *(list) --* List of DB instance identifiers that are part of the custom endpoint group. * *(string) --* * **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. * *(string) --* * **DBClusterEndpointArn** *(string) --* The Amazon Resource Name (ARN) for the endpoint. * **NextToken** *(string) --* A token to resume pagination. RDS / Paginator / DescribeEventSubscriptions DescribeEventSubscriptions ************************** class RDS.Paginator.DescribeEventSubscriptions paginator = client.get_paginator('describe_event_subscriptions') paginate(**kwargs) Creates an iterator that will paginate through responses from "RDS.Client.describe_event_subscriptions()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( SubscriptionName='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **SubscriptionName** (*string*) -- The name of the RDS event notification subscription you want to describe. * **Filters** (*list*) -- This parameter isn't currently supported. * *(dict) --* 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: * "DescribeDBClusterBacktracks" * "DescribeDBClusterEndpoints" * "DescribeDBClusters" * "DescribeDBInstances" * "DescribeDBRecommendations" * "DescribeDBShardGroups" * "DescribePendingMaintenanceActions" * **Name** *(string) --* **[REQUIRED]** The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* **[REQUIRED]** One or more filter values. Filter values are case- sensitive. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'EventSubscriptionsList': [ { 'CustomerAwsId': 'string', 'CustSubscriptionId': 'string', 'SnsTopicArn': 'string', 'Status': 'string', 'SubscriptionCreationTime': 'string', 'SourceType': 'string', 'SourceIdsList': [ 'string', ], 'EventCategoriesList': [ 'string', ], 'Enabled': True|False, 'EventSubscriptionArn': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* Data returned by the **DescribeEventSubscriptions** action. * **EventSubscriptionsList** *(list) --* A list of EventSubscriptions data types. * *(dict) --* Contains the results of a successful invocation of the "DescribeEventSubscriptions" action. * **CustomerAwsId** *(string) --* The Amazon Web Services customer account associated with the RDS event notification subscription. * **CustSubscriptionId** *(string) --* The RDS event notification subscription Id. * **SnsTopicArn** *(string) --* The topic ARN of the RDS event notification subscription. * **Status** *(string) --* The status of the RDS event notification subscription. Constraints: Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist The status "no-permission" indicates that RDS no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created. * **SubscriptionCreationTime** *(string) --* The time the RDS event notification subscription was created. * **SourceType** *(string) --* The source type for the RDS event notification subscription. * **SourceIdsList** *(list) --* A list of source IDs for the RDS event notification subscription. * *(string) --* * **EventCategoriesList** *(list) --* A list of event categories for the RDS event notification subscription. * *(string) --* * **Enabled** *(boolean) --* Specifies whether the subscription is enabled. True indicates the subscription is enabled. * **EventSubscriptionArn** *(string) --* The Amazon Resource Name (ARN) for the event subscription. * **NextToken** *(string) --* A token to resume pagination. RDS / Paginator / DescribeDBInstanceAutomatedBackups DescribeDBInstanceAutomatedBackups ********************************** class RDS.Paginator.DescribeDBInstanceAutomatedBackups paginator = client.get_paginator('describe_db_instance_automated_backups') paginate(**kwargs) Creates an iterator that will paginate through responses from "RDS.Client.describe_db_instance_automated_backups()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DbiResourceId='string', DBInstanceIdentifier='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], DBInstanceAutomatedBackupsArn='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DbiResourceId** (*string*) -- The resource ID of the DB instance that is the source of the automated backup. This parameter isn't case-sensitive. * **DBInstanceIdentifier** (*string*) -- (Optional) The user- supplied instance identifier. If this parameter is specified, it must match the identifier of an existing DB instance. It returns information from the specific DB instance's automated backup. This parameter isn't case- sensitive. * **Filters** (*list*) -- A filter that specifies which resources to return based on status. Supported filters are the following: * "status" * "active" - Automated backups for current instances. * "creating" - Automated backups that are waiting for the first automated snapshot to be available. * "retained" - Automated backups for deleted instances and after backup replication is stopped. * "db-instance-id" - Accepts DB instance identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance automated backups identified by these ARNs. * "dbi-resource-id" - Accepts DB resource identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance resources identified by these ARNs. Returns all resources by default. The status for each resource is specified in the response. * *(dict) --* 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: * "DescribeDBClusterBacktracks" * "DescribeDBClusterEndpoints" * "DescribeDBClusters" * "DescribeDBInstances" * "DescribeDBRecommendations" * "DescribeDBShardGroups" * "DescribePendingMaintenanceActions" * **Name** *(string) --* **[REQUIRED]** The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* **[REQUIRED]** One or more filter values. Filter values are case- sensitive. * *(string) --* * **DBInstanceAutomatedBackupsArn** (*string*) -- The Amazon Resource Name (ARN) of the replicated automated backups, for example, "arn:aws:rds:us-east-1:123456789012 :auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE". This setting doesn't apply to RDS Custom. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'DBInstanceAutomatedBackups': [ { 'DBInstanceArn': 'string', 'DbiResourceId': 'string', 'Region': 'string', 'DBInstanceIdentifier': 'string', 'RestoreWindow': { 'EarliestTime': datetime(2015, 1, 1), 'LatestTime': datetime(2015, 1, 1) }, 'AllocatedStorage': 123, 'Status': 'string', 'Port': 123, 'AvailabilityZone': 'string', 'VpcId': 'string', 'InstanceCreateTime': datetime(2015, 1, 1), 'MasterUsername': 'string', 'Engine': 'string', 'EngineVersion': 'string', 'LicenseModel': 'string', 'Iops': 123, 'OptionGroupName': 'string', 'TdeCredentialArn': 'string', 'Encrypted': True|False, 'StorageType': 'string', 'KmsKeyId': 'string', 'Timezone': 'string', 'IAMDatabaseAuthenticationEnabled': True|False, 'BackupRetentionPeriod': 123, 'DBInstanceAutomatedBackupsArn': 'string', 'DBInstanceAutomatedBackupsReplications': [ { 'DBInstanceAutomatedBackupsArn': 'string' }, ], 'BackupTarget': 'string', 'StorageThroughput': 123, 'AwsBackupRecoveryPointArn': 'string', 'DedicatedLogVolume': True|False, 'MultiTenant': 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 consists of system backups, transaction logs, and the database instance properties that existed at the time you deleted the source instance. * **DBInstanceArn** *(string) --* The Amazon Resource Name (ARN) for the automated backups. * **DbiResourceId** *(string) --* The resource ID for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region. * **Region** *(string) --* The Amazon Web Services Region associated with the automated backup. * **DBInstanceIdentifier** *(string) --* The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region. * **RestoreWindow** *(dict) --* The earliest and latest time a DB 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) --* The allocated storage size for the the automated backup in gibibytes (GiB). * **Status** *(string) --* A list of status information for an automated backup: * "active" - Automated backups for current instances. * "retained" - Automated backups for deleted instances. * "creating" - Automated backups that are waiting for the first automated snapshot to be available. * **Port** *(integer) --* The port number that the automated backup used for connections. Default: Inherits from the source DB instance Valid Values: "1150-65535" * **AvailabilityZone** *(string) --* The Availability Zone that the automated backup was created in. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones. * **VpcId** *(string) --* The VPC ID associated with the DB instance. * **InstanceCreateTime** *(datetime) --* The date and time when the DB instance was created. * **MasterUsername** *(string) --* The master user name 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) --* The 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) --* Indicates whether the automated backup is encrypted. * **StorageType** *(string) --* The storage type associated with the automated backup. * **KmsKeyId** *(string) --* The Amazon Web Services KMS key ID for an automated backup. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. * **Timezone** *(string) --* The time zone of the automated backup. In most cases, the "Timezone" element is empty. "Timezone" content appears only for Microsoft SQL Server DB instances that were created with a time zone specified. * **IAMDatabaseAuthenticationEnabled** *(boolean) --* True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false. * **BackupRetentionPeriod** *(integer) --* The retention period for the automated backups. * **DBInstanceAutomatedBackupsArn** *(string) --* The Amazon Resource Name (ARN) for the replicated automated backups. * **DBInstanceAutomatedBackupsReplications** *(list) --* The list of replications to different Amazon Web Services Regions associated with the automated backup. * *(dict) --* Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties. * **DBInstanceAutomatedBackupsArn** *(string) --* The Amazon Resource Name (ARN) of the replicated automated backups. * **BackupTarget** *(string) --* The location where automated backups are stored: Dedicated Local Zones, Amazon Web Services Outposts or the Amazon Web Services Region. * **StorageThroughput** *(integer) --* The storage throughput for the automated backup. * **AwsBackupRecoveryPointArn** *(string) --* The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup. * **DedicatedLogVolume** *(boolean) --* Indicates whether the DB instance has a dedicated log volume (DLV) enabled. * **MultiTenant** *(boolean) --* Specifies whether the automatic backup is for a DB instance in the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE). * **NextToken** *(string) --* A token to resume pagination. RDS / Paginator / DescribeDBClusterSnapshots DescribeDBClusterSnapshots ************************** class RDS.Paginator.DescribeDBClusterSnapshots paginator = client.get_paginator('describe_db_cluster_snapshots') paginate(**kwargs) Creates an iterator that will paginate through responses from "RDS.Client.describe_db_cluster_snapshots()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DBClusterIdentifier='string', DBClusterSnapshotIdentifier='string', SnapshotType='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], IncludeShared=True|False, IncludePublic=True|False, DbClusterResourceId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DBClusterIdentifier** (*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: * If supplied, must match the identifier of an existing DBCluster. * **DBClusterSnapshotIdentifier** (*string*) -- 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: * If supplied, must match the identifier of an existing DBClusterSnapshot. * If this identifier is for an automated snapshot, the "SnapshotType" parameter must also be specified. * **SnapshotType** (*string*) -- The type of DB cluster snapshots to be returned. You can specify one of the following values: * "automated" - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account. * "manual" - Return all DB cluster snapshots that have been taken by my Amazon Web Services account. * "shared" - Return all manual DB cluster snapshots that have been shared to my Amazon Web Services account. * "public" - Return all DB cluster snapshots that have been marked as public. If you don't specify a "SnapshotType" value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by enabling the "IncludeShared" parameter. You can include public DB cluster snapshots with these results by enabling the "IncludePublic" parameter. The "IncludeShared" and "IncludePublic" parameters don't apply for "SnapshotType" values of "manual" or "automated". The "IncludePublic" parameter doesn't apply when "SnapshotType" is set to "shared". The "IncludeShared" parameter doesn't apply when "SnapshotType" is set to "public". * **Filters** (*list*) -- A filter that specifies one or more DB cluster snapshots to describe. Supported filters: * "db-cluster-id" - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). * "db-cluster-snapshot-id" - Accepts DB cluster snapshot identifiers. * "snapshot-type" - Accepts types of DB cluster snapshots. * "engine" - Accepts names of database engines. * *(dict) --* 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: * "DescribeDBClusterBacktracks" * "DescribeDBClusterEndpoints" * "DescribeDBClusters" * "DescribeDBInstances" * "DescribeDBRecommendations" * "DescribeDBShardGroups" * "DescribePendingMaintenanceActions" * **Name** *(string) --* **[REQUIRED]** The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* **[REQUIRED]** One or more filter values. Filter values are case- sensitive. * *(string) --* * **IncludeShared** (*boolean*) -- Specifies whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included. You can give an Amazon Web Services account permission to restore a manual DB cluster snapshot from another Amazon Web Services account by the "ModifyDBClusterSnapshotAttribute" API action. * **IncludePublic** (*boolean*) -- Specifies whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included. You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action. * **DbClusterResourceId** (*string*) -- A specific DB cluster resource ID to describe. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'DBClusterSnapshots': [ { 'AvailabilityZones': [ 'string', ], 'DBClusterSnapshotIdentifier': 'string', 'DBClusterIdentifier': 'string', 'SnapshotCreateTime': datetime(2015, 1, 1), 'Engine': 'string', 'EngineMode': 'string', 'AllocatedStorage': 123, 'Status': 'string', 'Port': 123, 'VpcId': 'string', 'ClusterCreateTime': datetime(2015, 1, 1), 'MasterUsername': 'string', 'EngineVersion': 'string', 'LicenseModel': 'string', 'SnapshotType': 'string', 'PercentProgress': 123, 'StorageEncrypted': True|False, 'KmsKeyId': 'string', 'DBClusterSnapshotArn': 'string', 'SourceDBClusterSnapshotArn': 'string', 'IAMDatabaseAuthenticationEnabled': True|False, 'TagList': [ { 'Key': 'string', 'Value': 'string' }, ], 'DBSystemId': 'string', 'StorageType': 'string', 'DbClusterResourceId': 'string', 'StorageThroughput': 123 }, ], '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) --* The list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored. * *(string) --* * **DBClusterSnapshotIdentifier** *(string) --* The identifier for the DB cluster snapshot. * **DBClusterIdentifier** *(string) --* The DB cluster identifier of the DB cluster that this DB cluster snapshot was created from. * **SnapshotCreateTime** *(datetime) --* The time when the snapshot was taken, in Universal Coordinated Time (UTC). * **Engine** *(string) --* The name of the database engine for this DB cluster snapshot. * **EngineMode** *(string) --* The engine mode of the database engine for this DB cluster snapshot. * **AllocatedStorage** *(integer) --* The allocated storage size of the DB cluster snapshot in gibibytes (GiB). * **Status** *(string) --* The status of this DB cluster snapshot. Valid statuses are the following: * "available" * "copying" * "creating" * **Port** *(integer) --* The port that the DB cluster was listening on at the time of the snapshot. * **VpcId** *(string) --* The VPC ID associated with the DB cluster snapshot. * **ClusterCreateTime** *(datetime) --* The time when the DB cluster was created, in Universal Coordinated Time (UTC). * **MasterUsername** *(string) --* The master username for this DB cluster snapshot. * **EngineVersion** *(string) --* The version of the database engine for this DB cluster snapshot. * **LicenseModel** *(string) --* The license model information for this DB cluster snapshot. * **SnapshotType** *(string) --* The type of the DB cluster snapshot. * **PercentProgress** *(integer) --* The percentage of the estimated data that has been transferred. * **StorageEncrypted** *(boolean) --* Indicates whether the DB cluster snapshot is encrypted. * **KmsKeyId** *(string) --* If "StorageEncrypted" is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. * **DBClusterSnapshotArn** *(string) --* The Amazon Resource Name (ARN) for the DB cluster snapshot. * **SourceDBClusterSnapshotArn** *(string) --* If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value. * **IAMDatabaseAuthenticationEnabled** *(boolean) --* Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled. * **TagList** *(list) --* A list of tags. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **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}_.:/=+\-@]*)$"). * **DBSystemId** *(string) --* Reserved for future use. * **StorageType** *(string) --* The storage type associated with the DB cluster snapshot. This setting is only for Aurora DB clusters. * **DbClusterResourceId** *(string) --* The resource ID of the DB cluster that this DB cluster snapshot was created from. * **StorageThroughput** *(integer) --* The storage throughput for the DB cluster snapshot. The throughput is automatically set based on the IOPS that you provision, and is not configurable. This setting is only for non-Aurora Multi-AZ DB clusters. * **NextToken** *(string) --* A token to resume pagination. RDS / Paginator / DescribeDBClusterBacktracks DescribeDBClusterBacktracks *************************** class RDS.Paginator.DescribeDBClusterBacktracks paginator = client.get_paginator('describe_db_cluster_backtracks') paginate(**kwargs) Creates an iterator that will paginate through responses from "RDS.Client.describe_db_cluster_backtracks()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DBClusterIdentifier='string', BacktrackIdentifier='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DBClusterIdentifier** (*string*) -- **[REQUIRED]** The DB cluster identifier of the DB cluster to be described. This parameter is stored as a lowercase string. Constraints: * Must contain from 1 to 63 alphanumeric characters or hyphens. * First character must be a letter. * Can't end with a hyphen or contain two consecutive hyphens. Example: "my-cluster1" * **BacktrackIdentifier** (*string*) -- If specified, this value is the backtrack identifier of the backtrack to be described. Constraints: * Must contain a valid universally unique identifier (UUID). For more information about UUIDs, see Universally unique identifier. Example: "123e4567-e89b-12d3-a456-426655440000" * **Filters** (*list*) -- A filter that specifies one or more DB clusters to describe. Supported filters include the following: * "db-cluster-backtrack-id" - Accepts backtrack identifiers. The results list includes information about only the backtracks identified by these identifiers. * "db-cluster-backtrack-status" - Accepts any of the following backtrack status values: * "applying" * "completed" * "failed" * "pending" The results list includes information about only the backtracks identified by these values. * *(dict) --* 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: * "DescribeDBClusterBacktracks" * "DescribeDBClusterEndpoints" * "DescribeDBClusters" * "DescribeDBInstances" * "DescribeDBRecommendations" * "DescribeDBShardGroups" * "DescribePendingMaintenanceActions" * **Name** *(string) --* **[REQUIRED]** The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* **[REQUIRED]** One or more filter values. Filter values are case- sensitive. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'DBClusterBacktracks': [ { 'DBClusterIdentifier': 'string', 'BacktrackIdentifier': 'string', 'BacktrackTo': datetime(2015, 1, 1), 'BacktrackedFrom': datetime(2015, 1, 1), 'BacktrackRequestCreationTime': datetime(2015, 1, 1), 'Status': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* Contains the result of a successful invocation of the "DescribeDBClusterBacktracks" action. * **DBClusterBacktracks** *(list) --* Contains a list of backtracks for the user. * *(dict) --* This data type is used as a response element in the "DescribeDBClusterBacktracks" action. * **DBClusterIdentifier** *(string) --* Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster. * **BacktrackIdentifier** *(string) --* Contains the backtrack identifier. * **BacktrackTo** *(datetime) --* The timestamp of the time to which the DB cluster was backtracked. * **BacktrackedFrom** *(datetime) --* The timestamp of the time from which the DB cluster was backtracked. * **BacktrackRequestCreationTime** *(datetime) --* The timestamp of the time at which the backtrack was requested. * **Status** *(string) --* The status of the backtrack. This property returns one of the following values: * "applying" - The backtrack is currently being applied to or rolled back from the DB cluster. * "completed" - The backtrack has successfully been applied to or rolled back from the DB cluster. * "failed" - An error occurred while the backtrack was applied to or rolled back from the DB cluster. * "pending" - The backtrack is currently pending application to or rollback from the DB cluster. * **NextToken** *(string) --* A token to resume pagination. RDS / Paginator / DescribeDBProxyTargetGroups DescribeDBProxyTargetGroups *************************** class RDS.Paginator.DescribeDBProxyTargetGroups paginator = client.get_paginator('describe_db_proxy_target_groups') paginate(**kwargs) Creates an iterator that will paginate through responses from "RDS.Client.describe_db_proxy_target_groups()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DBProxyName='string', TargetGroupName='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DBProxyName** (*string*) -- **[REQUIRED]** The identifier of the "DBProxy" associated with the target group. * **TargetGroupName** (*string*) -- The identifier of the "DBProxyTargetGroup" to describe. * **Filters** (*list*) -- This parameter is not currently supported. * *(dict) --* 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: * "DescribeDBClusterBacktracks" * "DescribeDBClusterEndpoints" * "DescribeDBClusters" * "DescribeDBInstances" * "DescribeDBRecommendations" * "DescribeDBShardGroups" * "DescribePendingMaintenanceActions" * **Name** *(string) --* **[REQUIRED]** The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* **[REQUIRED]** One or more filter values. Filter values are case- sensitive. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'TargetGroups': [ { 'DBProxyName': 'string', 'TargetGroupName': 'string', 'TargetGroupArn': 'string', 'IsDefault': True|False, 'Status': 'string', 'ConnectionPoolConfig': { 'MaxConnectionsPercent': 123, 'MaxIdleConnectionsPercent': 123, 'ConnectionBorrowTimeout': 123, 'SessionPinningFilters': [ 'string', ], 'InitQuery': 'string' }, 'CreatedDate': datetime(2015, 1, 1), 'UpdatedDate': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **TargetGroups** *(list) --* An arbitrary number of "DBProxyTargetGroup" objects, containing details of the corresponding target groups. * *(dict) --* Represents a set of RDS DB instances, Aurora DB clusters, or both that a proxy can connect to. Currently, each target group is associated with exactly one RDS DB instance or Aurora DB cluster. This data type is used as a response element in the "DescribeDBProxyTargetGroups" action. * **DBProxyName** *(string) --* The identifier for the RDS proxy associated with this target group. * **TargetGroupName** *(string) --* The identifier for the target group. This name must be unique for all target groups owned by your Amazon Web Services account in the specified Amazon Web Services Region. * **TargetGroupArn** *(string) --* The Amazon Resource Name (ARN) representing the target group. * **IsDefault** *(boolean) --* Indicates whether this target group is the first one used for connection requests by the associated proxy. Because each proxy is currently associated with a single target group, currently this setting is always "true". * **Status** *(string) --* The current status of this target group. A status of "available" means the target group is correctly associated with a database. Other values indicate that you must wait for the target group to be ready, or take some action to resolve an issue. * **ConnectionPoolConfig** *(dict) --* The settings that determine the size and behavior of the connection pool for the target group. * **MaxConnectionsPercent** *(integer) --* The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the "max_connections" setting for the RDS DB instance or Aurora DB cluster used by the target group. * **MaxIdleConnectionsPercent** *(integer) --* Controls how actively the proxy closes idle database connections in the connection pool. The value is expressed as a percentage of the "max_connections" setting for the RDS DB instance or Aurora DB cluster used by the target group. With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database. * **ConnectionBorrowTimeout** *(integer) --* The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the proxy has opened its maximum number of connections and all connections are busy with client sessions. * **SessionPinningFilters** *(list) --* Each item in the list represents a class of SQL operations that normally cause all later statements in a session using a proxy to be pinned to the same underlying database connection. Including an item in the list exempts that class of SQL operations from the pinning behavior. This setting is only supported for MySQL engine family databases. Currently, the only allowed value is "EXCLUDE_VARIABLE_SETS". * *(string) --* * **InitQuery** *(string) --* One or more SQL statements for the proxy to run when opening each new database connection. The setting is typically used with "SET" statements to make sure that each connection has identical settings. The query added here must be valid. For including multiple variables in a single SET statement, use a comma separator. This is an optional field. For example: "SET variable1=value1, variable2=value2" Warning: Since you can access initialization query as part of target group configuration, it is not protected by authentication or cryptographic methods. Anyone with access to view or manage your proxy target group configuration can view the initialization query. You should not add sensitive data, such as passwords or long-lived encryption keys, to this option. * **CreatedDate** *(datetime) --* The date and time when the target group was first created. * **UpdatedDate** *(datetime) --* The date and time when the target group was last updated. * **NextToken** *(string) --* A token to resume pagination. RDS / Paginator / DescribeDBProxyTargets DescribeDBProxyTargets ********************** class RDS.Paginator.DescribeDBProxyTargets paginator = client.get_paginator('describe_db_proxy_targets') paginate(**kwargs) Creates an iterator that will paginate through responses from "RDS.Client.describe_db_proxy_targets()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DBProxyName='string', TargetGroupName='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DBProxyName** (*string*) -- **[REQUIRED]** The identifier of the "DBProxyTarget" to describe. * **TargetGroupName** (*string*) -- The identifier of the "DBProxyTargetGroup" to describe. * **Filters** (*list*) -- This parameter is not currently supported. * *(dict) --* 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: * "DescribeDBClusterBacktracks" * "DescribeDBClusterEndpoints" * "DescribeDBClusters" * "DescribeDBInstances" * "DescribeDBRecommendations" * "DescribeDBShardGroups" * "DescribePendingMaintenanceActions" * **Name** *(string) --* **[REQUIRED]** The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* **[REQUIRED]** One or more filter values. Filter values are case- sensitive. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Targets': [ { 'TargetArn': 'string', 'Endpoint': 'string', 'TrackedClusterId': 'string', 'RdsResourceId': 'string', 'Port': 123, 'Type': 'RDS_INSTANCE'|'RDS_SERVERLESS_ENDPOINT'|'TRACKED_CLUSTER', 'Role': 'READ_WRITE'|'READ_ONLY'|'UNKNOWN', 'TargetHealth': { 'State': 'REGISTERING'|'AVAILABLE'|'UNAVAILABLE', 'Reason': 'UNREACHABLE'|'CONNECTION_FAILED'|'AUTH_FAILURE'|'PENDING_PROXY_CAPACITY'|'INVALID_REPLICATION_STATE', 'Description': 'string' } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **Targets** *(list) --* An arbitrary number of "DBProxyTarget" objects, containing details of the corresponding targets. * *(dict) --* Contains the details for an RDS Proxy target. It represents an RDS DB instance or Aurora DB cluster that the proxy can connect to. One or more targets are associated with an RDS Proxy target group. This data type is used as a response element in the "DescribeDBProxyTargets" action. * **TargetArn** *(string) --* The Amazon Resource Name (ARN) for the RDS DB instance or Aurora DB cluster. * **Endpoint** *(string) --* The writer endpoint for the RDS DB instance or Aurora DB cluster. * **TrackedClusterId** *(string) --* The DB cluster identifier when the target represents an Aurora DB cluster. This field is blank when the target represents an RDS DB instance. * **RdsResourceId** *(string) --* The identifier representing the target. It can be the instance identifier for an RDS DB instance, or the cluster identifier for an Aurora DB cluster. * **Port** *(integer) --* The port that the RDS Proxy uses to connect to the target RDS DB instance or Aurora DB cluster. * **Type** *(string) --* Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents. * **Role** *(string) --* A value that indicates whether the target of the proxy can be used for read/write or read-only operations. * **TargetHealth** *(dict) --* Information about the connection health of the RDS Proxy target. * **State** *(string) --* The current state of the connection health lifecycle for the RDS Proxy target. The following is a typical lifecycle example for the states of an RDS Proxy target: "registering" > "unavailable" > "available" > "unavailable" > "available" * **Reason** *(string) --* The reason for the current health "State" of the RDS Proxy target. * **Description** *(string) --* A description of the health of the RDS Proxy target. If the "State" is "AVAILABLE", a description is not included. * **NextToken** *(string) --* A token to resume pagination. RDS / Paginator / DescribeDBInstances DescribeDBInstances ******************* class RDS.Paginator.DescribeDBInstances paginator = client.get_paginator('describe_db_instances') paginate(**kwargs) Creates an iterator that will paginate through responses from "RDS.Client.describe_db_instances()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DBInstanceIdentifier='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DBInstanceIdentifier** (*string*) -- The user-supplied instance identifier or the Amazon Resource Name (ARN) of the DB instance. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case-sensitive. Constraints: * If supplied, must match the identifier of an existing DB instance. * **Filters** (*list*) -- A filter that specifies one or more DB instances to describe. Supported Filters: * "db-cluster-id" - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB instances associated with the DB clusters identified by these ARNs. * "db-instance-id" - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list only includes information about the DB instances identified by these ARNs. * "dbi-resource-id" - Accepts DB instance resource identifiers. The results list only includes information about the DB instances identified by these DB instance resource identifiers. * "domain" - Accepts Active Directory directory IDs. The results list only includes information about the DB instances associated with these domains. * "engine" - Accepts engine names. The results list only includes information about the DB instances for these engines. * *(dict) --* 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: * "DescribeDBClusterBacktracks" * "DescribeDBClusterEndpoints" * "DescribeDBClusters" * "DescribeDBInstances" * "DescribeDBRecommendations" * "DescribeDBShardGroups" * "DescribePendingMaintenanceActions" * **Name** *(string) --* **[REQUIRED]** The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* **[REQUIRED]** One or more filter values. Filter values are case- sensitive. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'DBInstances': [ { 'DBInstanceIdentifier': 'string', 'DBInstanceClass': 'string', 'Engine': 'string', 'DBInstanceStatus': 'string', 'AutomaticRestartTime': datetime(2015, 1, 1), 'MasterUsername': 'string', 'DBName': 'string', 'Endpoint': { 'Address': 'string', 'Port': 123, 'HostedZoneId': 'string' }, 'AllocatedStorage': 123, 'InstanceCreateTime': datetime(2015, 1, 1), 'PreferredBackupWindow': 'string', 'BackupRetentionPeriod': 123, 'DBSecurityGroups': [ { 'DBSecurityGroupName': 'string', 'Status': 'string' }, ], 'VpcSecurityGroups': [ { 'VpcSecurityGroupId': 'string', 'Status': 'string' }, ], 'DBParameterGroups': [ { 'DBParameterGroupName': 'string', 'ParameterApplyStatus': 'string' }, ], 'AvailabilityZone': 'string', 'DBSubnetGroup': { 'DBSubnetGroupName': 'string', 'DBSubnetGroupDescription': 'string', 'VpcId': 'string', 'SubnetGroupStatus': 'string', 'Subnets': [ { 'SubnetIdentifier': 'string', 'SubnetAvailabilityZone': { 'Name': 'string' }, 'SubnetOutpost': { 'Arn': 'string' }, 'SubnetStatus': 'string' }, ], 'DBSubnetGroupArn': 'string', 'SupportedNetworkTypes': [ 'string', ] }, 'PreferredMaintenanceWindow': 'string', 'PendingModifiedValues': { 'DBInstanceClass': 'string', 'AllocatedStorage': 123, 'MasterUserPassword': 'string', 'Port': 123, 'BackupRetentionPeriod': 123, 'MultiAZ': True|False, 'EngineVersion': 'string', 'LicenseModel': 'string', 'Iops': 123, 'DBInstanceIdentifier': 'string', 'StorageType': 'string', 'CACertificateIdentifier': 'string', 'DBSubnetGroupName': 'string', 'PendingCloudwatchLogsExports': { 'LogTypesToEnable': [ 'string', ], 'LogTypesToDisable': [ 'string', ] }, 'ProcessorFeatures': [ { 'Name': 'string', 'Value': 'string' }, ], 'IAMDatabaseAuthenticationEnabled': True|False, 'AutomationMode': 'full'|'all-paused', 'ResumeFullAutomationModeTime': datetime(2015, 1, 1), 'StorageThroughput': 123, 'Engine': 'string', 'DedicatedLogVolume': True|False, 'MultiTenant': True|False }, 'LatestRestorableTime': datetime(2015, 1, 1), 'MultiAZ': True|False, 'EngineVersion': 'string', 'AutoMinorVersionUpgrade': True|False, 'ReadReplicaSourceDBInstanceIdentifier': 'string', 'ReadReplicaDBInstanceIdentifiers': [ 'string', ], 'ReadReplicaDBClusterIdentifiers': [ 'string', ], 'ReplicaMode': 'open-read-only'|'mounted', 'LicenseModel': 'string', 'Iops': 123, 'OptionGroupMemberships': [ { 'OptionGroupName': 'string', 'Status': 'string' }, ], 'CharacterSetName': 'string', 'NcharCharacterSetName': 'string', 'SecondaryAvailabilityZone': 'string', 'PubliclyAccessible': True|False, 'StatusInfos': [ { 'StatusType': 'string', 'Normal': True|False, 'Status': 'string', 'Message': 'string' }, ], 'StorageType': 'string', 'TdeCredentialArn': 'string', 'DbInstancePort': 123, 'DBClusterIdentifier': 'string', 'StorageEncrypted': True|False, 'KmsKeyId': 'string', 'DbiResourceId': 'string', 'CACertificateIdentifier': 'string', 'DomainMemberships': [ { 'Domain': 'string', 'Status': 'string', 'FQDN': 'string', 'IAMRoleName': 'string', 'OU': 'string', 'AuthSecretArn': 'string', 'DnsIps': [ 'string', ] }, ], 'CopyTagsToSnapshot': True|False, 'MonitoringInterval': 123, 'EnhancedMonitoringResourceArn': 'string', 'MonitoringRoleArn': 'string', 'PromotionTier': 123, 'DBInstanceArn': 'string', 'Timezone': 'string', 'IAMDatabaseAuthenticationEnabled': True|False, 'DatabaseInsightsMode': 'standard'|'advanced', 'PerformanceInsightsEnabled': True|False, 'PerformanceInsightsKMSKeyId': 'string', 'PerformanceInsightsRetentionPeriod': 123, 'EnabledCloudwatchLogsExports': [ 'string', ], 'ProcessorFeatures': [ { 'Name': 'string', 'Value': 'string' }, ], 'DeletionProtection': True|False, 'AssociatedRoles': [ { 'RoleArn': 'string', 'FeatureName': 'string', 'Status': 'string' }, ], 'ListenerEndpoint': { 'Address': 'string', 'Port': 123, 'HostedZoneId': 'string' }, 'MaxAllocatedStorage': 123, 'TagList': [ { 'Key': 'string', 'Value': 'string' }, ], 'DBInstanceAutomatedBackupsReplications': [ { 'DBInstanceAutomatedBackupsArn': 'string' }, ], 'CustomerOwnedIpEnabled': True|False, 'AwsBackupRecoveryPointArn': 'string', 'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping', 'ActivityStreamKmsKeyId': 'string', 'ActivityStreamKinesisStreamName': 'string', 'ActivityStreamMode': 'sync'|'async', 'ActivityStreamEngineNativeAuditFieldsIncluded': True|False, 'AutomationMode': 'full'|'all-paused', 'ResumeFullAutomationModeTime': datetime(2015, 1, 1), 'CustomIamInstanceProfile': 'string', 'BackupTarget': 'string', 'NetworkType': 'string', 'ActivityStreamPolicyStatus': 'locked'|'unlocked'|'locking-policy'|'unlocking-policy', 'StorageThroughput': 123, 'DBSystemId': 'string', 'MasterUserSecret': { 'SecretArn': 'string', 'SecretStatus': 'string', 'KmsKeyId': 'string' }, 'CertificateDetails': { 'CAIdentifier': 'string', 'ValidTill': datetime(2015, 1, 1) }, 'ReadReplicaSourceDBClusterIdentifier': 'string', 'PercentProgress': 'string', 'DedicatedLogVolume': True|False, 'IsStorageConfigUpgradeAvailable': True|False, 'MultiTenant': True|False, 'EngineLifecycleSupport': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* Contains the result of a successful invocation of the "DescribeDBInstances" action. * **DBInstances** *(list) --* A list of "DBInstance" instances. * *(dict) --* Contains the details of an Amazon RDS DB instance. This data type is used as a response element in the operations "CreateDBInstance", "CreateDBInstanceReadReplica", "DeleteDBInstance", "DescribeDBInstances", "ModifyDBInstance", "PromoteReadReplica", "RebootDBInstance", "RestoreDBInstanceFromDBSnapshot", "RestoreDBInstanceFromS3", "RestoreDBInstanceToPointInTime", "StartDBInstance", and "StopDBInstance". * **DBInstanceIdentifier** *(string) --* The user-supplied database identifier. This identifier is the unique key that identifies a DB instance. * **DBInstanceClass** *(string) --* The name of the compute and memory capacity class of the DB instance. * **Engine** *(string) --* The database engine used for this DB instance. * **DBInstanceStatus** *(string) --* The current state of this database. For information about DB instance statuses, see Viewing DB instance status in the *Amazon RDS User Guide.* * **AutomaticRestartTime** *(datetime) --* The time when a stopped DB instance is restarted automatically. * **MasterUsername** *(string) --* The master username for the DB instance. * **DBName** *(string) --* The initial database name that you provided (if required) when you created the DB instance. This name is returned for the life of your DB instance. For an RDS for Oracle CDB instance, the name identifies the PDB rather than the CDB. * **Endpoint** *(dict) --* The connection endpoint for the DB instance. Note: The endpoint might not be shown for instances with the status of "creating". * **Address** *(string) --* Specifies the DNS address of the DB instance. * **Port** *(integer) --* Specifies the port that the database engine is listening on. * **HostedZoneId** *(string) --* Specifies the ID that Amazon Route 53 assigns when you create a hosted zone. * **AllocatedStorage** *(integer) --* The amount of storage in gibibytes (GiB) allocated for the DB instance. * **InstanceCreateTime** *(datetime) --* The date and time when the DB instance was created. * **PreferredBackupWindow** *(string) --* The daily time range during which automated backups are created if automated backups are enabled, as determined by the "BackupRetentionPeriod". * **BackupRetentionPeriod** *(integer) --* 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: * "ModifyDBInstance" * "RebootDBInstance" * "RestoreDBInstanceFromDBSnapshot" * "RestoreDBInstanceToPointInTime" * **DBSecurityGroupName** *(string) --* The name of the DB security group. * **Status** *(string) --* The status of the DB security group. * **VpcSecurityGroups** *(list) --* The list of Amazon EC2 VPC security groups that the DB instance belongs to. * *(dict) --* This data type is used as a response element for queries on VPC security group membership. * **VpcSecurityGroupId** *(string) --* The name of the VPC security group. * **Status** *(string) --* The membership status of the VPC security group. Currently, the only valid status is "active". * **DBParameterGroups** *(list) --* 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: * "CreateDBInstance" * "CreateDBInstanceReadReplica" * "DeleteDBInstance" * "ModifyDBInstance" * "RebootDBInstance" * "RestoreDBInstanceFromDBSnapshot" * **DBParameterGroupName** *(string) --* The name of the DB parameter group. * **ParameterApplyStatus** *(string) --* The status of parameter updates. Valid values are: * "applying": The parameter group change is being applied to the database. * "failed-to-apply": The parameter group is in an invalid state. * "in-sync": The parameter group change is synchronized with the database. * "pending-database-upgrade": The parameter group change will be applied after the DB instance is upgraded. * "pending-reboot": The parameter group change will be applied after the DB instance reboots. * **AvailabilityZone** *(string) --* The name of the Availability Zone where the DB instance is located. * **DBSubnetGroup** *(dict) --* Information about 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. The list of subnets shown here might not reflect the current state of your VPC. For the most up-to-date information, we recommend checking your VPC configuration directly. * *(dict) --* This data type is used as a response element for the "DescribeDBSubnetGroups" operation. * **SubnetIdentifier** *(string) --* The identifier of the subnet. * **SubnetAvailabilityZone** *(dict) --* Contains Availability Zone information. This data type is used as an element in the "OrderableDBInstanceOption" data type. * **Name** *(string) --* The name of the Availability Zone. * **SubnetOutpost** *(dict) --* If the subnet is associated with an Outpost, this value specifies the Outpost. For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the *Amazon RDS User Guide.* * **Arn** *(string) --* The Amazon Resource Name (ARN) of the Outpost. * **SubnetStatus** *(string) --* The status of the subnet. * **DBSubnetGroupArn** *(string) --* The Amazon Resource Name (ARN) for the DB subnet group. * **SupportedNetworkTypes** *(list) --* The network type of the DB subnet group. Valid values: * "IPV4" * "DUAL" A "DBSubnetGroup" can support only the IPv4 protocol or the IPv4 and the IPv6 protocols ( "DUAL"). For more information, see Working with a DB instance in a VPC in the *Amazon RDS User Guide.* * *(string) --* * **PreferredMaintenanceWindow** *(string) --* The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). * **PendingModifiedValues** *(dict) --* Information about pending changes to the DB instance. This information is returned only when there are pending changes. Specific changes are identified by subelements. * **DBInstanceClass** *(string) --* The name of the compute and memory capacity class for the DB instance. * **AllocatedStorage** *(integer) --* The allocated storage size for the DB instance specified in gibibytes (GiB). * **MasterUserPassword** *(string) --* The master credentials for the DB instance. * **Port** *(integer) --* The port for the DB instance. * **BackupRetentionPeriod** *(integer) --* The number of days for which automated backups are retained. * **MultiAZ** *(boolean) --* Indicates whether the Single-AZ DB instance will change to a Multi-AZ deployment. * **EngineVersion** *(string) --* The database engine version. * **LicenseModel** *(string) --* The license model for the DB instance. Valid values: "license-included" | "bring-your-own- license" | "general-public-license" * **Iops** *(integer) --* The Provisioned IOPS value for the DB instance. * **DBInstanceIdentifier** *(string) --* The database identifier for the DB instance. * **StorageType** *(string) --* The storage type of the DB instance. * **CACertificateIdentifier** *(string) --* The identifier of the CA certificate for the DB instance. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the *Amazon RDS User Guide* and Using SSL/TLS to encrypt a connection to a DB cluster in the *Amazon Aurora User Guide*. * **DBSubnetGroupName** *(string) --* The DB subnet group for the DB instance. * **PendingCloudwatchLogsExports** *(dict) --* A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated. * **LogTypesToEnable** *(list) --* Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs. * *(string) --* * **LogTypesToDisable** *(list) --* Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs. * *(string) --* * **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: * "CreateDBInstance" * "ModifyDBInstance" * "RestoreDBInstanceFromDBSnapshot" * "RestoreDBInstanceFromS3" * "RestoreDBInstanceToPointInTime" 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: * "DescribeDBInstances" * "DescribeDBSnapshots" * "DescribeValidDBInstanceModifications" If you call "DescribeDBInstances", "ProcessorFeature" returns non-null values only if the following conditions are met: * You are accessing an Oracle DB instance. * Your Oracle DB instance class supports configuring the number of CPU cores and threads per core. * The current number CPU cores and threads is set to a non-default value. For more information, see Configuring the processor for a DB instance class in RDS for Oracle 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. * **IAMDatabaseAuthenticationEnabled** *(boolean) --* Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled. * **AutomationMode** *(string) --* The automation mode of the RDS Custom DB instance: "full" or "all-paused". If "full", the DB instance automates monitoring and instance recovery. If "all-paused", the instance pauses automation for the duration set by "--resume-full-automation-mode- minutes". * **ResumeFullAutomationModeTime** *(datetime) --* The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440. * **StorageThroughput** *(integer) --* The storage throughput of the DB instance. * **Engine** *(string) --* The database engine of the DB instance. * **DedicatedLogVolume** *(boolean) --* Indicates whether the DB instance has a dedicated log volume (DLV) enabled.> * **MultiTenant** *(boolean) --* Indicates whether the DB instance will change to the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE). * **LatestRestorableTime** *(datetime) --* The latest time to which a database in this DB instance can be restored with point-in-time restore. * **MultiAZ** *(boolean) --* Indicates whether the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom DB instances. * **EngineVersion** *(string) --* The version of the database engine. * **AutoMinorVersionUpgrade** *(boolean) --* Indicates whether minor version patches are applied automatically. For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version. * **ReadReplicaSourceDBInstanceIdentifier** *(string) --* The identifier of the source DB instance if this DB instance is a read replica. * **ReadReplicaDBInstanceIdentifiers** *(list) --* The identifiers of the read replicas associated with this DB instance. * *(string) --* * **ReadReplicaDBClusterIdentifiers** *(list) --* The identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn't contain information about cross-Region Aurora read replicas. Note: Currently, each RDS DB instance can have only one Aurora read replica. * *(string) --* * **ReplicaMode** *(string) --* The open mode of a Db2 or an Oracle read replica. The default is "open-read-only". For more information, see Working with read replicas for Amazon RDS for Db2 and Working with read replicas for Amazon RDS for Oracle in the *Amazon RDS User Guide*. Note: This attribute is only supported in RDS for Db2, RDS for Oracle, and RDS Custom for Oracle. * **LicenseModel** *(string) --* The license model information for this DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. * **Iops** *(integer) --* The Provisioned IOPS (I/O operations per second) value for the DB instance. * **OptionGroupMemberships** *(list) --* The list of option group memberships for this DB instance. * *(dict) --* Provides information on the option groups the DB instance is a member of. * **OptionGroupName** *(string) --* The name of the option group that the instance belongs to. * **Status** *(string) --* The status of the DB instance's option group membership. Valid values are: "in-sync", "pending-apply", "pending-removal", "pending- maintenance-apply", "pending-maintenance- removal", "applying", "removing", and "failed". * **CharacterSetName** *(string) --* If present, specifies the name of the character set that this instance is associated with. * **NcharCharacterSetName** *(string) --* The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2. * **SecondaryAvailabilityZone** *(string) --* If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support. * **PubliclyAccessible** *(boolean) --* Indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it. When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance. * **StatusInfos** *(list) --* The status of a read replica. If the DB instance isn't a read replica, the value is blank. * *(dict) --* Provides a list of status information for a DB instance. * **StatusType** *(string) --* This value is currently "read replication." * **Normal** *(boolean) --* Indicates whether the instance is operating normally (TRUE) or is in an error state (FALSE). * **Status** *(string) --* The 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) --* The storage type associated with the DB instance. * **TdeCredentialArn** *(string) --* The ARN from the key store with which the instance is associated for TDE encryption. * **DbInstancePort** *(integer) --* 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, indicates the name of the DB cluster that the DB instance is a member of. * **StorageEncrypted** *(boolean) --* Indicates whether the DB instance is encrypted. * **KmsKeyId** *(string) --* If "StorageEncrypted" is enabled, the Amazon Web Services KMS key identifier for the encrypted DB instance. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. * **DbiResourceId** *(string) --* The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB instance is accessed. * **CACertificateIdentifier** *(string) --* The identifier of the CA certificate for this DB instance. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the *Amazon RDS User Guide* and Using SSL/TLS to encrypt a connection to a DB cluster in the *Amazon Aurora User Guide*. * **DomainMemberships** *(list) --* The Active Directory Domain membership records associated with the DB instance. * *(dict) --* An Active Directory Domain membership record associated with the DB instance or cluster. * **Domain** *(string) --* The identifier of the Active Directory Domain. * **Status** *(string) --* The status of the Active Directory Domain membership for the DB instance or cluster. Values include "joined", "pending-join", "failed", and so on. * **FQDN** *(string) --* The fully qualified domain name (FQDN) of the Active Directory Domain. * **IAMRoleName** *(string) --* The name of the IAM role used when making API calls to the Directory Service. * **OU** *(string) --* The Active Directory organizational unit for the DB instance or cluster. * **AuthSecretArn** *(string) --* The ARN for the Secrets Manager secret with the credentials for the user that's a member of the domain. * **DnsIps** *(list) --* The IPv4 DNS IP addresses of the primary and secondary Active Directory domain controllers. * *(string) --* * **CopyTagsToSnapshot** *(boolean) --* Indicates whether tags are copied from the DB instance to snapshots of the DB instance. This setting doesn't apply to Amazon Aurora DB instances. 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) --* The order of priority 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 RDS for Db2 and RDS for SQL Server DB instances that were created with a time zone specified. * **IAMDatabaseAuthenticationEnabled** *(boolean) --* Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled for the DB instance. For a list of engine versions that support IAM database authentication, see IAM database authentication in the *Amazon RDS User Guide* and IAM database authentication in Aurora in the *Amazon Aurora User Guide*. * **DatabaseInsightsMode** *(string) --* The mode of Database Insights that is enabled for the instance. * **PerformanceInsightsEnabled** *(boolean) --* Indicates whether Performance Insights is enabled for the DB instance. * **PerformanceInsightsKMSKeyId** *(string) --* The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. * **PerformanceInsightsRetentionPeriod** *(integer) --* The number of days to retain Performance Insights data. Valid Values: * "7" * *month* * 31, where *month* is a number of months from 1-23. Examples: "93" (3 months * 31), "341" (11 months * 31), "589" (19 months * 31) * "731" Default: "7" days * **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 Monitoring Amazon RDS log files in the *Amazon RDS User Guide.* * *(string) --* * **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: * "CreateDBInstance" * "ModifyDBInstance" * "RestoreDBInstanceFromDBSnapshot" * "RestoreDBInstanceFromS3" * "RestoreDBInstanceToPointInTime" 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: * "DescribeDBInstances" * "DescribeDBSnapshots" * "DescribeValidDBInstanceModifications" If you call "DescribeDBInstances", "ProcessorFeature" returns non-null values only if the following conditions are met: * You are accessing an Oracle DB instance. * Your Oracle DB instance class supports configuring the number of CPU cores and threads per core. * The current number CPU cores and threads is set to a non-default value. For more information, see Configuring the processor for a DB instance class in RDS for Oracle 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. * **DeletionProtection** *(boolean) --* Indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance. * **AssociatedRoles** *(list) --* The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance. * *(dict) --* Information about an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance. * **RoleArn** *(string) --* The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance. * **FeatureName** *(string) --* The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see "DBEngineVersion". * **Status** *(string) --* Information about the state of association between the IAM role and the DB instance. The Status property returns one of the following values: * "ACTIVE" - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf. * "PENDING" - the IAM role ARN is being associated with the DB instance. * "INVALID" - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf. * **ListenerEndpoint** *(dict) --* The listener connection endpoint for SQL Server Always On. * **Address** *(string) --* Specifies the DNS address of the DB instance. * **Port** *(integer) --* Specifies the port that the database engine is listening on. * **HostedZoneId** *(string) --* Specifies the ID that Amazon Route 53 assigns when you create a hosted zone. * **MaxAllocatedStorage** *(integer) --* The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. * **TagList** *(list) --* A list of tags. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **Key** *(string) --* A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **Value** *(string) --* A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white- space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **DBInstanceAutomatedBackupsReplications** *(list) --* The list of replicated automated backups associated with the DB instance. * *(dict) --* Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties. * **DBInstanceAutomatedBackupsArn** *(string) --* The Amazon Resource Name (ARN) of the replicated automated backups. * **CustomerOwnedIpEnabled** *(boolean) --* Indicates whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance. A >>*<>*< --engine-version " For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, use the following command: "aws rds describe-db-engine-versions --engine postgres --engine-version 13.3" The supported features are listed under "SupportedFeatureNames" in the output. * *(string) --* * **Status** *(string) --* The status of the DB engine version, either "available" or "deprecated". * **SupportsParallelQuery** *(boolean) --* Indicates whether you can use Aurora parallel query with a specific DB engine version. * **SupportsGlobalDatabases** *(boolean) --* Indicates whether you can use Aurora global databases with a specific DB engine version. * **MajorEngineVersion** *(string) --* The major engine version of the CEV. * **DatabaseInstallationFilesS3BucketName** *(string) --* The name of the Amazon S3 bucket that contains your database installation files. * **DatabaseInstallationFilesS3Prefix** *(string) --* The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed. * **DBEngineVersionArn** *(string) --* The ARN of the custom engine version. * **KMSKeyId** *(string) --* The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS. * **CreateTime** *(datetime) --* The creation time of the DB engine version. * **TagList** *(list) --* A list of tags. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **Key** *(string) --* A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **Value** *(string) --* A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white- space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **SupportsBabelfish** *(boolean) --* Indicates whether the engine version supports Babelfish for Aurora PostgreSQL. * **CustomDBEngineVersionManifest** *(string) --* JSON string that lists the installation files and parameters that RDS Custom uses to create a custom engine version (CEV). RDS Custom applies the patches in the order in which they're listed in the manifest. You can set the Oracle home, Oracle base, and UNIX/Linux user and group using the installation parameters. For more information, see JSON fields in the CEV manifest in the *Amazon RDS User Guide*. * **SupportsLimitlessDatabase** *(boolean) --* Indicates whether the DB engine version supports Aurora Limitless Database. * **SupportsCertificateRotationWithoutRestart** *(boolean) --* Indicates whether the engine version supports rotating the server certificate without rebooting the DB instance. * **SupportedCACertificateIdentifiers** *(list) --* A list of the supported CA certificate identifiers. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the *Amazon RDS User Guide* and Using SSL/TLS to encrypt a connection to a DB cluster in the *Amazon Aurora User Guide*. * *(string) --* * **SupportsLocalWriteForwarding** *(boolean) --* Indicates whether the DB engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances. Valid for: Aurora DB clusters only * **SupportsIntegrations** *(boolean) --* Indicates whether the DB engine version supports zero-ETL integrations with Amazon Redshift. * **ServerlessV2FeaturesSupport** *(dict) --* Specifies any Aurora Serverless v2 properties or limits that differ between Aurora engine versions. You can test the values of this attribute when deciding which Aurora version to use in a new or upgraded DB cluster. You can also retrieve the version of an existing DB cluster and check whether that version supports certain Aurora Serverless v2 features before you attempt to use those features. * **MinCapacity** *(float) --* If the minimum capacity is 0 ACUs, the engine version or platform version supports the automatic pause/resume feature of Aurora Serverless v2. * **MaxCapacity** *(float) --* Specifies the upper Aurora Serverless v2 capacity limit for a particular engine version or platform version. Depending on the engine version, the maximum capacity for an Aurora Serverless v2 cluster might be "256" or "128". * **NextToken** *(string) --* A token to resume pagination. RDS / Paginator / DescribeEvents DescribeEvents ************** class RDS.Paginator.DescribeEvents paginator = client.get_paginator('describe_events') paginate(**kwargs) Creates an iterator that will paginate through responses from "RDS.Client.describe_events()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( SourceIdentifier='string', SourceType='db-instance'|'db-parameter-group'|'db-security-group'|'db-snapshot'|'db-cluster'|'db-cluster-snapshot'|'custom-engine-version'|'db-proxy'|'blue-green-deployment', 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' } ) Parameters: * **SourceIdentifier** (*string*) -- The identifier of the event source for which events are returned. If not specified, then all sources are included in the response. Constraints: * If "SourceIdentifier" is supplied, "SourceType" must also be provided. * If the source type is a DB instance, a "DBInstanceIdentifier" value must be supplied. * If the source type is a DB cluster, a "DBClusterIdentifier" value must be supplied. * If the source type is a DB parameter group, a "DBParameterGroupName" value must be supplied. * If the source type is a DB security group, a "DBSecurityGroupName" value must be supplied. * If the source type is a DB snapshot, a "DBSnapshotIdentifier" value must be supplied. * If the source type is a DB cluster snapshot, a "DBClusterSnapshotIdentifier" value must be supplied. * If the source type is an RDS Proxy, a "DBProxyName" value must be supplied. * Can't end with a hyphen or contain two consecutive hyphens. * **SourceType** (*string*) -- The event source to retrieve events for. If no value is specified, all events are returned. * **StartTime** (*datetime*) -- 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 * **EndTime** (*datetime*) -- 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 * **Duration** (*integer*) -- The number of minutes to retrieve events for. Default: 60 * **EventCategories** (*list*) -- A list of event categories that trigger notifications for a event notification subscription. * *(string) --* * **Filters** (*list*) -- This parameter isn't currently supported. * *(dict) --* 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: * "DescribeDBClusterBacktracks" * "DescribeDBClusterEndpoints" * "DescribeDBClusters" * "DescribeDBInstances" * "DescribeDBRecommendations" * "DescribeDBShardGroups" * "DescribePendingMaintenanceActions" * **Name** *(string) --* **[REQUIRED]** The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* **[REQUIRED]** One or more filter values. Filter values are case- sensitive. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Events': [ { 'SourceIdentifier': 'string', 'SourceType': 'db-instance'|'db-parameter-group'|'db-security-group'|'db-snapshot'|'db-cluster'|'db-cluster-snapshot'|'custom-engine-version'|'db-proxy'|'blue-green-deployment', '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. * *(string) --* * **Date** *(datetime) --* Specifies the date and time of the event. * **SourceArn** *(string) --* The Amazon Resource Name (ARN) for the event. * **NextToken** *(string) --* A token to resume pagination. RDS / Paginator / DescribeDBClusterParameters DescribeDBClusterParameters *************************** class RDS.Paginator.DescribeDBClusterParameters paginator = client.get_paginator('describe_db_cluster_parameters') paginate(**kwargs) Creates an iterator that will paginate through responses from "RDS.Client.describe_db_cluster_parameters()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DBClusterParameterGroupName='string', Source='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DBClusterParameterGroupName** (*string*) -- **[REQUIRED]** The name of a specific DB cluster parameter group to return parameter details for. Constraints: * If supplied, must match the name of an existing DBClusterParameterGroup. * **Source** (*string*) -- A specific source to return parameters for. Valid Values: * "engine-default" * "system" * "user" * **Filters** (*list*) -- A filter that specifies one or more DB cluster parameters to describe. The only supported filter is "parameter-name". The results list only includes information about the DB cluster parameters with these names. * *(dict) --* 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: * "DescribeDBClusterBacktracks" * "DescribeDBClusterEndpoints" * "DescribeDBClusters" * "DescribeDBInstances" * "DescribeDBRecommendations" * "DescribeDBShardGroups" * "DescribePendingMaintenanceActions" * **Name** *(string) --* **[REQUIRED]** The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* **[REQUIRED]** One or more filter values. Filter values are case- sensitive. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **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) --* The name of the parameter. * **ParameterValue** *(string) --* The value of the parameter. * **Description** *(string) --* Provides a description of the parameter. * **Source** *(string) --* 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. * *(string) --* * **NextToken** *(string) --* A token to resume pagination. RDS / Paginator / DescribeCertificates DescribeCertificates ******************** class RDS.Paginator.DescribeCertificates paginator = client.get_paginator('describe_certificates') paginate(**kwargs) Creates an iterator that will paginate through responses from "RDS.Client.describe_certificates()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( CertificateIdentifier='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **CertificateIdentifier** (*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: * Must match an existing CertificateIdentifier. * **Filters** (*list*) -- This parameter isn't currently supported. * *(dict) --* 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: * "DescribeDBClusterBacktracks" * "DescribeDBClusterEndpoints" * "DescribeDBClusters" * "DescribeDBInstances" * "DescribeDBRecommendations" * "DescribeDBShardGroups" * "DescribePendingMaintenanceActions" * **Name** *(string) --* **[REQUIRED]** The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* **[REQUIRED]** One or more filter values. Filter values are case- sensitive. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'DefaultCertificateForNewLaunches': 'string', 'Certificates': [ { 'CertificateIdentifier': 'string', 'CertificateType': 'string', 'Thumbprint': 'string', 'ValidFrom': datetime(2015, 1, 1), 'ValidTill': datetime(2015, 1, 1), 'CertificateArn': 'string', 'CustomerOverride': True|False, 'CustomerOverrideValidTill': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* Data returned by the **DescribeCertificates** action. * **DefaultCertificateForNewLaunches** *(string) --* The default root CA for new databases created by your Amazon Web Services account. This is either the root CA override set on your Amazon Web Services account or the system default CA for the Region if no override exists. To override the default CA, use the "ModifyCertificates" operation. * **Certificates** *(list) --* The list of "Certificate" objects for the Amazon Web Services account. * *(dict) --* A CA certificate for an Amazon Web Services account. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the *Amazon RDS User Guide* and Using SSL/TLS to encrypt a connection to a DB cluster in the *Amazon Aurora User Guide*. * **CertificateIdentifier** *(string) --* The unique key that identifies a certificate. * **CertificateType** *(string) --* The type of the certificate. * **Thumbprint** *(string) --* The thumbprint of the certificate. * **ValidFrom** *(datetime) --* The starting date from which the certificate is valid. * **ValidTill** *(datetime) --* The final date that the certificate continues to be valid. * **CertificateArn** *(string) --* The Amazon Resource Name (ARN) for the certificate. * **CustomerOverride** *(boolean) --* Indicates whether there is an override for the default certificate identifier. * **CustomerOverrideValidTill** *(datetime) --* If there is an override for the default certificate identifier, when the override expires. * **NextToken** *(string) --* A token to resume pagination. RDS / Paginator / DescribeDBParameters DescribeDBParameters ******************** class RDS.Paginator.DescribeDBParameters paginator = client.get_paginator('describe_db_parameters') paginate(**kwargs) Creates an iterator that will paginate through responses from "RDS.Client.describe_db_parameters()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( DBParameterGroupName='string', Source='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **DBParameterGroupName** (*string*) -- **[REQUIRED]** The name of a specific DB parameter group to return details for. Constraints: * If supplied, must match the name of an existing DBParameterGroup. * **Source** (*string*) -- The parameter types to return. Default: All parameter types returned Valid Values: "user | system | engine-default" * **Filters** (*list*) -- A filter that specifies one or more DB parameters to describe. The only supported filter is "parameter-name". The results list only includes information about the DB parameters with these names. * *(dict) --* 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: * "DescribeDBClusterBacktracks" * "DescribeDBClusterEndpoints" * "DescribeDBClusters" * "DescribeDBInstances" * "DescribeDBRecommendations" * "DescribeDBShardGroups" * "DescribePendingMaintenanceActions" * **Name** *(string) --* **[REQUIRED]** The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* **[REQUIRED]** One or more filter values. Filter values are case- sensitive. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **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) --* The name of the parameter. * **ParameterValue** *(string) --* The value of the parameter. * **Description** *(string) --* Provides a description of the parameter. * **Source** *(string) --* 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. * *(string) --* * **NextToken** *(string) --* A token to resume pagination. RDS / Paginator / DescribeOrderableDBInstanceOptions DescribeOrderableDBInstanceOptions ********************************** class RDS.Paginator.DescribeOrderableDBInstanceOptions paginator = client.get_paginator('describe_orderable_db_instance_options') paginate(**kwargs) Creates an iterator that will paginate through responses from "RDS.Client.describe_orderable_db_instance_options()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( Engine='string', EngineVersion='string', DBInstanceClass='string', LicenseModel='string', AvailabilityZoneGroup='string', Vpc=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **Engine** (*string*) -- **[REQUIRED]** The name of the database engine to describe DB instance options for. Valid Values: * "aurora-mysql" * "aurora-postgresql" * "custom-oracle-ee" * "custom-oracle-ee-cdb" * "custom-oracle-se2" * "custom-oracle-se2-cdb" * "db2-ae" * "db2-se" * "mariadb" * "mysql" * "oracle-ee" * "oracle-ee-cdb" * "oracle-se2" * "oracle-se2-cdb" * "postgres" * "sqlserver-ee" * "sqlserver-se" * "sqlserver-ex" * "sqlserver-web" * **EngineVersion** (*string*) -- A filter to include only the available options for the specified engine version. * **DBInstanceClass** (*string*) -- A filter to include only the available options for the specified DB instance class. * **LicenseModel** (*string*) -- A filter to include only the available options for the specified license model. RDS Custom supports only the BYOL licensing model. * **AvailabilityZoneGroup** (*string*) -- The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available options for the Local Zones in the group. Omit this parameter to show the available options in the specified Amazon Web Services Region. This setting doesn't apply to RDS Custom DB instances. * **Vpc** (*boolean*) -- Specifies whether to show only VPC or non-VPC offerings. RDS Custom supports only VPC offerings. RDS Custom supports only VPC offerings. If you describe non-VPC offerings for RDS Custom, the output shows VPC offerings. * **Filters** (*list*) -- This parameter isn't currently supported. * *(dict) --* 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: * "DescribeDBClusterBacktracks" * "DescribeDBClusterEndpoints" * "DescribeDBClusters" * "DescribeDBInstances" * "DescribeDBRecommendations" * "DescribeDBShardGroups" * "DescribePendingMaintenanceActions" * **Name** *(string) --* **[REQUIRED]** The name of the filter. Filter names are case- sensitive. * **Values** *(list) --* **[REQUIRED]** One or more filter values. Filter values are case- sensitive. * *(string) --* * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'OrderableDBInstanceOptions': [ { 'Engine': 'string', 'EngineVersion': 'string', 'DBInstanceClass': 'string', 'LicenseModel': 'string', 'AvailabilityZoneGroup': 'string', 'AvailabilityZones': [ { 'Name': 'string' }, ], 'MultiAZCapable': True|False, 'ReadReplicaCapable': True|False, 'Vpc': True|False, 'SupportsStorageEncryption': True|False, 'StorageType': 'string', 'SupportsIops': True|False, 'SupportsEnhancedMonitoring': True|False, 'SupportsIAMDatabaseAuthentication': True|False, 'SupportsPerformanceInsights': True|False, 'MinStorageSize': 123, 'MaxStorageSize': 123, 'MinIopsPerDbInstance': 123, 'MaxIopsPerDbInstance': 123, 'MinIopsPerGib': 123.0, 'MaxIopsPerGib': 123.0, 'AvailableProcessorFeatures': [ { 'Name': 'string', 'DefaultValue': 'string', 'AllowedValues': 'string' }, ], 'SupportedEngineModes': [ 'string', ], 'SupportsStorageAutoscaling': True|False, 'SupportsKerberosAuthentication': True|False, 'OutpostCapable': True|False, 'SupportedActivityStreamModes': [ 'string', ], 'SupportsGlobalDatabases': True|False, 'SupportsClusters': True|False, 'SupportedNetworkTypes': [ 'string', ], 'SupportsStorageThroughput': True|False, 'MinStorageThroughputPerDbInstance': 123, 'MaxStorageThroughputPerDbInstance': 123, 'MinStorageThroughputPerIops': 123.0, 'MaxStorageThroughputPerIops': 123.0, 'SupportsDedicatedLogVolume': 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. * **AvailabilityZoneGroup** *(string) --* The Availability Zone group for a DB instance. * **AvailabilityZones** *(list) --* A list of Availability Zones for a DB instance. * *(dict) --* Contains Availability Zone information. This data type is used as an element in the "OrderableDBInstanceOption" data type. * **Name** *(string) --* The name of the Availability Zone. * **MultiAZCapable** *(boolean) --* Indicates whether a DB instance is Multi-AZ capable. * **ReadReplicaCapable** *(boolean) --* Indicates whether a DB instance can have a read replica. * **Vpc** *(boolean) --* Indicates whether a DB instance is in a VPC. * **SupportsStorageEncryption** *(boolean) --* Indicates whether a DB instance supports encrypted storage. * **StorageType** *(string) --* 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) --* Indicates whether a DB instance supports Performance Insights. * **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. * *(string) --* * **SupportsStorageAutoscaling** *(boolean) --* Indicates whether Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class. * **SupportsKerberosAuthentication** *(boolean) --* Indicates whether a DB instance supports Kerberos Authentication. * **OutpostCapable** *(boolean) --* Indicates whether a DB instance supports RDS on Outposts. For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the *Amazon RDS User Guide.* * **SupportedActivityStreamModes** *(list) --* The list of supported modes for Database Activity Streams. Aurora PostgreSQL returns the value "[sync, async]". Aurora MySQL and RDS for Oracle return "[async]" only. If Database Activity Streams isn't supported, the return value is an empty list. * *(string) --* * **SupportsGlobalDatabases** *(boolean) --* Indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes. * **SupportsClusters** *(boolean) --* Indicates whether DB instances can be configured as a Multi-AZ DB cluster. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the *Amazon RDS User Guide.* * **SupportedNetworkTypes** *(list) --* The network types supported by the DB instance ( "IPV4" or "DUAL"). A DB instance can support only the IPv4 protocol or the IPv4 and the IPv6 protocols ( "DUAL"). For more information, see Working with a DB instance in a VPC in the *Amazon RDS User Guide.* * *(string) --* * **SupportsStorageThroughput** *(boolean) --* Indicates whether a DB instance supports storage throughput. * **MinStorageThroughputPerDbInstance** *(integer) --* Minimum storage throughput for a DB instance. * **MaxStorageThroughputPerDbInstance** *(integer) --* Maximum storage throughput for a DB instance. * **MinStorageThroughputPerIops** *(float) --* Minimum storage throughput to provisioned IOPS ratio for a DB instance. * **MaxStorageThroughputPerIops** *(float) --* Maximum storage throughput to provisioned IOPS ratio for a DB instance. * **SupportsDedicatedLogVolume** *(boolean) --* Indicates whether a DB instance supports using a dedicated log volume (DLV). * **NextToken** *(string) --* A token to resume pagination. RDS / Client / modify_option_group modify_option_group ******************* RDS.Client.modify_option_group(**kwargs) Modifies an existing option group. See also: AWS API Documentation **Request Syntax** response = client.modify_option_group( OptionGroupName='string', OptionsToInclude=[ { 'OptionName': 'string', 'Port': 123, 'OptionVersion': 'string', 'DBSecurityGroupMemberships': [ 'string', ], 'VpcSecurityGroupMemberships': [ 'string', ], 'OptionSettings': [ { 'Name': 'string', 'Value': 'string', 'DefaultValue': 'string', 'Description': 'string', 'ApplyType': 'string', 'DataType': 'string', 'AllowedValues': 'string', 'IsModifiable': True|False, 'IsCollection': True|False }, ] }, ], OptionsToRemove=[ 'string', ], ApplyImmediately=True|False ) Parameters: * **OptionGroupName** (*string*) -- **[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 * **OptionsToInclude** (*list*) -- Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration. * *(dict) --* A list of all available options for an option group. * **OptionName** *(string) --* **[REQUIRED]** The configuration of options to include in a group. * **Port** *(integer) --* The optional port for the option. * **OptionVersion** *(string) --* The version for the option. * **DBSecurityGroupMemberships** *(list) --* A list of DB security groups used for this option. * *(string) --* * **VpcSecurityGroupMemberships** *(list) --* A list of VPC security group names used for this option. * *(string) --* * **OptionSettings** *(list) --* The option settings to include in an option group. * *(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) --* Indicates whether the option setting can be modified from the default. * **IsCollection** *(boolean) --* Indicates whether the option setting is part of a collection. * **OptionsToRemove** (*list*) -- Options in this list are removed from the option group. * *(string) --* * **ApplyImmediately** (*boolean*) -- Specifies whether to apply the change immediately or during the next maintenance window for each instance associated with the option group. Return type: dict Returns: **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', 'SourceOptionGroup': 'string', 'SourceAccountId': 'string', 'CopyTimestamp': datetime(2015, 1, 1) } } **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) --* The details of an option. * **OptionName** *(string) --* The name of the option. * **OptionDescription** *(string) --* The description of the option. * **Persistent** *(boolean) --* Indicates whether this option is persistent. * **Permanent** *(boolean) --* Indicates whether 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) --* Indicates whether the option setting can be modified from the default. * **IsCollection** *(boolean) --* Indicates whether 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: * "ModifyDBInstance" * "RebootDBInstance" * "RestoreDBInstanceFromDBSnapshot" * "RestoreDBInstanceToPointInTime" * **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 membership status of the VPC security group. Currently, the only valid status is "active". * **AllowsVpcAndNonVpcInstanceMemberships** *(boolean) --* Indicates whether this option group can be applied to both VPC and non-VPC instances. The value "true" indicates the option group can be applied to both VPC and non-VPC instances. * **VpcId** *(string) --* If **AllowsVpcAndNonVpcInstanceMemberships** is "false", this field is blank. If **AllowsVpcAndNonVpcInstanceMemberships** is "true" and this field is blank, then this option group can be applied to both VPC and non-VPC instances. If this field contains a value, then this option group can only be applied to instances that are in the VPC indicated by this field. * **OptionGroupArn** *(string) --* Specifies the Amazon Resource Name (ARN) for the option group. * **SourceOptionGroup** *(string) --* Specifies the name of the option group from which this option group is copied. * **SourceAccountId** *(string) --* Specifies the Amazon Web Services account ID for the option group from which this option group is copied. * **CopyTimestamp** *(datetime) --* Indicates when the option group was copied. **Exceptions** * "RDS.Client.exceptions.InvalidOptionGroupStateFault" * "RDS.Client.exceptions.OptionGroupNotFoundFault" **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: { 'OptionGroup': { }, 'ResponseMetadata': { '...': '...', }, } RDS / Client / describe_db_cluster_snapshot_attributes describe_db_cluster_snapshot_attributes *************************************** RDS.Client.describe_db_cluster_snapshot_attributes(**kwargs) Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot. When sharing snapshots with other Amazon Web Services accounts, "DescribeDBClusterSnapshotAttributes" returns the "restore" attribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore the manual DB cluster snapshot. If "all" is included in the list of values for the "restore" attribute, then the manual DB cluster snapshot is public and can be copied or restored by all Amazon Web Services accounts. To add or remove access for an Amazon Web Services account to copy or restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or private, use the "ModifyDBClusterSnapshotAttribute" API action. See also: AWS API Documentation **Request Syntax** response = client.describe_db_cluster_snapshot_attributes( DBClusterSnapshotIdentifier='string' ) Parameters: **DBClusterSnapshotIdentifier** (*string*) -- **[REQUIRED]** The identifier for the DB cluster snapshot to describe the attributes for. Return type: dict Returns: **Response Syntax** { 'DBClusterSnapshotAttributesResult': { 'DBClusterSnapshotIdentifier': 'string', 'DBClusterSnapshotAttributes': [ { 'AttributeName': 'string', 'AttributeValues': [ 'string', ] }, ] } } **Response Structure** * *(dict) --* * **DBClusterSnapshotAttributesResult** *(dict) --* Contains the results of a successful call to the "DescribeDBClusterSnapshotAttributes" API action. Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot. For more information, see the "ModifyDBClusterSnapshotAttribute" API action. * **DBClusterSnapshotIdentifier** *(string) --* The identifier of the manual DB cluster snapshot that the attributes apply to. * **DBClusterSnapshotAttributes** *(list) --* The list of attributes and values for the manual DB cluster snapshot. * *(dict) --* Contains the name and values of a manual DB cluster snapshot attribute. Manual DB cluster snapshot attributes are used to authorize other Amazon Web Services accounts to restore a manual DB cluster snapshot. For more information, see the "ModifyDBClusterSnapshotAttribute" API action. * **AttributeName** *(string) --* The name of the manual DB cluster snapshot attribute. The attribute named "restore" refers to the list of Amazon Web Services accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the "ModifyDBClusterSnapshotAttribute" API action. * **AttributeValues** *(list) --* The value(s) for the manual DB cluster snapshot attribute. If the "AttributeName" field is set to "restore", then this element returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual DB cluster snapshot. If a value of "all" is in the list, then the manual DB cluster snapshot is public and available for any Amazon Web Services account to copy or restore. * *(string) --* **Exceptions** * "RDS.Client.exceptions.DBClusterSnapshotNotFoundFault" **Examples** This example lists attributes for the specified DB cluster snapshot. response = client.describe_db_cluster_snapshot_attributes( DBClusterSnapshotIdentifier='mydbclustersnapshot', ) print(response) Expected Output: { 'DBClusterSnapshotAttributesResult': { }, 'ResponseMetadata': { '...': '...', }, } RDS / Client / describe_engine_default_cluster_parameters describe_engine_default_cluster_parameters ****************************************** RDS.Client.describe_engine_default_cluster_parameters(**kwargs) Returns the default engine and system parameter information for the cluster database engine. For more information on Amazon Aurora, see What is Amazon Aurora? in the *Amazon Aurora User Guide*. See also: AWS API Documentation **Request Syntax** response = client.describe_engine_default_cluster_parameters( DBParameterGroupFamily='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], MaxRecords=123, Marker='string' ) Parameters: * **DBParameterGroupFamily** (*string*) -- **[REQUIRED]** The name of the DB cluster parameter group family to return engine parameter information for. * **Filters** (*list*) -- This parameter isn't currently supported. * *(dict) --* 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: * "DescribeDBClusterBacktracks" * "DescribeDBClusterEndpoints" * "DescribeDBClusters" * "DescribeDBInstances" * "DescribeDBRecommendations" * "DescribeDBShardGroups" * "DescribePendingMaintenanceActions" * **Name** *(string) --* **[REQUIRED]** The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* **[REQUIRED]** One or more filter values. Filter values are case- sensitive. * *(string) --* * **MaxRecords** (*integer*) -- 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. * **Marker** (*string*) -- An optional pagination token provided by a previous "DescribeEngineDefaultClusterParameters" request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by "MaxRecords". Return type: dict Returns: **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) --* The name of the parameter. * **ParameterValue** *(string) --* The value of the parameter. * **Description** *(string) --* Provides a description of the parameter. * **Source** *(string) --* 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. * *(string) --* **Examples** This example lists default parameters for the specified DB cluster engine. response = client.describe_engine_default_cluster_parameters( DBParameterGroupFamily='aurora5.6', ) print(response) Expected Output: { 'EngineDefaults': { }, 'ResponseMetadata': { '...': '...', }, } RDS / Client / create_db_instance_read_replica create_db_instance_read_replica ******************************* RDS.Client.create_db_instance_read_replica(**kwargs) Creates a new DB instance that acts as a read replica for an existing source DB instance or Multi-AZ DB cluster. You can create a read replica for a DB instance running MariaDB, MySQL, Oracle, PostgreSQL, or SQL Server. You can create a read replica for a Multi-AZ DB cluster running MySQL or PostgreSQL. For more information, see Working with read replicas and Migrating from a Multi-AZ DB cluster to a DB instance using a read replica in the *Amazon RDS User Guide*. Amazon RDS for Db2 supports this operation for standby replicas. To create a standby replica for a DB instance running Db2, you must set "ReplicaMode" to "mounted". Amazon Aurora doesn't support this operation. To create a DB instance for an Aurora DB cluster, use the "CreateDBInstance" operation. RDS creates read replicas with backups disabled. All other attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance or cluster, except as specified. Warning: Your source DB instance or cluster 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, DatabaseInsightsMode='standard'|'advanced', EnablePerformanceInsights=True|False, PerformanceInsightsKMSKeyId='string', PerformanceInsightsRetentionPeriod=123, EnableCloudwatchLogsExports=[ 'string', ], ProcessorFeatures=[ { 'Name': 'string', 'Value': 'string' }, ], UseDefaultProcessorFeatures=True|False, DeletionProtection=True|False, Domain='string', DomainIAMRoleName='string', DomainFqdn='string', DomainOu='string', DomainAuthSecretArn='string', DomainDnsIps=[ 'string', ], ReplicaMode='open-read-only'|'mounted', MaxAllocatedStorage=123, CustomIamInstanceProfile='string', NetworkType='string', StorageThroughput=123, EnableCustomerOwnedIp=True|False, BackupTarget='string', AllocatedStorage=123, SourceDBClusterIdentifier='string', DedicatedLogVolume=True|False, UpgradeStorageConfig=True|False, CACertificateIdentifier='string', SourceRegion='string' ) Parameters: * **DBInstanceIdentifier** (*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. * **SourceDBInstanceIdentifier** (*string*) -- The identifier of the DB instance that will act as the source for the read replica. Each DB instance can have up to 15 read replicas, except for the following engines: * Db2 - Can have up to three replicas. * Oracle - Can have up to five read replicas. * SQL Server - Can have up to five read replicas. Constraints: * Must be the identifier of an existing Db2, MariaDB, MySQL, Oracle, PostgreSQL, or SQL Server DB instance. * Can't be specified if the "SourceDBClusterIdentifier" parameter is also specified. * For the limitations of Oracle read replicas, see Version and licensing considerations for RDS for Oracle replicas in the *Amazon RDS User Guide*. * For the limitations of SQL Server read replicas, see Read replica limitations with SQL Server in the *Amazon RDS User Guide*. * The specified DB instance must have automatic backups enabled, that is, its backup retention period must be greater than 0. * If the source DB instance is in the same Amazon Web Services Region as the read replica, specify a valid DB instance identifier. * If the source DB instance is in a different Amazon Web Services Region from the read replica, specify a valid DB instance ARN. For more information, see Constructing an ARN for Amazon RDS in the *Amazon RDS User Guide*. This doesn't apply to SQL Server or RDS Custom, which don't support cross-Region replicas. * **DBInstanceClass** (*string*) -- The compute and memory capacity of the read replica, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the *Amazon RDS User Guide*. Default: Inherits the value from the source DB instance. * **AvailabilityZone** (*string*) -- The Availability Zone (AZ) where the read replica will be created. Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region. Example: "us-east-1d" * **Port** (*integer*) -- The port number that the DB instance uses for connections. Valid Values: "1150-65535" Default: Inherits the value from the source DB instance. * **MultiAZ** (*boolean*) -- Specifies 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 is a Multi-AZ DB instance or a Multi-AZ DB cluster. This setting doesn't apply to RDS Custom DB instances. * **AutoMinorVersionUpgrade** (*boolean*) -- Specifies whether to automatically apply minor engine upgrades to the read replica during the maintenance window. This setting doesn't apply to RDS Custom DB instances. Default: Inherits the value from the source DB instance. For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version. * **Iops** (*integer*) -- The amount of Provisioned IOPS (input/output operations per second) to initially allocate for the DB instance. * **OptionGroupName** (*string*) -- The option group to associate the DB instance with. If not specified, RDS uses the option group associated with the source DB instance or cluster. Note: For SQL Server, you must use the option group associated with the source. This setting doesn't apply to RDS Custom DB instances. * **DBParameterGroupName** (*string*) -- The name of the DB parameter group to associate with this read replica DB instance. For the Db2 DB engine, if your source DB instance uses the Bring Your Own License model, then a custom parameter group must be associated with the replica. For a same Amazon Web Services Region replica, if you don't specify a custom parameter group, Amazon RDS associates the custom parameter group associated with the source DB instance. For a cross- Region replica, you must specify a custom parameter group. This custom parameter group must include your IBM Site ID and IBM Customer ID. For more information, see IBM IDs for Bring Your Own License for Db2. For Single-AZ or Multi-AZ DB instance read replica instances, if you don't specify a value for "DBParameterGroupName", then Amazon RDS uses the "DBParameterGroup" of the source DB instance for a same Region read replica, or the default "DBParameterGroup" for the specified DB engine for a cross- Region read replica. For Multi-AZ DB cluster same Region read replica instances, if you don't specify a value for "DBParameterGroupName", then Amazon RDS uses the default "DBParameterGroup". Specifying a parameter group for this operation is only supported for MySQL DB instances for cross-Region read replicas, for Multi-AZ DB cluster read replica instances, for Db2 DB instances, and for Oracle DB instances. It isn't supported for MySQL DB instances for same Region read replicas or for RDS Custom. Constraints: * Must be 1 to 255 letters, numbers, or hyphens. * First character must be a letter. * Can't end with a hyphen or contain two consecutive hyphens. * **PubliclyAccessible** (*boolean*) -- Specifies whether the DB instance is publicly accessible. When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it. When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance. * **Tags** (*list*) -- A list of tags. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **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}_.:/=+\-@]*)$"). * **DBSubnetGroupName** (*string*) -- 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: * If supplied, must match the name of an existing DB subnet group. * The specified DB subnet group must be in the same Amazon Web Services Region in which the operation is running. * All read replicas in one Amazon Web Services Region that are created from the same source DB instance must either: * Specify DB subnet groups from the same VPC. All these read replicas are created in the same VPC. * Not specify a DB subnet group. All these read replicas are created outside of any VPC. Example: "mydbsubnetgroup" * **VpcSecurityGroupIds** (*list*) -- A list of Amazon EC2 VPC security groups to associate with the read replica. This setting doesn't apply to RDS Custom DB instances. Default: The default EC2 VPC security group for the DB subnet group's VPC. * *(string) --* * **StorageType** (*string*) -- The storage type to associate with the read replica. If you specify "io1", "io2", or "gp3", you must also include a value for the "Iops" parameter. Valid Values: "gp2 | gp3 | io1 | io2 | standard" Default: "io1" if the "Iops" parameter is specified. Otherwise, "gp3". * **CopyTagsToSnapshot** (*boolean*) -- Specifies whether to copy all tags from the read replica to snapshots of the read replica. By default, tags aren't copied. * **MonitoringInterval** (*integer*) -- The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the read replica. To disable collection of Enhanced Monitoring metrics, specify "0". The default is "0". If "MonitoringRoleArn" is specified, then you must set "MonitoringInterval" to a value other than "0". This setting doesn't apply to RDS Custom DB instances. Valid Values: "0, 1, 5, 10, 15, 30, 60" Default: "0" * **MonitoringRoleArn** (*string*) -- The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, "arn:aws:iam:123456789012:role/emaccess". For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring in the *Amazon RDS User Guide*. If "MonitoringInterval" is set to a value other than 0, then you must supply a "MonitoringRoleArn" value. This setting doesn't apply to RDS Custom DB instances. * **KmsKeyId** (*string*) -- The Amazon Web Services KMS key identifier for an encrypted read replica. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you create an encrypted read replica in the same Amazon Web Services Region as the source DB instance or Multi-AZ DB cluster, don't specify a value for this parameter. A read replica in the same Amazon Web Services Region is always encrypted with the same KMS key as the source DB instance or cluster. If you create an encrypted read replica in a different Amazon Web Services Region, then you must specify a KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region that they are created in, and you can't use KMS keys from one Amazon Web Services Region in another Amazon Web Services Region. You can't create an encrypted read replica from an unencrypted DB instance or Multi-AZ DB cluster. This setting doesn't apply to RDS Custom, which uses the same KMS key as the primary replica. * **PreSignedUrl** (*string*) -- When you are creating a read replica from one Amazon Web Services GovCloud (US) Region to another or from one China Amazon Web Services Region to another, the URL that contains a Signature Version 4 signed request for the "CreateDBInstanceReadReplica" API operation in the source Amazon Web Services Region that contains the source DB instance. This setting applies only to Amazon Web Services GovCloud (US) Regions and China Amazon Web Services Regions. It's ignored in other Amazon Web Services Regions. This setting applies only when replicating from a source DB *instance*. Source DB clusters aren't supported in Amazon Web Services GovCloud (US) Regions and China Amazon Web Services Regions. You must specify this parameter when you create an encrypted read replica from another Amazon Web Services Region by using the Amazon RDS API. Don't specify "PreSignedUrl" when you are creating an encrypted read replica in the same Amazon Web Services Region. The presigned URL must be a valid request for the "CreateDBInstanceReadReplica" API operation that can run in the source Amazon Web Services Region that contains the encrypted source DB instance. The presigned URL request must contain the following parameter values: * "DestinationRegion" - The Amazon Web Services Region that the encrypted read replica is created in. This Amazon Web Services Region is the same one where the "CreateDBInstanceReadReplica" operation is called that contains this presigned URL. For example, if you create an encrypted DB instance in the us-west-1 Amazon Web Services Region, from a source DB instance in the us-east-2 Amazon Web Services Region, then you call the "CreateDBInstanceReadReplica" operation in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the "CreateDBInstanceReadReplica" operation in the us-west-2 Amazon Web Services Region. For this example, the "DestinationRegion" in the presigned URL must be set to the us-east-1 Amazon Web Services Region. * "KmsKeyId" - The KMS key identifier for the key to use to encrypt the read replica in the destination Amazon Web Services Region. This is the same identifier for both the "CreateDBInstanceReadReplica" operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL. * "SourceDBInstanceIdentifier" - The DB instance identifier for the encrypted DB instance to be replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are creating an encrypted read replica from a DB instance in the us-west-2 Amazon Web Services Region, then your "SourceDBInstanceIdentifier" looks like the following example: "arn:aws:rds:us-west-2:123456789012:instance:mysql- instance1-20161115". To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process. Note: If you are using an Amazon Web Services SDK tool or the CLI, you can specify "SourceRegion" (or "--source-region" for the CLI) instead of specifying "PreSignedUrl" manually. Specifying "SourceRegion" autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region. This setting doesn't apply to RDS Custom DB instances. Please note that this parameter is automatically populated if it is not provided. Including this parameter is not required * **EnableIAMDatabaseAuthentication** (*boolean*) -- Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled. For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the *Amazon RDS User Guide*. This setting doesn't apply to RDS Custom DB instances. * **DatabaseInsightsMode** (*string*) -- The mode of Database Insights to enable for the read replica. Note: This setting isn't supported. * **EnablePerformanceInsights** (*boolean*) -- Specifies whether to enable Performance Insights for the read replica. For more information, see Using Amazon Performance Insights in the *Amazon RDS User Guide*. This setting doesn't apply to RDS Custom DB instances. * **PerformanceInsightsKMSKeyId** (*string*) -- The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you do not specify a value for "PerformanceInsightsKMSKeyId", then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region. This setting doesn't apply to RDS Custom DB instances. * **PerformanceInsightsRetentionPeriod** (*integer*) -- The number of days to retain Performance Insights data. This setting doesn't apply to RDS Custom DB instances. Valid Values: * "7" * *month* * 31, where *month* is a number of months from 1-23. Examples: "93" (3 months * 31), "341" (11 months * 31), "589" (19 months * 31) * "731" Default: "7" days If you specify a retention period that isn't valid, such as "94", Amazon RDS returns an error. * **EnableCloudwatchLogsExports** (*list*) -- The list of logs that the new DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the *Amazon RDS User Guide*. This setting doesn't apply to RDS Custom DB instances. * *(string) --* * **ProcessorFeatures** (*list*) -- The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. This setting doesn't apply to RDS Custom DB instances. * *(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: * "CreateDBInstance" * "ModifyDBInstance" * "RestoreDBInstanceFromDBSnapshot" * "RestoreDBInstanceFromS3" * "RestoreDBInstanceToPointInTime" 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: * "DescribeDBInstances" * "DescribeDBSnapshots" * "DescribeValidDBInstanceModifications" If you call "DescribeDBInstances", "ProcessorFeature" returns non-null values only if the following conditions are met: * You are accessing an Oracle DB instance. * Your Oracle DB instance class supports configuring the number of CPU cores and threads per core. * The current number CPU cores and threads is set to a non- default value. For more information, see Configuring the processor for a DB instance class in RDS for Oracle 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. * **UseDefaultProcessorFeatures** (*boolean*) -- Specifies whether the DB instance class of the DB instance uses its default processor features. This setting doesn't apply to RDS Custom DB instances. * **DeletionProtection** (*boolean*) -- Specifies whether to enable deletion protection for the DB instance. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance. * **Domain** (*string*) -- The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain. For more information, see Kerberos Authentication in the *Amazon RDS User Guide*. This setting doesn't apply to RDS Custom DB instances. * **DomainIAMRoleName** (*string*) -- The name of the IAM role to use when making API calls to the Directory Service. This setting doesn't apply to RDS Custom DB instances. * **DomainFqdn** (*string*) -- The fully qualified domain name (FQDN) of an Active Directory domain. Constraints: * Can't be longer than 64 characters. Example: "mymanagedADtest.mymanagedAD.mydomain" * **DomainOu** (*string*) -- The Active Directory organizational unit for your DB instance to join. Constraints: * Must be in the distinguished name format. * Can't be longer than 64 characters. Example: "OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanage dAD,DC=mydomain" * **DomainAuthSecretArn** (*string*) -- The ARN for the Secrets Manager secret with the credentials for the user joining the domain. Example: "arn:aws:secretsmanager:region:account- number:secret:myselfmanagedADtestsecret-123456" * **DomainDnsIps** (*list*) -- The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers. Constraints: * Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list. Example: "123.124.125.126,234.235.236.237" * *(string) --* * **ReplicaMode** (*string*) -- The open mode of the replica database. Note: This parameter is only supported for Db2 DB instances and Oracle DB instances.Db2 Standby DB replicas are included in Db2 Advanced Edition (AE) and Db2 Standard Edition (SE). The main use case for standby replicas is cross-Region disaster recovery. Because it doesn't accept user connections, a standby replica can't serve a read- only workload. You can create a combination of standby and read-only DB replicas for the same primary DB instance. For more information, see Working with read replicas for Amazon RDS for Db2 in the *Amazon RDS User Guide*. To create standby DB replicas for RDS for Db2, set this parameter to "mounted". Oracle Mounted DB replicas are included in Oracle Database Enterprise Edition. The main use case for mounted replicas is cross- Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload. You can create a combination of mounted and read-only DB replicas for the same primary DB instance. For more information, see Working with read replicas for Amazon RDS for Oracle in the *Amazon RDS User Guide*. For RDS Custom, you must specify this parameter and set it to "mounted". The value won't be set by default. After replica creation, you can manage the open mode manually. * **MaxAllocatedStorage** (*integer*) -- The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the *Amazon RDS User Guide*. * **CustomIamInstanceProfile** (*string*) -- The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements: * The profile must exist in your account. * The profile must have an IAM role that Amazon EC2 has permissions to assume. * The instance profile name and the associated IAM role name must start with the prefix "AWSRDSCustom". For the list of permissions required for the IAM role, see Configure IAM and your VPC in the *Amazon RDS User Guide*. This setting is required for RDS Custom DB instances. * **NetworkType** (*string*) -- The network type of the DB instance. Valid Values: * "IPV4" * "DUAL" The network type is determined by the "DBSubnetGroup" specified for read replica. A "DBSubnetGroup" can support only the IPv4 protocol or the IPv4 and the IPv6 protocols ( "DUAL"). For more information, see Working with a DB instance in a VPC in the *Amazon RDS User Guide.* * **StorageThroughput** (*integer*) -- Specifies the storage throughput value for the read replica. This setting doesn't apply to RDS Custom or Amazon Aurora DB instances. * **EnableCustomerOwnedIp** (*boolean*) -- Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts read replica. A *CoIP* provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the read replica from outside of its virtual private cloud (VPC) on your local network. For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the *Amazon RDS User Guide*. For more information about CoIPs, see Customer-owned IP addresses in the *Amazon Web Services Outposts User Guide*. * **BackupTarget** (*string*) -- The location where RDS stores automated backups and manual snapshots. Valid Values: * "local" for Dedicated Local Zones * "region" for Amazon Web Services Region * **AllocatedStorage** (*integer*) -- The amount of storage (in gibibytes) to allocate initially for the read replica. Follow the allocation rules specified in "CreateDBInstance". This setting isn't valid for RDS for SQL Server. Note: Be sure to allocate enough storage for your read replica so that the create operation can succeed. You can also allocate additional storage for future growth. * **SourceDBClusterIdentifier** (*string*) -- The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas. Constraints: * Must be the identifier of an existing Multi-AZ DB cluster. * Can't be specified if the "SourceDBInstanceIdentifier" parameter is also specified. * The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0. * The source DB cluster must be in the same Amazon Web Services Region as the read replica. Cross-Region replication isn't supported. * **DedicatedLogVolume** (*boolean*) -- Indicates whether the DB instance has a dedicated log volume (DLV) enabled. * **UpgradeStorageConfig** (*boolean*) -- Whether to upgrade the storage file system configuration on the read replica. This option migrates the read replica from the old storage file system layout to the preferred layout. * **CACertificateIdentifier** (*string*) -- The CA certificate identifier to use for the read replica's server certificate. This setting doesn't apply to RDS Custom DB instances. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the *Amazon RDS User Guide* and Using SSL/TLS to encrypt a connection to a DB cluster in the *Amazon Aurora User Guide*. * **SourceRegion** (*string*) -- The ID of the region that contains the source for the read replica. Return type: dict Returns: **Response Syntax** { 'DBInstance': { 'DBInstanceIdentifier': 'string', 'DBInstanceClass': 'string', 'Engine': 'string', 'DBInstanceStatus': 'string', 'AutomaticRestartTime': datetime(2015, 1, 1), 'MasterUsername': 'string', 'DBName': 'string', 'Endpoint': { 'Address': 'string', 'Port': 123, 'HostedZoneId': 'string' }, 'AllocatedStorage': 123, 'InstanceCreateTime': datetime(2015, 1, 1), 'PreferredBackupWindow': 'string', 'BackupRetentionPeriod': 123, 'DBSecurityGroups': [ { 'DBSecurityGroupName': 'string', 'Status': 'string' }, ], 'VpcSecurityGroups': [ { 'VpcSecurityGroupId': 'string', 'Status': 'string' }, ], 'DBParameterGroups': [ { 'DBParameterGroupName': 'string', 'ParameterApplyStatus': 'string' }, ], 'AvailabilityZone': 'string', 'DBSubnetGroup': { 'DBSubnetGroupName': 'string', 'DBSubnetGroupDescription': 'string', 'VpcId': 'string', 'SubnetGroupStatus': 'string', 'Subnets': [ { 'SubnetIdentifier': 'string', 'SubnetAvailabilityZone': { 'Name': 'string' }, 'SubnetOutpost': { 'Arn': 'string' }, 'SubnetStatus': 'string' }, ], 'DBSubnetGroupArn': 'string', 'SupportedNetworkTypes': [ 'string', ] }, 'PreferredMaintenanceWindow': 'string', 'PendingModifiedValues': { 'DBInstanceClass': 'string', 'AllocatedStorage': 123, 'MasterUserPassword': 'string', 'Port': 123, 'BackupRetentionPeriod': 123, 'MultiAZ': True|False, 'EngineVersion': 'string', 'LicenseModel': 'string', 'Iops': 123, 'DBInstanceIdentifier': 'string', 'StorageType': 'string', 'CACertificateIdentifier': 'string', 'DBSubnetGroupName': 'string', 'PendingCloudwatchLogsExports': { 'LogTypesToEnable': [ 'string', ], 'LogTypesToDisable': [ 'string', ] }, 'ProcessorFeatures': [ { 'Name': 'string', 'Value': 'string' }, ], 'IAMDatabaseAuthenticationEnabled': True|False, 'AutomationMode': 'full'|'all-paused', 'ResumeFullAutomationModeTime': datetime(2015, 1, 1), 'StorageThroughput': 123, 'Engine': 'string', 'DedicatedLogVolume': True|False, 'MultiTenant': True|False }, 'LatestRestorableTime': datetime(2015, 1, 1), 'MultiAZ': True|False, 'EngineVersion': 'string', 'AutoMinorVersionUpgrade': True|False, 'ReadReplicaSourceDBInstanceIdentifier': 'string', 'ReadReplicaDBInstanceIdentifiers': [ 'string', ], 'ReadReplicaDBClusterIdentifiers': [ 'string', ], 'ReplicaMode': 'open-read-only'|'mounted', 'LicenseModel': 'string', 'Iops': 123, 'OptionGroupMemberships': [ { 'OptionGroupName': 'string', 'Status': 'string' }, ], 'CharacterSetName': 'string', 'NcharCharacterSetName': 'string', 'SecondaryAvailabilityZone': 'string', 'PubliclyAccessible': True|False, 'StatusInfos': [ { 'StatusType': 'string', 'Normal': True|False, 'Status': 'string', 'Message': 'string' }, ], 'StorageType': 'string', 'TdeCredentialArn': 'string', 'DbInstancePort': 123, 'DBClusterIdentifier': 'string', 'StorageEncrypted': True|False, 'KmsKeyId': 'string', 'DbiResourceId': 'string', 'CACertificateIdentifier': 'string', 'DomainMemberships': [ { 'Domain': 'string', 'Status': 'string', 'FQDN': 'string', 'IAMRoleName': 'string', 'OU': 'string', 'AuthSecretArn': 'string', 'DnsIps': [ 'string', ] }, ], 'CopyTagsToSnapshot': True|False, 'MonitoringInterval': 123, 'EnhancedMonitoringResourceArn': 'string', 'MonitoringRoleArn': 'string', 'PromotionTier': 123, 'DBInstanceArn': 'string', 'Timezone': 'string', 'IAMDatabaseAuthenticationEnabled': True|False, 'DatabaseInsightsMode': 'standard'|'advanced', 'PerformanceInsightsEnabled': True|False, 'PerformanceInsightsKMSKeyId': 'string', 'PerformanceInsightsRetentionPeriod': 123, 'EnabledCloudwatchLogsExports': [ 'string', ], 'ProcessorFeatures': [ { 'Name': 'string', 'Value': 'string' }, ], 'DeletionProtection': True|False, 'AssociatedRoles': [ { 'RoleArn': 'string', 'FeatureName': 'string', 'Status': 'string' }, ], 'ListenerEndpoint': { 'Address': 'string', 'Port': 123, 'HostedZoneId': 'string' }, 'MaxAllocatedStorage': 123, 'TagList': [ { 'Key': 'string', 'Value': 'string' }, ], 'DBInstanceAutomatedBackupsReplications': [ { 'DBInstanceAutomatedBackupsArn': 'string' }, ], 'CustomerOwnedIpEnabled': True|False, 'AwsBackupRecoveryPointArn': 'string', 'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping', 'ActivityStreamKmsKeyId': 'string', 'ActivityStreamKinesisStreamName': 'string', 'ActivityStreamMode': 'sync'|'async', 'ActivityStreamEngineNativeAuditFieldsIncluded': True|False, 'AutomationMode': 'full'|'all-paused', 'ResumeFullAutomationModeTime': datetime(2015, 1, 1), 'CustomIamInstanceProfile': 'string', 'BackupTarget': 'string', 'NetworkType': 'string', 'ActivityStreamPolicyStatus': 'locked'|'unlocked'|'locking-policy'|'unlocking-policy', 'StorageThroughput': 123, 'DBSystemId': 'string', 'MasterUserSecret': { 'SecretArn': 'string', 'SecretStatus': 'string', 'KmsKeyId': 'string' }, 'CertificateDetails': { 'CAIdentifier': 'string', 'ValidTill': datetime(2015, 1, 1) }, 'ReadReplicaSourceDBClusterIdentifier': 'string', 'PercentProgress': 'string', 'DedicatedLogVolume': True|False, 'IsStorageConfigUpgradeAvailable': True|False, 'MultiTenant': True|False, 'EngineLifecycleSupport': 'string' } } **Response Structure** * *(dict) --* * **DBInstance** *(dict) --* Contains the details of an Amazon RDS DB instance. This data type is used as a response element in the operations "CreateDBInstance", "CreateDBInstanceReadReplica", "DeleteDBInstance", "DescribeDBInstances", "ModifyDBInstance", "PromoteReadReplica", "RebootDBInstance", "RestoreDBInstanceFromDBSnapshot", "RestoreDBInstanceFromS3", "RestoreDBInstanceToPointInTime", "StartDBInstance", and "StopDBInstance". * **DBInstanceIdentifier** *(string) --* The user-supplied database identifier. This identifier is the unique key that identifies a DB instance. * **DBInstanceClass** *(string) --* The name of the compute and memory capacity class of the DB instance. * **Engine** *(string) --* The database engine used for this DB instance. * **DBInstanceStatus** *(string) --* The current state of this database. For information about DB instance statuses, see Viewing DB instance status in the *Amazon RDS User Guide.* * **AutomaticRestartTime** *(datetime) --* The time when a stopped DB instance is restarted automatically. * **MasterUsername** *(string) --* The master username for the DB instance. * **DBName** *(string) --* The initial database name that you provided (if required) when you created the DB instance. This name is returned for the life of your DB instance. For an RDS for Oracle CDB instance, the name identifies the PDB rather than the CDB. * **Endpoint** *(dict) --* The connection endpoint for the DB instance. Note: The endpoint might not be shown for instances with the status of "creating". * **Address** *(string) --* Specifies the DNS address of the DB instance. * **Port** *(integer) --* Specifies the port that the database engine is listening on. * **HostedZoneId** *(string) --* Specifies the ID that Amazon Route 53 assigns when you create a hosted zone. * **AllocatedStorage** *(integer) --* The amount of storage in gibibytes (GiB) allocated for the DB instance. * **InstanceCreateTime** *(datetime) --* The date and time when the DB instance was created. * **PreferredBackupWindow** *(string) --* The daily time range during which automated backups are created if automated backups are enabled, as determined by the "BackupRetentionPeriod". * **BackupRetentionPeriod** *(integer) --* 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: * "ModifyDBInstance" * "RebootDBInstance" * "RestoreDBInstanceFromDBSnapshot" * "RestoreDBInstanceToPointInTime" * **DBSecurityGroupName** *(string) --* The name of the DB security group. * **Status** *(string) --* The status of the DB security group. * **VpcSecurityGroups** *(list) --* The list of Amazon EC2 VPC security groups that the DB instance belongs to. * *(dict) --* This data type is used as a response element for queries on VPC security group membership. * **VpcSecurityGroupId** *(string) --* The name of the VPC security group. * **Status** *(string) --* The membership status of the VPC security group. Currently, the only valid status is "active". * **DBParameterGroups** *(list) --* 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: * "CreateDBInstance" * "CreateDBInstanceReadReplica" * "DeleteDBInstance" * "ModifyDBInstance" * "RebootDBInstance" * "RestoreDBInstanceFromDBSnapshot" * **DBParameterGroupName** *(string) --* The name of the DB parameter group. * **ParameterApplyStatus** *(string) --* The status of parameter updates. Valid values are: * "applying": The parameter group change is being applied to the database. * "failed-to-apply": The parameter group is in an invalid state. * "in-sync": The parameter group change is synchronized with the database. * "pending-database-upgrade": The parameter group change will be applied after the DB instance is upgraded. * "pending-reboot": The parameter group change will be applied after the DB instance reboots. * **AvailabilityZone** *(string) --* The name of the Availability Zone where the DB instance is located. * **DBSubnetGroup** *(dict) --* Information about 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. The list of subnets shown here might not reflect the current state of your VPC. For the most up-to-date information, we recommend checking your VPC configuration directly. * *(dict) --* This data type is used as a response element for the "DescribeDBSubnetGroups" operation. * **SubnetIdentifier** *(string) --* The identifier of the subnet. * **SubnetAvailabilityZone** *(dict) --* Contains Availability Zone information. This data type is used as an element in the "OrderableDBInstanceOption" data type. * **Name** *(string) --* The name of the Availability Zone. * **SubnetOutpost** *(dict) --* If the subnet is associated with an Outpost, this value specifies the Outpost. For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the *Amazon RDS User Guide.* * **Arn** *(string) --* The Amazon Resource Name (ARN) of the Outpost. * **SubnetStatus** *(string) --* The status of the subnet. * **DBSubnetGroupArn** *(string) --* The Amazon Resource Name (ARN) for the DB subnet group. * **SupportedNetworkTypes** *(list) --* The network type of the DB subnet group. Valid values: * "IPV4" * "DUAL" A "DBSubnetGroup" can support only the IPv4 protocol or the IPv4 and the IPv6 protocols ( "DUAL"). For more information, see Working with a DB instance in a VPC in the *Amazon RDS User Guide.* * *(string) --* * **PreferredMaintenanceWindow** *(string) --* The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). * **PendingModifiedValues** *(dict) --* Information about pending changes to the DB instance. This information is returned only when there are pending changes. Specific changes are identified by subelements. * **DBInstanceClass** *(string) --* The name of the compute and memory capacity class for the DB instance. * **AllocatedStorage** *(integer) --* The allocated storage size for the DB instance specified in gibibytes (GiB). * **MasterUserPassword** *(string) --* The master credentials for the DB instance. * **Port** *(integer) --* The port for the DB instance. * **BackupRetentionPeriod** *(integer) --* The number of days for which automated backups are retained. * **MultiAZ** *(boolean) --* Indicates whether the Single-AZ DB instance will change to a Multi-AZ deployment. * **EngineVersion** *(string) --* The database engine version. * **LicenseModel** *(string) --* The license model for the DB instance. Valid values: "license-included" | "bring-your-own- license" | "general-public-license" * **Iops** *(integer) --* The Provisioned IOPS value for the DB instance. * **DBInstanceIdentifier** *(string) --* The database identifier for the DB instance. * **StorageType** *(string) --* The storage type of the DB instance. * **CACertificateIdentifier** *(string) --* The identifier of the CA certificate for the DB instance. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the *Amazon RDS User Guide* and Using SSL/TLS to encrypt a connection to a DB cluster in the *Amazon Aurora User Guide*. * **DBSubnetGroupName** *(string) --* The DB subnet group for the DB instance. * **PendingCloudwatchLogsExports** *(dict) --* A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated. * **LogTypesToEnable** *(list) --* Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs. * *(string) --* * **LogTypesToDisable** *(list) --* Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs. * *(string) --* * **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: * "CreateDBInstance" * "ModifyDBInstance" * "RestoreDBInstanceFromDBSnapshot" * "RestoreDBInstanceFromS3" * "RestoreDBInstanceToPointInTime" 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: * "DescribeDBInstances" * "DescribeDBSnapshots" * "DescribeValidDBInstanceModifications" If you call "DescribeDBInstances", "ProcessorFeature" returns non-null values only if the following conditions are met: * You are accessing an Oracle DB instance. * Your Oracle DB instance class supports configuring the number of CPU cores and threads per core. * The current number CPU cores and threads is set to a non-default value. For more information, see Configuring the processor for a DB instance class in RDS for Oracle 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. * **IAMDatabaseAuthenticationEnabled** *(boolean) --* Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled. * **AutomationMode** *(string) --* The automation mode of the RDS Custom DB instance: "full" or "all-paused". If "full", the DB instance automates monitoring and instance recovery. If "all- paused", the instance pauses automation for the duration set by "--resume-full-automation-mode-minutes". * **ResumeFullAutomationModeTime** *(datetime) --* The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440. * **StorageThroughput** *(integer) --* The storage throughput of the DB instance. * **Engine** *(string) --* The database engine of the DB instance. * **DedicatedLogVolume** *(boolean) --* Indicates whether the DB instance has a dedicated log volume (DLV) enabled.> * **MultiTenant** *(boolean) --* Indicates whether the DB instance will change to the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE). * **LatestRestorableTime** *(datetime) --* The latest time to which a database in this DB instance can be restored with point-in-time restore. * **MultiAZ** *(boolean) --* Indicates whether the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom DB instances. * **EngineVersion** *(string) --* The version of the database engine. * **AutoMinorVersionUpgrade** *(boolean) --* Indicates whether minor version patches are applied automatically. For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version. * **ReadReplicaSourceDBInstanceIdentifier** *(string) --* The identifier of the source DB instance if this DB instance is a read replica. * **ReadReplicaDBInstanceIdentifiers** *(list) --* The identifiers of the read replicas associated with this DB instance. * *(string) --* * **ReadReplicaDBClusterIdentifiers** *(list) --* The identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn't contain information about cross-Region Aurora read replicas. Note: Currently, each RDS DB instance can have only one Aurora read replica. * *(string) --* * **ReplicaMode** *(string) --* The open mode of a Db2 or an Oracle read replica. The default is "open-read-only". For more information, see Working with read replicas for Amazon RDS for Db2 and Working with read replicas for Amazon RDS for Oracle in the *Amazon RDS User Guide*. Note: This attribute is only supported in RDS for Db2, RDS for Oracle, and RDS Custom for Oracle. * **LicenseModel** *(string) --* The license model information for this DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. * **Iops** *(integer) --* The Provisioned IOPS (I/O operations per second) value for the DB instance. * **OptionGroupMemberships** *(list) --* The list of option group memberships for this DB instance. * *(dict) --* Provides information on the option groups the DB instance is a member of. * **OptionGroupName** *(string) --* The name of the option group that the instance belongs to. * **Status** *(string) --* The status of the DB instance's option group membership. Valid values are: "in-sync", "pending- apply", "pending-removal", "pending-maintenance- apply", "pending-maintenance-removal", "applying", "removing", and "failed". * **CharacterSetName** *(string) --* If present, specifies the name of the character set that this instance is associated with. * **NcharCharacterSetName** *(string) --* The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2. * **SecondaryAvailabilityZone** *(string) --* If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support. * **PubliclyAccessible** *(boolean) --* Indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it. When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance. * **StatusInfos** *(list) --* The status of a read replica. If the DB instance isn't a read replica, the value is blank. * *(dict) --* Provides a list of status information for a DB instance. * **StatusType** *(string) --* This value is currently "read replication." * **Normal** *(boolean) --* Indicates whether the instance is operating normally (TRUE) or is in an error state (FALSE). * **Status** *(string) --* The 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) --* The storage type associated with the DB instance. * **TdeCredentialArn** *(string) --* The ARN from the key store with which the instance is associated for TDE encryption. * **DbInstancePort** *(integer) --* 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, indicates the name of the DB cluster that the DB instance is a member of. * **StorageEncrypted** *(boolean) --* Indicates whether the DB instance is encrypted. * **KmsKeyId** *(string) --* If "StorageEncrypted" is enabled, the Amazon Web Services KMS key identifier for the encrypted DB instance. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. * **DbiResourceId** *(string) --* The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB instance is accessed. * **CACertificateIdentifier** *(string) --* The identifier of the CA certificate for this DB instance. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the *Amazon RDS User Guide* and Using SSL/TLS to encrypt a connection to a DB cluster in the *Amazon Aurora User Guide*. * **DomainMemberships** *(list) --* The Active Directory Domain membership records associated with the DB instance. * *(dict) --* An Active Directory Domain membership record associated with the DB instance or cluster. * **Domain** *(string) --* The identifier of the Active Directory Domain. * **Status** *(string) --* The status of the Active Directory Domain membership for the DB instance or cluster. Values include "joined", "pending-join", "failed", and so on. * **FQDN** *(string) --* The fully qualified domain name (FQDN) of the Active Directory Domain. * **IAMRoleName** *(string) --* The name of the IAM role used when making API calls to the Directory Service. * **OU** *(string) --* The Active Directory organizational unit for the DB instance or cluster. * **AuthSecretArn** *(string) --* The ARN for the Secrets Manager secret with the credentials for the user that's a member of the domain. * **DnsIps** *(list) --* The IPv4 DNS IP addresses of the primary and secondary Active Directory domain controllers. * *(string) --* * **CopyTagsToSnapshot** *(boolean) --* Indicates whether tags are copied from the DB instance to snapshots of the DB instance. This setting doesn't apply to Amazon Aurora DB instances. 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) --* The order of priority 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 RDS for Db2 and RDS for SQL Server DB instances that were created with a time zone specified. * **IAMDatabaseAuthenticationEnabled** *(boolean) --* Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled for the DB instance. For a list of engine versions that support IAM database authentication, see IAM database authentication in the *Amazon RDS User Guide* and IAM database authentication in Aurora in the *Amazon Aurora User Guide*. * **DatabaseInsightsMode** *(string) --* The mode of Database Insights that is enabled for the instance. * **PerformanceInsightsEnabled** *(boolean) --* Indicates whether Performance Insights is enabled for the DB instance. * **PerformanceInsightsKMSKeyId** *(string) --* The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. * **PerformanceInsightsRetentionPeriod** *(integer) --* The number of days to retain Performance Insights data. Valid Values: * "7" * *month* * 31, where *month* is a number of months from 1-23. Examples: "93" (3 months * 31), "341" (11 months * 31), "589" (19 months * 31) * "731" Default: "7" days * **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 Monitoring Amazon RDS log files in the *Amazon RDS User Guide.* * *(string) --* * **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: * "CreateDBInstance" * "ModifyDBInstance" * "RestoreDBInstanceFromDBSnapshot" * "RestoreDBInstanceFromS3" * "RestoreDBInstanceToPointInTime" 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: * "DescribeDBInstances" * "DescribeDBSnapshots" * "DescribeValidDBInstanceModifications" If you call "DescribeDBInstances", "ProcessorFeature" returns non-null values only if the following conditions are met: * You are accessing an Oracle DB instance. * Your Oracle DB instance class supports configuring the number of CPU cores and threads per core. * The current number CPU cores and threads is set to a non-default value. For more information, see Configuring the processor for a DB instance class in RDS for Oracle 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. * **DeletionProtection** *(boolean) --* Indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance. * **AssociatedRoles** *(list) --* The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance. * *(dict) --* Information about an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance. * **RoleArn** *(string) --* The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance. * **FeatureName** *(string) --* The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see "DBEngineVersion". * **Status** *(string) --* Information about the state of association between the IAM role and the DB instance. The Status property returns one of the following values: * "ACTIVE" - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf. * "PENDING" - the IAM role ARN is being associated with the DB instance. * "INVALID" - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf. * **ListenerEndpoint** *(dict) --* The listener connection endpoint for SQL Server Always On. * **Address** *(string) --* Specifies the DNS address of the DB instance. * **Port** *(integer) --* Specifies the port that the database engine is listening on. * **HostedZoneId** *(string) --* Specifies the ID that Amazon Route 53 assigns when you create a hosted zone. * **MaxAllocatedStorage** *(integer) --* The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. * **TagList** *(list) --* A list of tags. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **Key** *(string) --* A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **Value** *(string) --* A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **DBInstanceAutomatedBackupsReplications** *(list) --* The list of replicated automated backups associated with the DB instance. * *(dict) --* Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties. * **DBInstanceAutomatedBackupsArn** *(string) --* The Amazon Resource Name (ARN) of the replicated automated backups. * **CustomerOwnedIpEnabled** *(boolean) --* Indicates whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance. A >>*<>*< --engine-version " For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, use the following command: "aws rds describe-db-engine-versions --engine postgres --engine-version 13.3" The supported features are listed under "SupportedFeatureNames" in the output. * *(string) --* * **Status** *(string) --* The status of the DB engine version, either "available" or "deprecated". * **SupportsParallelQuery** *(boolean) --* Indicates whether you can use Aurora parallel query with a specific DB engine version. * **SupportsGlobalDatabases** *(boolean) --* Indicates whether you can use Aurora global databases with a specific DB engine version. * **MajorEngineVersion** *(string) --* The major engine version of the CEV. * **DatabaseInstallationFilesS3BucketName** *(string) --* The name of the Amazon S3 bucket that contains your database installation files. * **DatabaseInstallationFilesS3Prefix** *(string) --* The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed. * **DBEngineVersionArn** *(string) --* The ARN of the custom engine version. * **KMSKeyId** *(string) --* The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS. * **CreateTime** *(datetime) --* The creation time of the DB engine version. * **TagList** *(list) --* A list of tags. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **Key** *(string) --* A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **Value** *(string) --* A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **SupportsBabelfish** *(boolean) --* Indicates whether the engine version supports Babelfish for Aurora PostgreSQL. * **CustomDBEngineVersionManifest** *(string) --* JSON string that lists the installation files and parameters that RDS Custom uses to create a custom engine version (CEV). RDS Custom applies the patches in the order in which they're listed in the manifest. You can set the Oracle home, Oracle base, and UNIX/Linux user and group using the installation parameters. For more information, see JSON fields in the CEV manifest in the *Amazon RDS User Guide*. * **SupportsLimitlessDatabase** *(boolean) --* Indicates whether the DB engine version supports Aurora Limitless Database. * **SupportsCertificateRotationWithoutRestart** *(boolean) --* Indicates whether the engine version supports rotating the server certificate without rebooting the DB instance. * **SupportedCACertificateIdentifiers** *(list) --* A list of the supported CA certificate identifiers. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the *Amazon RDS User Guide* and Using SSL/TLS to encrypt a connection to a DB cluster in the *Amazon Aurora User Guide*. * *(string) --* * **SupportsLocalWriteForwarding** *(boolean) --* Indicates whether the DB engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances. Valid for: Aurora DB clusters only * **SupportsIntegrations** *(boolean) --* Indicates whether the DB engine version supports zero-ETL integrations with Amazon Redshift. * **ServerlessV2FeaturesSupport** *(dict) --* Specifies any Aurora Serverless v2 properties or limits that differ between Aurora engine versions. You can test the values of this attribute when deciding which Aurora version to use in a new or upgraded DB cluster. You can also retrieve the version of an existing DB cluster and check whether that version supports certain Aurora Serverless v2 features before you attempt to use those features. * **MinCapacity** *(float) --* If the minimum capacity is 0 ACUs, the engine version or platform version supports the automatic pause/resume feature of Aurora Serverless v2. * **MaxCapacity** *(float) --* Specifies the upper Aurora Serverless v2 capacity limit for a particular engine version or platform version. Depending on the engine version, the maximum capacity for an Aurora Serverless v2 cluster might be "256" or "128". **Exceptions** * "RDS.Client.exceptions.CustomDBEngineVersionNotFoundFault" * "RDS.Client.exceptions.InvalidCustomDBEngineVersionStateFault" RDS / Client / describe_db_proxy_target_groups describe_db_proxy_target_groups ******************************* RDS.Client.describe_db_proxy_target_groups(**kwargs) Returns information about DB proxy target groups, represented by "DBProxyTargetGroup" data structures. See also: AWS API Documentation **Request Syntax** response = client.describe_db_proxy_target_groups( DBProxyName='string', TargetGroupName='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], Marker='string', MaxRecords=123 ) Parameters: * **DBProxyName** (*string*) -- **[REQUIRED]** The identifier of the "DBProxy" associated with the target group. * **TargetGroupName** (*string*) -- The identifier of the "DBProxyTargetGroup" to describe. * **Filters** (*list*) -- This parameter is not currently supported. * *(dict) --* 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: * "DescribeDBClusterBacktracks" * "DescribeDBClusterEndpoints" * "DescribeDBClusters" * "DescribeDBInstances" * "DescribeDBRecommendations" * "DescribeDBShardGroups" * "DescribePendingMaintenanceActions" * **Name** *(string) --* **[REQUIRED]** The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* **[REQUIRED]** One or more filter values. Filter values are case- sensitive. * *(string) --* * **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". * **MaxRecords** (*integer*) -- 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. Return type: dict Returns: **Response Syntax** { 'TargetGroups': [ { 'DBProxyName': 'string', 'TargetGroupName': 'string', 'TargetGroupArn': 'string', 'IsDefault': True|False, 'Status': 'string', 'ConnectionPoolConfig': { 'MaxConnectionsPercent': 123, 'MaxIdleConnectionsPercent': 123, 'ConnectionBorrowTimeout': 123, 'SessionPinningFilters': [ 'string', ], 'InitQuery': 'string' }, 'CreatedDate': datetime(2015, 1, 1), 'UpdatedDate': datetime(2015, 1, 1) }, ], 'Marker': 'string' } **Response Structure** * *(dict) --* * **TargetGroups** *(list) --* An arbitrary number of "DBProxyTargetGroup" objects, containing details of the corresponding target groups. * *(dict) --* Represents a set of RDS DB instances, Aurora DB clusters, or both that a proxy can connect to. Currently, each target group is associated with exactly one RDS DB instance or Aurora DB cluster. This data type is used as a response element in the "DescribeDBProxyTargetGroups" action. * **DBProxyName** *(string) --* The identifier for the RDS proxy associated with this target group. * **TargetGroupName** *(string) --* The identifier for the target group. This name must be unique for all target groups owned by your Amazon Web Services account in the specified Amazon Web Services Region. * **TargetGroupArn** *(string) --* The Amazon Resource Name (ARN) representing the target group. * **IsDefault** *(boolean) --* Indicates whether this target group is the first one used for connection requests by the associated proxy. Because each proxy is currently associated with a single target group, currently this setting is always "true". * **Status** *(string) --* The current status of this target group. A status of "available" means the target group is correctly associated with a database. Other values indicate that you must wait for the target group to be ready, or take some action to resolve an issue. * **ConnectionPoolConfig** *(dict) --* The settings that determine the size and behavior of the connection pool for the target group. * **MaxConnectionsPercent** *(integer) --* The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the "max_connections" setting for the RDS DB instance or Aurora DB cluster used by the target group. * **MaxIdleConnectionsPercent** *(integer) --* Controls how actively the proxy closes idle database connections in the connection pool. The value is expressed as a percentage of the "max_connections" setting for the RDS DB instance or Aurora DB cluster used by the target group. With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database. * **ConnectionBorrowTimeout** *(integer) --* The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the proxy has opened its maximum number of connections and all connections are busy with client sessions. * **SessionPinningFilters** *(list) --* Each item in the list represents a class of SQL operations that normally cause all later statements in a session using a proxy to be pinned to the same underlying database connection. Including an item in the list exempts that class of SQL operations from the pinning behavior. This setting is only supported for MySQL engine family databases. Currently, the only allowed value is "EXCLUDE_VARIABLE_SETS". * *(string) --* * **InitQuery** *(string) --* One or more SQL statements for the proxy to run when opening each new database connection. The setting is typically used with "SET" statements to make sure that each connection has identical settings. The query added here must be valid. For including multiple variables in a single SET statement, use a comma separator. This is an optional field. For example: "SET variable1=value1, variable2=value2" Warning: Since you can access initialization query as part of target group configuration, it is not protected by authentication or cryptographic methods. Anyone with access to view or manage your proxy target group configuration can view the initialization query. You should not add sensitive data, such as passwords or long-lived encryption keys, to this option. * **CreatedDate** *(datetime) --* The date and time when the target group was first created. * **UpdatedDate** *(datetime) --* The date and time when the target group was last updated. * **Marker** *(string) --* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by "MaxRecords". **Exceptions** * "RDS.Client.exceptions.DBProxyNotFoundFault" * "RDS.Client.exceptions.DBProxyTargetGroupNotFoundFault" * "RDS.Client.exceptions.InvalidDBProxyStateFault" RDS / Client / delete_option_group delete_option_group ******************* RDS.Client.delete_option_group(**kwargs) Deletes an existing option group. See also: AWS API Documentation **Request Syntax** response = client.delete_option_group( OptionGroupName='string' ) Parameters: **OptionGroupName** (*string*) -- **[REQUIRED]** The name of the option group to be deleted. Note: You can't delete default option groups. Returns: None **Exceptions** * "RDS.Client.exceptions.OptionGroupNotFoundFault" * "RDS.Client.exceptions.InvalidOptionGroupStateFault" **Examples** This example deletes the specified option group. response = client.delete_option_group( OptionGroupName='mydboptiongroup', ) print(response) Expected Output: { 'ResponseMetadata': { '...': '...', }, } RDS / Client / restore_db_instance_from_s3 restore_db_instance_from_s3 *************************** RDS.Client.restore_db_instance_from_s3(**kwargs) Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files. You can create a backup of your on-premises database, store it on Amazon Simple Storage Service (Amazon S3), and then restore the backup file onto a new Amazon RDS DB instance running MySQL. For more information, see Importing Data into an Amazon RDS MySQL DB Instance in the *Amazon RDS User Guide.* This operation doesn't apply to RDS Custom. See also: AWS API Documentation **Request Syntax** response = client.restore_db_instance_from_s3( DBName='string', DBInstanceIdentifier='string', AllocatedStorage=123, DBInstanceClass='string', Engine='string', MasterUsername='string', MasterUserPassword='string', DBSecurityGroups=[ 'string', ], VpcSecurityGroupIds=[ 'string', ], AvailabilityZone='string', DBSubnetGroupName='string', PreferredMaintenanceWindow='string', DBParameterGroupName='string', BackupRetentionPeriod=123, PreferredBackupWindow='string', Port=123, MultiAZ=True|False, EngineVersion='string', AutoMinorVersionUpgrade=True|False, LicenseModel='string', Iops=123, OptionGroupName='string', PubliclyAccessible=True|False, Tags=[ { 'Key': 'string', 'Value': 'string' }, ], StorageType='string', StorageEncrypted=True|False, KmsKeyId='string', CopyTagsToSnapshot=True|False, MonitoringInterval=123, MonitoringRoleArn='string', EnableIAMDatabaseAuthentication=True|False, SourceEngine='string', SourceEngineVersion='string', S3BucketName='string', S3Prefix='string', S3IngestionRoleArn='string', DatabaseInsightsMode='standard'|'advanced', EnablePerformanceInsights=True|False, PerformanceInsightsKMSKeyId='string', PerformanceInsightsRetentionPeriod=123, EnableCloudwatchLogsExports=[ 'string', ], ProcessorFeatures=[ { 'Name': 'string', 'Value': 'string' }, ], UseDefaultProcessorFeatures=True|False, DeletionProtection=True|False, MaxAllocatedStorage=123, NetworkType='string', StorageThroughput=123, ManageMasterUserPassword=True|False, MasterUserSecretKmsKeyId='string', DedicatedLogVolume=True|False, CACertificateIdentifier='string', EngineLifecycleSupport='string' ) Parameters: * **DBName** (*string*) -- The name of the database to create when the DB instance is created. Follow the naming rules specified in "CreateDBInstance". * **DBInstanceIdentifier** (*string*) -- **[REQUIRED]** The DB instance identifier. This parameter is stored as a lowercase string. Constraints: * Must contain from 1 to 63 letters, numbers, or hyphens. * First character must be a letter. * Can't end with a hyphen or contain two consecutive hyphens. Example: "mydbinstance" * **AllocatedStorage** (*integer*) -- The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in "CreateDBInstance". This setting isn't valid for RDS for SQL Server. Note: Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also allocate additional storage for future growth. * **DBInstanceClass** (*string*) -- **[REQUIRED]** The compute and memory capacity of the DB instance, for example db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the *Amazon RDS User Guide.* Importing from Amazon S3 isn't supported on the db.t2.micro DB instance class. * **Engine** (*string*) -- **[REQUIRED]** The name of the database engine to be used for this instance. Valid Values: "mysql" * **MasterUsername** (*string*) -- The name for the master user. Constraints: * Must be 1 to 16 letters or numbers. * First character must be a letter. * Can't be a reserved word for the chosen database engine. * **MasterUserPassword** (*string*) -- The password for the master user. Constraints: * Can't be specified if "ManageMasterUserPassword" is turned on. * Can include any printable ASCII character except "/", """, or "@". For RDS for Oracle, can't include the "&" (ampersand) or the "'" (single quotes) character. Length Constraints: * RDS for Db2 - Must contain from 8 to 128 characters. * RDS for MariaDB - Must contain from 8 to 41 characters. * RDS for Microsoft SQL Server - Must contain from 8 to 128 characters. * RDS for MySQL - Must contain from 8 to 41 characters. * RDS for Oracle - Must contain from 8 to 30 characters. * RDS for PostgreSQL - Must contain from 8 to 128 characters. * **DBSecurityGroups** (*list*) -- A list of DB security groups to associate with this DB instance. Default: The default DB security group for the database engine. * *(string) --* * **VpcSecurityGroupIds** (*list*) -- A list of VPC security groups to associate with this DB instance. * *(string) --* * **AvailabilityZone** (*string*) -- The Availability Zone that the DB instance is created in. For information about Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones in the *Amazon RDS User Guide.* Default: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region. Example: "us-east-1d" Constraint: The "AvailabilityZone" parameter can't be specified if the DB instance is a Multi-AZ deployment. The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint. * **DBSubnetGroupName** (*string*) -- A DB subnet group to associate with this DB instance. Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example: "mydbsubnetgroup" * **PreferredMaintenanceWindow** (*string*) -- 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: * Must be in the format "ddd:hh24:mi-ddd:hh24:mi". * Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. * Must be in Universal Coordinated Time (UTC). * Must not conflict with the preferred backup window. * Must be at least 30 minutes. * **DBParameterGroupName** (*string*) -- 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. * **BackupRetentionPeriod** (*integer*) -- The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. For more information, see "CreateDBInstance". * **PreferredBackupWindow** (*string*) -- The time range each day during which automated backups are created if automated backups are enabled. For more information, see Backup window in the *Amazon RDS User Guide.* Constraints: * Must be in the format "hh24:mi-hh24:mi". * Must be in Universal Coordinated Time (UTC). * Must not conflict with the preferred maintenance window. * Must be at least 30 minutes. * **Port** (*integer*) -- The port number on which the database accepts connections. Type: Integer Valid Values: "1150"- "65535" Default: "3306" * **MultiAZ** (*boolean*) -- Specifies whether the DB instance is a Multi-AZ deployment. If the DB instance is a Multi-AZ deployment, you can't set the "AvailabilityZone" parameter. * **EngineVersion** (*string*) -- The version number of the database engine to use. Choose the latest minor version of your database engine. For information about engine versions, see "CreateDBInstance", or call "DescribeDBEngineVersions". * **AutoMinorVersionUpgrade** (*boolean*) -- Specifies whether to automatically apply minor engine upgrades to the DB instance during the maintenance window. By default, minor engine upgrades are not applied automatically. For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version. * **LicenseModel** (*string*) -- The license model for this DB instance. Use "general-public-license". * **Iops** (*integer*) -- The amount of Provisioned IOPS (input/output operations per second) to allocate initially for the DB instance. For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the *Amazon RDS User Guide.* * **OptionGroupName** (*string*) -- The name of the option group to associate with this DB instance. If this argument is omitted, the default option group for the specified engine is used. * **PubliclyAccessible** (*boolean*) -- Specifies whether the DB instance is publicly accessible. When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it. When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance. * **Tags** (*list*) -- A list of tags to associate with this DB instance. For more information, see Tagging Amazon RDS Resources in the *Amazon RDS User Guide.* * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **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}_.:/=+\-@]*)$"). * **StorageType** (*string*) -- Specifies the storage type to be associated with the DB instance. Valid Values: "gp2 | gp3 | io1 | io2 | standard" If you specify "io1", "io2", or "gp3", you must also include a value for the "Iops" parameter. Default: "io1" if the "Iops" parameter is specified; otherwise "gp2" * **StorageEncrypted** (*boolean*) -- Specifies whether the new DB instance is encrypted or not. * **KmsKeyId** (*string*) -- The Amazon Web Services KMS key identifier for an encrypted DB instance. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN. If the "StorageEncrypted" parameter is enabled, and you do not specify a value for the "KmsKeyId" parameter, then Amazon RDS will use your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region. * **CopyTagsToSnapshot** (*boolean*) -- Specifies whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. * **MonitoringInterval** (*integer*) -- 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" * **MonitoringRoleArn** (*string*) -- 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. * **EnableIAMDatabaseAuthentication** (*boolean*) -- Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled. For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the *Amazon RDS User Guide.* * **SourceEngine** (*string*) -- **[REQUIRED]** The name of the engine of your source database. Valid Values: "mysql" * **SourceEngineVersion** (*string*) -- **[REQUIRED]** The version of the database that the backup files were created from. MySQL versions 5.6 and 5.7 are supported. Example: "5.6.40" * **S3BucketName** (*string*) -- **[REQUIRED]** The name of your Amazon S3 bucket that contains your database backup file. * **S3Prefix** (*string*) -- The prefix of your Amazon S3 bucket. * **S3IngestionRoleArn** (*string*) -- **[REQUIRED]** An Amazon Web Services Identity and Access Management (IAM) role with a trust policy and a permissions policy that allows Amazon RDS to access your Amazon S3 bucket. For information about this role, see Creating an IAM role manually in the *Amazon RDS User Guide.* * **DatabaseInsightsMode** (*string*) -- Specifies the mode of Database Insights to enable for the DB instance. Note: Aurora DB instances inherit this value from the DB cluster, so you can't change this value. * **EnablePerformanceInsights** (*boolean*) -- Specifies whether to enable Performance Insights for the DB instance. For more information, see Using Amazon Performance Insights in the *Amazon RDS User Guide*. * **PerformanceInsightsKMSKeyId** (*string*) -- The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you do not specify a value for "PerformanceInsightsKMSKeyId", then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region. * **PerformanceInsightsRetentionPeriod** (*integer*) -- The number of days to retain Performance Insights data. The default is 7 days. The following values are valid: * 7 * *month* * 31, where *month* is a number of months from 1-23 * 731 For example, the following values are valid: * 93 (3 months * 31) * 341 (11 months * 31) * 589 (19 months * 31) * 731 If you specify a retention period such as 94, which isn't a valid value, RDS issues an error. * **EnableCloudwatchLogsExports** (*list*) -- 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*. * *(string) --* * **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: * "CreateDBInstance" * "ModifyDBInstance" * "RestoreDBInstanceFromDBSnapshot" * "RestoreDBInstanceFromS3" * "RestoreDBInstanceToPointInTime" 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: * "DescribeDBInstances" * "DescribeDBSnapshots" * "DescribeValidDBInstanceModifications" If you call "DescribeDBInstances", "ProcessorFeature" returns non-null values only if the following conditions are met: * You are accessing an Oracle DB instance. * Your Oracle DB instance class supports configuring the number of CPU cores and threads per core. * The current number CPU cores and threads is set to a non- default value. For more information, see Configuring the processor for a DB instance class in RDS for Oracle 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. * **UseDefaultProcessorFeatures** (*boolean*) -- Specifies whether the DB instance class of the DB instance uses its default processor features. * **DeletionProtection** (*boolean*) -- Specifies whether to enable deletion protection for the DB instance. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see Deleting a DB Instance. * **MaxAllocatedStorage** (*integer*) -- The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the *Amazon RDS User Guide*. * **NetworkType** (*string*) -- The network type of the DB instance. Valid Values: * "IPV4" * "DUAL" The network type is determined by the "DBSubnetGroup" specified for the DB instance. A "DBSubnetGroup" can support only the IPv4 protocol or the IPv4 and the IPv6 protocols ( "DUAL"). For more information, see Working with a DB instance in a VPC in the *Amazon RDS User Guide.* * **StorageThroughput** (*integer*) -- Specifies the storage throughput value for the DB instance. This setting doesn't apply to RDS Custom or Amazon Aurora. * **ManageMasterUserPassword** (*boolean*) -- Specifies whether to manage the master user password with Amazon Web Services Secrets Manager. For more information, see Password management with Amazon Web Services Secrets Manager in the *Amazon RDS User Guide.* Constraints: * Can't manage the master user password with Amazon Web Services Secrets Manager if "MasterUserPassword" is specified. * **MasterUserSecretKmsKeyId** (*string*) -- The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager. This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB instance. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN. If you don't specify "MasterUserSecretKmsKeyId", then the "aws/secretsmanager" KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the "aws/secretsmanager" KMS key to encrypt the secret, and you must use a customer managed KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region. * **DedicatedLogVolume** (*boolean*) -- Specifies whether to enable a dedicated log volume (DLV) for the DB instance. * **CACertificateIdentifier** (*string*) -- The CA certificate identifier to use for the DB instance's server certificate. This setting doesn't apply to RDS Custom DB instances. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the *Amazon RDS User Guide* and Using SSL/TLS to encrypt a connection to a DB cluster in the *Amazon Aurora User Guide*. * **EngineLifecycleSupport** (*string*) -- The life cycle type for this DB instance. Note: By default, this value is set to "open-source-rds-extended- support", which enrolls your DB instance into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to "open-source-rds-extended-support-disabled". In this case, RDS automatically upgrades your restored DB instance to a higher engine version, if the major engine version is past its end of standard support date. You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Amazon RDS Extended Support Amazon RDS in the *Amazon RDS User Guide*. This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster. Valid Values: "open-source-rds-extended-support | open-source- rds-extended-support-disabled" Default: "open-source-rds-extended-support" Return type: dict Returns: **Response Syntax** { 'DBInstance': { 'DBInstanceIdentifier': 'string', 'DBInstanceClass': 'string', 'Engine': 'string', 'DBInstanceStatus': 'string', 'AutomaticRestartTime': datetime(2015, 1, 1), 'MasterUsername': 'string', 'DBName': 'string', 'Endpoint': { 'Address': 'string', 'Port': 123, 'HostedZoneId': 'string' }, 'AllocatedStorage': 123, 'InstanceCreateTime': datetime(2015, 1, 1), 'PreferredBackupWindow': 'string', 'BackupRetentionPeriod': 123, 'DBSecurityGroups': [ { 'DBSecurityGroupName': 'string', 'Status': 'string' }, ], 'VpcSecurityGroups': [ { 'VpcSecurityGroupId': 'string', 'Status': 'string' }, ], 'DBParameterGroups': [ { 'DBParameterGroupName': 'string', 'ParameterApplyStatus': 'string' }, ], 'AvailabilityZone': 'string', 'DBSubnetGroup': { 'DBSubnetGroupName': 'string', 'DBSubnetGroupDescription': 'string', 'VpcId': 'string', 'SubnetGroupStatus': 'string', 'Subnets': [ { 'SubnetIdentifier': 'string', 'SubnetAvailabilityZone': { 'Name': 'string' }, 'SubnetOutpost': { 'Arn': 'string' }, 'SubnetStatus': 'string' }, ], 'DBSubnetGroupArn': 'string', 'SupportedNetworkTypes': [ 'string', ] }, 'PreferredMaintenanceWindow': 'string', 'PendingModifiedValues': { 'DBInstanceClass': 'string', 'AllocatedStorage': 123, 'MasterUserPassword': 'string', 'Port': 123, 'BackupRetentionPeriod': 123, 'MultiAZ': True|False, 'EngineVersion': 'string', 'LicenseModel': 'string', 'Iops': 123, 'DBInstanceIdentifier': 'string', 'StorageType': 'string', 'CACertificateIdentifier': 'string', 'DBSubnetGroupName': 'string', 'PendingCloudwatchLogsExports': { 'LogTypesToEnable': [ 'string', ], 'LogTypesToDisable': [ 'string', ] }, 'ProcessorFeatures': [ { 'Name': 'string', 'Value': 'string' }, ], 'IAMDatabaseAuthenticationEnabled': True|False, 'AutomationMode': 'full'|'all-paused', 'ResumeFullAutomationModeTime': datetime(2015, 1, 1), 'StorageThroughput': 123, 'Engine': 'string', 'DedicatedLogVolume': True|False, 'MultiTenant': True|False }, 'LatestRestorableTime': datetime(2015, 1, 1), 'MultiAZ': True|False, 'EngineVersion': 'string', 'AutoMinorVersionUpgrade': True|False, 'ReadReplicaSourceDBInstanceIdentifier': 'string', 'ReadReplicaDBInstanceIdentifiers': [ 'string', ], 'ReadReplicaDBClusterIdentifiers': [ 'string', ], 'ReplicaMode': 'open-read-only'|'mounted', 'LicenseModel': 'string', 'Iops': 123, 'OptionGroupMemberships': [ { 'OptionGroupName': 'string', 'Status': 'string' }, ], 'CharacterSetName': 'string', 'NcharCharacterSetName': 'string', 'SecondaryAvailabilityZone': 'string', 'PubliclyAccessible': True|False, 'StatusInfos': [ { 'StatusType': 'string', 'Normal': True|False, 'Status': 'string', 'Message': 'string' }, ], 'StorageType': 'string', 'TdeCredentialArn': 'string', 'DbInstancePort': 123, 'DBClusterIdentifier': 'string', 'StorageEncrypted': True|False, 'KmsKeyId': 'string', 'DbiResourceId': 'string', 'CACertificateIdentifier': 'string', 'DomainMemberships': [ { 'Domain': 'string', 'Status': 'string', 'FQDN': 'string', 'IAMRoleName': 'string', 'OU': 'string', 'AuthSecretArn': 'string', 'DnsIps': [ 'string', ] }, ], 'CopyTagsToSnapshot': True|False, 'MonitoringInterval': 123, 'EnhancedMonitoringResourceArn': 'string', 'MonitoringRoleArn': 'string', 'PromotionTier': 123, 'DBInstanceArn': 'string', 'Timezone': 'string', 'IAMDatabaseAuthenticationEnabled': True|False, 'DatabaseInsightsMode': 'standard'|'advanced', 'PerformanceInsightsEnabled': True|False, 'PerformanceInsightsKMSKeyId': 'string', 'PerformanceInsightsRetentionPeriod': 123, 'EnabledCloudwatchLogsExports': [ 'string', ], 'ProcessorFeatures': [ { 'Name': 'string', 'Value': 'string' }, ], 'DeletionProtection': True|False, 'AssociatedRoles': [ { 'RoleArn': 'string', 'FeatureName': 'string', 'Status': 'string' }, ], 'ListenerEndpoint': { 'Address': 'string', 'Port': 123, 'HostedZoneId': 'string' }, 'MaxAllocatedStorage': 123, 'TagList': [ { 'Key': 'string', 'Value': 'string' }, ], 'DBInstanceAutomatedBackupsReplications': [ { 'DBInstanceAutomatedBackupsArn': 'string' }, ], 'CustomerOwnedIpEnabled': True|False, 'AwsBackupRecoveryPointArn': 'string', 'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping', 'ActivityStreamKmsKeyId': 'string', 'ActivityStreamKinesisStreamName': 'string', 'ActivityStreamMode': 'sync'|'async', 'ActivityStreamEngineNativeAuditFieldsIncluded': True|False, 'AutomationMode': 'full'|'all-paused', 'ResumeFullAutomationModeTime': datetime(2015, 1, 1), 'CustomIamInstanceProfile': 'string', 'BackupTarget': 'string', 'NetworkType': 'string', 'ActivityStreamPolicyStatus': 'locked'|'unlocked'|'locking-policy'|'unlocking-policy', 'StorageThroughput': 123, 'DBSystemId': 'string', 'MasterUserSecret': { 'SecretArn': 'string', 'SecretStatus': 'string', 'KmsKeyId': 'string' }, 'CertificateDetails': { 'CAIdentifier': 'string', 'ValidTill': datetime(2015, 1, 1) }, 'ReadReplicaSourceDBClusterIdentifier': 'string', 'PercentProgress': 'string', 'DedicatedLogVolume': True|False, 'IsStorageConfigUpgradeAvailable': True|False, 'MultiTenant': True|False, 'EngineLifecycleSupport': 'string' } } **Response Structure** * *(dict) --* * **DBInstance** *(dict) --* Contains the details of an Amazon RDS DB instance. This data type is used as a response element in the operations "CreateDBInstance", "CreateDBInstanceReadReplica", "DeleteDBInstance", "DescribeDBInstances", "ModifyDBInstance", "PromoteReadReplica", "RebootDBInstance", "RestoreDBInstanceFromDBSnapshot", "RestoreDBInstanceFromS3", "RestoreDBInstanceToPointInTime", "StartDBInstance", and "StopDBInstance". * **DBInstanceIdentifier** *(string) --* The user-supplied database identifier. This identifier is the unique key that identifies a DB instance. * **DBInstanceClass** *(string) --* The name of the compute and memory capacity class of the DB instance. * **Engine** *(string) --* The database engine used for this DB instance. * **DBInstanceStatus** *(string) --* The current state of this database. For information about DB instance statuses, see Viewing DB instance status in the *Amazon RDS User Guide.* * **AutomaticRestartTime** *(datetime) --* The time when a stopped DB instance is restarted automatically. * **MasterUsername** *(string) --* The master username for the DB instance. * **DBName** *(string) --* The initial database name that you provided (if required) when you created the DB instance. This name is returned for the life of your DB instance. For an RDS for Oracle CDB instance, the name identifies the PDB rather than the CDB. * **Endpoint** *(dict) --* The connection endpoint for the DB instance. Note: The endpoint might not be shown for instances with the status of "creating". * **Address** *(string) --* Specifies the DNS address of the DB instance. * **Port** *(integer) --* Specifies the port that the database engine is listening on. * **HostedZoneId** *(string) --* Specifies the ID that Amazon Route 53 assigns when you create a hosted zone. * **AllocatedStorage** *(integer) --* The amount of storage in gibibytes (GiB) allocated for the DB instance. * **InstanceCreateTime** *(datetime) --* The date and time when the DB instance was created. * **PreferredBackupWindow** *(string) --* The daily time range during which automated backups are created if automated backups are enabled, as determined by the "BackupRetentionPeriod". * **BackupRetentionPeriod** *(integer) --* 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: * "ModifyDBInstance" * "RebootDBInstance" * "RestoreDBInstanceFromDBSnapshot" * "RestoreDBInstanceToPointInTime" * **DBSecurityGroupName** *(string) --* The name of the DB security group. * **Status** *(string) --* The status of the DB security group. * **VpcSecurityGroups** *(list) --* The list of Amazon EC2 VPC security groups that the DB instance belongs to. * *(dict) --* This data type is used as a response element for queries on VPC security group membership. * **VpcSecurityGroupId** *(string) --* The name of the VPC security group. * **Status** *(string) --* The membership status of the VPC security group. Currently, the only valid status is "active". * **DBParameterGroups** *(list) --* 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: * "CreateDBInstance" * "CreateDBInstanceReadReplica" * "DeleteDBInstance" * "ModifyDBInstance" * "RebootDBInstance" * "RestoreDBInstanceFromDBSnapshot" * **DBParameterGroupName** *(string) --* The name of the DB parameter group. * **ParameterApplyStatus** *(string) --* The status of parameter updates. Valid values are: * "applying": The parameter group change is being applied to the database. * "failed-to-apply": The parameter group is in an invalid state. * "in-sync": The parameter group change is synchronized with the database. * "pending-database-upgrade": The parameter group change will be applied after the DB instance is upgraded. * "pending-reboot": The parameter group change will be applied after the DB instance reboots. * **AvailabilityZone** *(string) --* The name of the Availability Zone where the DB instance is located. * **DBSubnetGroup** *(dict) --* Information about 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. The list of subnets shown here might not reflect the current state of your VPC. For the most up-to-date information, we recommend checking your VPC configuration directly. * *(dict) --* This data type is used as a response element for the "DescribeDBSubnetGroups" operation. * **SubnetIdentifier** *(string) --* The identifier of the subnet. * **SubnetAvailabilityZone** *(dict) --* Contains Availability Zone information. This data type is used as an element in the "OrderableDBInstanceOption" data type. * **Name** *(string) --* The name of the Availability Zone. * **SubnetOutpost** *(dict) --* If the subnet is associated with an Outpost, this value specifies the Outpost. For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the *Amazon RDS User Guide.* * **Arn** *(string) --* The Amazon Resource Name (ARN) of the Outpost. * **SubnetStatus** *(string) --* The status of the subnet. * **DBSubnetGroupArn** *(string) --* The Amazon Resource Name (ARN) for the DB subnet group. * **SupportedNetworkTypes** *(list) --* The network type of the DB subnet group. Valid values: * "IPV4" * "DUAL" A "DBSubnetGroup" can support only the IPv4 protocol or the IPv4 and the IPv6 protocols ( "DUAL"). For more information, see Working with a DB instance in a VPC in the *Amazon RDS User Guide.* * *(string) --* * **PreferredMaintenanceWindow** *(string) --* The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). * **PendingModifiedValues** *(dict) --* Information about pending changes to the DB instance. This information is returned only when there are pending changes. Specific changes are identified by subelements. * **DBInstanceClass** *(string) --* The name of the compute and memory capacity class for the DB instance. * **AllocatedStorage** *(integer) --* The allocated storage size for the DB instance specified in gibibytes (GiB). * **MasterUserPassword** *(string) --* The master credentials for the DB instance. * **Port** *(integer) --* The port for the DB instance. * **BackupRetentionPeriod** *(integer) --* The number of days for which automated backups are retained. * **MultiAZ** *(boolean) --* Indicates whether the Single-AZ DB instance will change to a Multi-AZ deployment. * **EngineVersion** *(string) --* The database engine version. * **LicenseModel** *(string) --* The license model for the DB instance. Valid values: "license-included" | "bring-your-own- license" | "general-public-license" * **Iops** *(integer) --* The Provisioned IOPS value for the DB instance. * **DBInstanceIdentifier** *(string) --* The database identifier for the DB instance. * **StorageType** *(string) --* The storage type of the DB instance. * **CACertificateIdentifier** *(string) --* The identifier of the CA certificate for the DB instance. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the *Amazon RDS User Guide* and Using SSL/TLS to encrypt a connection to a DB cluster in the *Amazon Aurora User Guide*. * **DBSubnetGroupName** *(string) --* The DB subnet group for the DB instance. * **PendingCloudwatchLogsExports** *(dict) --* A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated. * **LogTypesToEnable** *(list) --* Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs. * *(string) --* * **LogTypesToDisable** *(list) --* Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs. * *(string) --* * **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: * "CreateDBInstance" * "ModifyDBInstance" * "RestoreDBInstanceFromDBSnapshot" * "RestoreDBInstanceFromS3" * "RestoreDBInstanceToPointInTime" 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: * "DescribeDBInstances" * "DescribeDBSnapshots" * "DescribeValidDBInstanceModifications" If you call "DescribeDBInstances", "ProcessorFeature" returns non-null values only if the following conditions are met: * You are accessing an Oracle DB instance. * Your Oracle DB instance class supports configuring the number of CPU cores and threads per core. * The current number CPU cores and threads is set to a non-default value. For more information, see Configuring the processor for a DB instance class in RDS for Oracle 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. * **IAMDatabaseAuthenticationEnabled** *(boolean) --* Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled. * **AutomationMode** *(string) --* The automation mode of the RDS Custom DB instance: "full" or "all-paused". If "full", the DB instance automates monitoring and instance recovery. If "all- paused", the instance pauses automation for the duration set by "--resume-full-automation-mode-minutes". * **ResumeFullAutomationModeTime** *(datetime) --* The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440. * **StorageThroughput** *(integer) --* The storage throughput of the DB instance. * **Engine** *(string) --* The database engine of the DB instance. * **DedicatedLogVolume** *(boolean) --* Indicates whether the DB instance has a dedicated log volume (DLV) enabled.> * **MultiTenant** *(boolean) --* Indicates whether the DB instance will change to the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE). * **LatestRestorableTime** *(datetime) --* The latest time to which a database in this DB instance can be restored with point-in-time restore. * **MultiAZ** *(boolean) --* Indicates whether the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom DB instances. * **EngineVersion** *(string) --* The version of the database engine. * **AutoMinorVersionUpgrade** *(boolean) --* Indicates whether minor version patches are applied automatically. For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version. * **ReadReplicaSourceDBInstanceIdentifier** *(string) --* The identifier of the source DB instance if this DB instance is a read replica. * **ReadReplicaDBInstanceIdentifiers** *(list) --* The identifiers of the read replicas associated with this DB instance. * *(string) --* * **ReadReplicaDBClusterIdentifiers** *(list) --* The identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn't contain information about cross-Region Aurora read replicas. Note: Currently, each RDS DB instance can have only one Aurora read replica. * *(string) --* * **ReplicaMode** *(string) --* The open mode of a Db2 or an Oracle read replica. The default is "open-read-only". For more information, see Working with read replicas for Amazon RDS for Db2 and Working with read replicas for Amazon RDS for Oracle in the *Amazon RDS User Guide*. Note: This attribute is only supported in RDS for Db2, RDS for Oracle, and RDS Custom for Oracle. * **LicenseModel** *(string) --* The license model information for this DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. * **Iops** *(integer) --* The Provisioned IOPS (I/O operations per second) value for the DB instance. * **OptionGroupMemberships** *(list) --* The list of option group memberships for this DB instance. * *(dict) --* Provides information on the option groups the DB instance is a member of. * **OptionGroupName** *(string) --* The name of the option group that the instance belongs to. * **Status** *(string) --* The status of the DB instance's option group membership. Valid values are: "in-sync", "pending- apply", "pending-removal", "pending-maintenance- apply", "pending-maintenance-removal", "applying", "removing", and "failed". * **CharacterSetName** *(string) --* If present, specifies the name of the character set that this instance is associated with. * **NcharCharacterSetName** *(string) --* The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2. * **SecondaryAvailabilityZone** *(string) --* If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support. * **PubliclyAccessible** *(boolean) --* Indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it. When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance. * **StatusInfos** *(list) --* The status of a read replica. If the DB instance isn't a read replica, the value is blank. * *(dict) --* Provides a list of status information for a DB instance. * **StatusType** *(string) --* This value is currently "read replication." * **Normal** *(boolean) --* Indicates whether the instance is operating normally (TRUE) or is in an error state (FALSE). * **Status** *(string) --* The 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) --* The storage type associated with the DB instance. * **TdeCredentialArn** *(string) --* The ARN from the key store with which the instance is associated for TDE encryption. * **DbInstancePort** *(integer) --* 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, indicates the name of the DB cluster that the DB instance is a member of. * **StorageEncrypted** *(boolean) --* Indicates whether the DB instance is encrypted. * **KmsKeyId** *(string) --* If "StorageEncrypted" is enabled, the Amazon Web Services KMS key identifier for the encrypted DB instance. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. * **DbiResourceId** *(string) --* The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB instance is accessed. * **CACertificateIdentifier** *(string) --* The identifier of the CA certificate for this DB instance. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the *Amazon RDS User Guide* and Using SSL/TLS to encrypt a connection to a DB cluster in the *Amazon Aurora User Guide*. * **DomainMemberships** *(list) --* The Active Directory Domain membership records associated with the DB instance. * *(dict) --* An Active Directory Domain membership record associated with the DB instance or cluster. * **Domain** *(string) --* The identifier of the Active Directory Domain. * **Status** *(string) --* The status of the Active Directory Domain membership for the DB instance or cluster. Values include "joined", "pending-join", "failed", and so on. * **FQDN** *(string) --* The fully qualified domain name (FQDN) of the Active Directory Domain. * **IAMRoleName** *(string) --* The name of the IAM role used when making API calls to the Directory Service. * **OU** *(string) --* The Active Directory organizational unit for the DB instance or cluster. * **AuthSecretArn** *(string) --* The ARN for the Secrets Manager secret with the credentials for the user that's a member of the domain. * **DnsIps** *(list) --* The IPv4 DNS IP addresses of the primary and secondary Active Directory domain controllers. * *(string) --* * **CopyTagsToSnapshot** *(boolean) --* Indicates whether tags are copied from the DB instance to snapshots of the DB instance. This setting doesn't apply to Amazon Aurora DB instances. 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) --* The order of priority 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 RDS for Db2 and RDS for SQL Server DB instances that were created with a time zone specified. * **IAMDatabaseAuthenticationEnabled** *(boolean) --* Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled for the DB instance. For a list of engine versions that support IAM database authentication, see IAM database authentication in the *Amazon RDS User Guide* and IAM database authentication in Aurora in the *Amazon Aurora User Guide*. * **DatabaseInsightsMode** *(string) --* The mode of Database Insights that is enabled for the instance. * **PerformanceInsightsEnabled** *(boolean) --* Indicates whether Performance Insights is enabled for the DB instance. * **PerformanceInsightsKMSKeyId** *(string) --* The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. * **PerformanceInsightsRetentionPeriod** *(integer) --* The number of days to retain Performance Insights data. Valid Values: * "7" * *month* * 31, where *month* is a number of months from 1-23. Examples: "93" (3 months * 31), "341" (11 months * 31), "589" (19 months * 31) * "731" Default: "7" days * **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 Monitoring Amazon RDS log files in the *Amazon RDS User Guide.* * *(string) --* * **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: * "CreateDBInstance" * "ModifyDBInstance" * "RestoreDBInstanceFromDBSnapshot" * "RestoreDBInstanceFromS3" * "RestoreDBInstanceToPointInTime" 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: * "DescribeDBInstances" * "DescribeDBSnapshots" * "DescribeValidDBInstanceModifications" If you call "DescribeDBInstances", "ProcessorFeature" returns non-null values only if the following conditions are met: * You are accessing an Oracle DB instance. * Your Oracle DB instance class supports configuring the number of CPU cores and threads per core. * The current number CPU cores and threads is set to a non-default value. For more information, see Configuring the processor for a DB instance class in RDS for Oracle 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. * **DeletionProtection** *(boolean) --* Indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance. * **AssociatedRoles** *(list) --* The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance. * *(dict) --* Information about an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance. * **RoleArn** *(string) --* The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance. * **FeatureName** *(string) --* The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see "DBEngineVersion". * **Status** *(string) --* Information about the state of association between the IAM role and the DB instance. The Status property returns one of the following values: * "ACTIVE" - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf. * "PENDING" - the IAM role ARN is being associated with the DB instance. * "INVALID" - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf. * **ListenerEndpoint** *(dict) --* The listener connection endpoint for SQL Server Always On. * **Address** *(string) --* Specifies the DNS address of the DB instance. * **Port** *(integer) --* Specifies the port that the database engine is listening on. * **HostedZoneId** *(string) --* Specifies the ID that Amazon Route 53 assigns when you create a hosted zone. * **MaxAllocatedStorage** *(integer) --* The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. * **TagList** *(list) --* A list of tags. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **Key** *(string) --* A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **Value** *(string) --* A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **DBInstanceAutomatedBackupsReplications** *(list) --* The list of replicated automated backups associated with the DB instance. * *(dict) --* Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties. * **DBInstanceAutomatedBackupsArn** *(string) --* The Amazon Resource Name (ARN) of the replicated automated backups. * **CustomerOwnedIpEnabled** *(boolean) --* Indicates whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance. A >>*<>*< * **MultiTenant** *(boolean) --* Indicates whether the DB instance will change to the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE). * **LatestRestorableTime** *(datetime) --* The latest time to which a database in this DB instance can be restored with point-in-time restore. * **MultiAZ** *(boolean) --* Indicates whether the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom DB instances. * **EngineVersion** *(string) --* The version of the database engine. * **AutoMinorVersionUpgrade** *(boolean) --* Indicates whether minor version patches are applied automatically. For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version. * **ReadReplicaSourceDBInstanceIdentifier** *(string) --* The identifier of the source DB instance if this DB instance is a read replica. * **ReadReplicaDBInstanceIdentifiers** *(list) --* The identifiers of the read replicas associated with this DB instance. * *(string) --* * **ReadReplicaDBClusterIdentifiers** *(list) --* The identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn't contain information about cross-Region Aurora read replicas. Note: Currently, each RDS DB instance can have only one Aurora read replica. * *(string) --* * **ReplicaMode** *(string) --* The open mode of a Db2 or an Oracle read replica. The default is "open-read-only". For more information, see Working with read replicas for Amazon RDS for Db2 and Working with read replicas for Amazon RDS for Oracle in the *Amazon RDS User Guide*. Note: This attribute is only supported in RDS for Db2, RDS for Oracle, and RDS Custom for Oracle. * **LicenseModel** *(string) --* The license model information for this DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. * **Iops** *(integer) --* The Provisioned IOPS (I/O operations per second) value for the DB instance. * **OptionGroupMemberships** *(list) --* The list of option group memberships for this DB instance. * *(dict) --* Provides information on the option groups the DB instance is a member of. * **OptionGroupName** *(string) --* The name of the option group that the instance belongs to. * **Status** *(string) --* The status of the DB instance's option group membership. Valid values are: "in-sync", "pending- apply", "pending-removal", "pending-maintenance- apply", "pending-maintenance-removal", "applying", "removing", and "failed". * **CharacterSetName** *(string) --* If present, specifies the name of the character set that this instance is associated with. * **NcharCharacterSetName** *(string) --* The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2. * **SecondaryAvailabilityZone** *(string) --* If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support. * **PubliclyAccessible** *(boolean) --* Indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it. When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance. * **StatusInfos** *(list) --* The status of a read replica. If the DB instance isn't a read replica, the value is blank. * *(dict) --* Provides a list of status information for a DB instance. * **StatusType** *(string) --* This value is currently "read replication." * **Normal** *(boolean) --* Indicates whether the instance is operating normally (TRUE) or is in an error state (FALSE). * **Status** *(string) --* The 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) --* The storage type associated with the DB instance. * **TdeCredentialArn** *(string) --* The ARN from the key store with which the instance is associated for TDE encryption. * **DbInstancePort** *(integer) --* 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, indicates the name of the DB cluster that the DB instance is a member of. * **StorageEncrypted** *(boolean) --* Indicates whether the DB instance is encrypted. * **KmsKeyId** *(string) --* If "StorageEncrypted" is enabled, the Amazon Web Services KMS key identifier for the encrypted DB instance. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. * **DbiResourceId** *(string) --* The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB instance is accessed. * **CACertificateIdentifier** *(string) --* The identifier of the CA certificate for this DB instance. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the *Amazon RDS User Guide* and Using SSL/TLS to encrypt a connection to a DB cluster in the *Amazon Aurora User Guide*. * **DomainMemberships** *(list) --* The Active Directory Domain membership records associated with the DB instance. * *(dict) --* An Active Directory Domain membership record associated with the DB instance or cluster. * **Domain** *(string) --* The identifier of the Active Directory Domain. * **Status** *(string) --* The status of the Active Directory Domain membership for the DB instance or cluster. Values include "joined", "pending-join", "failed", and so on. * **FQDN** *(string) --* The fully qualified domain name (FQDN) of the Active Directory Domain. * **IAMRoleName** *(string) --* The name of the IAM role used when making API calls to the Directory Service. * **OU** *(string) --* The Active Directory organizational unit for the DB instance or cluster. * **AuthSecretArn** *(string) --* The ARN for the Secrets Manager secret with the credentials for the user that's a member of the domain. * **DnsIps** *(list) --* The IPv4 DNS IP addresses of the primary and secondary Active Directory domain controllers. * *(string) --* * **CopyTagsToSnapshot** *(boolean) --* Indicates whether tags are copied from the DB instance to snapshots of the DB instance. This setting doesn't apply to Amazon Aurora DB instances. 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) --* The order of priority 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 RDS for Db2 and RDS for SQL Server DB instances that were created with a time zone specified. * **IAMDatabaseAuthenticationEnabled** *(boolean) --* Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled for the DB instance. For a list of engine versions that support IAM database authentication, see IAM database authentication in the *Amazon RDS User Guide* and IAM database authentication in Aurora in the *Amazon Aurora User Guide*. * **DatabaseInsightsMode** *(string) --* The mode of Database Insights that is enabled for the instance. * **PerformanceInsightsEnabled** *(boolean) --* Indicates whether Performance Insights is enabled for the DB instance. * **PerformanceInsightsKMSKeyId** *(string) --* The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. * **PerformanceInsightsRetentionPeriod** *(integer) --* The number of days to retain Performance Insights data. Valid Values: * "7" * *month* * 31, where *month* is a number of months from 1-23. Examples: "93" (3 months * 31), "341" (11 months * 31), "589" (19 months * 31) * "731" Default: "7" days * **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 Monitoring Amazon RDS log files in the *Amazon RDS User Guide.* * *(string) --* * **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: * "CreateDBInstance" * "ModifyDBInstance" * "RestoreDBInstanceFromDBSnapshot" * "RestoreDBInstanceFromS3" * "RestoreDBInstanceToPointInTime" 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: * "DescribeDBInstances" * "DescribeDBSnapshots" * "DescribeValidDBInstanceModifications" If you call "DescribeDBInstances", "ProcessorFeature" returns non-null values only if the following conditions are met: * You are accessing an Oracle DB instance. * Your Oracle DB instance class supports configuring the number of CPU cores and threads per core. * The current number CPU cores and threads is set to a non-default value. For more information, see Configuring the processor for a DB instance class in RDS for Oracle 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. * **DeletionProtection** *(boolean) --* Indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance. * **AssociatedRoles** *(list) --* The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance. * *(dict) --* Information about an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance. * **RoleArn** *(string) --* The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance. * **FeatureName** *(string) --* The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see "DBEngineVersion". * **Status** *(string) --* Information about the state of association between the IAM role and the DB instance. The Status property returns one of the following values: * "ACTIVE" - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf. * "PENDING" - the IAM role ARN is being associated with the DB instance. * "INVALID" - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf. * **ListenerEndpoint** *(dict) --* The listener connection endpoint for SQL Server Always On. * **Address** *(string) --* Specifies the DNS address of the DB instance. * **Port** *(integer) --* Specifies the port that the database engine is listening on. * **HostedZoneId** *(string) --* Specifies the ID that Amazon Route 53 assigns when you create a hosted zone. * **MaxAllocatedStorage** *(integer) --* The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. * **TagList** *(list) --* A list of tags. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **Key** *(string) --* A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **Value** *(string) --* A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **DBInstanceAutomatedBackupsReplications** *(list) --* The list of replicated automated backups associated with the DB instance. * *(dict) --* Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties. * **DBInstanceAutomatedBackupsArn** *(string) --* The Amazon Resource Name (ARN) of the replicated automated backups. * **CustomerOwnedIpEnabled** *(boolean) --* Indicates whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance. A >>*<>*< * **MultiTenant** *(boolean) --* Indicates whether the DB instance will change to the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE). * **LatestRestorableTime** *(datetime) --* The latest time to which a database in this DB instance can be restored with point-in-time restore. * **MultiAZ** *(boolean) --* Indicates whether the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom DB instances. * **EngineVersion** *(string) --* The version of the database engine. * **AutoMinorVersionUpgrade** *(boolean) --* Indicates whether minor version patches are applied automatically. For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version. * **ReadReplicaSourceDBInstanceIdentifier** *(string) --* The identifier of the source DB instance if this DB instance is a read replica. * **ReadReplicaDBInstanceIdentifiers** *(list) --* The identifiers of the read replicas associated with this DB instance. * *(string) --* * **ReadReplicaDBClusterIdentifiers** *(list) --* The identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn't contain information about cross-Region Aurora read replicas. Note: Currently, each RDS DB instance can have only one Aurora read replica. * *(string) --* * **ReplicaMode** *(string) --* The open mode of a Db2 or an Oracle read replica. The default is "open-read-only". For more information, see Working with read replicas for Amazon RDS for Db2 and Working with read replicas for Amazon RDS for Oracle in the *Amazon RDS User Guide*. Note: This attribute is only supported in RDS for Db2, RDS for Oracle, and RDS Custom for Oracle. * **LicenseModel** *(string) --* The license model information for this DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. * **Iops** *(integer) --* The Provisioned IOPS (I/O operations per second) value for the DB instance. * **OptionGroupMemberships** *(list) --* The list of option group memberships for this DB instance. * *(dict) --* Provides information on the option groups the DB instance is a member of. * **OptionGroupName** *(string) --* The name of the option group that the instance belongs to. * **Status** *(string) --* The status of the DB instance's option group membership. Valid values are: "in-sync", "pending- apply", "pending-removal", "pending-maintenance- apply", "pending-maintenance-removal", "applying", "removing", and "failed". * **CharacterSetName** *(string) --* If present, specifies the name of the character set that this instance is associated with. * **NcharCharacterSetName** *(string) --* The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2. * **SecondaryAvailabilityZone** *(string) --* If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support. * **PubliclyAccessible** *(boolean) --* Indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it. When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance. * **StatusInfos** *(list) --* The status of a read replica. If the DB instance isn't a read replica, the value is blank. * *(dict) --* Provides a list of status information for a DB instance. * **StatusType** *(string) --* This value is currently "read replication." * **Normal** *(boolean) --* Indicates whether the instance is operating normally (TRUE) or is in an error state (FALSE). * **Status** *(string) --* The 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) --* The storage type associated with the DB instance. * **TdeCredentialArn** *(string) --* The ARN from the key store with which the instance is associated for TDE encryption. * **DbInstancePort** *(integer) --* 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, indicates the name of the DB cluster that the DB instance is a member of. * **StorageEncrypted** *(boolean) --* Indicates whether the DB instance is encrypted. * **KmsKeyId** *(string) --* If "StorageEncrypted" is enabled, the Amazon Web Services KMS key identifier for the encrypted DB instance. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. * **DbiResourceId** *(string) --* The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB instance is accessed. * **CACertificateIdentifier** *(string) --* The identifier of the CA certificate for this DB instance. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the *Amazon RDS User Guide* and Using SSL/TLS to encrypt a connection to a DB cluster in the *Amazon Aurora User Guide*. * **DomainMemberships** *(list) --* The Active Directory Domain membership records associated with the DB instance. * *(dict) --* An Active Directory Domain membership record associated with the DB instance or cluster. * **Domain** *(string) --* The identifier of the Active Directory Domain. * **Status** *(string) --* The status of the Active Directory Domain membership for the DB instance or cluster. Values include "joined", "pending-join", "failed", and so on. * **FQDN** *(string) --* The fully qualified domain name (FQDN) of the Active Directory Domain. * **IAMRoleName** *(string) --* The name of the IAM role used when making API calls to the Directory Service. * **OU** *(string) --* The Active Directory organizational unit for the DB instance or cluster. * **AuthSecretArn** *(string) --* The ARN for the Secrets Manager secret with the credentials for the user that's a member of the domain. * **DnsIps** *(list) --* The IPv4 DNS IP addresses of the primary and secondary Active Directory domain controllers. * *(string) --* * **CopyTagsToSnapshot** *(boolean) --* Indicates whether tags are copied from the DB instance to snapshots of the DB instance. This setting doesn't apply to Amazon Aurora DB instances. 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) --* The order of priority 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 RDS for Db2 and RDS for SQL Server DB instances that were created with a time zone specified. * **IAMDatabaseAuthenticationEnabled** *(boolean) --* Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled for the DB instance. For a list of engine versions that support IAM database authentication, see IAM database authentication in the *Amazon RDS User Guide* and IAM database authentication in Aurora in the *Amazon Aurora User Guide*. * **DatabaseInsightsMode** *(string) --* The mode of Database Insights that is enabled for the instance. * **PerformanceInsightsEnabled** *(boolean) --* Indicates whether Performance Insights is enabled for the DB instance. * **PerformanceInsightsKMSKeyId** *(string) --* The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. * **PerformanceInsightsRetentionPeriod** *(integer) --* The number of days to retain Performance Insights data. Valid Values: * "7" * *month* * 31, where *month* is a number of months from 1-23. Examples: "93" (3 months * 31), "341" (11 months * 31), "589" (19 months * 31) * "731" Default: "7" days * **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 Monitoring Amazon RDS log files in the *Amazon RDS User Guide.* * *(string) --* * **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: * "CreateDBInstance" * "ModifyDBInstance" * "RestoreDBInstanceFromDBSnapshot" * "RestoreDBInstanceFromS3" * "RestoreDBInstanceToPointInTime" 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: * "DescribeDBInstances" * "DescribeDBSnapshots" * "DescribeValidDBInstanceModifications" If you call "DescribeDBInstances", "ProcessorFeature" returns non-null values only if the following conditions are met: * You are accessing an Oracle DB instance. * Your Oracle DB instance class supports configuring the number of CPU cores and threads per core. * The current number CPU cores and threads is set to a non-default value. For more information, see Configuring the processor for a DB instance class in RDS for Oracle 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. * **DeletionProtection** *(boolean) --* Indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance. * **AssociatedRoles** *(list) --* The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance. * *(dict) --* Information about an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance. * **RoleArn** *(string) --* The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance. * **FeatureName** *(string) --* The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see "DBEngineVersion". * **Status** *(string) --* Information about the state of association between the IAM role and the DB instance. The Status property returns one of the following values: * "ACTIVE" - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf. * "PENDING" - the IAM role ARN is being associated with the DB instance. * "INVALID" - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf. * **ListenerEndpoint** *(dict) --* The listener connection endpoint for SQL Server Always On. * **Address** *(string) --* Specifies the DNS address of the DB instance. * **Port** *(integer) --* Specifies the port that the database engine is listening on. * **HostedZoneId** *(string) --* Specifies the ID that Amazon Route 53 assigns when you create a hosted zone. * **MaxAllocatedStorage** *(integer) --* The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. * **TagList** *(list) --* A list of tags. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **Key** *(string) --* A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **Value** *(string) --* A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **DBInstanceAutomatedBackupsReplications** *(list) --* The list of replicated automated backups associated with the DB instance. * *(dict) --* Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties. * **DBInstanceAutomatedBackupsArn** *(string) --* The Amazon Resource Name (ARN) of the replicated automated backups. * **CustomerOwnedIpEnabled** *(boolean) --* Indicates whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance. A >>*<>*< * **MultiTenant** *(boolean) --* Indicates whether the DB instance will change to the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE). * **LatestRestorableTime** *(datetime) --* The latest time to which a database in this DB instance can be restored with point-in-time restore. * **MultiAZ** *(boolean) --* Indicates whether the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom DB instances. * **EngineVersion** *(string) --* The version of the database engine. * **AutoMinorVersionUpgrade** *(boolean) --* Indicates whether minor version patches are applied automatically. For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version. * **ReadReplicaSourceDBInstanceIdentifier** *(string) --* The identifier of the source DB instance if this DB instance is a read replica. * **ReadReplicaDBInstanceIdentifiers** *(list) --* The identifiers of the read replicas associated with this DB instance. * *(string) --* * **ReadReplicaDBClusterIdentifiers** *(list) --* The identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn't contain information about cross-Region Aurora read replicas. Note: Currently, each RDS DB instance can have only one Aurora read replica. * *(string) --* * **ReplicaMode** *(string) --* The open mode of a Db2 or an Oracle read replica. The default is "open-read-only". For more information, see Working with read replicas for Amazon RDS for Db2 and Working with read replicas for Amazon RDS for Oracle in the *Amazon RDS User Guide*. Note: This attribute is only supported in RDS for Db2, RDS for Oracle, and RDS Custom for Oracle. * **LicenseModel** *(string) --* The license model information for this DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. * **Iops** *(integer) --* The Provisioned IOPS (I/O operations per second) value for the DB instance. * **OptionGroupMemberships** *(list) --* The list of option group memberships for this DB instance. * *(dict) --* Provides information on the option groups the DB instance is a member of. * **OptionGroupName** *(string) --* The name of the option group that the instance belongs to. * **Status** *(string) --* The status of the DB instance's option group membership. Valid values are: "in-sync", "pending- apply", "pending-removal", "pending-maintenance- apply", "pending-maintenance-removal", "applying", "removing", and "failed". * **CharacterSetName** *(string) --* If present, specifies the name of the character set that this instance is associated with. * **NcharCharacterSetName** *(string) --* The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2. * **SecondaryAvailabilityZone** *(string) --* If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support. * **PubliclyAccessible** *(boolean) --* Indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it. When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance. * **StatusInfos** *(list) --* The status of a read replica. If the DB instance isn't a read replica, the value is blank. * *(dict) --* Provides a list of status information for a DB instance. * **StatusType** *(string) --* This value is currently "read replication." * **Normal** *(boolean) --* Indicates whether the instance is operating normally (TRUE) or is in an error state (FALSE). * **Status** *(string) --* The 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) --* The storage type associated with the DB instance. * **TdeCredentialArn** *(string) --* The ARN from the key store with which the instance is associated for TDE encryption. * **DbInstancePort** *(integer) --* 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, indicates the name of the DB cluster that the DB instance is a member of. * **StorageEncrypted** *(boolean) --* Indicates whether the DB instance is encrypted. * **KmsKeyId** *(string) --* If "StorageEncrypted" is enabled, the Amazon Web Services KMS key identifier for the encrypted DB instance. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. * **DbiResourceId** *(string) --* The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB instance is accessed. * **CACertificateIdentifier** *(string) --* The identifier of the CA certificate for this DB instance. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the *Amazon RDS User Guide* and Using SSL/TLS to encrypt a connection to a DB cluster in the *Amazon Aurora User Guide*. * **DomainMemberships** *(list) --* The Active Directory Domain membership records associated with the DB instance. * *(dict) --* An Active Directory Domain membership record associated with the DB instance or cluster. * **Domain** *(string) --* The identifier of the Active Directory Domain. * **Status** *(string) --* The status of the Active Directory Domain membership for the DB instance or cluster. Values include "joined", "pending-join", "failed", and so on. * **FQDN** *(string) --* The fully qualified domain name (FQDN) of the Active Directory Domain. * **IAMRoleName** *(string) --* The name of the IAM role used when making API calls to the Directory Service. * **OU** *(string) --* The Active Directory organizational unit for the DB instance or cluster. * **AuthSecretArn** *(string) --* The ARN for the Secrets Manager secret with the credentials for the user that's a member of the domain. * **DnsIps** *(list) --* The IPv4 DNS IP addresses of the primary and secondary Active Directory domain controllers. * *(string) --* * **CopyTagsToSnapshot** *(boolean) --* Indicates whether tags are copied from the DB instance to snapshots of the DB instance. This setting doesn't apply to Amazon Aurora DB instances. 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) --* The order of priority 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 RDS for Db2 and RDS for SQL Server DB instances that were created with a time zone specified. * **IAMDatabaseAuthenticationEnabled** *(boolean) --* Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled for the DB instance. For a list of engine versions that support IAM database authentication, see IAM database authentication in the *Amazon RDS User Guide* and IAM database authentication in Aurora in the *Amazon Aurora User Guide*. * **DatabaseInsightsMode** *(string) --* The mode of Database Insights that is enabled for the instance. * **PerformanceInsightsEnabled** *(boolean) --* Indicates whether Performance Insights is enabled for the DB instance. * **PerformanceInsightsKMSKeyId** *(string) --* The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. * **PerformanceInsightsRetentionPeriod** *(integer) --* The number of days to retain Performance Insights data. Valid Values: * "7" * *month* * 31, where *month* is a number of months from 1-23. Examples: "93" (3 months * 31), "341" (11 months * 31), "589" (19 months * 31) * "731" Default: "7" days * **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 Monitoring Amazon RDS log files in the *Amazon RDS User Guide.* * *(string) --* * **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: * "CreateDBInstance" * "ModifyDBInstance" * "RestoreDBInstanceFromDBSnapshot" * "RestoreDBInstanceFromS3" * "RestoreDBInstanceToPointInTime" 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: * "DescribeDBInstances" * "DescribeDBSnapshots" * "DescribeValidDBInstanceModifications" If you call "DescribeDBInstances", "ProcessorFeature" returns non-null values only if the following conditions are met: * You are accessing an Oracle DB instance. * Your Oracle DB instance class supports configuring the number of CPU cores and threads per core. * The current number CPU cores and threads is set to a non-default value. For more information, see Configuring the processor for a DB instance class in RDS for Oracle 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. * **DeletionProtection** *(boolean) --* Indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance. * **AssociatedRoles** *(list) --* The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance. * *(dict) --* Information about an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance. * **RoleArn** *(string) --* The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance. * **FeatureName** *(string) --* The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see "DBEngineVersion". * **Status** *(string) --* Information about the state of association between the IAM role and the DB instance. The Status property returns one of the following values: * "ACTIVE" - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf. * "PENDING" - the IAM role ARN is being associated with the DB instance. * "INVALID" - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf. * **ListenerEndpoint** *(dict) --* The listener connection endpoint for SQL Server Always On. * **Address** *(string) --* Specifies the DNS address of the DB instance. * **Port** *(integer) --* Specifies the port that the database engine is listening on. * **HostedZoneId** *(string) --* Specifies the ID that Amazon Route 53 assigns when you create a hosted zone. * **MaxAllocatedStorage** *(integer) --* The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. * **TagList** *(list) --* A list of tags. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **Key** *(string) --* A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **Value** *(string) --* A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **DBInstanceAutomatedBackupsReplications** *(list) --* The list of replicated automated backups associated with the DB instance. * *(dict) --* Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties. * **DBInstanceAutomatedBackupsArn** *(string) --* The Amazon Resource Name (ARN) of the replicated automated backups. * **CustomerOwnedIpEnabled** *(boolean) --* Indicates whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance. A >>*<>*< * **MultiTenant** *(boolean) --* Indicates whether the DB instance will change to the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE). * **LatestRestorableTime** *(datetime) --* The latest time to which a database in this DB instance can be restored with point-in-time restore. * **MultiAZ** *(boolean) --* Indicates whether the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom DB instances. * **EngineVersion** *(string) --* The version of the database engine. * **AutoMinorVersionUpgrade** *(boolean) --* Indicates whether minor version patches are applied automatically. For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version. * **ReadReplicaSourceDBInstanceIdentifier** *(string) --* The identifier of the source DB instance if this DB instance is a read replica. * **ReadReplicaDBInstanceIdentifiers** *(list) --* The identifiers of the read replicas associated with this DB instance. * *(string) --* * **ReadReplicaDBClusterIdentifiers** *(list) --* The identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn't contain information about cross-Region Aurora read replicas. Note: Currently, each RDS DB instance can have only one Aurora read replica. * *(string) --* * **ReplicaMode** *(string) --* The open mode of a Db2 or an Oracle read replica. The default is "open-read-only". For more information, see Working with read replicas for Amazon RDS for Db2 and Working with read replicas for Amazon RDS for Oracle in the *Amazon RDS User Guide*. Note: This attribute is only supported in RDS for Db2, RDS for Oracle, and RDS Custom for Oracle. * **LicenseModel** *(string) --* The license model information for this DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. * **Iops** *(integer) --* The Provisioned IOPS (I/O operations per second) value for the DB instance. * **OptionGroupMemberships** *(list) --* The list of option group memberships for this DB instance. * *(dict) --* Provides information on the option groups the DB instance is a member of. * **OptionGroupName** *(string) --* The name of the option group that the instance belongs to. * **Status** *(string) --* The status of the DB instance's option group membership. Valid values are: "in-sync", "pending- apply", "pending-removal", "pending-maintenance- apply", "pending-maintenance-removal", "applying", "removing", and "failed". * **CharacterSetName** *(string) --* If present, specifies the name of the character set that this instance is associated with. * **NcharCharacterSetName** *(string) --* The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2. * **SecondaryAvailabilityZone** *(string) --* If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support. * **PubliclyAccessible** *(boolean) --* Indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it. When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance. * **StatusInfos** *(list) --* The status of a read replica. If the DB instance isn't a read replica, the value is blank. * *(dict) --* Provides a list of status information for a DB instance. * **StatusType** *(string) --* This value is currently "read replication." * **Normal** *(boolean) --* Indicates whether the instance is operating normally (TRUE) or is in an error state (FALSE). * **Status** *(string) --* The 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) --* The storage type associated with the DB instance. * **TdeCredentialArn** *(string) --* The ARN from the key store with which the instance is associated for TDE encryption. * **DbInstancePort** *(integer) --* 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, indicates the name of the DB cluster that the DB instance is a member of. * **StorageEncrypted** *(boolean) --* Indicates whether the DB instance is encrypted. * **KmsKeyId** *(string) --* If "StorageEncrypted" is enabled, the Amazon Web Services KMS key identifier for the encrypted DB instance. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. * **DbiResourceId** *(string) --* The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB instance is accessed. * **CACertificateIdentifier** *(string) --* The identifier of the CA certificate for this DB instance. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the *Amazon RDS User Guide* and Using SSL/TLS to encrypt a connection to a DB cluster in the *Amazon Aurora User Guide*. * **DomainMemberships** *(list) --* The Active Directory Domain membership records associated with the DB instance. * *(dict) --* An Active Directory Domain membership record associated with the DB instance or cluster. * **Domain** *(string) --* The identifier of the Active Directory Domain. * **Status** *(string) --* The status of the Active Directory Domain membership for the DB instance or cluster. Values include "joined", "pending-join", "failed", and so on. * **FQDN** *(string) --* The fully qualified domain name (FQDN) of the Active Directory Domain. * **IAMRoleName** *(string) --* The name of the IAM role used when making API calls to the Directory Service. * **OU** *(string) --* The Active Directory organizational unit for the DB instance or cluster. * **AuthSecretArn** *(string) --* The ARN for the Secrets Manager secret with the credentials for the user that's a member of the domain. * **DnsIps** *(list) --* The IPv4 DNS IP addresses of the primary and secondary Active Directory domain controllers. * *(string) --* * **CopyTagsToSnapshot** *(boolean) --* Indicates whether tags are copied from the DB instance to snapshots of the DB instance. This setting doesn't apply to Amazon Aurora DB instances. 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) --* The order of priority 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 RDS for Db2 and RDS for SQL Server DB instances that were created with a time zone specified. * **IAMDatabaseAuthenticationEnabled** *(boolean) --* Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled for the DB instance. For a list of engine versions that support IAM database authentication, see IAM database authentication in the *Amazon RDS User Guide* and IAM database authentication in Aurora in the *Amazon Aurora User Guide*. * **DatabaseInsightsMode** *(string) --* The mode of Database Insights that is enabled for the instance. * **PerformanceInsightsEnabled** *(boolean) --* Indicates whether Performance Insights is enabled for the DB instance. * **PerformanceInsightsKMSKeyId** *(string) --* The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. * **PerformanceInsightsRetentionPeriod** *(integer) --* The number of days to retain Performance Insights data. Valid Values: * "7" * *month* * 31, where *month* is a number of months from 1-23. Examples: "93" (3 months * 31), "341" (11 months * 31), "589" (19 months * 31) * "731" Default: "7" days * **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 Monitoring Amazon RDS log files in the *Amazon RDS User Guide.* * *(string) --* * **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: * "CreateDBInstance" * "ModifyDBInstance" * "RestoreDBInstanceFromDBSnapshot" * "RestoreDBInstanceFromS3" * "RestoreDBInstanceToPointInTime" 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: * "DescribeDBInstances" * "DescribeDBSnapshots" * "DescribeValidDBInstanceModifications" If you call "DescribeDBInstances", "ProcessorFeature" returns non-null values only if the following conditions are met: * You are accessing an Oracle DB instance. * Your Oracle DB instance class supports configuring the number of CPU cores and threads per core. * The current number CPU cores and threads is set to a non-default value. For more information, see Configuring the processor for a DB instance class in RDS for Oracle 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. * **DeletionProtection** *(boolean) --* Indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance. * **AssociatedRoles** *(list) --* The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance. * *(dict) --* Information about an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance. * **RoleArn** *(string) --* The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance. * **FeatureName** *(string) --* The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see "DBEngineVersion". * **Status** *(string) --* Information about the state of association between the IAM role and the DB instance. The Status property returns one of the following values: * "ACTIVE" - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf. * "PENDING" - the IAM role ARN is being associated with the DB instance. * "INVALID" - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf. * **ListenerEndpoint** *(dict) --* The listener connection endpoint for SQL Server Always On. * **Address** *(string) --* Specifies the DNS address of the DB instance. * **Port** *(integer) --* Specifies the port that the database engine is listening on. * **HostedZoneId** *(string) --* Specifies the ID that Amazon Route 53 assigns when you create a hosted zone. * **MaxAllocatedStorage** *(integer) --* The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. * **TagList** *(list) --* A list of tags. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **Key** *(string) --* A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **Value** *(string) --* A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **DBInstanceAutomatedBackupsReplications** *(list) --* The list of replicated automated backups associated with the DB instance. * *(dict) --* Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties. * **DBInstanceAutomatedBackupsArn** *(string) --* The Amazon Resource Name (ARN) of the replicated automated backups. * **CustomerOwnedIpEnabled** *(boolean) --* Indicates whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance. A >>*<>*< * **MultiTenant** *(boolean) --* Indicates whether the DB instance will change to the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE). * **LatestRestorableTime** *(datetime) --* The latest time to which a database in this DB instance can be restored with point-in-time restore. * **MultiAZ** *(boolean) --* Indicates whether the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom DB instances. * **EngineVersion** *(string) --* The version of the database engine. * **AutoMinorVersionUpgrade** *(boolean) --* Indicates whether minor version patches are applied automatically. For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version. * **ReadReplicaSourceDBInstanceIdentifier** *(string) --* The identifier of the source DB instance if this DB instance is a read replica. * **ReadReplicaDBInstanceIdentifiers** *(list) --* The identifiers of the read replicas associated with this DB instance. * *(string) --* * **ReadReplicaDBClusterIdentifiers** *(list) --* The identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn't contain information about cross-Region Aurora read replicas. Note: Currently, each RDS DB instance can have only one Aurora read replica. * *(string) --* * **ReplicaMode** *(string) --* The open mode of a Db2 or an Oracle read replica. The default is "open-read-only". For more information, see Working with read replicas for Amazon RDS for Db2 and Working with read replicas for Amazon RDS for Oracle in the *Amazon RDS User Guide*. Note: This attribute is only supported in RDS for Db2, RDS for Oracle, and RDS Custom for Oracle. * **LicenseModel** *(string) --* The license model information for this DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. * **Iops** *(integer) --* The Provisioned IOPS (I/O operations per second) value for the DB instance. * **OptionGroupMemberships** *(list) --* The list of option group memberships for this DB instance. * *(dict) --* Provides information on the option groups the DB instance is a member of. * **OptionGroupName** *(string) --* The name of the option group that the instance belongs to. * **Status** *(string) --* The status of the DB instance's option group membership. Valid values are: "in-sync", "pending- apply", "pending-removal", "pending-maintenance- apply", "pending-maintenance-removal", "applying", "removing", and "failed". * **CharacterSetName** *(string) --* If present, specifies the name of the character set that this instance is associated with. * **NcharCharacterSetName** *(string) --* The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2. * **SecondaryAvailabilityZone** *(string) --* If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support. * **PubliclyAccessible** *(boolean) --* Indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it. When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance. * **StatusInfos** *(list) --* The status of a read replica. If the DB instance isn't a read replica, the value is blank. * *(dict) --* Provides a list of status information for a DB instance. * **StatusType** *(string) --* This value is currently "read replication." * **Normal** *(boolean) --* Indicates whether the instance is operating normally (TRUE) or is in an error state (FALSE). * **Status** *(string) --* The 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) --* The storage type associated with the DB instance. * **TdeCredentialArn** *(string) --* The ARN from the key store with which the instance is associated for TDE encryption. * **DbInstancePort** *(integer) --* 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, indicates the name of the DB cluster that the DB instance is a member of. * **StorageEncrypted** *(boolean) --* Indicates whether the DB instance is encrypted. * **KmsKeyId** *(string) --* If "StorageEncrypted" is enabled, the Amazon Web Services KMS key identifier for the encrypted DB instance. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. * **DbiResourceId** *(string) --* The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB instance is accessed. * **CACertificateIdentifier** *(string) --* The identifier of the CA certificate for this DB instance. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the *Amazon RDS User Guide* and Using SSL/TLS to encrypt a connection to a DB cluster in the *Amazon Aurora User Guide*. * **DomainMemberships** *(list) --* The Active Directory Domain membership records associated with the DB instance. * *(dict) --* An Active Directory Domain membership record associated with the DB instance or cluster. * **Domain** *(string) --* The identifier of the Active Directory Domain. * **Status** *(string) --* The status of the Active Directory Domain membership for the DB instance or cluster. Values include "joined", "pending-join", "failed", and so on. * **FQDN** *(string) --* The fully qualified domain name (FQDN) of the Active Directory Domain. * **IAMRoleName** *(string) --* The name of the IAM role used when making API calls to the Directory Service. * **OU** *(string) --* The Active Directory organizational unit for the DB instance or cluster. * **AuthSecretArn** *(string) --* The ARN for the Secrets Manager secret with the credentials for the user that's a member of the domain. * **DnsIps** *(list) --* The IPv4 DNS IP addresses of the primary and secondary Active Directory domain controllers. * *(string) --* * **CopyTagsToSnapshot** *(boolean) --* Indicates whether tags are copied from the DB instance to snapshots of the DB instance. This setting doesn't apply to Amazon Aurora DB instances. 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) --* The order of priority 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 RDS for Db2 and RDS for SQL Server DB instances that were created with a time zone specified. * **IAMDatabaseAuthenticationEnabled** *(boolean) --* Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled for the DB instance. For a list of engine versions that support IAM database authentication, see IAM database authentication in the *Amazon RDS User Guide* and IAM database authentication in Aurora in the *Amazon Aurora User Guide*. * **DatabaseInsightsMode** *(string) --* The mode of Database Insights that is enabled for the instance. * **PerformanceInsightsEnabled** *(boolean) --* Indicates whether Performance Insights is enabled for the DB instance. * **PerformanceInsightsKMSKeyId** *(string) --* The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. * **PerformanceInsightsRetentionPeriod** *(integer) --* The number of days to retain Performance Insights data. Valid Values: * "7" * *month* * 31, where *month* is a number of months from 1-23. Examples: "93" (3 months * 31), "341" (11 months * 31), "589" (19 months * 31) * "731" Default: "7" days * **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 Monitoring Amazon RDS log files in the *Amazon RDS User Guide.* * *(string) --* * **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: * "CreateDBInstance" * "ModifyDBInstance" * "RestoreDBInstanceFromDBSnapshot" * "RestoreDBInstanceFromS3" * "RestoreDBInstanceToPointInTime" 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: * "DescribeDBInstances" * "DescribeDBSnapshots" * "DescribeValidDBInstanceModifications" If you call "DescribeDBInstances", "ProcessorFeature" returns non-null values only if the following conditions are met: * You are accessing an Oracle DB instance. * Your Oracle DB instance class supports configuring the number of CPU cores and threads per core. * The current number CPU cores and threads is set to a non-default value. For more information, see Configuring the processor for a DB instance class in RDS for Oracle 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. * **DeletionProtection** *(boolean) --* Indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance. * **AssociatedRoles** *(list) --* The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance. * *(dict) --* Information about an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance. * **RoleArn** *(string) --* The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance. * **FeatureName** *(string) --* The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see "DBEngineVersion". * **Status** *(string) --* Information about the state of association between the IAM role and the DB instance. The Status property returns one of the following values: * "ACTIVE" - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf. * "PENDING" - the IAM role ARN is being associated with the DB instance. * "INVALID" - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf. * **ListenerEndpoint** *(dict) --* The listener connection endpoint for SQL Server Always On. * **Address** *(string) --* Specifies the DNS address of the DB instance. * **Port** *(integer) --* Specifies the port that the database engine is listening on. * **HostedZoneId** *(string) --* Specifies the ID that Amazon Route 53 assigns when you create a hosted zone. * **MaxAllocatedStorage** *(integer) --* The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. * **TagList** *(list) --* A list of tags. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **Key** *(string) --* A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **Value** *(string) --* A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **DBInstanceAutomatedBackupsReplications** *(list) --* The list of replicated automated backups associated with the DB instance. * *(dict) --* Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties. * **DBInstanceAutomatedBackupsArn** *(string) --* The Amazon Resource Name (ARN) of the replicated automated backups. * **CustomerOwnedIpEnabled** *(boolean) --* Indicates whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance. A >>*<>*< "unavailable" > "available" > "unavailable" > "available" * **Reason** *(string) --* The reason for the current health "State" of the RDS Proxy target. * **Description** *(string) --* A description of the health of the RDS Proxy target. If the "State" is "AVAILABLE", a description is not included. **Exceptions** * "RDS.Client.exceptions.DBProxyNotFoundFault" * "RDS.Client.exceptions.DBProxyTargetGroupNotFoundFault" * "RDS.Client.exceptions.DBClusterNotFoundFault" * "RDS.Client.exceptions.DBInstanceNotFoundFault" * "RDS.Client.exceptions.DBProxyTargetAlreadyRegisteredFault" * "RDS.Client.exceptions.InvalidDBInstanceStateFault" * "RDS.Client.exceptions.InvalidDBClusterStateFault" * "RDS.Client.exceptions.InvalidDBProxyStateFault" * "RDS.Client.exceptions.InsufficientAvailableIPsInSubnetFault" RDS / Client / modify_db_shard_group modify_db_shard_group ********************* RDS.Client.modify_db_shard_group(**kwargs) Modifies the settings of an Aurora Limitless Database DB shard group. You can change one or more settings by specifying these parameters and the new values in the request. See also: AWS API Documentation **Request Syntax** response = client.modify_db_shard_group( DBShardGroupIdentifier='string', MaxACU=123.0, MinACU=123.0, ComputeRedundancy=123 ) Parameters: * **DBShardGroupIdentifier** (*string*) -- **[REQUIRED]** The name of the DB shard group to modify. * **MaxACU** (*float*) -- The maximum capacity of the DB shard group in Aurora capacity units (ACUs). * **MinACU** (*float*) -- The minimum capacity of the DB shard group in Aurora capacity units (ACUs). * **ComputeRedundancy** (*integer*) -- Specifies whether to create standby DB shard groups for the DB shard group. Valid values are the following: * 0 - Creates a DB shard group without a standby DB shard group. This is the default value. * 1 - Creates a DB shard group with a standby DB shard group in a different Availability Zone (AZ). * 2 - Creates a DB shard group with two standby DB shard groups in two different AZs. Return type: dict Returns: **Response Syntax** { 'DBShardGroupResourceId': 'string', 'DBShardGroupIdentifier': 'string', 'DBClusterIdentifier': 'string', 'MaxACU': 123.0, 'MinACU': 123.0, 'ComputeRedundancy': 123, 'Status': 'string', 'PubliclyAccessible': True|False, 'Endpoint': 'string', 'DBShardGroupArn': 'string', 'TagList': [ { 'Key': 'string', 'Value': 'string' }, ] } **Response Structure** * *(dict) --* Contains the details for an Amazon RDS DB shard group. * **DBShardGroupResourceId** *(string) --* The Amazon Web Services Region-unique, immutable identifier for the DB shard group. * **DBShardGroupIdentifier** *(string) --* The name of the DB shard group. * **DBClusterIdentifier** *(string) --* The name of the primary DB cluster for the DB shard group. * **MaxACU** *(float) --* The maximum capacity of the DB shard group in Aurora capacity units (ACUs). * **MinACU** *(float) --* The minimum capacity of the DB shard group in Aurora capacity units (ACUs). * **ComputeRedundancy** *(integer) --* Specifies whether to create standby DB shard groups for the DB shard group. Valid values are the following: * 0 - Creates a DB shard group without a standby DB shard group. This is the default value. * 1 - Creates a DB shard group with a standby DB shard group in a different Availability Zone (AZ). * 2 - Creates a DB shard group with two standby DB shard groups in two different AZs. * **Status** *(string) --* The status of the DB shard group. * **PubliclyAccessible** *(boolean) --* Indicates whether the DB shard group is publicly accessible. When the DB shard group is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB shard group's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB shard group's VPC. Access to the DB shard group is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB shard group doesn't permit it. When the DB shard group isn't publicly accessible, it is an internal DB shard group with a DNS name that resolves to a private IP address. For more information, see CreateDBShardGroup. This setting is only for Aurora Limitless Database. * **Endpoint** *(string) --* The connection endpoint for the DB shard group. * **DBShardGroupArn** *(string) --* The Amazon Resource Name (ARN) for the DB shard group. * **TagList** *(list) --* A list of tags. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **Key** *(string) --* A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **Value** *(string) --* A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). **Exceptions** * "RDS.Client.exceptions.InvalidDBClusterStateFault" * "RDS.Client.exceptions.DBShardGroupAlreadyExistsFault" * "RDS.Client.exceptions.DBShardGroupNotFoundFault" RDS / Client / deregister_db_proxy_targets deregister_db_proxy_targets *************************** RDS.Client.deregister_db_proxy_targets(**kwargs) Remove the association between one or more "DBProxyTarget" data structures and a "DBProxyTargetGroup". See also: AWS API Documentation **Request Syntax** response = client.deregister_db_proxy_targets( DBProxyName='string', TargetGroupName='string', DBInstanceIdentifiers=[ 'string', ], DBClusterIdentifiers=[ 'string', ] ) Parameters: * **DBProxyName** (*string*) -- **[REQUIRED]** The identifier of the "DBProxy" that is associated with the "DBProxyTargetGroup". * **TargetGroupName** (*string*) -- The identifier of the "DBProxyTargetGroup". * **DBInstanceIdentifiers** (*list*) -- One or more DB instance identifiers. * *(string) --* * **DBClusterIdentifiers** (*list*) -- One or more DB cluster identifiers. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "RDS.Client.exceptions.DBProxyTargetNotFoundFault" * "RDS.Client.exceptions.DBProxyTargetGroupNotFoundFault" * "RDS.Client.exceptions.DBProxyNotFoundFault" * "RDS.Client.exceptions.InvalidDBProxyStateFault" RDS / Client / copy_db_parameter_group copy_db_parameter_group *********************** RDS.Client.copy_db_parameter_group(**kwargs) Copies the specified DB parameter group. Note: You can't copy a default DB parameter group. Instead, create a new custom DB parameter group, which copies the default parameters and values for the specified DB parameter group family. See also: AWS API Documentation **Request Syntax** response = client.copy_db_parameter_group( SourceDBParameterGroupIdentifier='string', TargetDBParameterGroupIdentifier='string', TargetDBParameterGroupDescription='string', Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **SourceDBParameterGroupIdentifier** (*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: * Must specify a valid DB parameter group. * **TargetDBParameterGroupIdentifier** (*string*) -- **[REQUIRED]** The identifier for the copied DB parameter group. Constraints: * Can't be null, empty, or blank * Must contain from 1 to 255 letters, numbers, or hyphens * First character must be a letter * Can't end with a hyphen or contain two consecutive hyphens Example: "my-db-parameter-group" * **TargetDBParameterGroupDescription** (*string*) -- **[REQUIRED]** A description for the copied DB parameter group. * **Tags** (*list*) -- A list of tags. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **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}_.:/=+\-@]*)$"). Return type: dict Returns: **Response Syntax** { 'DBParameterGroup': { 'DBParameterGroupName': 'string', 'DBParameterGroupFamily': 'string', 'Description': 'string', 'DBParameterGroupArn': 'string' } } **Response Structure** * *(dict) --* * **DBParameterGroup** *(dict) --* Contains the details of an Amazon RDS DB parameter group. This data type is used as a response element in the "DescribeDBParameterGroups" action. * **DBParameterGroupName** *(string) --* The name of the DB parameter group. * **DBParameterGroupFamily** *(string) --* The name of the DB parameter group family that this DB parameter group is compatible with. * **Description** *(string) --* Provides the customer-specified description for this DB parameter group. * **DBParameterGroupArn** *(string) --* The Amazon Resource Name (ARN) for the DB parameter group. **Exceptions** * "RDS.Client.exceptions.DBParameterGroupNotFoundFault" * "RDS.Client.exceptions.DBParameterGroupAlreadyExistsFault" * "RDS.Client.exceptions.DBParameterGroupQuotaExceededFault" **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: { 'DBParameterGroup': { }, 'ResponseMetadata': { '...': '...', }, } RDS / Client / add_role_to_db_cluster add_role_to_db_cluster ********************** RDS.Client.add_role_to_db_cluster(**kwargs) Associates an Identity and Access Management (IAM) role with a DB cluster. See also: AWS API Documentation **Request Syntax** response = client.add_role_to_db_cluster( DBClusterIdentifier='string', RoleArn='string', FeatureName='string' ) Parameters: * **DBClusterIdentifier** (*string*) -- **[REQUIRED]** The name of the DB cluster to associate the IAM role with. * **RoleArn** (*string*) -- **[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". * **FeatureName** (*string*) -- The name of the feature for the DB cluster that the IAM role is to be associated with. For information about supported feature names, see DBEngineVersion. Returns: None **Exceptions** * "RDS.Client.exceptions.DBClusterNotFoundFault" * "RDS.Client.exceptions.DBClusterRoleAlreadyExistsFault" * "RDS.Client.exceptions.InvalidDBClusterStateFault" * "RDS.Client.exceptions.DBClusterRoleQuotaExceededFault" RDS / Client / copy_option_group copy_option_group ***************** RDS.Client.copy_option_group(**kwargs) Copies the specified option group. See also: AWS API Documentation **Request Syntax** response = client.copy_option_group( SourceOptionGroupIdentifier='string', TargetOptionGroupIdentifier='string', TargetOptionGroupDescription='string', Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **SourceOptionGroupIdentifier** (*string*) -- **[REQUIRED]** The identifier for the source option group. Constraints: * Must specify a valid option group. * **TargetOptionGroupIdentifier** (*string*) -- **[REQUIRED]** The identifier for the copied option group. Constraints: * Can't be null, empty, or blank * Must contain from 1 to 255 letters, numbers, or hyphens * First character must be a letter * Can't end with a hyphen or contain two consecutive hyphens Example: "my-option-group" * **TargetOptionGroupDescription** (*string*) -- **[REQUIRED]** The description for the copied option group. * **Tags** (*list*) -- A list of tags. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **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}_.:/=+\-@]*)$"). Return type: dict Returns: **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', 'SourceOptionGroup': 'string', 'SourceAccountId': 'string', 'CopyTimestamp': datetime(2015, 1, 1) } } **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) --* The details of an option. * **OptionName** *(string) --* The name of the option. * **OptionDescription** *(string) --* The description of the option. * **Persistent** *(boolean) --* Indicates whether this option is persistent. * **Permanent** *(boolean) --* Indicates whether 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) --* Indicates whether the option setting can be modified from the default. * **IsCollection** *(boolean) --* Indicates whether 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: * "ModifyDBInstance" * "RebootDBInstance" * "RestoreDBInstanceFromDBSnapshot" * "RestoreDBInstanceToPointInTime" * **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 membership status of the VPC security group. Currently, the only valid status is "active". * **AllowsVpcAndNonVpcInstanceMemberships** *(boolean) --* Indicates whether this option group can be applied to both VPC and non-VPC instances. The value "true" indicates the option group can be applied to both VPC and non-VPC instances. * **VpcId** *(string) --* If **AllowsVpcAndNonVpcInstanceMemberships** is "false", this field is blank. If **AllowsVpcAndNonVpcInstanceMemberships** is "true" and this field is blank, then this option group can be applied to both VPC and non-VPC instances. If this field contains a value, then this option group can only be applied to instances that are in the VPC indicated by this field. * **OptionGroupArn** *(string) --* Specifies the Amazon Resource Name (ARN) for the option group. * **SourceOptionGroup** *(string) --* Specifies the name of the option group from which this option group is copied. * **SourceAccountId** *(string) --* Specifies the Amazon Web Services account ID for the option group from which this option group is copied. * **CopyTimestamp** *(datetime) --* Indicates when the option group was copied. **Exceptions** * "RDS.Client.exceptions.OptionGroupAlreadyExistsFault" * "RDS.Client.exceptions.OptionGroupNotFoundFault" * "RDS.Client.exceptions.OptionGroupQuotaExceededFault" **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: { 'OptionGroup': { }, 'ResponseMetadata': { '...': '...', }, } RDS / Client / delete_custom_db_engine_version delete_custom_db_engine_version ******************************* RDS.Client.delete_custom_db_engine_version(**kwargs) Deletes a custom engine version. To run this command, make sure you meet the following prerequisites: * The CEV must not be the default for RDS Custom. If it is, change the default before running this command. * The CEV must not be associated with an RDS Custom DB instance, RDS Custom instance snapshot, or automated backup of your RDS Custom instance. Typically, deletion takes a few minutes. Note: The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the "DeleteCustomDbEngineVersion" event aren't logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the "DeleteCustomDbEngineVersion" event. For more information, see Deleting a CEV in the *Amazon RDS User Guide*. See also: AWS API Documentation **Request Syntax** response = client.delete_custom_db_engine_version( Engine='string', EngineVersion='string' ) Parameters: * **Engine** (*string*) -- **[REQUIRED]** The database engine. RDS Custom for Oracle supports the following values: * "custom-oracle-ee" * "custom-oracle-ee-cdb" * "custom-oracle-se2" * "custom-oracle-se2-cdb" * **EngineVersion** (*string*) -- **[REQUIRED]** The custom engine version (CEV) for your DB instance. This option is required for RDS Custom, but optional for Amazon RDS. The combination of "Engine" and "EngineVersion" is unique per customer per Amazon Web Services Region. Return type: dict Returns: **Response Syntax** { 'Engine': 'string', 'EngineVersion': 'string', 'DBParameterGroupFamily': 'string', 'DBEngineDescription': 'string', 'DBEngineVersionDescription': 'string', 'DefaultCharacterSet': { 'CharacterSetName': 'string', 'CharacterSetDescription': 'string' }, 'Image': { 'ImageId': 'string', 'Status': 'string' }, 'DBEngineMediaType': 'string', 'SupportedCharacterSets': [ { 'CharacterSetName': 'string', 'CharacterSetDescription': 'string' }, ], 'SupportedNcharCharacterSets': [ { 'CharacterSetName': 'string', 'CharacterSetDescription': 'string' }, ], 'ValidUpgradeTarget': [ { 'Engine': 'string', 'EngineVersion': 'string', 'Description': 'string', 'AutoUpgrade': True|False, 'IsMajorVersionUpgrade': True|False, 'SupportedEngineModes': [ 'string', ], 'SupportsParallelQuery': True|False, 'SupportsGlobalDatabases': True|False, 'SupportsBabelfish': True|False, 'SupportsLimitlessDatabase': True|False, 'SupportsLocalWriteForwarding': True|False, 'SupportsIntegrations': True|False }, ], 'SupportedTimezones': [ { 'TimezoneName': 'string' }, ], 'ExportableLogTypes': [ 'string', ], 'SupportsLogExportsToCloudwatchLogs': True|False, 'SupportsReadReplica': True|False, 'SupportedEngineModes': [ 'string', ], 'SupportedFeatureNames': [ 'string', ], 'Status': 'string', 'SupportsParallelQuery': True|False, 'SupportsGlobalDatabases': True|False, 'MajorEngineVersion': 'string', 'DatabaseInstallationFilesS3BucketName': 'string', 'DatabaseInstallationFilesS3Prefix': 'string', 'DBEngineVersionArn': 'string', 'KMSKeyId': 'string', 'CreateTime': datetime(2015, 1, 1), 'TagList': [ { 'Key': 'string', 'Value': 'string' }, ], 'SupportsBabelfish': True|False, 'CustomDBEngineVersionManifest': 'string', 'SupportsLimitlessDatabase': True|False, 'SupportsCertificateRotationWithoutRestart': True|False, 'SupportedCACertificateIdentifiers': [ 'string', ], 'SupportsLocalWriteForwarding': True|False, 'SupportsIntegrations': True|False, 'ServerlessV2FeaturesSupport': { 'MinCapacity': 123.0, 'MaxCapacity': 123.0 } } **Response Structure** * *(dict) --* This data type is used as a response element in the action "DescribeDBEngineVersions". * **Engine** *(string) --* The name of the database engine. * **EngineVersion** *(string) --* The version number of the database engine. * **DBParameterGroupFamily** *(string) --* The name of the DB parameter group family for the database engine. * **DBEngineDescription** *(string) --* The description of the database engine. * **DBEngineVersionDescription** *(string) --* The description of the database engine version. * **DefaultCharacterSet** *(dict) --* The default character set for new instances of this engine version, if the "CharacterSetName" parameter of the CreateDBInstance API isn't specified. * **CharacterSetName** *(string) --* The name of the character set. * **CharacterSetDescription** *(string) --* The description of the character set. * **Image** *(dict) --* The EC2 image * **ImageId** *(string) --* A value that indicates the ID of the AMI. * **Status** *(string) --* A value that indicates the status of a custom engine version (CEV). * **DBEngineMediaType** *(string) --* A value that indicates the source media provider of the AMI based on the usage operation. Applicable for RDS Custom for SQL Server. * **SupportedCharacterSets** *(list) --* A list of the character sets supported by this engine for the "CharacterSetName" parameter of the "CreateDBInstance" operation. * *(dict) --* This data type is used as a response element in the action "DescribeDBEngineVersions". * **CharacterSetName** *(string) --* The name of the character set. * **CharacterSetDescription** *(string) --* The description of the character set. * **SupportedNcharCharacterSets** *(list) --* A list of the character sets supported by the Oracle DB engine for the "NcharCharacterSetName" parameter of the "CreateDBInstance" operation. * *(dict) --* This data type is used as a response element in the action "DescribeDBEngineVersions". * **CharacterSetName** *(string) --* The name of the character set. * **CharacterSetDescription** *(string) --* The description of the character set. * **ValidUpgradeTarget** *(list) --* A list of engine versions that this database engine version can be upgraded to. * *(dict) --* The version of the database engine that a DB instance can be upgraded to. * **Engine** *(string) --* The name of the upgrade target database engine. * **EngineVersion** *(string) --* The version number of the upgrade target database engine. * **Description** *(string) --* The version of the database engine that a DB instance can be upgraded to. * **AutoUpgrade** *(boolean) --* Indicates whether the target version is applied to any source DB instances that have "AutoMinorVersionUpgrade" set to true. This parameter is dynamic, and is set by RDS. * **IsMajorVersionUpgrade** *(boolean) --* Indicates whether upgrading to the target version requires upgrading the major version of the database engine. * **SupportedEngineModes** *(list) --* A list of the supported DB engine modes for the target engine version. * *(string) --* * **SupportsParallelQuery** *(boolean) --* Indicates whether you can use Aurora parallel query with the target engine version. * **SupportsGlobalDatabases** *(boolean) --* Indicates whether you can use Aurora global databases with the target engine version. * **SupportsBabelfish** *(boolean) --* Indicates whether you can use Babelfish for Aurora PostgreSQL with the target engine version. * **SupportsLimitlessDatabase** *(boolean) --* Indicates whether the DB engine version supports Aurora Limitless Database. * **SupportsLocalWriteForwarding** *(boolean) --* Indicates whether the target engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances. Valid for: Aurora DB clusters only * **SupportsIntegrations** *(boolean) --* Indicates whether the DB engine version supports zero- ETL integrations with Amazon Redshift. * **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. * *(string) --* * **SupportsLogExportsToCloudwatchLogs** *(boolean) --* 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. * *(string) --* * **SupportedFeatureNames** *(list) --* A list of features supported by the DB engine. The supported features vary by DB engine and DB engine version. To determine the supported features for a specific DB engine and DB engine version using the CLI, use the following command: "aws rds describe-db-engine-versions --engine --engine-version " For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, use the following command: "aws rds describe-db-engine-versions --engine postgres --engine-version 13.3" The supported features are listed under "SupportedFeatureNames" in the output. * *(string) --* * **Status** *(string) --* The status of the DB engine version, either "available" or "deprecated". * **SupportsParallelQuery** *(boolean) --* Indicates whether you can use Aurora parallel query with a specific DB engine version. * **SupportsGlobalDatabases** *(boolean) --* Indicates whether you can use Aurora global databases with a specific DB engine version. * **MajorEngineVersion** *(string) --* The major engine version of the CEV. * **DatabaseInstallationFilesS3BucketName** *(string) --* The name of the Amazon S3 bucket that contains your database installation files. * **DatabaseInstallationFilesS3Prefix** *(string) --* The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed. * **DBEngineVersionArn** *(string) --* The ARN of the custom engine version. * **KMSKeyId** *(string) --* The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS. * **CreateTime** *(datetime) --* The creation time of the DB engine version. * **TagList** *(list) --* A list of tags. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **Key** *(string) --* A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **Value** *(string) --* A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **SupportsBabelfish** *(boolean) --* Indicates whether the engine version supports Babelfish for Aurora PostgreSQL. * **CustomDBEngineVersionManifest** *(string) --* JSON string that lists the installation files and parameters that RDS Custom uses to create a custom engine version (CEV). RDS Custom applies the patches in the order in which they're listed in the manifest. You can set the Oracle home, Oracle base, and UNIX/Linux user and group using the installation parameters. For more information, see JSON fields in the CEV manifest in the *Amazon RDS User Guide*. * **SupportsLimitlessDatabase** *(boolean) --* Indicates whether the DB engine version supports Aurora Limitless Database. * **SupportsCertificateRotationWithoutRestart** *(boolean) --* Indicates whether the engine version supports rotating the server certificate without rebooting the DB instance. * **SupportedCACertificateIdentifiers** *(list) --* A list of the supported CA certificate identifiers. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the *Amazon RDS User Guide* and Using SSL/TLS to encrypt a connection to a DB cluster in the *Amazon Aurora User Guide*. * *(string) --* * **SupportsLocalWriteForwarding** *(boolean) --* Indicates whether the DB engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances. Valid for: Aurora DB clusters only * **SupportsIntegrations** *(boolean) --* Indicates whether the DB engine version supports zero-ETL integrations with Amazon Redshift. * **ServerlessV2FeaturesSupport** *(dict) --* Specifies any Aurora Serverless v2 properties or limits that differ between Aurora engine versions. You can test the values of this attribute when deciding which Aurora version to use in a new or upgraded DB cluster. You can also retrieve the version of an existing DB cluster and check whether that version supports certain Aurora Serverless v2 features before you attempt to use those features. * **MinCapacity** *(float) --* If the minimum capacity is 0 ACUs, the engine version or platform version supports the automatic pause/resume feature of Aurora Serverless v2. * **MaxCapacity** *(float) --* Specifies the upper Aurora Serverless v2 capacity limit for a particular engine version or platform version. Depending on the engine version, the maximum capacity for an Aurora Serverless v2 cluster might be "256" or "128". **Exceptions** * "RDS.Client.exceptions.CustomDBEngineVersionNotFoundFault" * "RDS.Client.exceptions.InvalidCustomDBEngineVersionStateFault" RDS / Client / describe_event_subscriptions describe_event_subscriptions **************************** RDS.Client.describe_event_subscriptions(**kwargs) Lists all the subscription descriptions for a customer account. The description for a subscription includes "SubscriptionName", "SNSTopicARN", "CustomerID", "SourceType", "SourceID", "CreationTime", and "Status". If you specify a "SubscriptionName", lists the description for that subscription. See also: AWS API Documentation **Request Syntax** response = client.describe_event_subscriptions( SubscriptionName='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], MaxRecords=123, Marker='string' ) Parameters: * **SubscriptionName** (*string*) -- The name of the RDS event notification subscription you want to describe. * **Filters** (*list*) -- This parameter isn't currently supported. * *(dict) --* 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: * "DescribeDBClusterBacktracks" * "DescribeDBClusterEndpoints" * "DescribeDBClusters" * "DescribeDBInstances" * "DescribeDBRecommendations" * "DescribeDBShardGroups" * "DescribePendingMaintenanceActions" * **Name** *(string) --* **[REQUIRED]** The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* **[REQUIRED]** One or more filter values. Filter values are case- sensitive. * *(string) --* * **MaxRecords** (*integer*) -- 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. * **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" . Return type: dict Returns: **Response Syntax** { 'Marker': 'string', 'EventSubscriptionsList': [ { 'CustomerAwsId': 'string', 'CustSubscriptionId': 'string', 'SnsTopicArn': 'string', 'Status': 'string', 'SubscriptionCreationTime': 'string', 'SourceType': 'string', 'SourceIdsList': [ 'string', ], 'EventCategoriesList': [ 'string', ], 'Enabled': True|False, 'EventSubscriptionArn': 'string' }, ] } **Response Structure** * *(dict) --* Data returned by the **DescribeEventSubscriptions** action. * **Marker** *(string) --* An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by "MaxRecords". * **EventSubscriptionsList** *(list) --* A list of EventSubscriptions data types. * *(dict) --* Contains the results of a successful invocation of the "DescribeEventSubscriptions" action. * **CustomerAwsId** *(string) --* The Amazon Web Services customer account associated with the RDS event notification subscription. * **CustSubscriptionId** *(string) --* The RDS event notification subscription Id. * **SnsTopicArn** *(string) --* The topic ARN of the RDS event notification subscription. * **Status** *(string) --* The status of the RDS event notification subscription. Constraints: Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist The status "no-permission" indicates that RDS no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created. * **SubscriptionCreationTime** *(string) --* The time the RDS event notification subscription was created. * **SourceType** *(string) --* The source type for the RDS event notification subscription. * **SourceIdsList** *(list) --* A list of source IDs for the RDS event notification subscription. * *(string) --* * **EventCategoriesList** *(list) --* A list of event categories for the RDS event notification subscription. * *(string) --* * **Enabled** *(boolean) --* Specifies whether the subscription is enabled. True indicates the subscription is enabled. * **EventSubscriptionArn** *(string) --* The Amazon Resource Name (ARN) for the event subscription. **Exceptions** * "RDS.Client.exceptions.SubscriptionNotFoundFault" **Examples** This example lists information for the specified DB event notification subscription. response = client.describe_event_subscriptions( SubscriptionName='mymysqleventsubscription', ) print(response) Expected Output: { 'ResponseMetadata': { '...': '...', }, } RDS / Client / get_waiter get_waiter ********** RDS.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" RDS / Client / delete_integration delete_integration ****************** RDS.Client.delete_integration(**kwargs) Deletes a zero-ETL integration with Amazon Redshift. See also: AWS API Documentation **Request Syntax** response = client.delete_integration( IntegrationIdentifier='string' ) Parameters: **IntegrationIdentifier** (*string*) -- **[REQUIRED]** The unique identifier of the integration. Return type: dict Returns: **Response Syntax** { 'SourceArn': 'string', 'TargetArn': 'string', 'IntegrationName': 'string', 'IntegrationArn': 'string', 'KMSKeyId': 'string', 'AdditionalEncryptionContext': { 'string': 'string' }, 'Status': 'creating'|'active'|'modifying'|'failed'|'deleting'|'syncing'|'needs_attention', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'CreateTime': datetime(2015, 1, 1), 'Errors': [ { 'ErrorCode': 'string', 'ErrorMessage': 'string' }, ], 'DataFilter': 'string', 'Description': 'string' } **Response Structure** * *(dict) --* A zero-ETL integration with Amazon Redshift. * **SourceArn** *(string) --* The Amazon Resource Name (ARN) of the database used as the source for replication. * **TargetArn** *(string) --* The ARN of the Redshift data warehouse used as the target for replication. * **IntegrationName** *(string) --* The name of the integration. * **IntegrationArn** *(string) --* The ARN of the integration. * **KMSKeyId** *(string) --* The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key used to to encrypt the integration. * **AdditionalEncryptionContext** *(dict) --* The encryption context for the integration. For more information, see Encryption context in the *Amazon Web Services Key Management Service Developer Guide*. * *(string) --* * *(string) --* * **Status** *(string) --* The current status of the integration. * **Tags** *(list) --* A list of tags. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **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}_.:/=+\-@]*)$"). * **CreateTime** *(datetime) --* The time when the integration was created, in Universal Coordinated Time (UTC). * **Errors** *(list) --* Any errors associated with the integration. * *(dict) --* An error associated with a zero-ETL integration with Amazon Redshift. * **ErrorCode** *(string) --* The error code associated with the integration. * **ErrorMessage** *(string) --* A message explaining the error. * **DataFilter** *(string) --* Data filters for the integration. These filters determine which tables from the source database are sent to the target Amazon Redshift data warehouse. * **Description** *(string) --* A description of the integration. **Exceptions** * "RDS.Client.exceptions.IntegrationNotFoundFault" * "RDS.Client.exceptions.IntegrationConflictOperationFault" * "RDS.Client.exceptions.InvalidIntegrationStateFault" RDS / Client / revoke_db_security_group_ingress revoke_db_security_group_ingress ******************************** RDS.Client.revoke_db_security_group_ingress(**kwargs) Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC security groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId). Note: EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see Migrate from EC2-Classic to a VPC in the *Amazon EC2 User Guide*, the blog EC2-Classic Networking is Retiring – Here’s How to Prepare, and Moving a DB instance not in a VPC into a VPC in the *Amazon RDS User Guide*. See also: AWS API Documentation **Request Syntax** response = client.revoke_db_security_group_ingress( DBSecurityGroupName='string', CIDRIP='string', EC2SecurityGroupName='string', EC2SecurityGroupId='string', EC2SecurityGroupOwnerId='string' ) Parameters: * **DBSecurityGroupName** (*string*) -- **[REQUIRED]** The name of the DB security group to revoke ingress from. * **CIDRIP** (*string*) -- The IP range to revoke access from. Must be a valid CIDR range. If "CIDRIP" is specified, "EC2SecurityGroupName", "EC2SecurityGroupId" and "EC2SecurityGroupOwnerId" can't be provided. * **EC2SecurityGroupName** (*string*) -- The name of the EC2 security group to revoke access from. For VPC DB security groups, "EC2SecurityGroupId" must be provided. Otherwise, EC2SecurityGroupOwnerId and either "EC2SecurityGroupName" or "EC2SecurityGroupId" must be provided. * **EC2SecurityGroupId** (*string*) -- The id of the EC2 security group to revoke access from. For VPC DB security groups, "EC2SecurityGroupId" must be provided. Otherwise, EC2SecurityGroupOwnerId and either "EC2SecurityGroupName" or "EC2SecurityGroupId" must be provided. * **EC2SecurityGroupOwnerId** (*string*) -- The Amazon Web Services account number of the owner of the EC2 security group specified in the "EC2SecurityGroupName" parameter. The Amazon Web Services access key ID isn't an acceptable value. For VPC DB security groups, "EC2SecurityGroupId" must be provided. Otherwise, EC2SecurityGroupOwnerId and either "EC2SecurityGroupName" or "EC2SecurityGroupId" must be provided. Return type: dict Returns: **Response Syntax** { 'DBSecurityGroup': { 'OwnerId': 'string', 'DBSecurityGroupName': 'string', 'DBSecurityGroupDescription': 'string', 'VpcId': 'string', 'EC2SecurityGroups': [ { 'Status': 'string', 'EC2SecurityGroupName': 'string', 'EC2SecurityGroupId': 'string', 'EC2SecurityGroupOwnerId': 'string' }, ], 'IPRanges': [ { 'Status': 'string', 'CIDRIP': 'string' }, ], 'DBSecurityGroupArn': 'string' } } **Response Structure** * *(dict) --* * **DBSecurityGroup** *(dict) --* Contains the details for an Amazon RDS DB security group. This data type is used as a response element in the "DescribeDBSecurityGroups" action. * **OwnerId** *(string) --* Provides the Amazon Web Services ID of the owner of a specific DB security group. * **DBSecurityGroupName** *(string) --* Specifies the name of the DB security group. * **DBSecurityGroupDescription** *(string) --* Provides the description of the DB security group. * **VpcId** *(string) --* Provides the VpcId of the DB security group. * **EC2SecurityGroups** *(list) --* Contains a list of "EC2SecurityGroup" elements. * *(dict) --* This data type is used as a response element in the following actions: * "AuthorizeDBSecurityGroupIngress" * "DescribeDBSecurityGroups" * "RevokeDBSecurityGroupIngress" * **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 Amazon Web Services ID of the owner of the EC2 security group specified in the "EC2SecurityGroupName" field. * **IPRanges** *(list) --* Contains a list of "IPRange" elements. * *(dict) --* This data type is used as a response element in the "DescribeDBSecurityGroups" action. * **Status** *(string) --* The status of the IP range. Status can be "authorizing", "authorized", "revoking", and "revoked". * **CIDRIP** *(string) --* The IP range. * **DBSecurityGroupArn** *(string) --* The Amazon Resource Name (ARN) for the DB security group. **Exceptions** * "RDS.Client.exceptions.DBSecurityGroupNotFoundFault" * "RDS.Client.exceptions.AuthorizationNotFoundFault" * "RDS.Client.exceptions.InvalidDBSecurityGroupStateFault" **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: { 'DBSecurityGroup': { }, 'ResponseMetadata': { '...': '...', }, } RDS / Client / create_integration create_integration ****************** RDS.Client.create_integration(**kwargs) Creates a zero-ETL integration with Amazon Redshift. See also: AWS API Documentation **Request Syntax** response = client.create_integration( SourceArn='string', TargetArn='string', IntegrationName='string', KMSKeyId='string', AdditionalEncryptionContext={ 'string': 'string' }, Tags=[ { 'Key': 'string', 'Value': 'string' }, ], DataFilter='string', Description='string' ) Parameters: * **SourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the database to use as the source for replication. * **TargetArn** (*string*) -- **[REQUIRED]** The ARN of the Redshift data warehouse to use as the target for replication. * **IntegrationName** (*string*) -- **[REQUIRED]** The name of the integration. * **KMSKeyId** (*string*) -- The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to encrypt the integration. If you don't specify an encryption key, RDS uses a default Amazon Web Services owned key. * **AdditionalEncryptionContext** (*dict*) -- An optional set of non-secret key–value pairs that contains additional contextual information about the data. For more information, see Encryption context in the *Amazon Web Services Key Management Service Developer Guide*. You can only include this parameter if you specify the "KMSKeyId" parameter. * *(string) --* * *(string) --* * **Tags** (*list*) -- A list of tags. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **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}_.:/=+\-@]*)$"). * **DataFilter** (*string*) -- Data filtering options for the integration. For more information, see Data filtering for Aurora zero-ETL integrations with Amazon Redshift or Data filtering for Amazon RDS zero-ETL integrations with Amazon Redshift. * **Description** (*string*) -- A description of the integration. Return type: dict Returns: **Response Syntax** { 'SourceArn': 'string', 'TargetArn': 'string', 'IntegrationName': 'string', 'IntegrationArn': 'string', 'KMSKeyId': 'string', 'AdditionalEncryptionContext': { 'string': 'string' }, 'Status': 'creating'|'active'|'modifying'|'failed'|'deleting'|'syncing'|'needs_attention', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'CreateTime': datetime(2015, 1, 1), 'Errors': [ { 'ErrorCode': 'string', 'ErrorMessage': 'string' }, ], 'DataFilter': 'string', 'Description': 'string' } **Response Structure** * *(dict) --* A zero-ETL integration with Amazon Redshift. * **SourceArn** *(string) --* The Amazon Resource Name (ARN) of the database used as the source for replication. * **TargetArn** *(string) --* The ARN of the Redshift data warehouse used as the target for replication. * **IntegrationName** *(string) --* The name of the integration. * **IntegrationArn** *(string) --* The ARN of the integration. * **KMSKeyId** *(string) --* The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key used to to encrypt the integration. * **AdditionalEncryptionContext** *(dict) --* The encryption context for the integration. For more information, see Encryption context in the *Amazon Web Services Key Management Service Developer Guide*. * *(string) --* * *(string) --* * **Status** *(string) --* The current status of the integration. * **Tags** *(list) --* A list of tags. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **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}_.:/=+\-@]*)$"). * **CreateTime** *(datetime) --* The time when the integration was created, in Universal Coordinated Time (UTC). * **Errors** *(list) --* Any errors associated with the integration. * *(dict) --* An error associated with a zero-ETL integration with Amazon Redshift. * **ErrorCode** *(string) --* The error code associated with the integration. * **ErrorMessage** *(string) --* A message explaining the error. * **DataFilter** *(string) --* Data filters for the integration. These filters determine which tables from the source database are sent to the target Amazon Redshift data warehouse. * **Description** *(string) --* A description of the integration. **Exceptions** * "RDS.Client.exceptions.DBClusterNotFoundFault" * "RDS.Client.exceptions.DBInstanceNotFoundFault" * "RDS.Client.exceptions.IntegrationAlreadyExistsFault" * "RDS.Client.exceptions.IntegrationQuotaExceededFault" * "RDS.Client.exceptions.KMSKeyNotAccessibleFault" * "RDS.Client.exceptions.IntegrationConflictOperationFault" RDS / Client / create_db_proxy create_db_proxy *************** RDS.Client.create_db_proxy(**kwargs) Creates a new DB proxy. See also: AWS API Documentation **Request Syntax** response = client.create_db_proxy( DBProxyName='string', EngineFamily='MYSQL'|'POSTGRESQL'|'SQLSERVER', Auth=[ { 'Description': 'string', 'UserName': 'string', 'AuthScheme': 'SECRETS', 'SecretArn': 'string', 'IAMAuth': 'DISABLED'|'REQUIRED'|'ENABLED', 'ClientPasswordAuthType': 'MYSQL_NATIVE_PASSWORD'|'MYSQL_CACHING_SHA2_PASSWORD'|'POSTGRES_SCRAM_SHA_256'|'POSTGRES_MD5'|'SQL_SERVER_AUTHENTICATION' }, ], RoleArn='string', VpcSubnetIds=[ 'string', ], VpcSecurityGroupIds=[ 'string', ], RequireTLS=True|False, IdleClientTimeout=123, DebugLogging=True|False, Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **DBProxyName** (*string*) -- **[REQUIRED]** The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens. * **EngineFamily** (*string*) -- **[REQUIRED]** The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. For Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases, specify "MYSQL". For Aurora PostgreSQL and RDS for PostgreSQL databases, specify "POSTGRESQL". For RDS for Microsoft SQL Server, specify "SQLSERVER". * **Auth** (*list*) -- **[REQUIRED]** The authorization mechanism that the proxy uses. * *(dict) --* Specifies 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) --* A value that indicates whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The "ENABLED" value is valid only for proxies with RDS for Microsoft SQL Server. * **ClientPasswordAuthType** *(string) --* The type of authentication the proxy uses for connections from clients. The following values are defaults for the corresponding engines: * RDS for MySQL: "MYSQL_CACHING_SHA2_PASSWORD" * RDS for SQL Server: "SQL_SERVER_AUTHENTICATION" * RDS for PostgreSQL: "POSTGRES_SCRAM_SHA2_256" * **RoleArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager. * **VpcSubnetIds** (*list*) -- **[REQUIRED]** One or more VPC subnet IDs to associate with the new proxy. * *(string) --* * **VpcSecurityGroupIds** (*list*) -- One or more VPC security group IDs to associate with the new proxy. * *(string) --* * **RequireTLS** (*boolean*) -- Specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy. By enabling this setting, you can enforce encrypted TLS connections to the proxy. * **IdleClientTimeout** (*integer*) -- The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. You can set this value higher or lower than the connection timeout limit for the associated database. * **DebugLogging** (*boolean*) -- Specifies 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. * **Tags** (*list*) -- An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **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}_.:/=+\-@]*)$"). Return type: dict Returns: **Response Syntax** { 'DBProxy': { 'DBProxyName': 'string', 'DBProxyArn': 'string', 'Status': 'available'|'modifying'|'incompatible-network'|'insufficient-resource-limits'|'creating'|'deleting'|'suspended'|'suspending'|'reactivating', 'EngineFamily': 'string', 'VpcId': 'string', 'VpcSecurityGroupIds': [ 'string', ], 'VpcSubnetIds': [ 'string', ], 'Auth': [ { 'Description': 'string', 'UserName': 'string', 'AuthScheme': 'SECRETS', 'SecretArn': 'string', 'IAMAuth': 'DISABLED'|'REQUIRED'|'ENABLED', 'ClientPasswordAuthType': 'MYSQL_NATIVE_PASSWORD'|'MYSQL_CACHING_SHA2_PASSWORD'|'POSTGRES_SCRAM_SHA_256'|'POSTGRES_MD5'|'SQL_SERVER_AUTHENTICATION' }, ], 'RoleArn': 'string', 'Endpoint': 'string', 'RequireTLS': True|False, 'IdleClientTimeout': 123, 'DebugLogging': True|False, 'CreatedDate': datetime(2015, 1, 1), 'UpdatedDate': datetime(2015, 1, 1) } } **Response Structure** * *(dict) --* * **DBProxy** *(dict) --* The "DBProxy" structure corresponding to the new proxy. * **DBProxyName** *(string) --* The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region. * **DBProxyArn** *(string) --* The Amazon Resource Name (ARN) for the proxy. * **Status** *(string) --* The current status of this proxy. A status of "available" means the proxy is ready to handle requests. Other values indicate that you must wait for the proxy to be ready, or take some action to resolve an issue. * **EngineFamily** *(string) --* The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. "MYSQL" supports Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases. "POSTGRESQL" supports Aurora PostgreSQL and RDS for PostgreSQL databases. "SQLSERVER" supports RDS for Microsoft SQL Server databases. * **VpcId** *(string) --* Provides the VPC ID of the DB proxy. * **VpcSecurityGroupIds** *(list) --* Provides a list of VPC security groups that the proxy belongs to. * *(string) --* * **VpcSubnetIds** *(list) --* The EC2 subnet IDs for the proxy. * *(string) --* * **Auth** *(list) --* One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster. * *(dict) --* Returns the details of authentication used by a proxy to log in as a specific database user. * **Description** *(string) --* A user-specified description about the authentication used by a proxy to log in as a specific database user. * **UserName** *(string) --* The name of the database user to which the proxy connects. * **AuthScheme** *(string) --* The type of authentication that the proxy uses for connections from the proxy to the underlying database. * **SecretArn** *(string) --* The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager. * **IAMAuth** *(string) --* Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. * **ClientPasswordAuthType** *(string) --* The type of authentication the proxy uses for connections from clients. * **RoleArn** *(string) --* The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager. * **Endpoint** *(string) --* The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application. * **RequireTLS** *(boolean) --* Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy. * **IdleClientTimeout** *(integer) --* The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection. The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by later connection requests. Default: 1800 (30 minutes) Constraints: 1 to 28,800 * **DebugLogging** *(boolean) --* Indicates whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs. * **CreatedDate** *(datetime) --* The date and time when the proxy was first created. * **UpdatedDate** *(datetime) --* The date and time when the proxy was last updated. **Exceptions** * "RDS.Client.exceptions.InvalidSubnet" * "RDS.Client.exceptions.DBProxyAlreadyExistsFault" * "RDS.Client.exceptions.DBProxyQuotaExceededFault" RDS / Client / remove_source_identifier_from_subscription remove_source_identifier_from_subscription ****************************************** RDS.Client.remove_source_identifier_from_subscription(**kwargs) Removes a source identifier from an existing RDS event notification subscription. See also: AWS API Documentation **Request Syntax** response = client.remove_source_identifier_from_subscription( SubscriptionName='string', SourceIdentifier='string' ) Parameters: * **SubscriptionName** (*string*) -- **[REQUIRED]** The name of the RDS event notification subscription you want to remove a source identifier from. * **SourceIdentifier** (*string*) -- **[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. Return type: dict Returns: **Response Syntax** { 'EventSubscription': { 'CustomerAwsId': 'string', 'CustSubscriptionId': 'string', 'SnsTopicArn': 'string', 'Status': 'string', 'SubscriptionCreationTime': 'string', 'SourceType': 'string', 'SourceIdsList': [ 'string', ], 'EventCategoriesList': [ 'string', ], 'Enabled': True|False, 'EventSubscriptionArn': 'string' } } **Response Structure** * *(dict) --* * **EventSubscription** *(dict) --* Contains the results of a successful invocation of the "DescribeEventSubscriptions" action. * **CustomerAwsId** *(string) --* The Amazon Web Services customer account associated with the RDS event notification subscription. * **CustSubscriptionId** *(string) --* The RDS event notification subscription Id. * **SnsTopicArn** *(string) --* The topic ARN of the RDS event notification subscription. * **Status** *(string) --* The status of the RDS event notification subscription. Constraints: Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist The status "no-permission" indicates that RDS no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created. * **SubscriptionCreationTime** *(string) --* The time the RDS event notification subscription was created. * **SourceType** *(string) --* The source type for the RDS event notification subscription. * **SourceIdsList** *(list) --* A list of source IDs for the RDS event notification subscription. * *(string) --* * **EventCategoriesList** *(list) --* A list of event categories for the RDS event notification subscription. * *(string) --* * **Enabled** *(boolean) --* Specifies whether the subscription is enabled. True indicates the subscription is enabled. * **EventSubscriptionArn** *(string) --* The Amazon Resource Name (ARN) for the event subscription. **Exceptions** * "RDS.Client.exceptions.SubscriptionNotFoundFault" * "RDS.Client.exceptions.SourceNotFoundFault" **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: { 'EventSubscription': { }, 'ResponseMetadata': { '...': '...', }, } RDS / Client / describe_events describe_events *************** RDS.Client.describe_events(**kwargs) Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days. Events specific to a particular DB instance, DB cluster, DB parameter group, DB security group, DB snapshot, DB cluster snapshot group, or RDS Proxy can be obtained by providing the name as a parameter. For more information on working with events, see Monitoring Amazon RDS events in the *Amazon RDS User Guide* and Monitoring Amazon Aurora events in the *Amazon Aurora User Guide*. Note: By default, RDS returns events that were generated in the past hour. See also: AWS API Documentation **Request Syntax** response = client.describe_events( SourceIdentifier='string', SourceType='db-instance'|'db-parameter-group'|'db-security-group'|'db-snapshot'|'db-cluster'|'db-cluster-snapshot'|'custom-engine-version'|'db-proxy'|'blue-green-deployment', StartTime=datetime(2015, 1, 1), EndTime=datetime(2015, 1, 1), Duration=123, EventCategories=[ 'string', ], Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], MaxRecords=123, Marker='string' ) Parameters: * **SourceIdentifier** (*string*) -- The identifier of the event source for which events are returned. If not specified, then all sources are included in the response. Constraints: * If "SourceIdentifier" is supplied, "SourceType" must also be provided. * If the source type is a DB instance, a "DBInstanceIdentifier" value must be supplied. * If the source type is a DB cluster, a "DBClusterIdentifier" value must be supplied. * If the source type is a DB parameter group, a "DBParameterGroupName" value must be supplied. * If the source type is a DB security group, a "DBSecurityGroupName" value must be supplied. * If the source type is a DB snapshot, a "DBSnapshotIdentifier" value must be supplied. * If the source type is a DB cluster snapshot, a "DBClusterSnapshotIdentifier" value must be supplied. * If the source type is an RDS Proxy, a "DBProxyName" value must be supplied. * Can't end with a hyphen or contain two consecutive hyphens. * **SourceType** (*string*) -- The event source to retrieve events for. If no value is specified, all events are returned. * **StartTime** (*datetime*) -- 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 * **EndTime** (*datetime*) -- 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 * **Duration** (*integer*) -- The number of minutes to retrieve events for. Default: 60 * **EventCategories** (*list*) -- A list of event categories that trigger notifications for a event notification subscription. * *(string) --* * **Filters** (*list*) -- This parameter isn't currently supported. * *(dict) --* 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: * "DescribeDBClusterBacktracks" * "DescribeDBClusterEndpoints" * "DescribeDBClusters" * "DescribeDBInstances" * "DescribeDBRecommendations" * "DescribeDBShardGroups" * "DescribePendingMaintenanceActions" * **Name** *(string) --* **[REQUIRED]** The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* **[REQUIRED]** One or more filter values. Filter values are case- sensitive. * *(string) --* * **MaxRecords** (*integer*) -- 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. * **Marker** (*string*) -- An optional pagination token provided by a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by "MaxRecords". Return type: dict Returns: **Response Syntax** { 'Marker': 'string', 'Events': [ { 'SourceIdentifier': 'string', 'SourceType': 'db-instance'|'db-parameter-group'|'db-security-group'|'db-snapshot'|'db-cluster'|'db-cluster-snapshot'|'custom-engine-version'|'db-proxy'|'blue-green-deployment', '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. * *(string) --* * **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': { '...': '...', }, } RDS / Client / describe_reserved_db_instances_offerings describe_reserved_db_instances_offerings **************************************** RDS.Client.describe_reserved_db_instances_offerings(**kwargs) Lists available reserved DB instance offerings. See also: AWS API Documentation **Request Syntax** response = client.describe_reserved_db_instances_offerings( ReservedDBInstancesOfferingId='string', DBInstanceClass='string', Duration='string', ProductDescription='string', OfferingType='string', MultiAZ=True|False, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], MaxRecords=123, Marker='string' ) Parameters: * **ReservedDBInstancesOfferingId** (*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" * **DBInstanceClass** (*string*) -- The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class. * **Duration** (*string*) -- Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration. Valid Values: "1 | 3 | 31536000 | 94608000" * **ProductDescription** (*string*) -- 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. * **OfferingType** (*string*) -- 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"" * **MultiAZ** (*boolean*) -- Specifies whether to show only those reservations that support Multi-AZ. * **Filters** (*list*) -- This parameter isn't currently supported. * *(dict) --* 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: * "DescribeDBClusterBacktracks" * "DescribeDBClusterEndpoints" * "DescribeDBClusters" * "DescribeDBInstances" * "DescribeDBRecommendations" * "DescribeDBShardGroups" * "DescribePendingMaintenanceActions" * **Name** *(string) --* **[REQUIRED]** The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* **[REQUIRED]** One or more filter values. Filter values are case- sensitive. * *(string) --* * **MaxRecords** (*integer*) -- 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. * **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". Return type: dict Returns: **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 whether the offering applies to Multi-AZ deployments. * **RecurringCharges** *(list) --* The recurring price charged to run this reserved DB instance. * *(dict) --* This data type is used as a response element in the "DescribeReservedDBInstances" and "DescribeReservedDBInstancesOfferings" actions. * **RecurringChargeAmount** *(float) --* The amount of the recurring charge. * **RecurringChargeFrequency** *(string) --* The frequency of the recurring charge. **Exceptions** * "RDS.Client.exceptions.ReservedDBInstancesOfferingNotFoundFault" **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': { '...': '...', }, } RDS / Client / delete_db_snapshot delete_db_snapshot ****************** RDS.Client.delete_db_snapshot(**kwargs) Deletes a DB snapshot. If the snapshot is being copied, the copy operation is terminated. Note: The DB snapshot must be in the "available" state to be deleted. See also: AWS API Documentation **Request Syntax** response = client.delete_db_snapshot( DBSnapshotIdentifier='string' ) Parameters: **DBSnapshotIdentifier** (*string*) -- **[REQUIRED]** The DB snapshot identifier. Constraints: Must be the name of an existing DB snapshot in the "available" state. Return type: dict Returns: **Response Syntax** { 'DBSnapshot': { 'DBSnapshotIdentifier': 'string', 'DBInstanceIdentifier': 'string', 'SnapshotCreateTime': datetime(2015, 1, 1), 'Engine': 'string', 'AllocatedStorage': 123, 'Status': 'string', 'Port': 123, 'AvailabilityZone': 'string', 'VpcId': 'string', 'InstanceCreateTime': datetime(2015, 1, 1), 'MasterUsername': 'string', 'EngineVersion': 'string', 'LicenseModel': 'string', 'SnapshotType': 'string', 'Iops': 123, 'OptionGroupName': 'string', 'PercentProgress': 123, 'SourceRegion': 'string', 'SourceDBSnapshotIdentifier': 'string', 'StorageType': 'string', 'TdeCredentialArn': 'string', 'Encrypted': True|False, 'KmsKeyId': 'string', 'DBSnapshotArn': 'string', 'Timezone': 'string', 'IAMDatabaseAuthenticationEnabled': True|False, 'ProcessorFeatures': [ { 'Name': 'string', 'Value': 'string' }, ], 'DbiResourceId': 'string', 'TagList': [ { 'Key': 'string', 'Value': 'string' }, ], 'OriginalSnapshotCreateTime': datetime(2015, 1, 1), 'SnapshotDatabaseTime': datetime(2015, 1, 1), 'SnapshotTarget': 'string', 'StorageThroughput': 123, 'DBSystemId': 'string', 'DedicatedLogVolume': True|False, 'MultiTenant': True|False, 'SnapshotAvailabilityZone': 'string' } } **Response Structure** * *(dict) --* * **DBSnapshot** *(dict) --* Contains the details of an Amazon RDS DB snapshot. This data type is used as a response element in the "DescribeDBSnapshots" action. * **DBSnapshotIdentifier** *(string) --* Specifies the identifier for the DB snapshot. * **DBInstanceIdentifier** *(string) --* Specifies the DB instance identifier of the DB instance this DB snapshot was created from. * **SnapshotCreateTime** *(datetime) --* Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied. * **Engine** *(string) --* Specifies the name of the database engine. * **AllocatedStorage** *(integer) --* Specifies the allocated storage size in gibibytes (GiB). * **Status** *(string) --* Specifies the status of this DB snapshot. * **Port** *(integer) --* Specifies the port that the database engine was listening on at the time of the snapshot. * **AvailabilityZone** *(string) --* Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot. * **VpcId** *(string) --* Provides the VPC ID associated with the DB snapshot. * **InstanceCreateTime** *(datetime) --* Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created. * **MasterUsername** *(string) --* Provides the master username for the DB snapshot. * **EngineVersion** *(string) --* Specifies the version of the database engine. * **LicenseModel** *(string) --* License model information for the restored DB instance. * **SnapshotType** *(string) --* Provides the type of the DB snapshot. * **Iops** *(integer) --* Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot. * **OptionGroupName** *(string) --* Provides the option group name for the DB snapshot. * **PercentProgress** *(integer) --* The percentage of the estimated data that has been transferred. * **SourceRegion** *(string) --* The Amazon Web Services Region that the DB snapshot was created in or copied from. * **SourceDBSnapshotIdentifier** *(string) --* The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has a value in the case of a cross-account or cross-Region copy. * **StorageType** *(string) --* Specifies the storage type associated with DB snapshot. * **TdeCredentialArn** *(string) --* The ARN from the key store with which to associate the instance for TDE encryption. * **Encrypted** *(boolean) --* Indicates whether the DB snapshot is encrypted. * **KmsKeyId** *(string) --* If "Encrypted" is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. * **DBSnapshotArn** *(string) --* The Amazon Resource Name (ARN) for the DB snapshot. * **Timezone** *(string) --* The time zone of the DB snapshot. In most cases, the "Timezone" element is empty. "Timezone" content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified. * **IAMDatabaseAuthenticationEnabled** *(boolean) --* Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled. * **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: * "CreateDBInstance" * "ModifyDBInstance" * "RestoreDBInstanceFromDBSnapshot" * "RestoreDBInstanceFromS3" * "RestoreDBInstanceToPointInTime" 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: * "DescribeDBInstances" * "DescribeDBSnapshots" * "DescribeValidDBInstanceModifications" If you call "DescribeDBInstances", "ProcessorFeature" returns non-null values only if the following conditions are met: * You are accessing an Oracle DB instance. * Your Oracle DB instance class supports configuring the number of CPU cores and threads per core. * The current number CPU cores and threads is set to a non-default value. For more information, see Configuring the processor for a DB instance class in RDS for Oracle 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. * **DbiResourceId** *(string) --* The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region. * **TagList** *(list) --* A list of tags. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **Key** *(string) --* A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **Value** *(string) --* A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **OriginalSnapshotCreateTime** *(datetime) --* Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied. * **SnapshotDatabaseTime** *(datetime) --* The timestamp of the most recent transaction applied to the database that you're backing up. Thus, if you restore a snapshot, SnapshotDatabaseTime is the most recent transaction in the restored DB instance. In contrast, originalSnapshotCreateTime specifies the system time that the snapshot completed. If you back up a read replica, you can determine the replica lag by comparing SnapshotDatabaseTime with originalSnapshotCreateTime. For example, if originalSnapshotCreateTime is two hours later than SnapshotDatabaseTime, then the replica lag is two hours. * **SnapshotTarget** *(string) --* Specifies where manual snapshots are stored: Dedicated Local Zones, Amazon Web Services Outposts or the Amazon Web Services Region. * **StorageThroughput** *(integer) --* Specifies the storage throughput for the DB snapshot. * **DBSystemId** *(string) --* The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. The Oracle SID is also the name of your CDB. * **DedicatedLogVolume** *(boolean) --* Indicates whether the DB instance has a dedicated log volume (DLV) enabled. * **MultiTenant** *(boolean) --* Indicates whether the snapshot is of a DB instance using the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE). * **SnapshotAvailabilityZone** *(string) --* Specifies the name of the Availability Zone where RDS stores the DB snapshot. This value is valid only for snapshots that RDS stores on a Dedicated Local Zone. **Exceptions** * "RDS.Client.exceptions.InvalidDBSnapshotStateFault" * "RDS.Client.exceptions.DBSnapshotNotFoundFault" **Examples** This example deletes the specified DB snapshot. response = client.delete_db_snapshot( DBSnapshotIdentifier='mydbsnapshot', ) print(response) Expected Output: { 'DBSnapshot': { }, 'ResponseMetadata': { '...': '...', }, } RDS / Client / remove_role_from_db_cluster remove_role_from_db_cluster *************************** RDS.Client.remove_role_from_db_cluster(**kwargs) Removes the asssociation of an Amazon Web Services Identity and Access Management (IAM) role from a DB cluster. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the *Amazon Aurora User Guide*. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the *Amazon RDS User Guide.* See also: AWS API Documentation **Request Syntax** response = client.remove_role_from_db_cluster( DBClusterIdentifier='string', RoleArn='string', FeatureName='string' ) Parameters: * **DBClusterIdentifier** (*string*) -- **[REQUIRED]** The name of the DB cluster to disassociate the IAM role from. * **RoleArn** (*string*) -- **[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". * **FeatureName** (*string*) -- The name of the feature for the DB cluster that the IAM role is to be disassociated from. For information about supported feature names, see DBEngineVersion. Returns: None **Exceptions** * "RDS.Client.exceptions.DBClusterNotFoundFault" * "RDS.Client.exceptions.DBClusterRoleNotFoundFault" * "RDS.Client.exceptions.InvalidDBClusterStateFault" RDS / Client / remove_tags_from_resource remove_tags_from_resource ************************* RDS.Client.remove_tags_from_resource(**kwargs) 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* or Tagging Amazon Aurora and Amazon RDS Resources in the *Amazon Aurora User Guide*. See also: AWS API Documentation **Request Syntax** response = client.remove_tags_from_resource( ResourceName='string', TagKeys=[ 'string', ] ) Parameters: * **ResourceName** (*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.* * **TagKeys** (*list*) -- **[REQUIRED]** The tag key (name) of the tag to be removed. * *(string) --* Returns: None **Exceptions** * "RDS.Client.exceptions.DBInstanceNotFoundFault" * "RDS.Client.exceptions.DBSnapshotNotFoundFault" * "RDS.Client.exceptions.DBClusterNotFoundFault" * "RDS.Client.exceptions.DBProxyNotFoundFault" * "RDS.Client.exceptions.DBProxyTargetGroupNotFoundFault" * "RDS.Client.exceptions.BlueGreenDeploymentNotFoundFault" * "RDS.Client.exceptions.IntegrationNotFoundFault" * "RDS.Client.exceptions.TenantDatabaseNotFoundFault" * "RDS.Client.exceptions.DBSnapshotTenantDatabaseNotFoundFault" **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': { '...': '...', }, } RDS / Client / create_db_snapshot create_db_snapshot ****************** RDS.Client.create_db_snapshot(**kwargs) Creates a snapshot of a DB instance. The source DB instance must be in the "available" or "storage-optimization" state. See also: AWS API Documentation **Request Syntax** response = client.create_db_snapshot( DBSnapshotIdentifier='string', DBInstanceIdentifier='string', Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **DBSnapshotIdentifier** (*string*) -- **[REQUIRED]** The identifier for the DB snapshot. Constraints: * Can't be null, empty, or blank * Must contain from 1 to 255 letters, numbers, or hyphens * First character must be a letter * Can't end with a hyphen or contain two consecutive hyphens Example: "my-snapshot-id" * **DBInstanceIdentifier** (*string*) -- **[REQUIRED]** The identifier of the DB instance that you want to create the snapshot of. Constraints: * Must match the identifier of an existing DBInstance. * **Tags** (*list*) -- A list of tags. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **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}_.:/=+\-@]*)$"). Return type: dict Returns: **Response Syntax** { 'DBSnapshot': { 'DBSnapshotIdentifier': 'string', 'DBInstanceIdentifier': 'string', 'SnapshotCreateTime': datetime(2015, 1, 1), 'Engine': 'string', 'AllocatedStorage': 123, 'Status': 'string', 'Port': 123, 'AvailabilityZone': 'string', 'VpcId': 'string', 'InstanceCreateTime': datetime(2015, 1, 1), 'MasterUsername': 'string', 'EngineVersion': 'string', 'LicenseModel': 'string', 'SnapshotType': 'string', 'Iops': 123, 'OptionGroupName': 'string', 'PercentProgress': 123, 'SourceRegion': 'string', 'SourceDBSnapshotIdentifier': 'string', 'StorageType': 'string', 'TdeCredentialArn': 'string', 'Encrypted': True|False, 'KmsKeyId': 'string', 'DBSnapshotArn': 'string', 'Timezone': 'string', 'IAMDatabaseAuthenticationEnabled': True|False, 'ProcessorFeatures': [ { 'Name': 'string', 'Value': 'string' }, ], 'DbiResourceId': 'string', 'TagList': [ { 'Key': 'string', 'Value': 'string' }, ], 'OriginalSnapshotCreateTime': datetime(2015, 1, 1), 'SnapshotDatabaseTime': datetime(2015, 1, 1), 'SnapshotTarget': 'string', 'StorageThroughput': 123, 'DBSystemId': 'string', 'DedicatedLogVolume': True|False, 'MultiTenant': True|False, 'SnapshotAvailabilityZone': 'string' } } **Response Structure** * *(dict) --* * **DBSnapshot** *(dict) --* Contains the details of an Amazon RDS DB snapshot. This data type is used as a response element in the "DescribeDBSnapshots" action. * **DBSnapshotIdentifier** *(string) --* Specifies the identifier for the DB snapshot. * **DBInstanceIdentifier** *(string) --* Specifies the DB instance identifier of the DB instance this DB snapshot was created from. * **SnapshotCreateTime** *(datetime) --* Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied. * **Engine** *(string) --* Specifies the name of the database engine. * **AllocatedStorage** *(integer) --* Specifies the allocated storage size in gibibytes (GiB). * **Status** *(string) --* Specifies the status of this DB snapshot. * **Port** *(integer) --* Specifies the port that the database engine was listening on at the time of the snapshot. * **AvailabilityZone** *(string) --* Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot. * **VpcId** *(string) --* Provides the VPC ID associated with the DB snapshot. * **InstanceCreateTime** *(datetime) --* Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created. * **MasterUsername** *(string) --* Provides the master username for the DB snapshot. * **EngineVersion** *(string) --* Specifies the version of the database engine. * **LicenseModel** *(string) --* License model information for the restored DB instance. * **SnapshotType** *(string) --* Provides the type of the DB snapshot. * **Iops** *(integer) --* Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot. * **OptionGroupName** *(string) --* Provides the option group name for the DB snapshot. * **PercentProgress** *(integer) --* The percentage of the estimated data that has been transferred. * **SourceRegion** *(string) --* The Amazon Web Services Region that the DB snapshot was created in or copied from. * **SourceDBSnapshotIdentifier** *(string) --* The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has a value in the case of a cross-account or cross-Region copy. * **StorageType** *(string) --* Specifies the storage type associated with DB snapshot. * **TdeCredentialArn** *(string) --* The ARN from the key store with which to associate the instance for TDE encryption. * **Encrypted** *(boolean) --* Indicates whether the DB snapshot is encrypted. * **KmsKeyId** *(string) --* If "Encrypted" is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. * **DBSnapshotArn** *(string) --* The Amazon Resource Name (ARN) for the DB snapshot. * **Timezone** *(string) --* The time zone of the DB snapshot. In most cases, the "Timezone" element is empty. "Timezone" content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified. * **IAMDatabaseAuthenticationEnabled** *(boolean) --* Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled. * **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: * "CreateDBInstance" * "ModifyDBInstance" * "RestoreDBInstanceFromDBSnapshot" * "RestoreDBInstanceFromS3" * "RestoreDBInstanceToPointInTime" 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: * "DescribeDBInstances" * "DescribeDBSnapshots" * "DescribeValidDBInstanceModifications" If you call "DescribeDBInstances", "ProcessorFeature" returns non-null values only if the following conditions are met: * You are accessing an Oracle DB instance. * Your Oracle DB instance class supports configuring the number of CPU cores and threads per core. * The current number CPU cores and threads is set to a non-default value. For more information, see Configuring the processor for a DB instance class in RDS for Oracle 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. * **DbiResourceId** *(string) --* The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region. * **TagList** *(list) --* A list of tags. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **Key** *(string) --* A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **Value** *(string) --* A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **OriginalSnapshotCreateTime** *(datetime) --* Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied. * **SnapshotDatabaseTime** *(datetime) --* The timestamp of the most recent transaction applied to the database that you're backing up. Thus, if you restore a snapshot, SnapshotDatabaseTime is the most recent transaction in the restored DB instance. In contrast, originalSnapshotCreateTime specifies the system time that the snapshot completed. If you back up a read replica, you can determine the replica lag by comparing SnapshotDatabaseTime with originalSnapshotCreateTime. For example, if originalSnapshotCreateTime is two hours later than SnapshotDatabaseTime, then the replica lag is two hours. * **SnapshotTarget** *(string) --* Specifies where manual snapshots are stored: Dedicated Local Zones, Amazon Web Services Outposts or the Amazon Web Services Region. * **StorageThroughput** *(integer) --* Specifies the storage throughput for the DB snapshot. * **DBSystemId** *(string) --* The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. The Oracle SID is also the name of your CDB. * **DedicatedLogVolume** *(boolean) --* Indicates whether the DB instance has a dedicated log volume (DLV) enabled. * **MultiTenant** *(boolean) --* Indicates whether the snapshot is of a DB instance using the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE). * **SnapshotAvailabilityZone** *(string) --* Specifies the name of the Availability Zone where RDS stores the DB snapshot. This value is valid only for snapshots that RDS stores on a Dedicated Local Zone. **Exceptions** * "RDS.Client.exceptions.DBSnapshotAlreadyExistsFault" * "RDS.Client.exceptions.InvalidDBInstanceStateFault" * "RDS.Client.exceptions.DBInstanceNotFoundFault" * "RDS.Client.exceptions.SnapshotQuotaExceededFault" **Examples** This example creates a DB snapshot. response = client.create_db_snapshot( DBInstanceIdentifier='mymysqlinstance', DBSnapshotIdentifier='mydbsnapshot', ) print(response) Expected Output: { 'DBSnapshot': { }, 'ResponseMetadata': { '...': '...', }, } RDS / Client / restore_db_cluster_to_point_in_time restore_db_cluster_to_point_in_time *********************************** RDS.Client.restore_db_cluster_to_point_in_time(**kwargs) Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before "LatestRestorableTime" for up to "BackupRetentionPeriod" days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group. Unless the "RestoreType" is set to "copy-on-write", the restore may occur in a different Availability Zone (AZ) from the original DB cluster. The AZ where RDS restores the DB cluster depends on the AZs in the specified subnet group. Note: For Aurora, this operation only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the "CreateDBInstance" operation 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" operation has completed and the DB cluster is available. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the *Amazon Aurora User Guide*. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the *Amazon RDS User Guide.* See also: AWS API Documentation **Request Syntax** response = client.restore_db_cluster_to_point_in_time( DBClusterIdentifier='string', RestoreType='string', SourceDBClusterIdentifier='string', RestoreToTime=datetime(2015, 1, 1), UseLatestRestorableTime=True|False, Port=123, DBSubnetGroupName='string', OptionGroupName='string', VpcSecurityGroupIds=[ 'string', ], Tags=[ { 'Key': 'string', 'Value': 'string' }, ], KmsKeyId='string', EnableIAMDatabaseAuthentication=True|False, BacktrackWindow=123, EnableCloudwatchLogsExports=[ 'string', ], DBClusterParameterGroupName='string', DeletionProtection=True|False, CopyTagsToSnapshot=True|False, Domain='string', DomainIAMRoleName='string', ScalingConfiguration={ 'MinCapacity': 123, 'MaxCapacity': 123, 'AutoPause': True|False, 'SecondsUntilAutoPause': 123, 'TimeoutAction': 'string', 'SecondsBeforeTimeout': 123 }, EngineMode='string', DBClusterInstanceClass='string', StorageType='string', PubliclyAccessible=True|False, Iops=123, ServerlessV2ScalingConfiguration={ 'MinCapacity': 123.0, 'MaxCapacity': 123.0, 'SecondsUntilAutoPause': 123 }, NetworkType='string', SourceDbClusterResourceId='string', RdsCustomClusterConfiguration={ 'InterconnectSubnetId': 'string', 'TransitGatewayMulticastDomainId': 'string', 'ReplicaMode': 'open-read-only'|'mounted' }, MonitoringInterval=123, MonitoringRoleArn='string', EnablePerformanceInsights=True|False, PerformanceInsightsKMSKeyId='string', PerformanceInsightsRetentionPeriod=123, EngineLifecycleSupport='string' ) Parameters: * **DBClusterIdentifier** (*string*) -- **[REQUIRED]** The name of the new DB cluster to be created. Constraints: * Must contain from 1 to 63 letters, numbers, or hyphens * First character must be a letter * Can't end with a hyphen or contain two consecutive hyphens Valid for: Aurora DB clusters and Multi-AZ DB clusters * **RestoreType** (*string*) -- The type of restore to be performed. You can specify one of the following values: * "full-copy" - The new DB cluster is restored as a full copy of the source DB cluster. * "copy-on-write" - The new DB cluster is restored as a clone of the source DB cluster. If you don't specify a "RestoreType" value, then the new DB cluster is restored as a full copy of the source DB cluster. Valid for: Aurora DB clusters and Multi-AZ DB clusters * **SourceDBClusterIdentifier** (*string*) -- The identifier of the source DB cluster from which to restore. Constraints: * Must match the identifier of an existing DBCluster. Valid for: Aurora DB clusters and Multi-AZ DB clusters * **RestoreToTime** (*datetime*) -- The date and time to restore the DB cluster to. Valid Values: Value must be a time in Universal Coordinated Time (UTC) format Constraints: * Must be before the latest restorable time for the DB instance * Must be specified if "UseLatestRestorableTime" parameter isn't provided * Can't be specified if the "UseLatestRestorableTime" parameter is enabled * Can't be specified if the "RestoreType" parameter is "copy- on-write" Example: "2015-03-07T23:45:00Z" Valid for: Aurora DB clusters and Multi-AZ DB clusters * **UseLatestRestorableTime** (*boolean*) -- Specifies whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster isn't restored to the latest restorable backup time. Constraints: Can't be specified if "RestoreToTime" parameter is provided. Valid for: Aurora DB clusters and Multi-AZ DB clusters * **Port** (*integer*) -- The port number on which the new DB cluster accepts connections. Constraints: A value from "1150-65535". Default: The default port for the engine. Valid for: Aurora DB clusters and Multi-AZ DB clusters * **DBSubnetGroupName** (*string*) -- The DB subnet group name to use for the new DB cluster. Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example: "mydbsubnetgroup" Valid for: Aurora DB clusters and Multi-AZ DB clusters * **OptionGroupName** (*string*) -- The name of the option group for the new DB cluster. DB clusters are associated with a default option group that can't be modified. * **VpcSecurityGroupIds** (*list*) -- A list of VPC security groups that the new DB cluster belongs to. Valid for: Aurora DB clusters and Multi-AZ DB clusters * *(string) --* * **Tags** (*list*) -- A list of tags. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **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}_.:/=+\-@]*)$"). * **KmsKeyId** (*string*) -- The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN. You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different from the KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key identified by the "KmsKeyId" parameter. If you don't specify a value for the "KmsKeyId" parameter, then the following occurs: * If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster. * If the DB cluster isn't encrypted, then the restored DB cluster isn't encrypted. If "DBClusterIdentifier" refers to a DB cluster that isn't encrypted, then the restore request is rejected. Valid for: Aurora DB clusters and Multi-AZ DB clusters * **EnableIAMDatabaseAuthentication** (*boolean*) -- Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled. For more information, see IAM Database Authentication in the *Amazon Aurora User Guide* or IAM database authentication for MariaDB, MySQL, and PostgreSQL in the *Amazon RDS User Guide*. Valid for: Aurora DB clusters and Multi-AZ DB clusters * **BacktrackWindow** (*integer*) -- The target backtrack window, in seconds. To disable backtracking, set this value to 0. Default: 0 Constraints: * If specified, this value must be set to a number from 0 to 259,200 (72 hours). Valid for: Aurora MySQL DB clusters only * **EnableCloudwatchLogsExports** (*list*) -- The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. **RDS for MySQL** Possible values are "error", "general", "slowquery", and "iam- db-auth-error". **RDS for PostgreSQL** Possible values are "postgresql", "upgrade", and "iam-db-auth- error". **Aurora MySQL** Possible values are "audit", "error", "general", "instance", "slowquery", and "iam-db-auth-error". **Aurora PostgreSQL** Possible value are "instance", "postgresql", and "iam-db-auth- error". For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the *Amazon RDS User Guide*. For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the *Amazon Aurora User Guide*. Valid for: Aurora DB clusters and Multi-AZ DB clusters * *(string) --* * **DBClusterParameterGroupName** (*string*) -- The name of the custom DB cluster parameter group to associate with this DB cluster. If the "DBClusterParameterGroupName" parameter is omitted, the default DB cluster parameter group for the specified engine is used. Constraints: * If supplied, must match the name of an existing DB cluster parameter group. * Must be 1 to 255 letters, numbers, or hyphens. * First character must be a letter. * Can't end with a hyphen or contain two consecutive hyphens. Valid for: Aurora DB clusters and Multi-AZ DB clusters * **DeletionProtection** (*boolean*) -- Specifies whether to enable deletion protection for the DB cluster. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. Valid for: Aurora DB clusters and Multi-AZ DB clusters * **CopyTagsToSnapshot** (*boolean*) -- Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them. Valid for: Aurora DB clusters and Multi-AZ DB clusters * **Domain** (*string*) -- The Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation. For Amazon Aurora DB clusters, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB cluster. For more information, see Kerberos Authentication in the *Amazon Aurora User Guide*. Valid for: Aurora DB clusters only * **DomainIAMRoleName** (*string*) -- The name of the IAM role to be used when making API calls to the Directory Service. Valid for: Aurora DB clusters only * **ScalingConfiguration** (*dict*) -- For DB clusters in "serverless" DB engine mode, the scaling properties of the DB cluster. Valid for: Aurora DB clusters only * **MinCapacity** *(integer) --* 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. * **MaxCapacity** *(integer) --* 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. * **AutoPause** *(boolean) --* 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. * **SecondsUntilAutoPause** *(integer) --* The time, in seconds, before an Aurora DB cluster in "serverless" mode is paused. Specify a value between 300 and 86,400 seconds. * **TimeoutAction** *(string) --* 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 v1 from finding a scaling point might be dropped. For more information, see Autoscaling for Aurora Serverless v1 in the *Amazon Aurora User Guide*. * **SecondsBeforeTimeout** *(integer) --* The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300. Specify a value between 60 and 600 seconds. * **EngineMode** (*string*) -- The engine mode of the new cluster. Specify "provisioned" or "serverless", depending on the type of the cluster you are creating. You can create an Aurora Serverless v1 clone from a provisioned cluster, or a provisioned clone from an Aurora Serverless v1 cluster. To create a clone that is an Aurora Serverless v1 cluster, the original cluster must be an Aurora Serverless v1 cluster or an encrypted provisioned cluster. To create a full copy that is an Aurora Serverless v1 cluster, specify the engine mode "serverless". Valid for: Aurora DB clusters only * **DBClusterInstanceClass** (*string*) -- The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB instance class in the *Amazon RDS User Guide*. Valid for: Multi-AZ DB clusters only * **StorageType** (*string*) -- Specifies the storage type to be associated with the DB cluster. When specified for a Multi-AZ DB cluster, a value for the "Iops" parameter is required. Valid Values: "aurora", "aurora-iopt1" (Aurora DB clusters); "io1" (Multi-AZ DB clusters) Default: "aurora" (Aurora DB clusters); "io1" (Multi-AZ DB clusters) Valid for: Aurora DB clusters and Multi-AZ DB clusters * **PubliclyAccessible** (*boolean*) -- Specifies whether the DB cluster is publicly accessible. When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB cluster doesn't permit it. When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address. Default: The default behavior varies depending on whether "DBSubnetGroupName" is specified. If "DBSubnetGroupName" isn't specified, and "PubliclyAccessible" isn't specified, the following applies: * If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private. * If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public. If "DBSubnetGroupName" is specified, and "PubliclyAccessible" isn't specified, the following applies: * If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private. * If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public. Valid for: Multi-AZ DB clusters only * **Iops** (*integer*) -- The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster. For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the *Amazon RDS User Guide*. Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance. Valid for: Multi-AZ DB clusters only * **ServerlessV2ScalingConfiguration** (*dict*) -- Contains the scaling configuration of an Aurora Serverless v2 DB cluster. For more information, see Using Amazon Aurora Serverless v2 in the *Amazon Aurora User Guide*. * **MinCapacity** *(float) --* The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. For Aurora versions that support the Aurora Serverless v2 auto-pause feature, the smallest value that you can use is 0. For versions that don't support Aurora Serverless v2 auto-pause, the smallest value that you can use is 0.5. * **MaxCapacity** *(float) --* The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 32, 32.5, 33, and so on. The largest value that you can use is 256 for recent Aurora versions, or 128 for older versions. You can check the attributes of your engine version or platform version to determine the specific maximum capacity supported. * **SecondsUntilAutoPause** *(integer) --* Specifies the number of seconds an Aurora Serverless v2 DB instance must be idle before Aurora attempts to automatically pause it. Specify a value between 300 seconds (five minutes) and 86,400 seconds (one day). The default is 300 seconds. * **NetworkType** (*string*) -- The network type of the DB cluster. Valid Values: * "IPV4" * "DUAL" The network type is determined by the "DBSubnetGroup" specified for the DB cluster. A "DBSubnetGroup" can support only the IPv4 protocol or the IPv4 and the IPv6 protocols ( "DUAL"). For more information, see Working with a DB instance in a VPC in the *Amazon Aurora User Guide.* Valid for: Aurora DB clusters only * **SourceDbClusterResourceId** (*string*) -- The resource ID of the source DB cluster from which to restore. * **RdsCustomClusterConfiguration** (*dict*) -- Reserved for future use. * **InterconnectSubnetId** *(string) --* Reserved for future use. * **TransitGatewayMulticastDomainId** *(string) --* Reserved for future use. * **ReplicaMode** *(string) --* Reserved for future use. * **MonitoringInterval** (*integer*) -- The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify "0". If "MonitoringRoleArn" is specified, also set "MonitoringInterval" to a value other than "0". Valid Values: "0 | 1 | 5 | 10 | 15 | 30 | 60" Default: "0" * **MonitoringRoleArn** (*string*) -- The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is "arn:aws:iam:123456789012:role/emaccess". If "MonitoringInterval" is set to a value other than "0", supply a "MonitoringRoleArn" value. * **EnablePerformanceInsights** (*boolean*) -- Specifies whether to turn on Performance Insights for the DB cluster. * **PerformanceInsightsKMSKeyId** (*string*) -- The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you don't specify a value for "PerformanceInsightsKMSKeyId", then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region. * **PerformanceInsightsRetentionPeriod** (*integer*) -- The number of days to retain Performance Insights data. Valid Values: * "7" * *month* * 31, where *month* is a number of months from 1-23. Examples: "93" (3 months * 31), "341" (11 months * 31), "589" (19 months * 31) * "731" Default: "7" days If you specify a retention period that isn't valid, such as "94", Amazon RDS issues an error. * **EngineLifecycleSupport** (*string*) -- The life cycle type for this DB cluster. Note: By default, this value is set to "open-source-rds-extended- support", which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to "open-source-rds-extended-support-disabled". In this case, RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date. You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections: * Amazon Aurora - Amazon RDS Extended Support with Amazon Aurora in the *Amazon Aurora User Guide* * Amazon RDS - Amazon RDS Extended Support with Amazon RDS in the *Amazon RDS User Guide* Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Valid Values: "open-source-rds-extended-support | open-source- rds-extended-support-disabled" Default: "open-source-rds-extended-support" Return type: dict Returns: **Response Syntax** { 'DBCluster': { 'AllocatedStorage': 123, 'AvailabilityZones': [ 'string', ], 'BackupRetentionPeriod': 123, 'CharacterSetName': 'string', 'DatabaseName': 'string', 'DBClusterIdentifier': 'string', 'DBClusterParameterGroup': 'string', 'DBSubnetGroup': 'string', 'Status': 'string', 'AutomaticRestartTime': datetime(2015, 1, 1), 'PercentProgress': 'string', 'EarliestRestorableTime': datetime(2015, 1, 1), 'Endpoint': 'string', 'ReaderEndpoint': 'string', 'CustomEndpoints': [ 'string', ], 'MultiAZ': True|False, 'Engine': 'string', 'EngineVersion': 'string', 'LatestRestorableTime': datetime(2015, 1, 1), 'Port': 123, 'MasterUsername': 'string', 'DBClusterOptionGroupMemberships': [ { 'DBClusterOptionGroupName': 'string', 'Status': 'string' }, ], 'PreferredBackupWindow': 'string', 'PreferredMaintenanceWindow': 'string', 'ReplicationSourceIdentifier': 'string', 'ReadReplicaIdentifiers': [ 'string', ], 'StatusInfos': [ { 'StatusType': 'string', 'Normal': True|False, 'Status': 'string', 'Message': 'string' }, ], 'DBClusterMembers': [ { 'DBInstanceIdentifier': 'string', 'IsClusterWriter': True|False, 'DBClusterParameterGroupStatus': 'string', 'PromotionTier': 123 }, ], 'VpcSecurityGroups': [ { 'VpcSecurityGroupId': 'string', 'Status': 'string' }, ], 'HostedZoneId': 'string', 'StorageEncrypted': True|False, 'KmsKeyId': 'string', 'DbClusterResourceId': 'string', 'DBClusterArn': 'string', 'AssociatedRoles': [ { 'RoleArn': 'string', 'Status': 'string', 'FeatureName': 'string' }, ], 'IAMDatabaseAuthenticationEnabled': True|False, 'CloneGroupId': 'string', 'ClusterCreateTime': datetime(2015, 1, 1), 'EarliestBacktrackTime': datetime(2015, 1, 1), 'BacktrackWindow': 123, 'BacktrackConsumedChangeRecords': 123, 'EnabledCloudwatchLogsExports': [ 'string', ], 'Capacity': 123, 'EngineMode': 'string', 'ScalingConfigurationInfo': { 'MinCapacity': 123, 'MaxCapacity': 123, 'AutoPause': True|False, 'SecondsUntilAutoPause': 123, 'TimeoutAction': 'string', 'SecondsBeforeTimeout': 123 }, 'RdsCustomClusterConfiguration': { 'InterconnectSubnetId': 'string', 'TransitGatewayMulticastDomainId': 'string', 'ReplicaMode': 'open-read-only'|'mounted' }, 'DeletionProtection': True|False, 'HttpEndpointEnabled': True|False, 'ActivityStreamMode': 'sync'|'async', 'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping', 'ActivityStreamKmsKeyId': 'string', 'ActivityStreamKinesisStreamName': 'string', 'CopyTagsToSnapshot': True|False, 'CrossAccountClone': True|False, 'DomainMemberships': [ { 'Domain': 'string', 'Status': 'string', 'FQDN': 'string', 'IAMRoleName': 'string', 'OU': 'string', 'AuthSecretArn': 'string', 'DnsIps': [ 'string', ] }, ], 'TagList': [ { 'Key': 'string', 'Value': 'string' }, ], 'GlobalClusterIdentifier': 'string', 'GlobalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'unknown', 'GlobalWriteForwardingRequested': True|False, 'PendingModifiedValues': { 'PendingCloudwatchLogsExports': { 'LogTypesToEnable': [ 'string', ], 'LogTypesToDisable': [ 'string', ] }, 'DBClusterIdentifier': 'string', 'MasterUserPassword': 'string', 'IAMDatabaseAuthenticationEnabled': True|False, 'EngineVersion': 'string', 'BackupRetentionPeriod': 123, 'AllocatedStorage': 123, 'RdsCustomClusterConfiguration': { 'InterconnectSubnetId': 'string', 'TransitGatewayMulticastDomainId': 'string', 'ReplicaMode': 'open-read-only'|'mounted' }, 'Iops': 123, 'StorageType': 'string', 'CertificateDetails': { 'CAIdentifier': 'string', 'ValidTill': datetime(2015, 1, 1) } }, 'DBClusterInstanceClass': 'string', 'StorageType': 'string', 'Iops': 123, 'PubliclyAccessible': True|False, 'AutoMinorVersionUpgrade': True|False, 'MonitoringInterval': 123, 'MonitoringRoleArn': 'string', 'DatabaseInsightsMode': 'standard'|'advanced', 'PerformanceInsightsEnabled': True|False, 'PerformanceInsightsKMSKeyId': 'string', 'PerformanceInsightsRetentionPeriod': 123, 'ServerlessV2ScalingConfiguration': { 'MinCapacity': 123.0, 'MaxCapacity': 123.0, 'SecondsUntilAutoPause': 123 }, 'ServerlessV2PlatformVersion': 'string', 'NetworkType': 'string', 'DBSystemId': 'string', 'MasterUserSecret': { 'SecretArn': 'string', 'SecretStatus': 'string', 'KmsKeyId': 'string' }, 'IOOptimizedNextAllowedModificationTime': datetime(2015, 1, 1), 'LocalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'requested', 'AwsBackupRecoveryPointArn': 'string', 'LimitlessDatabase': { 'Status': 'active'|'not-in-use'|'enabled'|'disabled'|'enabling'|'disabling'|'modifying-max-capacity'|'error', 'MinRequiredACU': 123.0 }, 'StorageThroughput': 123, 'ClusterScalabilityType': 'standard'|'limitless', 'CertificateDetails': { 'CAIdentifier': 'string', 'ValidTill': datetime(2015, 1, 1) }, 'EngineLifecycleSupport': 'string' } } **Response Structure** * *(dict) --* * **DBCluster** *(dict) --* Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster. For an Amazon Aurora DB cluster, this data type is used as a response element in the operations "CreateDBCluster", "DeleteDBCluster", "DescribeDBClusters", "FailoverDBCluster", "ModifyDBCluster", "PromoteReadReplicaDBCluster", "RestoreDBClusterFromS3", "RestoreDBClusterFromSnapshot", "RestoreDBClusterToPointInTime", "StartDBCluster", and "StopDBCluster". For a Multi-AZ DB cluster, this data type is used as a response element in the operations "CreateDBCluster", "DeleteDBCluster", "DescribeDBClusters", "FailoverDBCluster", "ModifyDBCluster", "RebootDBCluster", "RestoreDBClusterFromSnapshot", and "RestoreDBClusterToPointInTime". For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the *Amazon Aurora User Guide.* For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the *Amazon RDS User Guide.* * **AllocatedStorage** *(integer) --* "AllocatedStorage" specifies the allocated storage size in gibibytes (GiB). For Aurora, "AllocatedStorage" can vary because Aurora DB cluster storage size adjusts as needed. * **AvailabilityZones** *(list) --* The list of Availability Zones (AZs) where instances in the DB cluster can be created. * *(string) --* * **BackupRetentionPeriod** *(integer) --* 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) --* The name of the initial database that was specified for the DB cluster when it was created, if one was provided. This same name is returned for the life of the DB cluster. * **DBClusterIdentifier** *(string) --* The user-supplied identifier for the DB cluster. This identifier is the unique key that identifies a DB cluster. * **DBClusterParameterGroup** *(string) --* The name of the DB cluster parameter group for the DB cluster. * **DBSubnetGroup** *(string) --* Information about the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group. * **Status** *(string) --* The current state of this DB cluster. * **AutomaticRestartTime** *(datetime) --* The time when a stopped DB cluster is restarted automatically. * **PercentProgress** *(string) --* 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) --* 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) --* The custom endpoints associated with the DB cluster. * *(string) --* * **MultiAZ** *(boolean) --* Indicates whether the DB cluster has instances in multiple Availability Zones. * **Engine** *(string) --* The database engine used for this DB cluster. * **EngineVersion** *(string) --* The version of the database engine. * **LatestRestorableTime** *(datetime) --* The latest time to which a database can be restored with point-in-time restore. * **Port** *(integer) --* The port that the database engine is listening on. * **MasterUsername** *(string) --* The master username for the DB cluster. * **DBClusterOptionGroupMemberships** *(list) --* 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) --* The daily time range during which automated backups are created if automated backups are enabled, as determined by the "BackupRetentionPeriod". * **PreferredMaintenanceWindow** *(string) --* The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). * **ReplicationSourceIdentifier** *(string) --* The identifier of the source DB cluster if this DB cluster is a read replica. * **ReadReplicaIdentifiers** *(list) --* Contains one or more identifiers of the read replicas associated with this DB cluster. * *(string) --* * **StatusInfos** *(list) --* Reserved for future use. * *(dict) --* Reserved for future use. * **StatusType** *(string) --* Reserved for future use. * **Normal** *(boolean) --* Reserved for future use. * **Status** *(string) --* Reserved for future use. * **Message** *(string) --* Reserved for future use. * **DBClusterMembers** *(list) --* The list of DB 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) --* Indicates whether the cluster member is the primary DB instance for the DB cluster. * **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) --* The list of VPC security groups that the DB cluster belongs to. * *(dict) --* This data type is used as a response element for queries on VPC security group membership. * **VpcSecurityGroupId** *(string) --* The name of the VPC security group. * **Status** *(string) --* The membership status of the VPC security group. Currently, the only valid status is "active". * **HostedZoneId** *(string) --* The ID that Amazon Route 53 assigns when you create a hosted zone. * **StorageEncrypted** *(boolean) --* Indicates whether the DB cluster is encrypted. * **KmsKeyId** *(string) --* If "StorageEncrypted" is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. * **DbClusterResourceId** *(string) --* The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the KMS key for the DB cluster is accessed. * **DBClusterArn** *(string) --* The Amazon Resource Name (ARN) for the DB cluster. * **AssociatedRoles** *(list) --* A list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf. * *(dict) --* Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB cluster. * **RoleArn** *(string) --* The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster. * **Status** *(string) --* Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values: * "ACTIVE" - the IAM role ARN is associated with the DB cluster and can be used to access other Amazon Web Services on your behalf. * "PENDING" - the IAM role ARN is being associated with the DB cluster. * "INVALID" - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other Amazon Web Services on your behalf. * **FeatureName** *(string) --* The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion. * **IAMDatabaseAuthenticationEnabled** *(boolean) --* Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled. * **CloneGroupId** *(string) --* The ID of the clone group with which the DB cluster is associated. For newly created clusters, the ID is typically null. If you clone a DB cluster when the ID is null, the operation populates the ID value for the source cluster and the clone because both clusters become part of the same clone group. Even if you delete the clone cluster, the clone group ID remains for the lifetime of the source cluster to show that it was used in a cloning operation. For PITR, the clone group ID is inherited from the source cluster. For snapshot restore operations, the clone group ID isn't inherited from the source cluster. * **ClusterCreateTime** *(datetime) --* 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.* * *(string) --* * **Capacity** *(integer) --* The current capacity of an Aurora Serverless v1 DB cluster. The capacity is "0" (zero) when the cluster is paused. For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the *Amazon Aurora User Guide*. * **EngineMode** *(string) --* The DB engine mode of the DB cluster, either "provisioned" or "serverless". For more information, see CreateDBCluster. * **ScalingConfigurationInfo** *(dict) --* The scaling configuration for an Aurora DB cluster in "serverless" DB engine mode. For more information, see Using Amazon Aurora Serverless v1 in the *Amazon Aurora User Guide*. * **MinCapacity** *(integer) --* The minimum capacity for an Aurora DB cluster in "serverless" DB engine mode. * **MaxCapacity** *(integer) --* The maximum capacity for an Aurora DB cluster in "serverless" DB engine mode. * **AutoPause** *(boolean) --* Indicates whether automatic pause is allowed for the Aurora DB cluster in "serverless" DB engine mode. When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes. * **SecondsUntilAutoPause** *(integer) --* The remaining amount of time, in seconds, before the Aurora DB cluster in "serverless" mode is paused. A DB cluster can be paused only when it's idle (it has no connections). * **TimeoutAction** *(string) --* The action that occurs when Aurora times out while attempting to change the capacity of an Aurora Serverless v1 cluster. The value is either "ForceApplyCapacityChange" or "RollbackCapacityChange". "ForceApplyCapacityChange", the default, sets the capacity to the specified value as soon as possible. "RollbackCapacityChange" ignores the capacity change if a scaling point isn't found in the timeout period. * **SecondsBeforeTimeout** *(integer) --* The number of seconds before scaling times out. What happens when an attempted scaling action times out is determined by the "TimeoutAction" setting. * **RdsCustomClusterConfiguration** *(dict) --* Reserved for future use. * **InterconnectSubnetId** *(string) --* Reserved for future use. * **TransitGatewayMulticastDomainId** *(string) --* Reserved for future use. * **ReplicaMode** *(string) --* Reserved for future use. * **DeletionProtection** *(boolean) --* Indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. * **HttpEndpointEnabled** *(boolean) --* Indicates whether the HTTP endpoint is enabled for an Aurora DB cluster. When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the DB cluster. You can also query your database from inside the RDS console with the RDS query editor. For more information, see Using RDS Data API in the *Amazon Aurora User Guide*. * **ActivityStreamMode** *(string) --* The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously. * **ActivityStreamStatus** *(string) --* The status of the database activity stream. * **ActivityStreamKmsKeyId** *(string) --* The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. * **ActivityStreamKinesisStreamName** *(string) --* The name of the Amazon Kinesis data stream used for the database activity stream. * **CopyTagsToSnapshot** *(boolean) --* Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster. * **CrossAccountClone** *(boolean) --* Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account. * **DomainMemberships** *(list) --* The Active Directory Domain membership records associated with the DB cluster. * *(dict) --* An Active Directory Domain membership record associated with the DB instance or cluster. * **Domain** *(string) --* The identifier of the Active Directory Domain. * **Status** *(string) --* The status of the Active Directory Domain membership for the DB instance or cluster. Values include "joined", "pending-join", "failed", and so on. * **FQDN** *(string) --* The fully qualified domain name (FQDN) of the Active Directory Domain. * **IAMRoleName** *(string) --* The name of the IAM role used when making API calls to the Directory Service. * **OU** *(string) --* The Active Directory organizational unit for the DB instance or cluster. * **AuthSecretArn** *(string) --* The ARN for the Secrets Manager secret with the credentials for the user that's a member of the domain. * **DnsIps** *(list) --* The IPv4 DNS IP addresses of the primary and secondary Active Directory domain controllers. * *(string) --* * **TagList** *(list) --* A list of tags. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **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}_.:/=+\-@]*)$"). * **GlobalClusterIdentifier** *(string) --* Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster. * **GlobalWriteForwardingStatus** *(string) --* The status of write forwarding for a secondary cluster in an Aurora global database. * **GlobalWriteForwardingRequested** *(boolean) --* Indicates whether write forwarding is enabled for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of "GlobalWriteForwardingStatus" to confirm that the request has completed before using the write forwarding feature for this cluster. * **PendingModifiedValues** *(dict) --* Information about pending changes to the DB cluster. This information is returned only when there are pending changes. Specific changes are identified by subelements. * **PendingCloudwatchLogsExports** *(dict) --* A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated. * **LogTypesToEnable** *(list) --* Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs. * *(string) --* * **LogTypesToDisable** *(list) --* Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs. * *(string) --* * **DBClusterIdentifier** *(string) --* The DBClusterIdentifier value for the DB cluster. * **MasterUserPassword** *(string) --* The master credentials for the DB cluster. * **IAMDatabaseAuthenticationEnabled** *(boolean) --* Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled. * **EngineVersion** *(string) --* The database engine version. * **BackupRetentionPeriod** *(integer) --* The number of days for which automatic DB snapshots are retained. * **AllocatedStorage** *(integer) --* The allocated storage size in gibibytes (GiB) for all database engines except Amazon Aurora. For Aurora, "AllocatedStorage" always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed. * **RdsCustomClusterConfiguration** *(dict) --* Reserved for future use. * **InterconnectSubnetId** *(string) --* Reserved for future use. * **TransitGatewayMulticastDomainId** *(string) --* Reserved for future use. * **ReplicaMode** *(string) --* Reserved for future use. * **Iops** *(integer) --* The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters. * **StorageType** *(string) --* The storage type for the DB cluster. * **CertificateDetails** *(dict) --* The details of the DB instance’s server certificate. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the *Amazon RDS User Guide* and Using SSL/TLS to encrypt a connection to a DB cluster in the *Amazon Aurora User Guide*. * **CAIdentifier** *(string) --* The CA identifier of the CA certificate used for the DB instance's server certificate. * **ValidTill** *(datetime) --* The expiration date of the DB instance’s server certificate. * **DBClusterInstanceClass** *(string) --* The name of the compute and memory capacity class of the DB instance. This setting is only for non-Aurora Multi-AZ DB clusters. * **StorageType** *(string) --* The storage type associated with the DB cluster. * **Iops** *(integer) --* The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters. * **PubliclyAccessible** *(boolean) --* Indicates whether the DB cluster is publicly accessible. When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it. When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address. For more information, see CreateDBCluster. This setting is only for non-Aurora Multi-AZ DB clusters. * **AutoMinorVersionUpgrade** *(boolean) --* Indicates whether minor version patches are applied automatically. This setting is for Aurora DB clusters and Multi-AZ DB clusters. For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version. * **MonitoringInterval** *(integer) --* The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. This setting is only for -Aurora DB clusters and Multi-AZ DB clusters. * **MonitoringRoleArn** *(string) --* The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. This setting is only for Aurora DB clusters and Multi-AZ DB clusters. * **DatabaseInsightsMode** *(string) --* The mode of Database Insights that is enabled for the DB cluster. * **PerformanceInsightsEnabled** *(boolean) --* Indicates whether Performance Insights is enabled for the DB cluster. This setting is only for Aurora DB clusters and Multi-AZ DB clusters. * **PerformanceInsightsKMSKeyId** *(string) --* The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. This setting is only for Aurora DB clusters and Multi-AZ DB clusters. * **PerformanceInsightsRetentionPeriod** *(integer) --* The number of days to retain Performance Insights data. This setting is only for Aurora DB clusters and Multi-AZ DB clusters. Valid Values: * "7" * *month* * 31, where *month* is a number of months from 1-23. Examples: "93" (3 months * 31), "341" (11 months * 31), "589" (19 months * 31) * "731" Default: "7" days * **ServerlessV2ScalingConfiguration** *(dict) --* The scaling configuration for an Aurora Serverless v2 DB cluster. For more information, see Using Amazon Aurora Serverless v2 in the *Amazon Aurora User Guide*. * **MinCapacity** *(float) --* The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. For Aurora versions that support the Aurora Serverless v2 auto-pause feature, the smallest value that you can use is 0. For versions that don't support Aurora Serverless v2 auto-pause, the smallest value that you can use is 0.5. * **MaxCapacity** *(float) --* The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 32, 32.5, 33, and so on. The largest value that you can use is 256 for recent Aurora versions, or 128 for older versions. You can check the attributes of your engine version or platform version to determine the specific maximum capacity supported. * **SecondsUntilAutoPause** *(integer) --* The number of seconds an Aurora Serverless v2 DB instance must be idle before Aurora attempts to automatically pause it. This property is only shown when the minimum capacity for the cluster is set to 0 ACUs. Changing the minimum capacity to a nonzero value removes this property. If you later change the minimum capacity back to 0 ACUs, this property is reset to its default value unless you specify it again. This value ranges between 300 seconds (five minutes) and 86,400 seconds (one day). The default is 300 seconds. * **ServerlessV2PlatformVersion** *(string) --* The version of the Aurora Serverless V2 platform used by the DB cluster. For more information, see Using Aurora Serverless v2 in the *Amazon Aurora User Guide*. * **NetworkType** *(string) --* The network type of the DB instance. The network type is determined by the "DBSubnetGroup" specified for the DB cluster. A "DBSubnetGroup" can support only the IPv4 protocol or the IPv4 and the IPv6 protocols ( "DUAL"). For more information, see Working with a DB instance in a VPC in the *Amazon Aurora User Guide.* This setting is only for Aurora DB clusters. Valid Values: "IPV4 | DUAL" * **DBSystemId** *(string) --* Reserved for future use. * **MasterUserSecret** *(dict) --* The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password. For more information, see Password management with Amazon Web Services Secrets Manager in the *Amazon RDS User Guide* and Password management with Amazon Web Services Secrets Manager in the *Amazon Aurora User Guide.* * **SecretArn** *(string) --* The Amazon Resource Name (ARN) of the secret. * **SecretStatus** *(string) --* The status of the secret. The possible status values include the following: * "creating" - The secret is being created. * "active" - The secret is available for normal use and rotation. * "rotating" - The secret is being rotated. * "impaired" - The secret can be used to access database credentials, but it can't be rotated. A secret might have this status if, for example, permissions are changed so that RDS can no longer access either the secret or the KMS key for the secret. When a secret has this status, you can correct the condition that caused the status. Alternatively, modify the DB instance to turn off automatic management of database credentials, and then modify the DB instance again to turn on automatic management of database credentials. * **KmsKeyId** *(string) --* The Amazon Web Services KMS key identifier that is used to encrypt the secret. * **IOOptimizedNextAllowedModificationTime** *(datetime) --* The next time you can modify the DB cluster to use the "aurora-iopt1" storage type. This setting is only for Aurora DB clusters. * **LocalWriteForwardingStatus** *(string) --* Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it. * **AwsBackupRecoveryPointArn** *(string) --* The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup. * **LimitlessDatabase** *(dict) --* The details for Aurora Limitless Database. * **Status** *(string) --* The status of Aurora Limitless Database. * **MinRequiredACU** *(float) --* The minimum required capacity for Aurora Limitless Database in Aurora capacity units (ACUs). * **StorageThroughput** *(integer) --* The storage throughput for the DB cluster. The throughput is automatically set based on the IOPS that you provision, and is not configurable. This setting is only for non-Aurora Multi-AZ DB clusters. * **ClusterScalabilityType** *(string) --* The scalability mode of the Aurora DB cluster. When set to "limitless", the cluster operates as an Aurora Limitless Database. When set to "standard" (the default), the cluster uses normal DB instance creation. * **CertificateDetails** *(dict) --* The details of the DB instance’s server certificate. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the *Amazon RDS User Guide* and Using SSL/TLS to encrypt a connection to a DB cluster in the *Amazon Aurora User Guide*. * **CAIdentifier** *(string) --* The CA identifier of the CA certificate used for the DB instance's server certificate. * **ValidTill** *(datetime) --* The expiration date of the DB instance’s server certificate. * **EngineLifecycleSupport** *(string) --* The lifecycle type for the DB cluster. For more information, see CreateDBCluster. **Exceptions** * "RDS.Client.exceptions.DBClusterAlreadyExistsFault" * "RDS.Client.exceptions.DBClusterNotFoundFault" * "RDS.Client.exceptions.DBClusterQuotaExceededFault" * "RDS.Client.exceptions.DBClusterSnapshotNotFoundFault" * "RDS.Client.exceptions.DBSubnetGroupNotFoundFault" * "RDS.Client.exceptions.InsufficientDBClusterCapacityFault" * "RDS.Client.exceptions.InsufficientStorageClusterCapacityFault" * "RDS.Client.exceptions.InvalidDBClusterSnapshotStateFault" * "RDS.Client.exceptions.InvalidDBClusterStateFault" * "RDS.Client.exceptions.InvalidDBSnapshotStateFault" * "RDS.Client.exceptions.InvalidRestoreFault" * "RDS.Client.exceptions.InvalidSubnet" * "RDS.Client.exceptions.InvalidVPCNetworkStateFault" * "RDS.Client.exceptions.KMSKeyNotAccessibleFault" * "RDS.Client.exceptions.OptionGroupNotFoundFault" * "RDS.Client.exceptions.StorageQuotaExceededFault" * "RDS.Client.exceptions.DomainNotFoundFault" * "RDS.Client.exceptions.DBClusterParameterGroupNotFoundFault" * "RDS.Client.exceptions.DBClusterAutomatedBackupNotFoundFault" * "RDS.Client.exceptions.InsufficientDBInstanceCapacityFault" **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: { 'DBCluster': { }, 'ResponseMetadata': { '...': '...', }, } RDS / Client / start_db_cluster start_db_cluster **************** RDS.Client.start_db_cluster(**kwargs) Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster CLI command, or the "StopDBCluster" operation. For more information, see Stopping and Starting an Aurora Cluster in the *Amazon Aurora User Guide*. Note: This operation only applies to Aurora DB clusters. See also: AWS API Documentation **Request Syntax** response = client.start_db_cluster( DBClusterIdentifier='string' ) Parameters: **DBClusterIdentifier** (*string*) -- **[REQUIRED]** The DB cluster identifier of the Amazon Aurora DB cluster to be started. This parameter is stored as a lowercase string. Return type: dict Returns: **Response Syntax** { 'DBCluster': { 'AllocatedStorage': 123, 'AvailabilityZones': [ 'string', ], 'BackupRetentionPeriod': 123, 'CharacterSetName': 'string', 'DatabaseName': 'string', 'DBClusterIdentifier': 'string', 'DBClusterParameterGroup': 'string', 'DBSubnetGroup': 'string', 'Status': 'string', 'AutomaticRestartTime': datetime(2015, 1, 1), 'PercentProgress': 'string', 'EarliestRestorableTime': datetime(2015, 1, 1), 'Endpoint': 'string', 'ReaderEndpoint': 'string', 'CustomEndpoints': [ 'string', ], 'MultiAZ': True|False, 'Engine': 'string', 'EngineVersion': 'string', 'LatestRestorableTime': datetime(2015, 1, 1), 'Port': 123, 'MasterUsername': 'string', 'DBClusterOptionGroupMemberships': [ { 'DBClusterOptionGroupName': 'string', 'Status': 'string' }, ], 'PreferredBackupWindow': 'string', 'PreferredMaintenanceWindow': 'string', 'ReplicationSourceIdentifier': 'string', 'ReadReplicaIdentifiers': [ 'string', ], 'StatusInfos': [ { 'StatusType': 'string', 'Normal': True|False, 'Status': 'string', 'Message': 'string' }, ], 'DBClusterMembers': [ { 'DBInstanceIdentifier': 'string', 'IsClusterWriter': True|False, 'DBClusterParameterGroupStatus': 'string', 'PromotionTier': 123 }, ], 'VpcSecurityGroups': [ { 'VpcSecurityGroupId': 'string', 'Status': 'string' }, ], 'HostedZoneId': 'string', 'StorageEncrypted': True|False, 'KmsKeyId': 'string', 'DbClusterResourceId': 'string', 'DBClusterArn': 'string', 'AssociatedRoles': [ { 'RoleArn': 'string', 'Status': 'string', 'FeatureName': 'string' }, ], 'IAMDatabaseAuthenticationEnabled': True|False, 'CloneGroupId': 'string', 'ClusterCreateTime': datetime(2015, 1, 1), 'EarliestBacktrackTime': datetime(2015, 1, 1), 'BacktrackWindow': 123, 'BacktrackConsumedChangeRecords': 123, 'EnabledCloudwatchLogsExports': [ 'string', ], 'Capacity': 123, 'EngineMode': 'string', 'ScalingConfigurationInfo': { 'MinCapacity': 123, 'MaxCapacity': 123, 'AutoPause': True|False, 'SecondsUntilAutoPause': 123, 'TimeoutAction': 'string', 'SecondsBeforeTimeout': 123 }, 'RdsCustomClusterConfiguration': { 'InterconnectSubnetId': 'string', 'TransitGatewayMulticastDomainId': 'string', 'ReplicaMode': 'open-read-only'|'mounted' }, 'DeletionProtection': True|False, 'HttpEndpointEnabled': True|False, 'ActivityStreamMode': 'sync'|'async', 'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping', 'ActivityStreamKmsKeyId': 'string', 'ActivityStreamKinesisStreamName': 'string', 'CopyTagsToSnapshot': True|False, 'CrossAccountClone': True|False, 'DomainMemberships': [ { 'Domain': 'string', 'Status': 'string', 'FQDN': 'string', 'IAMRoleName': 'string', 'OU': 'string', 'AuthSecretArn': 'string', 'DnsIps': [ 'string', ] }, ], 'TagList': [ { 'Key': 'string', 'Value': 'string' }, ], 'GlobalClusterIdentifier': 'string', 'GlobalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'unknown', 'GlobalWriteForwardingRequested': True|False, 'PendingModifiedValues': { 'PendingCloudwatchLogsExports': { 'LogTypesToEnable': [ 'string', ], 'LogTypesToDisable': [ 'string', ] }, 'DBClusterIdentifier': 'string', 'MasterUserPassword': 'string', 'IAMDatabaseAuthenticationEnabled': True|False, 'EngineVersion': 'string', 'BackupRetentionPeriod': 123, 'AllocatedStorage': 123, 'RdsCustomClusterConfiguration': { 'InterconnectSubnetId': 'string', 'TransitGatewayMulticastDomainId': 'string', 'ReplicaMode': 'open-read-only'|'mounted' }, 'Iops': 123, 'StorageType': 'string', 'CertificateDetails': { 'CAIdentifier': 'string', 'ValidTill': datetime(2015, 1, 1) } }, 'DBClusterInstanceClass': 'string', 'StorageType': 'string', 'Iops': 123, 'PubliclyAccessible': True|False, 'AutoMinorVersionUpgrade': True|False, 'MonitoringInterval': 123, 'MonitoringRoleArn': 'string', 'DatabaseInsightsMode': 'standard'|'advanced', 'PerformanceInsightsEnabled': True|False, 'PerformanceInsightsKMSKeyId': 'string', 'PerformanceInsightsRetentionPeriod': 123, 'ServerlessV2ScalingConfiguration': { 'MinCapacity': 123.0, 'MaxCapacity': 123.0, 'SecondsUntilAutoPause': 123 }, 'ServerlessV2PlatformVersion': 'string', 'NetworkType': 'string', 'DBSystemId': 'string', 'MasterUserSecret': { 'SecretArn': 'string', 'SecretStatus': 'string', 'KmsKeyId': 'string' }, 'IOOptimizedNextAllowedModificationTime': datetime(2015, 1, 1), 'LocalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'requested', 'AwsBackupRecoveryPointArn': 'string', 'LimitlessDatabase': { 'Status': 'active'|'not-in-use'|'enabled'|'disabled'|'enabling'|'disabling'|'modifying-max-capacity'|'error', 'MinRequiredACU': 123.0 }, 'StorageThroughput': 123, 'ClusterScalabilityType': 'standard'|'limitless', 'CertificateDetails': { 'CAIdentifier': 'string', 'ValidTill': datetime(2015, 1, 1) }, 'EngineLifecycleSupport': 'string' } } **Response Structure** * *(dict) --* * **DBCluster** *(dict) --* Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster. For an Amazon Aurora DB cluster, this data type is used as a response element in the operations "CreateDBCluster", "DeleteDBCluster", "DescribeDBClusters", "FailoverDBCluster", "ModifyDBCluster", "PromoteReadReplicaDBCluster", "RestoreDBClusterFromS3", "RestoreDBClusterFromSnapshot", "RestoreDBClusterToPointInTime", "StartDBCluster", and "StopDBCluster". For a Multi-AZ DB cluster, this data type is used as a response element in the operations "CreateDBCluster", "DeleteDBCluster", "DescribeDBClusters", "FailoverDBCluster", "ModifyDBCluster", "RebootDBCluster", "RestoreDBClusterFromSnapshot", and "RestoreDBClusterToPointInTime". For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the *Amazon Aurora User Guide.* For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the *Amazon RDS User Guide.* * **AllocatedStorage** *(integer) --* "AllocatedStorage" specifies the allocated storage size in gibibytes (GiB). For Aurora, "AllocatedStorage" can vary because Aurora DB cluster storage size adjusts as needed. * **AvailabilityZones** *(list) --* The list of Availability Zones (AZs) where instances in the DB cluster can be created. * *(string) --* * **BackupRetentionPeriod** *(integer) --* 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) --* The name of the initial database that was specified for the DB cluster when it was created, if one was provided. This same name is returned for the life of the DB cluster. * **DBClusterIdentifier** *(string) --* The user-supplied identifier for the DB cluster. This identifier is the unique key that identifies a DB cluster. * **DBClusterParameterGroup** *(string) --* The name of the DB cluster parameter group for the DB cluster. * **DBSubnetGroup** *(string) --* Information about the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group. * **Status** *(string) --* The current state of this DB cluster. * **AutomaticRestartTime** *(datetime) --* The time when a stopped DB cluster is restarted automatically. * **PercentProgress** *(string) --* 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) --* 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) --* The custom endpoints associated with the DB cluster. * *(string) --* * **MultiAZ** *(boolean) --* Indicates whether the DB cluster has instances in multiple Availability Zones. * **Engine** *(string) --* The database engine used for this DB cluster. * **EngineVersion** *(string) --* The version of the database engine. * **LatestRestorableTime** *(datetime) --* The latest time to which a database can be restored with point-in-time restore. * **Port** *(integer) --* The port that the database engine is listening on. * **MasterUsername** *(string) --* The master username for the DB cluster. * **DBClusterOptionGroupMemberships** *(list) --* 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) --* The daily time range during which automated backups are created if automated backups are enabled, as determined by the "BackupRetentionPeriod". * **PreferredMaintenanceWindow** *(string) --* The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). * **ReplicationSourceIdentifier** *(string) --* The identifier of the source DB cluster if this DB cluster is a read replica. * **ReadReplicaIdentifiers** *(list) --* Contains one or more identifiers of the read replicas associated with this DB cluster. * *(string) --* * **StatusInfos** *(list) --* Reserved for future use. * *(dict) --* Reserved for future use. * **StatusType** *(string) --* Reserved for future use. * **Normal** *(boolean) --* Reserved for future use. * **Status** *(string) --* Reserved for future use. * **Message** *(string) --* Reserved for future use. * **DBClusterMembers** *(list) --* The list of DB 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) --* Indicates whether the cluster member is the primary DB instance for the DB cluster. * **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) --* The list of VPC security groups that the DB cluster belongs to. * *(dict) --* This data type is used as a response element for queries on VPC security group membership. * **VpcSecurityGroupId** *(string) --* The name of the VPC security group. * **Status** *(string) --* The membership status of the VPC security group. Currently, the only valid status is "active". * **HostedZoneId** *(string) --* The ID that Amazon Route 53 assigns when you create a hosted zone. * **StorageEncrypted** *(boolean) --* Indicates whether the DB cluster is encrypted. * **KmsKeyId** *(string) --* If "StorageEncrypted" is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. * **DbClusterResourceId** *(string) --* The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the KMS key for the DB cluster is accessed. * **DBClusterArn** *(string) --* The Amazon Resource Name (ARN) for the DB cluster. * **AssociatedRoles** *(list) --* A list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf. * *(dict) --* Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB cluster. * **RoleArn** *(string) --* The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster. * **Status** *(string) --* Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values: * "ACTIVE" - the IAM role ARN is associated with the DB cluster and can be used to access other Amazon Web Services on your behalf. * "PENDING" - the IAM role ARN is being associated with the DB cluster. * "INVALID" - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other Amazon Web Services on your behalf. * **FeatureName** *(string) --* The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion. * **IAMDatabaseAuthenticationEnabled** *(boolean) --* Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled. * **CloneGroupId** *(string) --* The ID of the clone group with which the DB cluster is associated. For newly created clusters, the ID is typically null. If you clone a DB cluster when the ID is null, the operation populates the ID value for the source cluster and the clone because both clusters become part of the same clone group. Even if you delete the clone cluster, the clone group ID remains for the lifetime of the source cluster to show that it was used in a cloning operation. For PITR, the clone group ID is inherited from the source cluster. For snapshot restore operations, the clone group ID isn't inherited from the source cluster. * **ClusterCreateTime** *(datetime) --* 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.* * *(string) --* * **Capacity** *(integer) --* The current capacity of an Aurora Serverless v1 DB cluster. The capacity is "0" (zero) when the cluster is paused. For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the *Amazon Aurora User Guide*. * **EngineMode** *(string) --* The DB engine mode of the DB cluster, either "provisioned" or "serverless". For more information, see CreateDBCluster. * **ScalingConfigurationInfo** *(dict) --* The scaling configuration for an Aurora DB cluster in "serverless" DB engine mode. For more information, see Using Amazon Aurora Serverless v1 in the *Amazon Aurora User Guide*. * **MinCapacity** *(integer) --* The minimum capacity for an Aurora DB cluster in "serverless" DB engine mode. * **MaxCapacity** *(integer) --* The maximum capacity for an Aurora DB cluster in "serverless" DB engine mode. * **AutoPause** *(boolean) --* Indicates whether automatic pause is allowed for the Aurora DB cluster in "serverless" DB engine mode. When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes. * **SecondsUntilAutoPause** *(integer) --* The remaining amount of time, in seconds, before the Aurora DB cluster in "serverless" mode is paused. A DB cluster can be paused only when it's idle (it has no connections). * **TimeoutAction** *(string) --* The action that occurs when Aurora times out while attempting to change the capacity of an Aurora Serverless v1 cluster. The value is either "ForceApplyCapacityChange" or "RollbackCapacityChange". "ForceApplyCapacityChange", the default, sets the capacity to the specified value as soon as possible. "RollbackCapacityChange" ignores the capacity change if a scaling point isn't found in the timeout period. * **SecondsBeforeTimeout** *(integer) --* The number of seconds before scaling times out. What happens when an attempted scaling action times out is determined by the "TimeoutAction" setting. * **RdsCustomClusterConfiguration** *(dict) --* Reserved for future use. * **InterconnectSubnetId** *(string) --* Reserved for future use. * **TransitGatewayMulticastDomainId** *(string) --* Reserved for future use. * **ReplicaMode** *(string) --* Reserved for future use. * **DeletionProtection** *(boolean) --* Indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. * **HttpEndpointEnabled** *(boolean) --* Indicates whether the HTTP endpoint is enabled for an Aurora DB cluster. When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the DB cluster. You can also query your database from inside the RDS console with the RDS query editor. For more information, see Using RDS Data API in the *Amazon Aurora User Guide*. * **ActivityStreamMode** *(string) --* The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously. * **ActivityStreamStatus** *(string) --* The status of the database activity stream. * **ActivityStreamKmsKeyId** *(string) --* The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. * **ActivityStreamKinesisStreamName** *(string) --* The name of the Amazon Kinesis data stream used for the database activity stream. * **CopyTagsToSnapshot** *(boolean) --* Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster. * **CrossAccountClone** *(boolean) --* Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account. * **DomainMemberships** *(list) --* The Active Directory Domain membership records associated with the DB cluster. * *(dict) --* An Active Directory Domain membership record associated with the DB instance or cluster. * **Domain** *(string) --* The identifier of the Active Directory Domain. * **Status** *(string) --* The status of the Active Directory Domain membership for the DB instance or cluster. Values include "joined", "pending-join", "failed", and so on. * **FQDN** *(string) --* The fully qualified domain name (FQDN) of the Active Directory Domain. * **IAMRoleName** *(string) --* The name of the IAM role used when making API calls to the Directory Service. * **OU** *(string) --* The Active Directory organizational unit for the DB instance or cluster. * **AuthSecretArn** *(string) --* The ARN for the Secrets Manager secret with the credentials for the user that's a member of the domain. * **DnsIps** *(list) --* The IPv4 DNS IP addresses of the primary and secondary Active Directory domain controllers. * *(string) --* * **TagList** *(list) --* A list of tags. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **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}_.:/=+\-@]*)$"). * **GlobalClusterIdentifier** *(string) --* Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster. * **GlobalWriteForwardingStatus** *(string) --* The status of write forwarding for a secondary cluster in an Aurora global database. * **GlobalWriteForwardingRequested** *(boolean) --* Indicates whether write forwarding is enabled for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of "GlobalWriteForwardingStatus" to confirm that the request has completed before using the write forwarding feature for this cluster. * **PendingModifiedValues** *(dict) --* Information about pending changes to the DB cluster. This information is returned only when there are pending changes. Specific changes are identified by subelements. * **PendingCloudwatchLogsExports** *(dict) --* A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated. * **LogTypesToEnable** *(list) --* Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs. * *(string) --* * **LogTypesToDisable** *(list) --* Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs. * *(string) --* * **DBClusterIdentifier** *(string) --* The DBClusterIdentifier value for the DB cluster. * **MasterUserPassword** *(string) --* The master credentials for the DB cluster. * **IAMDatabaseAuthenticationEnabled** *(boolean) --* Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled. * **EngineVersion** *(string) --* The database engine version. * **BackupRetentionPeriod** *(integer) --* The number of days for which automatic DB snapshots are retained. * **AllocatedStorage** *(integer) --* The allocated storage size in gibibytes (GiB) for all database engines except Amazon Aurora. For Aurora, "AllocatedStorage" always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed. * **RdsCustomClusterConfiguration** *(dict) --* Reserved for future use. * **InterconnectSubnetId** *(string) --* Reserved for future use. * **TransitGatewayMulticastDomainId** *(string) --* Reserved for future use. * **ReplicaMode** *(string) --* Reserved for future use. * **Iops** *(integer) --* The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters. * **StorageType** *(string) --* The storage type for the DB cluster. * **CertificateDetails** *(dict) --* The details of the DB instance’s server certificate. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the *Amazon RDS User Guide* and Using SSL/TLS to encrypt a connection to a DB cluster in the *Amazon Aurora User Guide*. * **CAIdentifier** *(string) --* The CA identifier of the CA certificate used for the DB instance's server certificate. * **ValidTill** *(datetime) --* The expiration date of the DB instance’s server certificate. * **DBClusterInstanceClass** *(string) --* The name of the compute and memory capacity class of the DB instance. This setting is only for non-Aurora Multi-AZ DB clusters. * **StorageType** *(string) --* The storage type associated with the DB cluster. * **Iops** *(integer) --* The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters. * **PubliclyAccessible** *(boolean) --* Indicates whether the DB cluster is publicly accessible. When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it. When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address. For more information, see CreateDBCluster. This setting is only for non-Aurora Multi-AZ DB clusters. * **AutoMinorVersionUpgrade** *(boolean) --* Indicates whether minor version patches are applied automatically. This setting is for Aurora DB clusters and Multi-AZ DB clusters. For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version. * **MonitoringInterval** *(integer) --* The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. This setting is only for -Aurora DB clusters and Multi-AZ DB clusters. * **MonitoringRoleArn** *(string) --* The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. This setting is only for Aurora DB clusters and Multi-AZ DB clusters. * **DatabaseInsightsMode** *(string) --* The mode of Database Insights that is enabled for the DB cluster. * **PerformanceInsightsEnabled** *(boolean) --* Indicates whether Performance Insights is enabled for the DB cluster. This setting is only for Aurora DB clusters and Multi-AZ DB clusters. * **PerformanceInsightsKMSKeyId** *(string) --* The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. This setting is only for Aurora DB clusters and Multi-AZ DB clusters. * **PerformanceInsightsRetentionPeriod** *(integer) --* The number of days to retain Performance Insights data. This setting is only for Aurora DB clusters and Multi-AZ DB clusters. Valid Values: * "7" * *month* * 31, where *month* is a number of months from 1-23. Examples: "93" (3 months * 31), "341" (11 months * 31), "589" (19 months * 31) * "731" Default: "7" days * **ServerlessV2ScalingConfiguration** *(dict) --* The scaling configuration for an Aurora Serverless v2 DB cluster. For more information, see Using Amazon Aurora Serverless v2 in the *Amazon Aurora User Guide*. * **MinCapacity** *(float) --* The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. For Aurora versions that support the Aurora Serverless v2 auto-pause feature, the smallest value that you can use is 0. For versions that don't support Aurora Serverless v2 auto-pause, the smallest value that you can use is 0.5. * **MaxCapacity** *(float) --* The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 32, 32.5, 33, and so on. The largest value that you can use is 256 for recent Aurora versions, or 128 for older versions. You can check the attributes of your engine version or platform version to determine the specific maximum capacity supported. * **SecondsUntilAutoPause** *(integer) --* The number of seconds an Aurora Serverless v2 DB instance must be idle before Aurora attempts to automatically pause it. This property is only shown when the minimum capacity for the cluster is set to 0 ACUs. Changing the minimum capacity to a nonzero value removes this property. If you later change the minimum capacity back to 0 ACUs, this property is reset to its default value unless you specify it again. This value ranges between 300 seconds (five minutes) and 86,400 seconds (one day). The default is 300 seconds. * **ServerlessV2PlatformVersion** *(string) --* The version of the Aurora Serverless V2 platform used by the DB cluster. For more information, see Using Aurora Serverless v2 in the *Amazon Aurora User Guide*. * **NetworkType** *(string) --* The network type of the DB instance. The network type is determined by the "DBSubnetGroup" specified for the DB cluster. A "DBSubnetGroup" can support only the IPv4 protocol or the IPv4 and the IPv6 protocols ( "DUAL"). For more information, see Working with a DB instance in a VPC in the *Amazon Aurora User Guide.* This setting is only for Aurora DB clusters. Valid Values: "IPV4 | DUAL" * **DBSystemId** *(string) --* Reserved for future use. * **MasterUserSecret** *(dict) --* The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password. For more information, see Password management with Amazon Web Services Secrets Manager in the *Amazon RDS User Guide* and Password management with Amazon Web Services Secrets Manager in the *Amazon Aurora User Guide.* * **SecretArn** *(string) --* The Amazon Resource Name (ARN) of the secret. * **SecretStatus** *(string) --* The status of the secret. The possible status values include the following: * "creating" - The secret is being created. * "active" - The secret is available for normal use and rotation. * "rotating" - The secret is being rotated. * "impaired" - The secret can be used to access database credentials, but it can't be rotated. A secret might have this status if, for example, permissions are changed so that RDS can no longer access either the secret or the KMS key for the secret. When a secret has this status, you can correct the condition that caused the status. Alternatively, modify the DB instance to turn off automatic management of database credentials, and then modify the DB instance again to turn on automatic management of database credentials. * **KmsKeyId** *(string) --* The Amazon Web Services KMS key identifier that is used to encrypt the secret. * **IOOptimizedNextAllowedModificationTime** *(datetime) --* The next time you can modify the DB cluster to use the "aurora-iopt1" storage type. This setting is only for Aurora DB clusters. * **LocalWriteForwardingStatus** *(string) --* Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it. * **AwsBackupRecoveryPointArn** *(string) --* The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup. * **LimitlessDatabase** *(dict) --* The details for Aurora Limitless Database. * **Status** *(string) --* The status of Aurora Limitless Database. * **MinRequiredACU** *(float) --* The minimum required capacity for Aurora Limitless Database in Aurora capacity units (ACUs). * **StorageThroughput** *(integer) --* The storage throughput for the DB cluster. The throughput is automatically set based on the IOPS that you provision, and is not configurable. This setting is only for non-Aurora Multi-AZ DB clusters. * **ClusterScalabilityType** *(string) --* The scalability mode of the Aurora DB cluster. When set to "limitless", the cluster operates as an Aurora Limitless Database. When set to "standard" (the default), the cluster uses normal DB instance creation. * **CertificateDetails** *(dict) --* The details of the DB instance’s server certificate. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the *Amazon RDS User Guide* and Using SSL/TLS to encrypt a connection to a DB cluster in the *Amazon Aurora User Guide*. * **CAIdentifier** *(string) --* The CA identifier of the CA certificate used for the DB instance's server certificate. * **ValidTill** *(datetime) --* The expiration date of the DB instance’s server certificate. * **EngineLifecycleSupport** *(string) --* The lifecycle type for the DB cluster. For more information, see CreateDBCluster. **Exceptions** * "RDS.Client.exceptions.DBClusterNotFoundFault" * "RDS.Client.exceptions.InvalidDBClusterStateFault" * "RDS.Client.exceptions.InvalidDBInstanceStateFault" * "RDS.Client.exceptions.InvalidDBShardGroupStateFault" RDS / Client / copy_db_cluster_parameter_group copy_db_cluster_parameter_group ******************************* RDS.Client.copy_db_cluster_parameter_group(**kwargs) Copies the specified DB cluster parameter group. Note: You can't copy a default DB cluster parameter group. Instead, create a new custom DB cluster parameter group, which copies the default parameters and values for the specified DB cluster parameter group family. 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' }, ] ) Parameters: * **SourceDBClusterParameterGroupIdentifier** (*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: * Must specify a valid DB cluster parameter group. * **TargetDBClusterParameterGroupIdentifier** (*string*) -- **[REQUIRED]** The identifier for the copied DB cluster parameter group. Constraints: * Can't be null, empty, or blank * Must contain from 1 to 255 letters, numbers, or hyphens * First character must be a letter * Can't end with a hyphen or contain two consecutive hyphens Example: "my-cluster-param-group1" * **TargetDBClusterParameterGroupDescription** (*string*) -- **[REQUIRED]** A description for the copied DB cluster parameter group. * **Tags** (*list*) -- A list of tags. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **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}_.:/=+\-@]*)$"). Return type: dict Returns: **Response Syntax** { 'DBClusterParameterGroup': { 'DBClusterParameterGroupName': 'string', 'DBParameterGroupFamily': 'string', 'Description': 'string', 'DBClusterParameterGroupArn': 'string' } } **Response Structure** * *(dict) --* * **DBClusterParameterGroup** *(dict) --* Contains the details of an Amazon RDS DB cluster parameter group. This data type is used as a response element in the "DescribeDBClusterParameterGroups" action. * **DBClusterParameterGroupName** *(string) --* The name of the DB cluster parameter group. * **DBParameterGroupFamily** *(string) --* The name of the DB parameter group family that this DB cluster parameter group is compatible with. * **Description** *(string) --* Provides the customer-specified description for this DB cluster parameter group. * **DBClusterParameterGroupArn** *(string) --* The Amazon Resource Name (ARN) for the DB cluster parameter group. **Exceptions** * "RDS.Client.exceptions.DBParameterGroupNotFoundFault" * "RDS.Client.exceptions.DBParameterGroupQuotaExceededFault" * "RDS.Client.exceptions.DBParameterGroupAlreadyExistsFault" **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: { 'DBClusterParameterGroup': { }, 'ResponseMetadata': { '...': '...', }, } RDS / Client / describe_global_clusters describe_global_clusters ************************ RDS.Client.describe_global_clusters(**kwargs) Returns information about Aurora global database clusters. This API supports pagination. For more information on Amazon Aurora, see What is Amazon Aurora? in the *Amazon Aurora User Guide*. Note: This action only applies to Aurora DB clusters. See also: AWS API Documentation **Request Syntax** response = client.describe_global_clusters( GlobalClusterIdentifier='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], MaxRecords=123, Marker='string' ) Parameters: * **GlobalClusterIdentifier** (*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: * If supplied, must match an existing DBClusterIdentifier. * **Filters** (*list*) -- A filter that specifies one or more global database clusters to describe. This parameter is case-sensitive. Currently, the only supported filter is "region". If used, the request returns information about any global cluster with at least one member (primary or secondary) in the specified Amazon Web Services Regions. * *(dict) --* 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: * "DescribeDBClusterBacktracks" * "DescribeDBClusterEndpoints" * "DescribeDBClusters" * "DescribeDBInstances" * "DescribeDBRecommendations" * "DescribeDBShardGroups" * "DescribePendingMaintenanceActions" * **Name** *(string) --* **[REQUIRED]** The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* **[REQUIRED]** One or more filter values. Filter values are case- sensitive. * *(string) --* * **MaxRecords** (*integer*) -- 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. * **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". Return type: dict Returns: **Response Syntax** { 'Marker': 'string', 'GlobalClusters': [ { 'GlobalClusterIdentifier': 'string', 'GlobalClusterResourceId': 'string', 'GlobalClusterArn': 'string', 'Status': 'string', 'Engine': 'string', 'EngineVersion': 'string', 'EngineLifecycleSupport': 'string', 'DatabaseName': 'string', 'StorageEncrypted': True|False, 'DeletionProtection': True|False, 'GlobalClusterMembers': [ { 'DBClusterArn': 'string', 'Readers': [ 'string', ], 'IsWriter': True|False, 'GlobalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'unknown', 'SynchronizationStatus': 'connected'|'pending-resync' }, ], 'Endpoint': 'string', 'FailoverState': { 'Status': 'pending'|'failing-over'|'cancelling', 'FromDbClusterArn': 'string', 'ToDbClusterArn': 'string', 'IsDataLossAllowed': True|False }, 'TagList': [ { 'Key': 'string', 'Value': 'string' }, ] }, ] } **Response Structure** * *(dict) --* * **Marker** *(string) --* An optional pagination token provided by a previous "DescribeGlobalClusters" request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by "MaxRecords". * **GlobalClusters** *(list) --* The list of global clusters returned by this request. * *(dict) --* A data type representing an Aurora global database. * **GlobalClusterIdentifier** *(string) --* Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster. * **GlobalClusterResourceId** *(string) --* The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB cluster is accessed. * **GlobalClusterArn** *(string) --* The Amazon Resource Name (ARN) for the global database cluster. * **Status** *(string) --* Specifies the current state of this global database cluster. * **Engine** *(string) --* The Aurora database engine used by the global database cluster. * **EngineVersion** *(string) --* Indicates the database engine version. * **EngineLifecycleSupport** *(string) --* The lifecycle type for the global cluster. For more information, see CreateGlobalCluster. * **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 primary and secondary clusters within the global database cluster. * *(dict) --* A data structure with information about any primary and secondary clusters associated with a global cluster (Aurora global database). * **DBClusterArn** *(string) --* The Amazon Resource Name (ARN) for each Aurora DB cluster in the global cluster. * **Readers** *(list) --* The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the global cluster. * *(string) --* * **IsWriter** *(boolean) --* Indicates whether the Aurora DB cluster is the primary cluster (that is, has read-write capability) for the global cluster with which it is associated. * **GlobalWriteForwardingStatus** *(string) --* The status of write forwarding for a secondary cluster in the global cluster. * **SynchronizationStatus** *(string) --* The status of synchronization of each Aurora DB cluster in the global cluster. * **Endpoint** *(string) --* The writer endpoint for the new global database cluster. This endpoint always points to the writer DB instance in the current primary cluster. * **FailoverState** *(dict) --* A data object containing all properties for the current state of an in-process or pending switchover or failover process for this global cluster (Aurora global database). This object is empty unless the "SwitchoverGlobalCluster" or "FailoverGlobalCluster" operation was called on this global cluster. * **Status** *(string) --* The current status of the global cluster. Possible values are as follows: * pending – The service received a request to switch over or fail over the global cluster. The global cluster's primary DB cluster and the specified secondary DB cluster are being verified before the operation starts. * failing-over – Aurora is promoting the chosen secondary Aurora DB cluster to become the new primary DB cluster to fail over the global cluster. * cancelling – The request to switch over or fail over the global cluster was cancelled and the primary Aurora DB cluster and the selected secondary Aurora DB cluster are returning to their previous states. * switching-over – This status covers the range of Aurora internal operations that take place during the switchover process, such as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB cluster, and synchronizing replicas. * **FromDbClusterArn** *(string) --* The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being demoted, and which is associated with this state. * **ToDbClusterArn** *(string) --* The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being promoted, and which is associated with this state. * **IsDataLossAllowed** *(boolean) --* Indicates whether the operation is a global switchover or a global failover. If data loss is allowed, then the operation is a global failover. Otherwise, it's a switchover. * **TagList** *(list) --* A list of tags. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **Key** *(string) --* A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **Value** *(string) --* A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). **Exceptions** * "RDS.Client.exceptions.GlobalClusterNotFoundFault" RDS / Client / describe_pending_maintenance_actions describe_pending_maintenance_actions ************************************ RDS.Client.describe_pending_maintenance_actions(**kwargs) Returns a list of resources (for example, DB instances) that have at least one pending maintenance action. This API follows an eventual consistency model. This means that the result of the "DescribePendingMaintenanceActions" command might not be immediately visible to all subsequent RDS commands. Keep this in mind when you use "DescribePendingMaintenanceActions" immediately after using a previous API command such as "ApplyPendingMaintenanceActions". See also: AWS API Documentation **Request Syntax** response = client.describe_pending_maintenance_actions( ResourceIdentifier='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], Marker='string', MaxRecords=123 ) Parameters: * **ResourceIdentifier** (*string*) -- The ARN of a resource to return pending maintenance actions for. * **Filters** (*list*) -- A filter that specifies one or more resources to return pending maintenance actions for. Supported filters: * "db-cluster-id" - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes pending maintenance actions for the DB clusters identified by these ARNs. * "db-instance-id" - Accepts DB instance identifiers and DB instance ARNs. The results list only includes pending maintenance actions for the DB instances identified by these ARNs. * *(dict) --* 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: * "DescribeDBClusterBacktracks" * "DescribeDBClusterEndpoints" * "DescribeDBClusters" * "DescribeDBInstances" * "DescribeDBRecommendations" * "DescribeDBShardGroups" * "DescribePendingMaintenanceActions" * **Name** *(string) --* **[REQUIRED]** The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* **[REQUIRED]** One or more filter values. Filter values are case- sensitive. * *(string) --* * **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". * **MaxRecords** (*integer*) -- 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. Return type: dict Returns: **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. For more information about maintenance actions, see Maintaining a DB instance. Valid Values: * "ca-certificate-rotation" * "db-upgrade" * "hardware-maintenance" * "os-upgrade" * "system-update" For more information about these actions, see Maintenance actions for Amazon Aurora or Maintenance actions for Amazon RDS. * **AutoAppliedAfterDate** *(datetime) --* The date of the maintenance window when the action is applied. The maintenance action is applied to the resource during its first maintenance window after this date. * **ForcedApplyDate** *(datetime) --* The date when the maintenance action is automatically applied. On this date, the maintenance action is applied to the resource as soon as possible, regardless of the maintenance window for the resource. There might be a delay of one or more days from this date before the maintenance action is applied. * **OptInStatus** *(string) --* Indicates the type of opt-in request that has been received for the resource. * **CurrentApplyDate** *(datetime) --* The effective date when the pending maintenance action is applied to the resource. This date takes into account opt-in requests received from the "ApplyPendingMaintenanceAction" API, the "AutoAppliedAfterDate", and the "ForcedApplyDate". This value is blank if an opt-in request has not been received and nothing has been specified as "AutoAppliedAfterDate" or "ForcedApplyDate". * **Description** *(string) --* A description providing more detail about the maintenance action. * **Marker** *(string) --* An optional pagination token provided by a previous "DescribePendingMaintenanceActions" request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by "MaxRecords". **Exceptions** * "RDS.Client.exceptions.ResourceNotFoundFault" **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': { '...': '...', }, } RDS / Client / failover_global_cluster failover_global_cluster *********************** RDS.Client.failover_global_cluster(**kwargs) Promotes the specified secondary DB cluster to be the primary DB cluster in the global database cluster to fail over or switch over a global database. Switchover operations were previously called "managed planned failovers." Note: Although this operation can be used either to fail over or to switch over a global database cluster, its intended use is for global database failover. To switch over a global database cluster, we recommend that you use the SwitchoverGlobalCluster operation instead. How you use this operation depends on whether you are failing over or switching over your global database cluster: * Failing over - Specify the "AllowDataLoss" parameter and don't specify the "Switchover" parameter. * Switching over - Specify the "Switchover" parameter or omit it, but don't specify the "AllowDataLoss" parameter. **About failing over and switching over** While failing over and switching over a global database cluster both change the primary DB cluster, you use these operations for different reasons: * *Failing over* - Use this operation to respond to an unplanned event, such as a Regional disaster in the primary Region. Failing over can result in a loss of write transaction data that wasn't replicated to the chosen secondary before the failover event occurred. However, the recovery process that promotes a DB instance on the chosen seconday DB cluster to be the primary writer DB instance guarantees that the data is in a transactionally consistent state. For more information about failing over an Amazon Aurora global database, see Performing managed failovers for Aurora global databases in the *Amazon Aurora User Guide*. * *Switching over* - Use this operation on a healthy global database cluster for planned events, such as Regional rotation or to fail back to the original primary DB cluster after a failover operation. With this operation, there is no data loss. For more information about switching over an Amazon Aurora global database, see Performing switchovers for Aurora global databases in the *Amazon Aurora User Guide*. See also: AWS API Documentation **Request Syntax** response = client.failover_global_cluster( GlobalClusterIdentifier='string', TargetDbClusterIdentifier='string', AllowDataLoss=True|False, Switchover=True|False ) Parameters: * **GlobalClusterIdentifier** (*string*) -- **[REQUIRED]** The identifier of the global database cluster (Aurora global database) this operation should apply to. The identifier is the unique key assigned by the user when the Aurora global database is created. In other words, it's the name of the Aurora global database. Constraints: * Must match the identifier of an existing global database cluster. * **TargetDbClusterIdentifier** (*string*) -- **[REQUIRED]** The identifier of the secondary Aurora DB cluster that you want to promote to the primary for the global database cluster. Use the Amazon Resource Name (ARN) for the identifier so that Aurora can locate the cluster in its Amazon Web Services Region. * **AllowDataLoss** (*boolean*) -- Specifies whether to allow data loss for this global database cluster operation. Allowing data loss triggers a global failover operation. If you don't specify "AllowDataLoss", the global database cluster operation defaults to a switchover. Constraints: * Can't be specified together with the "Switchover" parameter. * **Switchover** (*boolean*) -- Specifies whether to switch over this global database cluster. Constraints: * Can't be specified together with the "AllowDataLoss" parameter. Return type: dict Returns: **Response Syntax** { 'GlobalCluster': { 'GlobalClusterIdentifier': 'string', 'GlobalClusterResourceId': 'string', 'GlobalClusterArn': 'string', 'Status': 'string', 'Engine': 'string', 'EngineVersion': 'string', 'EngineLifecycleSupport': 'string', 'DatabaseName': 'string', 'StorageEncrypted': True|False, 'DeletionProtection': True|False, 'GlobalClusterMembers': [ { 'DBClusterArn': 'string', 'Readers': [ 'string', ], 'IsWriter': True|False, 'GlobalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'unknown', 'SynchronizationStatus': 'connected'|'pending-resync' }, ], 'Endpoint': 'string', 'FailoverState': { 'Status': 'pending'|'failing-over'|'cancelling', 'FromDbClusterArn': 'string', 'ToDbClusterArn': 'string', 'IsDataLossAllowed': True|False }, 'TagList': [ { 'Key': 'string', 'Value': 'string' }, ] } } **Response Structure** * *(dict) --* * **GlobalCluster** *(dict) --* A data type representing an Aurora global database. * **GlobalClusterIdentifier** *(string) --* Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster. * **GlobalClusterResourceId** *(string) --* The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB cluster is accessed. * **GlobalClusterArn** *(string) --* The Amazon Resource Name (ARN) for the global database cluster. * **Status** *(string) --* Specifies the current state of this global database cluster. * **Engine** *(string) --* The Aurora database engine used by the global database cluster. * **EngineVersion** *(string) --* Indicates the database engine version. * **EngineLifecycleSupport** *(string) --* The lifecycle type for the global cluster. For more information, see CreateGlobalCluster. * **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 primary and secondary clusters within the global database cluster. * *(dict) --* A data structure with information about any primary and secondary clusters associated with a global cluster (Aurora global database). * **DBClusterArn** *(string) --* The Amazon Resource Name (ARN) for each Aurora DB cluster in the global cluster. * **Readers** *(list) --* The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the global cluster. * *(string) --* * **IsWriter** *(boolean) --* Indicates whether the Aurora DB cluster is the primary cluster (that is, has read-write capability) for the global cluster with which it is associated. * **GlobalWriteForwardingStatus** *(string) --* The status of write forwarding for a secondary cluster in the global cluster. * **SynchronizationStatus** *(string) --* The status of synchronization of each Aurora DB cluster in the global cluster. * **Endpoint** *(string) --* The writer endpoint for the new global database cluster. This endpoint always points to the writer DB instance in the current primary cluster. * **FailoverState** *(dict) --* A data object containing all properties for the current state of an in-process or pending switchover or failover process for this global cluster (Aurora global database). This object is empty unless the "SwitchoverGlobalCluster" or "FailoverGlobalCluster" operation was called on this global cluster. * **Status** *(string) --* The current status of the global cluster. Possible values are as follows: * pending – The service received a request to switch over or fail over the global cluster. The global cluster's primary DB cluster and the specified secondary DB cluster are being verified before the operation starts. * failing-over – Aurora is promoting the chosen secondary Aurora DB cluster to become the new primary DB cluster to fail over the global cluster. * cancelling – The request to switch over or fail over the global cluster was cancelled and the primary Aurora DB cluster and the selected secondary Aurora DB cluster are returning to their previous states. * switching-over – This status covers the range of Aurora internal operations that take place during the switchover process, such as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB cluster, and synchronizing replicas. * **FromDbClusterArn** *(string) --* The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being demoted, and which is associated with this state. * **ToDbClusterArn** *(string) --* The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being promoted, and which is associated with this state. * **IsDataLossAllowed** *(boolean) --* Indicates whether the operation is a global switchover or a global failover. If data loss is allowed, then the operation is a global failover. Otherwise, it's a switchover. * **TagList** *(list) --* A list of tags. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **Key** *(string) --* A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **Value** *(string) --* A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). **Exceptions** * "RDS.Client.exceptions.GlobalClusterNotFoundFault" * "RDS.Client.exceptions.InvalidGlobalClusterStateFault" * "RDS.Client.exceptions.InvalidDBClusterStateFault" * "RDS.Client.exceptions.DBClusterNotFoundFault" RDS / Client / backtrack_db_cluster backtrack_db_cluster ******************** RDS.Client.backtrack_db_cluster(**kwargs) Backtracks a DB cluster to a specific time, without creating a new DB cluster. For more information on backtracking, see Backtracking an Aurora DB Cluster in the *Amazon Aurora User Guide*. Note: This action applies only to Aurora MySQL DB clusters. See also: AWS API Documentation **Request Syntax** response = client.backtrack_db_cluster( DBClusterIdentifier='string', BacktrackTo=datetime(2015, 1, 1), Force=True|False, UseEarliestTimeOnPointInTimeUnavailable=True|False ) Parameters: * **DBClusterIdentifier** (*string*) -- **[REQUIRED]** The DB cluster identifier of the DB cluster to be backtracked. This parameter is stored as a lowercase string. Constraints: * Must contain from 1 to 63 alphanumeric characters or hyphens. * First character must be a letter. * Can't end with a hyphen or contain two consecutive hyphens. Example: "my-cluster1" * **BacktrackTo** (*datetime*) -- **[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: * Must contain a valid ISO 8601 timestamp. * Can't contain a timestamp set in the future. Example: "2017-07-08T18:00Z" * **Force** (*boolean*) -- Specifies whether to force the DB cluster to backtrack when binary logging is enabled. Otherwise, an error occurs when binary logging is enabled. * **UseEarliestTimeOnPointInTimeUnavailable** (*boolean*) -- Specifies whether to backtrack the DB cluster to the earliest possible backtrack time when *BacktrackTo* is set to a timestamp earlier than the earliest backtrack time. When this parameter is disabled and *BacktrackTo* is set to a timestamp earlier than the earliest backtrack time, an error occurs. Return type: dict Returns: **Response Syntax** { 'DBClusterIdentifier': 'string', 'BacktrackIdentifier': 'string', 'BacktrackTo': datetime(2015, 1, 1), 'BacktrackedFrom': datetime(2015, 1, 1), 'BacktrackRequestCreationTime': datetime(2015, 1, 1), 'Status': 'string' } **Response Structure** * *(dict) --* This data type is used as a response element in the "DescribeDBClusterBacktracks" action. * **DBClusterIdentifier** *(string) --* Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster. * **BacktrackIdentifier** *(string) --* Contains the backtrack identifier. * **BacktrackTo** *(datetime) --* The timestamp of the time to which the DB cluster was backtracked. * **BacktrackedFrom** *(datetime) --* The timestamp of the time from which the DB cluster was backtracked. * **BacktrackRequestCreationTime** *(datetime) --* The timestamp of the time at which the backtrack was requested. * **Status** *(string) --* The status of the backtrack. This property returns one of the following values: * "applying" - The backtrack is currently being applied to or rolled back from the DB cluster. * "completed" - The backtrack has successfully been applied to or rolled back from the DB cluster. * "failed" - An error occurred while the backtrack was applied to or rolled back from the DB cluster. * "pending" - The backtrack is currently pending application to or rollback from the DB cluster. **Exceptions** * "RDS.Client.exceptions.DBClusterNotFoundFault" * "RDS.Client.exceptions.InvalidDBClusterStateFault" RDS / Client / delete_tenant_database delete_tenant_database ********************** RDS.Client.delete_tenant_database(**kwargs) Deletes a tenant database from your DB instance. This command only applies to RDS for Oracle container database (CDB) instances. You can't delete a tenant database when it is the only tenant in the DB instance. See also: AWS API Documentation **Request Syntax** response = client.delete_tenant_database( DBInstanceIdentifier='string', TenantDBName='string', SkipFinalSnapshot=True|False, FinalDBSnapshotIdentifier='string' ) Parameters: * **DBInstanceIdentifier** (*string*) -- **[REQUIRED]** The user-supplied identifier for the DB instance that contains the tenant database that you want to delete. * **TenantDBName** (*string*) -- **[REQUIRED]** The user-supplied name of the tenant database that you want to remove from your DB instance. Amazon RDS deletes the tenant database with this name. This parameter isn’t case-sensitive. * **SkipFinalSnapshot** (*boolean*) -- Specifies whether to skip the creation of a final DB snapshot before removing the tenant database from your DB instance. If you enable this parameter, RDS doesn't create a DB snapshot. If you don't enable this parameter, RDS creates a DB snapshot before it deletes the tenant database. By default, RDS doesn't skip the final snapshot. If you don't enable this parameter, you must specify the "FinalDBSnapshotIdentifier" parameter. * **FinalDBSnapshotIdentifier** (*string*) -- The "DBSnapshotIdentifier" of the new "DBSnapshot" created when the "SkipFinalSnapshot" parameter is disabled. Note: If you enable this parameter and also enable "SkipFinalShapshot", the command results in an error. Return type: dict Returns: **Response Syntax** { 'TenantDatabase': { 'TenantDatabaseCreateTime': datetime(2015, 1, 1), 'DBInstanceIdentifier': 'string', 'TenantDBName': 'string', 'Status': 'string', 'MasterUsername': 'string', 'DbiResourceId': 'string', 'TenantDatabaseResourceId': 'string', 'TenantDatabaseARN': 'string', 'CharacterSetName': 'string', 'NcharCharacterSetName': 'string', 'DeletionProtection': True|False, 'PendingModifiedValues': { 'MasterUserPassword': 'string', 'TenantDBName': 'string' }, 'MasterUserSecret': { 'SecretArn': 'string', 'SecretStatus': 'string', 'KmsKeyId': 'string' }, 'TagList': [ { 'Key': 'string', 'Value': 'string' }, ] } } **Response Structure** * *(dict) --* * **TenantDatabase** *(dict) --* A tenant database in the DB instance. This data type is an element in the response to the "DescribeTenantDatabases" action. * **TenantDatabaseCreateTime** *(datetime) --* The creation time of the tenant database. * **DBInstanceIdentifier** *(string) --* The ID of the DB instance that contains the tenant database. * **TenantDBName** *(string) --* The database name of the tenant database. * **Status** *(string) --* The status of the tenant database. * **MasterUsername** *(string) --* The master username of the tenant database. * **DbiResourceId** *(string) --* The Amazon Web Services Region-unique, immutable identifier for the DB instance. * **TenantDatabaseResourceId** *(string) --* The Amazon Web Services Region-unique, immutable identifier for the tenant database. * **TenantDatabaseARN** *(string) --* The Amazon Resource Name (ARN) for the tenant database. * **CharacterSetName** *(string) --* The character set of the tenant database. * **NcharCharacterSetName** *(string) --* The "NCHAR" character set name of the tenant database. * **DeletionProtection** *(boolean) --* Specifies whether deletion protection is enabled for the DB instance. * **PendingModifiedValues** *(dict) --* Information about pending changes for a tenant database. * **MasterUserPassword** *(string) --* The master password for the tenant database. * **TenantDBName** *(string) --* The name of the tenant database. * **MasterUserSecret** *(dict) --* Contains the secret managed by RDS in Amazon Web Services Secrets Manager for the master user password. For more information, see Password management with Amazon Web Services Secrets Manager in the *Amazon RDS User Guide* and Password management with Amazon Web Services Secrets Manager in the *Amazon Aurora User Guide.* * **SecretArn** *(string) --* The Amazon Resource Name (ARN) of the secret. * **SecretStatus** *(string) --* The status of the secret. The possible status values include the following: * "creating" - The secret is being created. * "active" - The secret is available for normal use and rotation. * "rotating" - The secret is being rotated. * "impaired" - The secret can be used to access database credentials, but it can't be rotated. A secret might have this status if, for example, permissions are changed so that RDS can no longer access either the secret or the KMS key for the secret. When a secret has this status, you can correct the condition that caused the status. Alternatively, modify the DB instance to turn off automatic management of database credentials, and then modify the DB instance again to turn on automatic management of database credentials. * **KmsKeyId** *(string) --* The Amazon Web Services KMS key identifier that is used to encrypt the secret. * **TagList** *(list) --* A list of tags. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **Key** *(string) --* A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **Value** *(string) --* A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). **Exceptions** * "RDS.Client.exceptions.DBInstanceNotFoundFault" * "RDS.Client.exceptions.TenantDatabaseNotFoundFault" * "RDS.Client.exceptions.InvalidDBInstanceStateFault" RDS / Client / modify_activity_stream modify_activity_stream ********************** RDS.Client.modify_activity_stream(**kwargs) Changes the audit policy state of a database activity stream to either locked (default) or unlocked. A locked policy is read-only, whereas an unlocked policy is read/write. If your activity stream is started and locked, you can unlock it, customize your audit policy, and then lock your activity stream. Restarting the activity stream isn't required. For more information, see Modifying a database activity stream in the *Amazon RDS User Guide*. This operation is supported for RDS for Oracle and Microsoft SQL Server. See also: AWS API Documentation **Request Syntax** response = client.modify_activity_stream( ResourceArn='string', AuditPolicyState='locked'|'unlocked' ) Parameters: * **ResourceArn** (*string*) -- The Amazon Resource Name (ARN) of the RDS for Oracle or Microsoft SQL Server DB instance. For example, "arn:aws:rds:us-east-1:12345667890:db:my-orcl-db". * **AuditPolicyState** (*string*) -- The audit policy state. When a policy is unlocked, it is read/write. When it is locked, it is read-only. You can edit your audit policy only when the activity stream is unlocked or stopped. Return type: dict Returns: **Response Syntax** { 'KmsKeyId': 'string', 'KinesisStreamName': 'string', 'Status': 'stopped'|'starting'|'started'|'stopping', 'Mode': 'sync'|'async', 'EngineNativeAuditFieldsIncluded': True|False, 'PolicyStatus': 'locked'|'unlocked'|'locking-policy'|'unlocking-policy' } **Response Structure** * *(dict) --* * **KmsKeyId** *(string) --* The Amazon Web Services KMS key identifier for encryption of messages in the database activity stream. * **KinesisStreamName** *(string) --* The name of the Amazon Kinesis data stream to be used for the database activity stream. * **Status** *(string) --* The status of the modification to the database activity stream. * **Mode** *(string) --* The mode of the database activity stream. * **EngineNativeAuditFieldsIncluded** *(boolean) --* Indicates whether engine-native audit fields are included in the database activity stream. * **PolicyStatus** *(string) --* The status of the modification to the policy state of the database activity stream. **Exceptions** * "RDS.Client.exceptions.InvalidDBInstanceStateFault" * "RDS.Client.exceptions.ResourceNotFoundFault" * "RDS.Client.exceptions.DBInstanceNotFoundFault" RDS / Client / restore_db_cluster_from_snapshot restore_db_cluster_from_snapshot ******************************** RDS.Client.restore_db_cluster_from_snapshot(**kwargs) Creates a new DB cluster from a DB snapshot or DB cluster snapshot. The target DB cluster is created from the source snapshot with a default configuration. If you don't specify a security group, the new DB cluster is associated with the default security group. Note: This operation only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the "CreateDBInstance" operation to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in "DBClusterIdentifier". You can create DB instances only after the "RestoreDBClusterFromSnapshot" operation has completed and the DB cluster is available. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the *Amazon Aurora User Guide*. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the *Amazon RDS User Guide.* See also: AWS API Documentation **Request Syntax** response = client.restore_db_cluster_from_snapshot( AvailabilityZones=[ 'string', ], DBClusterIdentifier='string', SnapshotIdentifier='string', Engine='string', EngineVersion='string', Port=123, DBSubnetGroupName='string', DatabaseName='string', OptionGroupName='string', VpcSecurityGroupIds=[ 'string', ], Tags=[ { 'Key': 'string', 'Value': 'string' }, ], KmsKeyId='string', EnableIAMDatabaseAuthentication=True|False, BacktrackWindow=123, EnableCloudwatchLogsExports=[ 'string', ], EngineMode='string', ScalingConfiguration={ 'MinCapacity': 123, 'MaxCapacity': 123, 'AutoPause': True|False, 'SecondsUntilAutoPause': 123, 'TimeoutAction': 'string', 'SecondsBeforeTimeout': 123 }, DBClusterParameterGroupName='string', DeletionProtection=True|False, CopyTagsToSnapshot=True|False, Domain='string', DomainIAMRoleName='string', DBClusterInstanceClass='string', StorageType='string', Iops=123, PubliclyAccessible=True|False, ServerlessV2ScalingConfiguration={ 'MinCapacity': 123.0, 'MaxCapacity': 123.0, 'SecondsUntilAutoPause': 123 }, NetworkType='string', RdsCustomClusterConfiguration={ 'InterconnectSubnetId': 'string', 'TransitGatewayMulticastDomainId': 'string', 'ReplicaMode': 'open-read-only'|'mounted' }, MonitoringInterval=123, MonitoringRoleArn='string', EnablePerformanceInsights=True|False, PerformanceInsightsKMSKeyId='string', PerformanceInsightsRetentionPeriod=123, EngineLifecycleSupport='string' ) Parameters: * **AvailabilityZones** (*list*) -- Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be created. Valid for: Aurora DB clusters only * *(string) --* * **DBClusterIdentifier** (*string*) -- **[REQUIRED]** The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't case-sensitive. Constraints: * Must contain from 1 to 63 letters, numbers, or hyphens * First character must be a letter * Can't end with a hyphen or contain two consecutive hyphens Example: "my-snapshot-id" Valid for: Aurora DB clusters and Multi-AZ DB clusters * **SnapshotIdentifier** (*string*) -- **[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: * Must match the identifier of an existing Snapshot. Valid for: Aurora DB clusters and Multi-AZ DB clusters * **Engine** (*string*) -- **[REQUIRED]** The database engine to use for the new DB cluster. Default: The same as source Constraint: Must be compatible with the engine of the source Valid for: Aurora DB clusters and Multi-AZ DB clusters * **EngineVersion** (*string*) -- The version of the database engine to use for the new DB cluster. If you don't specify an engine version, the default version for the database engine in the Amazon Web Services Region is used. To list all of the available engine versions for Aurora MySQL, use the following command: "aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"" To list all of the available engine versions for Aurora PostgreSQL, use the following command: "aws rds describe-db-engine-versions --engine aurora- postgresql --query "DBEngineVersions[].EngineVersion"" To list all of the available engine versions for RDS for MySQL, use the following command: "aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"" To list all of the available engine versions for RDS for PostgreSQL, use the following command: "aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"" **Aurora MySQL** See Database engine updates for Amazon Aurora MySQL in the *Amazon Aurora User Guide*. **Aurora PostgreSQL** See Amazon Aurora PostgreSQL releases and engine versions in the *Amazon Aurora User Guide*. **MySQL** See Amazon RDS for MySQL in the *Amazon RDS User Guide.* **PostgreSQL** See Amazon RDS for PostgreSQL versions and extensions in the *Amazon RDS User Guide.* Valid for: Aurora DB clusters and Multi-AZ DB clusters * **Port** (*integer*) -- The port number on which the new DB cluster accepts connections. Constraints: This value must be "1150-65535" Default: The same port as the original DB cluster. Valid for: Aurora DB clusters and Multi-AZ DB clusters * **DBSubnetGroupName** (*string*) -- The name of the DB subnet group to use for the new DB cluster. Constraints: If supplied, must match the name of an existing DB subnet group. Example: "mydbsubnetgroup" Valid for: Aurora DB clusters and Multi-AZ DB clusters * **DatabaseName** (*string*) -- The database name for the restored DB cluster. Valid for: Aurora DB clusters and Multi-AZ DB clusters * **OptionGroupName** (*string*) -- The name of the option group to use for the restored DB cluster. DB clusters are associated with a default option group that can't be modified. * **VpcSecurityGroupIds** (*list*) -- A list of VPC security groups that the new DB cluster will belong to. Valid for: Aurora DB clusters and Multi-AZ DB clusters * *(string) --* * **Tags** (*list*) -- The tags to be assigned to the restored DB cluster. Valid for: Aurora DB clusters and Multi-AZ DB clusters * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **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}_.:/=+\-@]*)$"). * **KmsKeyId** (*string*) -- The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN. When you don't specify a value for the "KmsKeyId" parameter, then the following occurs: * If the DB snapshot or DB cluster snapshot in "SnapshotIdentifier" is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot. * If the DB snapshot or DB cluster snapshot in "SnapshotIdentifier" isn't encrypted, then the restored DB cluster isn't encrypted. Valid for: Aurora DB clusters and Multi-AZ DB clusters * **EnableIAMDatabaseAuthentication** (*boolean*) -- Specifies whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled. For more information, see IAM Database Authentication in the *Amazon Aurora User Guide* or IAM database authentication for MariaDB, MySQL, and PostgreSQL in the *Amazon RDS User Guide*. Valid for: Aurora DB clusters and Multi-AZ DB clusters * **BacktrackWindow** (*integer*) -- The target backtrack window, in seconds. To disable backtracking, set this value to 0. Note: Currently, Backtrack is only supported for Aurora MySQL DB clusters. Default: 0 Constraints: * If specified, this value must be set to a number from 0 to 259,200 (72 hours). Valid for: Aurora DB clusters only * **EnableCloudwatchLogsExports** (*list*) -- The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the list depend on the DB engine being used. **RDS for MySQL** Possible values are "error", "general", "slowquery", and "iam- db-auth-error". **RDS for PostgreSQL** Possible values are "postgresql", "upgrade", and "iam-db-auth- error". **Aurora MySQL** Possible values are "audit", "error", "general", "instance", "slowquery", and "iam-db-auth-error". **Aurora PostgreSQL** Possible value are "instance", "postgresql", and "iam-db-auth- error". For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the *Amazon RDS User Guide*. For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the *Amazon Aurora User Guide*. Valid for: Aurora DB clusters and Multi-AZ DB clusters * *(string) --* * **EngineMode** (*string*) -- The DB engine mode of the DB cluster, either "provisioned" or "serverless". For more information, see CreateDBCluster. Valid for: Aurora DB clusters only * **ScalingConfiguration** (*dict*) -- For DB clusters in "serverless" DB engine mode, the scaling properties of the DB cluster. Valid for: Aurora DB clusters only * **MinCapacity** *(integer) --* 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. * **MaxCapacity** *(integer) --* 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. * **AutoPause** *(boolean) --* 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. * **SecondsUntilAutoPause** *(integer) --* The time, in seconds, before an Aurora DB cluster in "serverless" mode is paused. Specify a value between 300 and 86,400 seconds. * **TimeoutAction** *(string) --* 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 v1 from finding a scaling point might be dropped. For more information, see Autoscaling for Aurora Serverless v1 in the *Amazon Aurora User Guide*. * **SecondsBeforeTimeout** *(integer) --* The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300. Specify a value between 60 and 600 seconds. * **DBClusterParameterGroupName** (*string*) -- 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: * If supplied, must match the name of an existing default DB cluster parameter group. * Must be 1 to 255 letters, numbers, or hyphens. * First character must be a letter. * Can't end with a hyphen or contain two consecutive hyphens. Valid for: Aurora DB clusters and Multi-AZ DB clusters * **DeletionProtection** (*boolean*) -- Specifies whether to enable deletion protection for the DB cluster. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. Valid for: Aurora DB clusters and Multi-AZ DB clusters * **CopyTagsToSnapshot** (*boolean*) -- Specifies whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them. Valid for: Aurora DB clusters and Multi-AZ DB clusters * **Domain** (*string*) -- The Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain. For more information, see Kerberos Authentication in the *Amazon RDS User Guide*. Valid for: Aurora DB clusters only * **DomainIAMRoleName** (*string*) -- The name of the IAM role to be used when making API calls to the Directory Service. Valid for: Aurora DB clusters only * **DBClusterInstanceClass** (*string*) -- The compute and memory capacity of the each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the *Amazon RDS User Guide.* Valid for: Multi-AZ DB clusters only * **StorageType** (*string*) -- Specifies the storage type to be associated with the DB cluster. When specified for a Multi-AZ DB cluster, a value for the "Iops" parameter is required. Valid Values: "aurora", "aurora-iopt1" (Aurora DB clusters); "io1" (Multi-AZ DB clusters) Default: "aurora" (Aurora DB clusters); "io1" (Multi-AZ DB clusters) Valid for: Aurora DB clusters and Multi-AZ DB clusters * **Iops** (*integer*) -- The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster. For information about valid IOPS values, see Amazon RDS Provisioned IOPS storage in the *Amazon RDS User Guide*. Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB instance. Valid for: Aurora DB clusters and Multi-AZ DB clusters * **PubliclyAccessible** (*boolean*) -- Specifies whether the DB cluster is publicly accessible. When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB cluster doesn't permit it. When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address. Default: The default behavior varies depending on whether "DBSubnetGroupName" is specified. If "DBSubnetGroupName" isn't specified, and "PubliclyAccessible" isn't specified, the following applies: * If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private. * If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public. If "DBSubnetGroupName" is specified, and "PubliclyAccessible" isn't specified, the following applies: * If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private. * If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public. Valid for: Aurora DB clusters and Multi-AZ DB clusters * **ServerlessV2ScalingConfiguration** (*dict*) -- Contains the scaling configuration of an Aurora Serverless v2 DB cluster. For more information, see Using Amazon Aurora Serverless v2 in the *Amazon Aurora User Guide*. * **MinCapacity** *(float) --* The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. For Aurora versions that support the Aurora Serverless v2 auto-pause feature, the smallest value that you can use is 0. For versions that don't support Aurora Serverless v2 auto-pause, the smallest value that you can use is 0.5. * **MaxCapacity** *(float) --* The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 32, 32.5, 33, and so on. The largest value that you can use is 256 for recent Aurora versions, or 128 for older versions. You can check the attributes of your engine version or platform version to determine the specific maximum capacity supported. * **SecondsUntilAutoPause** *(integer) --* Specifies the number of seconds an Aurora Serverless v2 DB instance must be idle before Aurora attempts to automatically pause it. Specify a value between 300 seconds (five minutes) and 86,400 seconds (one day). The default is 300 seconds. * **NetworkType** (*string*) -- The network type of the DB cluster. Valid Values: * "IPV4" * "DUAL" The network type is determined by the "DBSubnetGroup" specified for the DB cluster. A "DBSubnetGroup" can support only the IPv4 protocol or the IPv4 and the IPv6 protocols ( "DUAL"). For more information, see Working with a DB instance in a VPC in the *Amazon Aurora User Guide.* Valid for: Aurora DB clusters only * **RdsCustomClusterConfiguration** (*dict*) -- Reserved for future use. * **InterconnectSubnetId** *(string) --* Reserved for future use. * **TransitGatewayMulticastDomainId** *(string) --* Reserved for future use. * **ReplicaMode** *(string) --* Reserved for future use. * **MonitoringInterval** (*integer*) -- The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify "0". If "MonitoringRoleArn" is specified, also set "MonitoringInterval" to a value other than "0". Valid Values: "0 | 1 | 5 | 10 | 15 | 30 | 60" Default: "0" * **MonitoringRoleArn** (*string*) -- The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example is "arn:aws:iam:123456789012:role/emaccess". If "MonitoringInterval" is set to a value other than "0", supply a "MonitoringRoleArn" value. * **EnablePerformanceInsights** (*boolean*) -- Specifies whether to turn on Performance Insights for the DB cluster. * **PerformanceInsightsKMSKeyId** (*string*) -- The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you don't specify a value for "PerformanceInsightsKMSKeyId", then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region. * **PerformanceInsightsRetentionPeriod** (*integer*) -- The number of days to retain Performance Insights data. Valid Values: * "7" * *month* * 31, where *month* is a number of months from 1-23. Examples: "93" (3 months * 31), "341" (11 months * 31), "589" (19 months * 31) * "731" Default: "7" days If you specify a retention period that isn't valid, such as "94", Amazon RDS issues an error. * **EngineLifecycleSupport** (*string*) -- The life cycle type for this DB cluster. Note: By default, this value is set to "open-source-rds-extended- support", which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to "open-source-rds-extended-support-disabled". In this case, RDS automatically upgrades your restored DB cluster to a higher engine version, if the major engine version is past its end of standard support date. You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections: * Amazon Aurora - Amazon RDS Extended Support with Amazon Aurora in the *Amazon Aurora User Guide* * Amazon RDS - Amazon RDS Extended Support with Amazon RDS in the *Amazon RDS User Guide* Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters Valid Values: "open-source-rds-extended-support | open-source- rds-extended-support-disabled" Default: "open-source-rds-extended-support" Return type: dict Returns: **Response Syntax** { 'DBCluster': { 'AllocatedStorage': 123, 'AvailabilityZones': [ 'string', ], 'BackupRetentionPeriod': 123, 'CharacterSetName': 'string', 'DatabaseName': 'string', 'DBClusterIdentifier': 'string', 'DBClusterParameterGroup': 'string', 'DBSubnetGroup': 'string', 'Status': 'string', 'AutomaticRestartTime': datetime(2015, 1, 1), 'PercentProgress': 'string', 'EarliestRestorableTime': datetime(2015, 1, 1), 'Endpoint': 'string', 'ReaderEndpoint': 'string', 'CustomEndpoints': [ 'string', ], 'MultiAZ': True|False, 'Engine': 'string', 'EngineVersion': 'string', 'LatestRestorableTime': datetime(2015, 1, 1), 'Port': 123, 'MasterUsername': 'string', 'DBClusterOptionGroupMemberships': [ { 'DBClusterOptionGroupName': 'string', 'Status': 'string' }, ], 'PreferredBackupWindow': 'string', 'PreferredMaintenanceWindow': 'string', 'ReplicationSourceIdentifier': 'string', 'ReadReplicaIdentifiers': [ 'string', ], 'StatusInfos': [ { 'StatusType': 'string', 'Normal': True|False, 'Status': 'string', 'Message': 'string' }, ], 'DBClusterMembers': [ { 'DBInstanceIdentifier': 'string', 'IsClusterWriter': True|False, 'DBClusterParameterGroupStatus': 'string', 'PromotionTier': 123 }, ], 'VpcSecurityGroups': [ { 'VpcSecurityGroupId': 'string', 'Status': 'string' }, ], 'HostedZoneId': 'string', 'StorageEncrypted': True|False, 'KmsKeyId': 'string', 'DbClusterResourceId': 'string', 'DBClusterArn': 'string', 'AssociatedRoles': [ { 'RoleArn': 'string', 'Status': 'string', 'FeatureName': 'string' }, ], 'IAMDatabaseAuthenticationEnabled': True|False, 'CloneGroupId': 'string', 'ClusterCreateTime': datetime(2015, 1, 1), 'EarliestBacktrackTime': datetime(2015, 1, 1), 'BacktrackWindow': 123, 'BacktrackConsumedChangeRecords': 123, 'EnabledCloudwatchLogsExports': [ 'string', ], 'Capacity': 123, 'EngineMode': 'string', 'ScalingConfigurationInfo': { 'MinCapacity': 123, 'MaxCapacity': 123, 'AutoPause': True|False, 'SecondsUntilAutoPause': 123, 'TimeoutAction': 'string', 'SecondsBeforeTimeout': 123 }, 'RdsCustomClusterConfiguration': { 'InterconnectSubnetId': 'string', 'TransitGatewayMulticastDomainId': 'string', 'ReplicaMode': 'open-read-only'|'mounted' }, 'DeletionProtection': True|False, 'HttpEndpointEnabled': True|False, 'ActivityStreamMode': 'sync'|'async', 'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping', 'ActivityStreamKmsKeyId': 'string', 'ActivityStreamKinesisStreamName': 'string', 'CopyTagsToSnapshot': True|False, 'CrossAccountClone': True|False, 'DomainMemberships': [ { 'Domain': 'string', 'Status': 'string', 'FQDN': 'string', 'IAMRoleName': 'string', 'OU': 'string', 'AuthSecretArn': 'string', 'DnsIps': [ 'string', ] }, ], 'TagList': [ { 'Key': 'string', 'Value': 'string' }, ], 'GlobalClusterIdentifier': 'string', 'GlobalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'unknown', 'GlobalWriteForwardingRequested': True|False, 'PendingModifiedValues': { 'PendingCloudwatchLogsExports': { 'LogTypesToEnable': [ 'string', ], 'LogTypesToDisable': [ 'string', ] }, 'DBClusterIdentifier': 'string', 'MasterUserPassword': 'string', 'IAMDatabaseAuthenticationEnabled': True|False, 'EngineVersion': 'string', 'BackupRetentionPeriod': 123, 'AllocatedStorage': 123, 'RdsCustomClusterConfiguration': { 'InterconnectSubnetId': 'string', 'TransitGatewayMulticastDomainId': 'string', 'ReplicaMode': 'open-read-only'|'mounted' }, 'Iops': 123, 'StorageType': 'string', 'CertificateDetails': { 'CAIdentifier': 'string', 'ValidTill': datetime(2015, 1, 1) } }, 'DBClusterInstanceClass': 'string', 'StorageType': 'string', 'Iops': 123, 'PubliclyAccessible': True|False, 'AutoMinorVersionUpgrade': True|False, 'MonitoringInterval': 123, 'MonitoringRoleArn': 'string', 'DatabaseInsightsMode': 'standard'|'advanced', 'PerformanceInsightsEnabled': True|False, 'PerformanceInsightsKMSKeyId': 'string', 'PerformanceInsightsRetentionPeriod': 123, 'ServerlessV2ScalingConfiguration': { 'MinCapacity': 123.0, 'MaxCapacity': 123.0, 'SecondsUntilAutoPause': 123 }, 'ServerlessV2PlatformVersion': 'string', 'NetworkType': 'string', 'DBSystemId': 'string', 'MasterUserSecret': { 'SecretArn': 'string', 'SecretStatus': 'string', 'KmsKeyId': 'string' }, 'IOOptimizedNextAllowedModificationTime': datetime(2015, 1, 1), 'LocalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'requested', 'AwsBackupRecoveryPointArn': 'string', 'LimitlessDatabase': { 'Status': 'active'|'not-in-use'|'enabled'|'disabled'|'enabling'|'disabling'|'modifying-max-capacity'|'error', 'MinRequiredACU': 123.0 }, 'StorageThroughput': 123, 'ClusterScalabilityType': 'standard'|'limitless', 'CertificateDetails': { 'CAIdentifier': 'string', 'ValidTill': datetime(2015, 1, 1) }, 'EngineLifecycleSupport': 'string' } } **Response Structure** * *(dict) --* * **DBCluster** *(dict) --* Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster. For an Amazon Aurora DB cluster, this data type is used as a response element in the operations "CreateDBCluster", "DeleteDBCluster", "DescribeDBClusters", "FailoverDBCluster", "ModifyDBCluster", "PromoteReadReplicaDBCluster", "RestoreDBClusterFromS3", "RestoreDBClusterFromSnapshot", "RestoreDBClusterToPointInTime", "StartDBCluster", and "StopDBCluster". For a Multi-AZ DB cluster, this data type is used as a response element in the operations "CreateDBCluster", "DeleteDBCluster", "DescribeDBClusters", "FailoverDBCluster", "ModifyDBCluster", "RebootDBCluster", "RestoreDBClusterFromSnapshot", and "RestoreDBClusterToPointInTime". For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the *Amazon Aurora User Guide.* For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the *Amazon RDS User Guide.* * **AllocatedStorage** *(integer) --* "AllocatedStorage" specifies the allocated storage size in gibibytes (GiB). For Aurora, "AllocatedStorage" can vary because Aurora DB cluster storage size adjusts as needed. * **AvailabilityZones** *(list) --* The list of Availability Zones (AZs) where instances in the DB cluster can be created. * *(string) --* * **BackupRetentionPeriod** *(integer) --* 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) --* The name of the initial database that was specified for the DB cluster when it was created, if one was provided. This same name is returned for the life of the DB cluster. * **DBClusterIdentifier** *(string) --* The user-supplied identifier for the DB cluster. This identifier is the unique key that identifies a DB cluster. * **DBClusterParameterGroup** *(string) --* The name of the DB cluster parameter group for the DB cluster. * **DBSubnetGroup** *(string) --* Information about the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group. * **Status** *(string) --* The current state of this DB cluster. * **AutomaticRestartTime** *(datetime) --* The time when a stopped DB cluster is restarted automatically. * **PercentProgress** *(string) --* 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) --* 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) --* The custom endpoints associated with the DB cluster. * *(string) --* * **MultiAZ** *(boolean) --* Indicates whether the DB cluster has instances in multiple Availability Zones. * **Engine** *(string) --* The database engine used for this DB cluster. * **EngineVersion** *(string) --* The version of the database engine. * **LatestRestorableTime** *(datetime) --* The latest time to which a database can be restored with point-in-time restore. * **Port** *(integer) --* The port that the database engine is listening on. * **MasterUsername** *(string) --* The master username for the DB cluster. * **DBClusterOptionGroupMemberships** *(list) --* 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) --* The daily time range during which automated backups are created if automated backups are enabled, as determined by the "BackupRetentionPeriod". * **PreferredMaintenanceWindow** *(string) --* The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). * **ReplicationSourceIdentifier** *(string) --* The identifier of the source DB cluster if this DB cluster is a read replica. * **ReadReplicaIdentifiers** *(list) --* Contains one or more identifiers of the read replicas associated with this DB cluster. * *(string) --* * **StatusInfos** *(list) --* Reserved for future use. * *(dict) --* Reserved for future use. * **StatusType** *(string) --* Reserved for future use. * **Normal** *(boolean) --* Reserved for future use. * **Status** *(string) --* Reserved for future use. * **Message** *(string) --* Reserved for future use. * **DBClusterMembers** *(list) --* The list of DB 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) --* Indicates whether the cluster member is the primary DB instance for the DB cluster. * **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) --* The list of VPC security groups that the DB cluster belongs to. * *(dict) --* This data type is used as a response element for queries on VPC security group membership. * **VpcSecurityGroupId** *(string) --* The name of the VPC security group. * **Status** *(string) --* The membership status of the VPC security group. Currently, the only valid status is "active". * **HostedZoneId** *(string) --* The ID that Amazon Route 53 assigns when you create a hosted zone. * **StorageEncrypted** *(boolean) --* Indicates whether the DB cluster is encrypted. * **KmsKeyId** *(string) --* If "StorageEncrypted" is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. * **DbClusterResourceId** *(string) --* The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the KMS key for the DB cluster is accessed. * **DBClusterArn** *(string) --* The Amazon Resource Name (ARN) for the DB cluster. * **AssociatedRoles** *(list) --* A list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf. * *(dict) --* Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB cluster. * **RoleArn** *(string) --* The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster. * **Status** *(string) --* Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values: * "ACTIVE" - the IAM role ARN is associated with the DB cluster and can be used to access other Amazon Web Services on your behalf. * "PENDING" - the IAM role ARN is being associated with the DB cluster. * "INVALID" - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other Amazon Web Services on your behalf. * **FeatureName** *(string) --* The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion. * **IAMDatabaseAuthenticationEnabled** *(boolean) --* Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled. * **CloneGroupId** *(string) --* The ID of the clone group with which the DB cluster is associated. For newly created clusters, the ID is typically null. If you clone a DB cluster when the ID is null, the operation populates the ID value for the source cluster and the clone because both clusters become part of the same clone group. Even if you delete the clone cluster, the clone group ID remains for the lifetime of the source cluster to show that it was used in a cloning operation. For PITR, the clone group ID is inherited from the source cluster. For snapshot restore operations, the clone group ID isn't inherited from the source cluster. * **ClusterCreateTime** *(datetime) --* 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.* * *(string) --* * **Capacity** *(integer) --* The current capacity of an Aurora Serverless v1 DB cluster. The capacity is "0" (zero) when the cluster is paused. For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the *Amazon Aurora User Guide*. * **EngineMode** *(string) --* The DB engine mode of the DB cluster, either "provisioned" or "serverless". For more information, see CreateDBCluster. * **ScalingConfigurationInfo** *(dict) --* The scaling configuration for an Aurora DB cluster in "serverless" DB engine mode. For more information, see Using Amazon Aurora Serverless v1 in the *Amazon Aurora User Guide*. * **MinCapacity** *(integer) --* The minimum capacity for an Aurora DB cluster in "serverless" DB engine mode. * **MaxCapacity** *(integer) --* The maximum capacity for an Aurora DB cluster in "serverless" DB engine mode. * **AutoPause** *(boolean) --* Indicates whether automatic pause is allowed for the Aurora DB cluster in "serverless" DB engine mode. When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes. * **SecondsUntilAutoPause** *(integer) --* The remaining amount of time, in seconds, before the Aurora DB cluster in "serverless" mode is paused. A DB cluster can be paused only when it's idle (it has no connections). * **TimeoutAction** *(string) --* The action that occurs when Aurora times out while attempting to change the capacity of an Aurora Serverless v1 cluster. The value is either "ForceApplyCapacityChange" or "RollbackCapacityChange". "ForceApplyCapacityChange", the default, sets the capacity to the specified value as soon as possible. "RollbackCapacityChange" ignores the capacity change if a scaling point isn't found in the timeout period. * **SecondsBeforeTimeout** *(integer) --* The number of seconds before scaling times out. What happens when an attempted scaling action times out is determined by the "TimeoutAction" setting. * **RdsCustomClusterConfiguration** *(dict) --* Reserved for future use. * **InterconnectSubnetId** *(string) --* Reserved for future use. * **TransitGatewayMulticastDomainId** *(string) --* Reserved for future use. * **ReplicaMode** *(string) --* Reserved for future use. * **DeletionProtection** *(boolean) --* Indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. * **HttpEndpointEnabled** *(boolean) --* Indicates whether the HTTP endpoint is enabled for an Aurora DB cluster. When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the DB cluster. You can also query your database from inside the RDS console with the RDS query editor. For more information, see Using RDS Data API in the *Amazon Aurora User Guide*. * **ActivityStreamMode** *(string) --* The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously. * **ActivityStreamStatus** *(string) --* The status of the database activity stream. * **ActivityStreamKmsKeyId** *(string) --* The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. * **ActivityStreamKinesisStreamName** *(string) --* The name of the Amazon Kinesis data stream used for the database activity stream. * **CopyTagsToSnapshot** *(boolean) --* Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster. * **CrossAccountClone** *(boolean) --* Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account. * **DomainMemberships** *(list) --* The Active Directory Domain membership records associated with the DB cluster. * *(dict) --* An Active Directory Domain membership record associated with the DB instance or cluster. * **Domain** *(string) --* The identifier of the Active Directory Domain. * **Status** *(string) --* The status of the Active Directory Domain membership for the DB instance or cluster. Values include "joined", "pending-join", "failed", and so on. * **FQDN** *(string) --* The fully qualified domain name (FQDN) of the Active Directory Domain. * **IAMRoleName** *(string) --* The name of the IAM role used when making API calls to the Directory Service. * **OU** *(string) --* The Active Directory organizational unit for the DB instance or cluster. * **AuthSecretArn** *(string) --* The ARN for the Secrets Manager secret with the credentials for the user that's a member of the domain. * **DnsIps** *(list) --* The IPv4 DNS IP addresses of the primary and secondary Active Directory domain controllers. * *(string) --* * **TagList** *(list) --* A list of tags. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **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}_.:/=+\-@]*)$"). * **GlobalClusterIdentifier** *(string) --* Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster. * **GlobalWriteForwardingStatus** *(string) --* The status of write forwarding for a secondary cluster in an Aurora global database. * **GlobalWriteForwardingRequested** *(boolean) --* Indicates whether write forwarding is enabled for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of "GlobalWriteForwardingStatus" to confirm that the request has completed before using the write forwarding feature for this cluster. * **PendingModifiedValues** *(dict) --* Information about pending changes to the DB cluster. This information is returned only when there are pending changes. Specific changes are identified by subelements. * **PendingCloudwatchLogsExports** *(dict) --* A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated. * **LogTypesToEnable** *(list) --* Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs. * *(string) --* * **LogTypesToDisable** *(list) --* Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs. * *(string) --* * **DBClusterIdentifier** *(string) --* The DBClusterIdentifier value for the DB cluster. * **MasterUserPassword** *(string) --* The master credentials for the DB cluster. * **IAMDatabaseAuthenticationEnabled** *(boolean) --* Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled. * **EngineVersion** *(string) --* The database engine version. * **BackupRetentionPeriod** *(integer) --* The number of days for which automatic DB snapshots are retained. * **AllocatedStorage** *(integer) --* The allocated storage size in gibibytes (GiB) for all database engines except Amazon Aurora. For Aurora, "AllocatedStorage" always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed. * **RdsCustomClusterConfiguration** *(dict) --* Reserved for future use. * **InterconnectSubnetId** *(string) --* Reserved for future use. * **TransitGatewayMulticastDomainId** *(string) --* Reserved for future use. * **ReplicaMode** *(string) --* Reserved for future use. * **Iops** *(integer) --* The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters. * **StorageType** *(string) --* The storage type for the DB cluster. * **CertificateDetails** *(dict) --* The details of the DB instance’s server certificate. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the *Amazon RDS User Guide* and Using SSL/TLS to encrypt a connection to a DB cluster in the *Amazon Aurora User Guide*. * **CAIdentifier** *(string) --* The CA identifier of the CA certificate used for the DB instance's server certificate. * **ValidTill** *(datetime) --* The expiration date of the DB instance’s server certificate. * **DBClusterInstanceClass** *(string) --* The name of the compute and memory capacity class of the DB instance. This setting is only for non-Aurora Multi-AZ DB clusters. * **StorageType** *(string) --* The storage type associated with the DB cluster. * **Iops** *(integer) --* The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters. * **PubliclyAccessible** *(boolean) --* Indicates whether the DB cluster is publicly accessible. When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it. When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address. For more information, see CreateDBCluster. This setting is only for non-Aurora Multi-AZ DB clusters. * **AutoMinorVersionUpgrade** *(boolean) --* Indicates whether minor version patches are applied automatically. This setting is for Aurora DB clusters and Multi-AZ DB clusters. For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version. * **MonitoringInterval** *(integer) --* The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. This setting is only for -Aurora DB clusters and Multi-AZ DB clusters. * **MonitoringRoleArn** *(string) --* The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. This setting is only for Aurora DB clusters and Multi-AZ DB clusters. * **DatabaseInsightsMode** *(string) --* The mode of Database Insights that is enabled for the DB cluster. * **PerformanceInsightsEnabled** *(boolean) --* Indicates whether Performance Insights is enabled for the DB cluster. This setting is only for Aurora DB clusters and Multi-AZ DB clusters. * **PerformanceInsightsKMSKeyId** *(string) --* The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. This setting is only for Aurora DB clusters and Multi-AZ DB clusters. * **PerformanceInsightsRetentionPeriod** *(integer) --* The number of days to retain Performance Insights data. This setting is only for Aurora DB clusters and Multi-AZ DB clusters. Valid Values: * "7" * *month* * 31, where *month* is a number of months from 1-23. Examples: "93" (3 months * 31), "341" (11 months * 31), "589" (19 months * 31) * "731" Default: "7" days * **ServerlessV2ScalingConfiguration** *(dict) --* The scaling configuration for an Aurora Serverless v2 DB cluster. For more information, see Using Amazon Aurora Serverless v2 in the *Amazon Aurora User Guide*. * **MinCapacity** *(float) --* The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. For Aurora versions that support the Aurora Serverless v2 auto-pause feature, the smallest value that you can use is 0. For versions that don't support Aurora Serverless v2 auto-pause, the smallest value that you can use is 0.5. * **MaxCapacity** *(float) --* The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 32, 32.5, 33, and so on. The largest value that you can use is 256 for recent Aurora versions, or 128 for older versions. You can check the attributes of your engine version or platform version to determine the specific maximum capacity supported. * **SecondsUntilAutoPause** *(integer) --* The number of seconds an Aurora Serverless v2 DB instance must be idle before Aurora attempts to automatically pause it. This property is only shown when the minimum capacity for the cluster is set to 0 ACUs. Changing the minimum capacity to a nonzero value removes this property. If you later change the minimum capacity back to 0 ACUs, this property is reset to its default value unless you specify it again. This value ranges between 300 seconds (five minutes) and 86,400 seconds (one day). The default is 300 seconds. * **ServerlessV2PlatformVersion** *(string) --* The version of the Aurora Serverless V2 platform used by the DB cluster. For more information, see Using Aurora Serverless v2 in the *Amazon Aurora User Guide*. * **NetworkType** *(string) --* The network type of the DB instance. The network type is determined by the "DBSubnetGroup" specified for the DB cluster. A "DBSubnetGroup" can support only the IPv4 protocol or the IPv4 and the IPv6 protocols ( "DUAL"). For more information, see Working with a DB instance in a VPC in the *Amazon Aurora User Guide.* This setting is only for Aurora DB clusters. Valid Values: "IPV4 | DUAL" * **DBSystemId** *(string) --* Reserved for future use. * **MasterUserSecret** *(dict) --* The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password. For more information, see Password management with Amazon Web Services Secrets Manager in the *Amazon RDS User Guide* and Password management with Amazon Web Services Secrets Manager in the *Amazon Aurora User Guide.* * **SecretArn** *(string) --* The Amazon Resource Name (ARN) of the secret. * **SecretStatus** *(string) --* The status of the secret. The possible status values include the following: * "creating" - The secret is being created. * "active" - The secret is available for normal use and rotation. * "rotating" - The secret is being rotated. * "impaired" - The secret can be used to access database credentials, but it can't be rotated. A secret might have this status if, for example, permissions are changed so that RDS can no longer access either the secret or the KMS key for the secret. When a secret has this status, you can correct the condition that caused the status. Alternatively, modify the DB instance to turn off automatic management of database credentials, and then modify the DB instance again to turn on automatic management of database credentials. * **KmsKeyId** *(string) --* The Amazon Web Services KMS key identifier that is used to encrypt the secret. * **IOOptimizedNextAllowedModificationTime** *(datetime) --* The next time you can modify the DB cluster to use the "aurora-iopt1" storage type. This setting is only for Aurora DB clusters. * **LocalWriteForwardingStatus** *(string) --* Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it. * **AwsBackupRecoveryPointArn** *(string) --* The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup. * **LimitlessDatabase** *(dict) --* The details for Aurora Limitless Database. * **Status** *(string) --* The status of Aurora Limitless Database. * **MinRequiredACU** *(float) --* The minimum required capacity for Aurora Limitless Database in Aurora capacity units (ACUs). * **StorageThroughput** *(integer) --* The storage throughput for the DB cluster. The throughput is automatically set based on the IOPS that you provision, and is not configurable. This setting is only for non-Aurora Multi-AZ DB clusters. * **ClusterScalabilityType** *(string) --* The scalability mode of the Aurora DB cluster. When set to "limitless", the cluster operates as an Aurora Limitless Database. When set to "standard" (the default), the cluster uses normal DB instance creation. * **CertificateDetails** *(dict) --* The details of the DB instance’s server certificate. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the *Amazon RDS User Guide* and Using SSL/TLS to encrypt a connection to a DB cluster in the *Amazon Aurora User Guide*. * **CAIdentifier** *(string) --* The CA identifier of the CA certificate used for the DB instance's server certificate. * **ValidTill** *(datetime) --* The expiration date of the DB instance’s server certificate. * **EngineLifecycleSupport** *(string) --* The lifecycle type for the DB cluster. For more information, see CreateDBCluster. **Exceptions** * "RDS.Client.exceptions.DBClusterAlreadyExistsFault" * "RDS.Client.exceptions.DBClusterQuotaExceededFault" * "RDS.Client.exceptions.StorageQuotaExceededFault" * "RDS.Client.exceptions.DBSubnetGroupNotFoundFault" * "RDS.Client.exceptions.DBSnapshotNotFoundFault" * "RDS.Client.exceptions.DBClusterSnapshotNotFoundFault" * "RDS.Client.exceptions.InsufficientDBClusterCapacityFault" * "RDS.Client.exceptions.InsufficientStorageClusterCapacityFault" * "RDS.Client.exceptions.InvalidDBSnapshotStateFault" * "RDS.Client.exceptions.InvalidDBClusterSnapshotStateFault" * "RDS.Client.exceptions.StorageQuotaExceededFault" * "RDS.Client.exceptions.InvalidVPCNetworkStateFault" * "RDS.Client.exceptions.DBSubnetGroupDoesNotCoverEnoughAZs" * "RDS.Client.exceptions.InvalidRestoreFault" * "RDS.Client.exceptions.DBSubnetGroupNotFoundFault" * "RDS.Client.exceptions.InvalidSubnet" * "RDS.Client.exceptions.OptionGroupNotFoundFault" * "RDS.Client.exceptions.KMSKeyNotAccessibleFault" * "RDS.Client.exceptions.DomainNotFoundFault" * "RDS.Client.exceptions.DBClusterParameterGroupNotFoundFault" * "RDS.Client.exceptions.InvalidDBInstanceStateFault" * "RDS.Client.exceptions.InsufficientDBInstanceCapacityFault" **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: { 'DBCluster': { }, 'ResponseMetadata': { '...': '...', }, } RDS / Client / modify_integration modify_integration ****************** RDS.Client.modify_integration(**kwargs) Modifies a zero-ETL integration with Amazon Redshift. See also: AWS API Documentation **Request Syntax** response = client.modify_integration( IntegrationIdentifier='string', IntegrationName='string', DataFilter='string', Description='string' ) Parameters: * **IntegrationIdentifier** (*string*) -- **[REQUIRED]** The unique identifier of the integration to modify. * **IntegrationName** (*string*) -- A new name for the integration. * **DataFilter** (*string*) -- A new data filter for the integration. For more information, see Data filtering for Aurora zero-ETL integrations with Amazon Redshift or Data filtering for Amazon RDS zero-ETL integrations with Amazon Redshift. * **Description** (*string*) -- A new description for the integration. Return type: dict Returns: **Response Syntax** { 'SourceArn': 'string', 'TargetArn': 'string', 'IntegrationName': 'string', 'IntegrationArn': 'string', 'KMSKeyId': 'string', 'AdditionalEncryptionContext': { 'string': 'string' }, 'Status': 'creating'|'active'|'modifying'|'failed'|'deleting'|'syncing'|'needs_attention', 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'CreateTime': datetime(2015, 1, 1), 'Errors': [ { 'ErrorCode': 'string', 'ErrorMessage': 'string' }, ], 'DataFilter': 'string', 'Description': 'string' } **Response Structure** * *(dict) --* A zero-ETL integration with Amazon Redshift. * **SourceArn** *(string) --* The Amazon Resource Name (ARN) of the database used as the source for replication. * **TargetArn** *(string) --* The ARN of the Redshift data warehouse used as the target for replication. * **IntegrationName** *(string) --* The name of the integration. * **IntegrationArn** *(string) --* The ARN of the integration. * **KMSKeyId** *(string) --* The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key used to to encrypt the integration. * **AdditionalEncryptionContext** *(dict) --* The encryption context for the integration. For more information, see Encryption context in the *Amazon Web Services Key Management Service Developer Guide*. * *(string) --* * *(string) --* * **Status** *(string) --* The current status of the integration. * **Tags** *(list) --* A list of tags. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **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}_.:/=+\-@]*)$"). * **CreateTime** *(datetime) --* The time when the integration was created, in Universal Coordinated Time (UTC). * **Errors** *(list) --* Any errors associated with the integration. * *(dict) --* An error associated with a zero-ETL integration with Amazon Redshift. * **ErrorCode** *(string) --* The error code associated with the integration. * **ErrorMessage** *(string) --* A message explaining the error. * **DataFilter** *(string) --* Data filters for the integration. These filters determine which tables from the source database are sent to the target Amazon Redshift data warehouse. * **Description** *(string) --* A description of the integration. **Exceptions** * "RDS.Client.exceptions.IntegrationNotFoundFault" * "RDS.Client.exceptions.InvalidIntegrationStateFault" * "RDS.Client.exceptions.IntegrationConflictOperationFault" RDS / Client / describe_db_parameters describe_db_parameters ********************** RDS.Client.describe_db_parameters(**kwargs) Returns the detailed parameter list for a particular DB parameter group. See also: AWS API Documentation **Request Syntax** response = client.describe_db_parameters( DBParameterGroupName='string', Source='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], MaxRecords=123, Marker='string' ) Parameters: * **DBParameterGroupName** (*string*) -- **[REQUIRED]** The name of a specific DB parameter group to return details for. Constraints: * If supplied, must match the name of an existing DBParameterGroup. * **Source** (*string*) -- The parameter types to return. Default: All parameter types returned Valid Values: "user | system | engine-default" * **Filters** (*list*) -- A filter that specifies one or more DB parameters to describe. The only supported filter is "parameter-name". The results list only includes information about the DB parameters with these names. * *(dict) --* 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: * "DescribeDBClusterBacktracks" * "DescribeDBClusterEndpoints" * "DescribeDBClusters" * "DescribeDBInstances" * "DescribeDBRecommendations" * "DescribeDBShardGroups" * "DescribePendingMaintenanceActions" * **Name** *(string) --* **[REQUIRED]** The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* **[REQUIRED]** One or more filter values. Filter values are case- sensitive. * *(string) --* * **MaxRecords** (*integer*) -- 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. * **Marker** (*string*) -- An optional pagination token provided by a previous "DescribeDBParameters" request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by "MaxRecords". Return type: dict Returns: **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) --* The name of the parameter. * **ParameterValue** *(string) --* The value of the parameter. * **Description** *(string) --* Provides a description of the parameter. * **Source** *(string) --* 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. * *(string) --* * **Marker** *(string) --* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by "MaxRecords". **Exceptions** * "RDS.Client.exceptions.DBParameterGroupNotFoundFault" **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': { '...': '...', }, } RDS / Client / delete_db_cluster_automated_backup delete_db_cluster_automated_backup ********************************** RDS.Client.delete_db_cluster_automated_backup(**kwargs) Deletes automated backups using the "DbClusterResourceId" value of the source DB cluster or the Amazon Resource Name (ARN) of the automated backups. See also: AWS API Documentation **Request Syntax** response = client.delete_db_cluster_automated_backup( DbClusterResourceId='string' ) Parameters: **DbClusterResourceId** (*string*) -- **[REQUIRED]** The identifier for the source DB cluster, which can't be changed and which is unique to an Amazon Web Services Region. Return type: dict Returns: **Response Syntax** { 'DBClusterAutomatedBackup': { 'Engine': 'string', 'VpcId': 'string', 'DBClusterAutomatedBackupsArn': 'string', 'DBClusterIdentifier': 'string', 'RestoreWindow': { 'EarliestTime': datetime(2015, 1, 1), 'LatestTime': datetime(2015, 1, 1) }, 'MasterUsername': 'string', 'DbClusterResourceId': 'string', 'Region': 'string', 'LicenseModel': 'string', 'Status': 'string', 'IAMDatabaseAuthenticationEnabled': True|False, 'ClusterCreateTime': datetime(2015, 1, 1), 'StorageEncrypted': True|False, 'AllocatedStorage': 123, 'EngineVersion': 'string', 'DBClusterArn': 'string', 'BackupRetentionPeriod': 123, 'EngineMode': 'string', 'AvailabilityZones': [ 'string', ], 'Port': 123, 'KmsKeyId': 'string', 'StorageType': 'string', 'Iops': 123, 'AwsBackupRecoveryPointArn': 'string', 'StorageThroughput': 123 } } **Response Structure** * *(dict) --* * **DBClusterAutomatedBackup** *(dict) --* An automated backup of a DB cluster. It consists of system backups, transaction logs, and the database cluster properties that existed at the time you deleted the source cluster. * **Engine** *(string) --* The name of the database engine for this automated backup. * **VpcId** *(string) --* The VPC ID associated with the DB cluster. * **DBClusterAutomatedBackupsArn** *(string) --* The Amazon Resource Name (ARN) for the automated backups. * **DBClusterIdentifier** *(string) --* The identifier for the source DB cluster, which can't be changed and which is unique to an Amazon Web Services Region. * **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. * **MasterUsername** *(string) --* The master user name of the automated backup. * **DbClusterResourceId** *(string) --* The resource ID for the source DB cluster, which can't be changed and which is unique to an Amazon Web Services Region. * **Region** *(string) --* The Amazon Web Services Region associated with the automated backup. * **LicenseModel** *(string) --* The license model information for this DB cluster automated backup. * **Status** *(string) --* A list of status information for an automated backup: * "retained" - Automated backups for deleted clusters. * **IAMDatabaseAuthenticationEnabled** *(boolean) --* Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled. * **ClusterCreateTime** *(datetime) --* The time when the DB cluster was created, in Universal Coordinated Time (UTC). * **StorageEncrypted** *(boolean) --* Indicates whether the source DB cluster is encrypted. * **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. * **EngineVersion** *(string) --* The version of the database engine for the automated backup. * **DBClusterArn** *(string) --* The Amazon Resource Name (ARN) for the source DB cluster. * **BackupRetentionPeriod** *(integer) --* The retention period for the automated backups. * **EngineMode** *(string) --* The engine mode of the database engine for the automated backup. * **AvailabilityZones** *(list) --* The Availability Zones where instances in the DB cluster can be created. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones. * *(string) --* * **Port** *(integer) --* The port number that the automated backup used for connections. Default: Inherits from the source DB cluster Valid Values: "1150-65535" * **KmsKeyId** *(string) --* The Amazon Web Services KMS key ID for an automated backup. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. * **StorageType** *(string) --* The storage type associated with the DB cluster. This setting is only for non-Aurora Multi-AZ DB clusters. * **Iops** *(integer) --* The IOPS (I/O operations per second) value for the automated backup. This setting is only for non-Aurora Multi-AZ DB clusters. * **AwsBackupRecoveryPointArn** *(string) --* The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup. * **StorageThroughput** *(integer) --* The storage throughput for the automated backup. The throughput is automatically set based on the IOPS that you provision, and is not configurable. This setting is only for non-Aurora Multi-AZ DB clusters. **Exceptions** * "RDS.Client.exceptions.InvalidDBClusterAutomatedBackupStateFault" * "RDS.Client.exceptions.DBClusterAutomatedBackupNotFoundFault" RDS / Client / describe_db_log_files describe_db_log_files ********************* RDS.Client.describe_db_log_files(**kwargs) Returns a list of DB log files for the DB instance. This command doesn't apply to RDS Custom. See also: AWS API Documentation **Request Syntax** response = client.describe_db_log_files( DBInstanceIdentifier='string', FilenameContains='string', FileLastWritten=123, FileSize=123, Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], MaxRecords=123, Marker='string' ) Parameters: * **DBInstanceIdentifier** (*string*) -- **[REQUIRED]** The customer-assigned name of the DB instance that contains the log files you want to list. Constraints: * Must match the identifier of an existing DBInstance. * **FilenameContains** (*string*) -- Filters the available log files for log file names that contain the specified string. * **FileLastWritten** (*integer*) -- Filters the available log files for files written since the specified date, in POSIX timestamp format with milliseconds. * **FileSize** (*integer*) -- Filters the available log files for files larger than the specified size. * **Filters** (*list*) -- This parameter isn't currently supported. * *(dict) --* 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: * "DescribeDBClusterBacktracks" * "DescribeDBClusterEndpoints" * "DescribeDBClusters" * "DescribeDBInstances" * "DescribeDBRecommendations" * "DescribeDBShardGroups" * "DescribePendingMaintenanceActions" * **Name** *(string) --* **[REQUIRED]** The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* **[REQUIRED]** One or more filter values. Filter values are case- sensitive. * *(string) --* * **MaxRecords** (*integer*) -- 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. * **Marker** (*string*) -- The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords. Return type: dict Returns: **Response Syntax** { 'DescribeDBLogFiles': [ { 'LogFileName': 'string', 'LastWritten': 123, 'Size': 123 }, ], 'Marker': 'string' } **Response Structure** * *(dict) --* The response from a call to "DescribeDBLogFiles". * **DescribeDBLogFiles** *(list) --* The DB log files returned. * *(dict) --* This data type is used as a response element to "DescribeDBLogFiles". * **LogFileName** *(string) --* The name of the log file for the specified DB instance. * **LastWritten** *(integer) --* A POSIX timestamp when the last log entry was written. * **Size** *(integer) --* The size, in bytes, of the log file for the specified DB instance. * **Marker** *(string) --* A pagination token that can be used in a later "DescribeDBLogFiles" request. **Exceptions** * "RDS.Client.exceptions.DBInstanceNotFoundFault" * "RDS.Client.exceptions.DBInstanceNotReadyFault" **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': { '...': '...', }, } RDS / Client / modify_db_subnet_group modify_db_subnet_group ********************** RDS.Client.modify_db_subnet_group(**kwargs) Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region. See also: AWS API Documentation **Request Syntax** response = client.modify_db_subnet_group( DBSubnetGroupName='string', DBSubnetGroupDescription='string', SubnetIds=[ 'string', ] ) Parameters: * **DBSubnetGroupName** (*string*) -- **[REQUIRED]** The name for the DB subnet group. This value is stored as a lowercase string. You can't modify the default subnet group. Constraints: Must match the name of an existing DBSubnetGroup. Must not be default. Example: "mydbsubnetgroup" * **DBSubnetGroupDescription** (*string*) -- The description for the DB subnet group. * **SubnetIds** (*list*) -- **[REQUIRED]** The EC2 subnet IDs for the DB subnet group. * *(string) --* Return type: dict Returns: **Response Syntax** { 'DBSubnetGroup': { 'DBSubnetGroupName': 'string', 'DBSubnetGroupDescription': 'string', 'VpcId': 'string', 'SubnetGroupStatus': 'string', 'Subnets': [ { 'SubnetIdentifier': 'string', 'SubnetAvailabilityZone': { 'Name': 'string' }, 'SubnetOutpost': { 'Arn': 'string' }, 'SubnetStatus': 'string' }, ], 'DBSubnetGroupArn': 'string', 'SupportedNetworkTypes': [ 'string', ] } } **Response Structure** * *(dict) --* * **DBSubnetGroup** *(dict) --* Contains the details of an Amazon RDS DB subnet group. This data type is used as a response element in the "DescribeDBSubnetGroups" action. * **DBSubnetGroupName** *(string) --* The name of the DB subnet group. * **DBSubnetGroupDescription** *(string) --* Provides the description of the DB subnet group. * **VpcId** *(string) --* Provides the VpcId of the DB subnet group. * **SubnetGroupStatus** *(string) --* Provides the status of the DB subnet group. * **Subnets** *(list) --* Contains a list of "Subnet" elements. The list of subnets shown here might not reflect the current state of your VPC. For the most up-to-date information, we recommend checking your VPC configuration directly. * *(dict) --* This data type is used as a response element for the "DescribeDBSubnetGroups" operation. * **SubnetIdentifier** *(string) --* The identifier of the subnet. * **SubnetAvailabilityZone** *(dict) --* Contains Availability Zone information. This data type is used as an element in the "OrderableDBInstanceOption" data type. * **Name** *(string) --* The name of the Availability Zone. * **SubnetOutpost** *(dict) --* If the subnet is associated with an Outpost, this value specifies the Outpost. For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the *Amazon RDS User Guide.* * **Arn** *(string) --* The Amazon Resource Name (ARN) of the Outpost. * **SubnetStatus** *(string) --* The status of the subnet. * **DBSubnetGroupArn** *(string) --* The Amazon Resource Name (ARN) for the DB subnet group. * **SupportedNetworkTypes** *(list) --* The network type of the DB subnet group. Valid values: * "IPV4" * "DUAL" A "DBSubnetGroup" can support only the IPv4 protocol or the IPv4 and the IPv6 protocols ( "DUAL"). For more information, see Working with a DB instance in a VPC in the *Amazon RDS User Guide.* * *(string) --* **Exceptions** * "RDS.Client.exceptions.DBSubnetGroupNotFoundFault" * "RDS.Client.exceptions.DBSubnetQuotaExceededFault" * "RDS.Client.exceptions.SubnetAlreadyInUse" * "RDS.Client.exceptions.DBSubnetGroupDoesNotCoverEnoughAZs" * "RDS.Client.exceptions.InvalidSubnet" **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: { 'DBSubnetGroup': { }, 'ResponseMetadata': { '...': '...', }, } RDS / Client / describe_reserved_db_instances describe_reserved_db_instances ****************************** RDS.Client.describe_reserved_db_instances(**kwargs) Returns information about reserved DB instances for this account, or about a specified reserved DB instance. See also: AWS API Documentation **Request Syntax** response = client.describe_reserved_db_instances( ReservedDBInstanceId='string', ReservedDBInstancesOfferingId='string', DBInstanceClass='string', Duration='string', ProductDescription='string', OfferingType='string', MultiAZ=True|False, LeaseId='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], MaxRecords=123, Marker='string' ) Parameters: * **ReservedDBInstanceId** (*string*) -- The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID. * **ReservedDBInstancesOfferingId** (*string*) -- The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier. * **DBInstanceClass** (*string*) -- The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class. * **Duration** (*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" * **ProductDescription** (*string*) -- The product description filter value. Specify this parameter to show only those reservations matching the specified product description. * **OfferingType** (*string*) -- 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"" * **MultiAZ** (*boolean*) -- Specifies whether to show only those reservations that support Multi-AZ. * **LeaseId** (*string*) -- The lease identifier filter value. Specify this parameter to show only the reservation that matches the specified lease ID. Note: Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance. * **Filters** (*list*) -- This parameter isn't currently supported. * *(dict) --* 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: * "DescribeDBClusterBacktracks" * "DescribeDBClusterEndpoints" * "DescribeDBClusters" * "DescribeDBInstances" * "DescribeDBRecommendations" * "DescribeDBShardGroups" * "DescribePendingMaintenanceActions" * **Name** *(string) --* **[REQUIRED]** The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* **[REQUIRED]** One or more filter values. Filter values are case- sensitive. * *(string) --* * **MaxRecords** (*integer*) -- 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. * **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". Return type: dict Returns: **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 whether the reservation applies to Multi-AZ deployments. * **State** *(string) --* The state of the reserved DB instance. * **RecurringCharges** *(list) --* The recurring price charged to run this reserved DB instance. * *(dict) --* This data type is used as a response element in the "DescribeReservedDBInstances" and "DescribeReservedDBInstancesOfferings" actions. * **RecurringChargeAmount** *(float) --* The amount of the recurring charge. * **RecurringChargeFrequency** *(string) --* The frequency of the recurring charge. * **ReservedDBInstanceArn** *(string) --* The Amazon Resource Name (ARN) for the reserved DB instance. * **LeaseId** *(string) --* The unique identifier for the lease associated with the reserved DB instance. Note: Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance. **Exceptions** * "RDS.Client.exceptions.ReservedDBInstanceNotFoundFault" **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': { '...': '...', }, } RDS / Client / describe_db_cluster_parameters describe_db_cluster_parameters ****************************** RDS.Client.describe_db_cluster_parameters(**kwargs) Returns the detailed parameter list for a particular DB cluster parameter group. For more information on Amazon Aurora, see What is Amazon Aurora? in the *Amazon Aurora User Guide*. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the *Amazon RDS User Guide*. See also: AWS API Documentation **Request Syntax** response = client.describe_db_cluster_parameters( DBClusterParameterGroupName='string', Source='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], MaxRecords=123, Marker='string' ) Parameters: * **DBClusterParameterGroupName** (*string*) -- **[REQUIRED]** The name of a specific DB cluster parameter group to return parameter details for. Constraints: * If supplied, must match the name of an existing DBClusterParameterGroup. * **Source** (*string*) -- A specific source to return parameters for. Valid Values: * "engine-default" * "system" * "user" * **Filters** (*list*) -- A filter that specifies one or more DB cluster parameters to describe. The only supported filter is "parameter-name". The results list only includes information about the DB cluster parameters with these names. * *(dict) --* 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: * "DescribeDBClusterBacktracks" * "DescribeDBClusterEndpoints" * "DescribeDBClusters" * "DescribeDBInstances" * "DescribeDBRecommendations" * "DescribeDBShardGroups" * "DescribePendingMaintenanceActions" * **Name** *(string) --* **[REQUIRED]** The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* **[REQUIRED]** One or more filter values. Filter values are case- sensitive. * *(string) --* * **MaxRecords** (*integer*) -- 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. * **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". Return type: dict Returns: **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) --* The name of the parameter. * **ParameterValue** *(string) --* The value of the parameter. * **Description** *(string) --* Provides a description of the parameter. * **Source** *(string) --* 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. * *(string) --* * **Marker** *(string) --* An optional pagination token provided by a previous "DescribeDBClusterParameters" request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by "MaxRecords". **Exceptions** * "RDS.Client.exceptions.DBParameterGroupNotFoundFault" **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': { '...': '...', }, } RDS / Client / describe_db_cluster_parameter_groups describe_db_cluster_parameter_groups ************************************ RDS.Client.describe_db_cluster_parameter_groups(**kwargs) Returns a list of "DBClusterParameterGroup" descriptions. If a "DBClusterParameterGroupName" parameter is specified, the list will contain only the description of the specified DB cluster parameter group. For more information on Amazon Aurora, see What is Amazon Aurora? in the *Amazon Aurora User Guide*. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the *Amazon RDS User Guide*. See also: AWS API Documentation **Request Syntax** response = client.describe_db_cluster_parameter_groups( DBClusterParameterGroupName='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], MaxRecords=123, Marker='string' ) Parameters: * **DBClusterParameterGroupName** (*string*) -- The name of a specific DB cluster parameter group to return details for. Constraints: * If supplied, must match the name of an existing DBClusterParameterGroup. * **Filters** (*list*) -- This parameter isn't currently supported. * *(dict) --* 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: * "DescribeDBClusterBacktracks" * "DescribeDBClusterEndpoints" * "DescribeDBClusters" * "DescribeDBInstances" * "DescribeDBRecommendations" * "DescribeDBShardGroups" * "DescribePendingMaintenanceActions" * **Name** *(string) --* **[REQUIRED]** The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* **[REQUIRED]** One or more filter values. Filter values are case- sensitive. * *(string) --* * **MaxRecords** (*integer*) -- 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. * **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". Return type: dict Returns: **Response Syntax** { 'Marker': 'string', 'DBClusterParameterGroups': [ { 'DBClusterParameterGroupName': 'string', 'DBParameterGroupFamily': 'string', 'Description': 'string', 'DBClusterParameterGroupArn': 'string' }, ] } **Response Structure** * *(dict) --* * **Marker** *(string) --* An optional pagination token provided by a previous "DescribeDBClusterParameterGroups" request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by "MaxRecords". * **DBClusterParameterGroups** *(list) --* A list of DB cluster parameter groups. * *(dict) --* Contains the details of an Amazon RDS DB cluster parameter group. This data type is used as a response element in the "DescribeDBClusterParameterGroups" action. * **DBClusterParameterGroupName** *(string) --* The name of the DB cluster parameter group. * **DBParameterGroupFamily** *(string) --* The name of the DB parameter group family that this DB cluster parameter group is compatible with. * **Description** *(string) --* Provides the customer-specified description for this DB cluster parameter group. * **DBClusterParameterGroupArn** *(string) --* The Amazon Resource Name (ARN) for the DB cluster parameter group. **Exceptions** * "RDS.Client.exceptions.DBParameterGroupNotFoundFault" **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': { '...': '...', }, } RDS / Client / modify_db_snapshot modify_db_snapshot ****************** RDS.Client.modify_db_snapshot(**kwargs) Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted or unencrypted, but not shared or public. Amazon RDS supports upgrading DB snapshots for MySQL, PostgreSQL, and Oracle. This operation doesn't apply to RDS Custom or RDS for Db2. See also: AWS API Documentation **Request Syntax** response = client.modify_db_snapshot( DBSnapshotIdentifier='string', EngineVersion='string', OptionGroupName='string' ) Parameters: * **DBSnapshotIdentifier** (*string*) -- **[REQUIRED]** The identifier of the DB snapshot to modify. * **EngineVersion** (*string*) -- 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** For the list of engine versions that are available for upgrading a DB snapshot, see Upgrading a MySQL DB snapshot engine version in the *Amazon RDS User Guide.* **Oracle** * "19.0.0.0.ru-2022-01.rur-2022-01.r1" (supported for 12.2.0.1 DB snapshots) * "19.0.0.0.ru-2022-07.rur-2022-07.r1" (supported for 12.1.0.2 DB snapshots) * "12.1.0.2.v8" (supported for 12.1.0.1 DB snapshots) * "11.2.0.4.v12" (supported for 11.2.0.2 DB snapshots) * "11.2.0.4.v11" (supported for 11.2.0.3 DB snapshots) **PostgreSQL** For the list of engine versions that are available for upgrading a DB snapshot, see Upgrading a PostgreSQL DB snapshot engine version in the *Amazon RDS User Guide.* * **OptionGroupName** (*string*) -- 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.* Return type: dict Returns: **Response Syntax** { 'DBSnapshot': { 'DBSnapshotIdentifier': 'string', 'DBInstanceIdentifier': 'string', 'SnapshotCreateTime': datetime(2015, 1, 1), 'Engine': 'string', 'AllocatedStorage': 123, 'Status': 'string', 'Port': 123, 'AvailabilityZone': 'string', 'VpcId': 'string', 'InstanceCreateTime': datetime(2015, 1, 1), 'MasterUsername': 'string', 'EngineVersion': 'string', 'LicenseModel': 'string', 'SnapshotType': 'string', 'Iops': 123, 'OptionGroupName': 'string', 'PercentProgress': 123, 'SourceRegion': 'string', 'SourceDBSnapshotIdentifier': 'string', 'StorageType': 'string', 'TdeCredentialArn': 'string', 'Encrypted': True|False, 'KmsKeyId': 'string', 'DBSnapshotArn': 'string', 'Timezone': 'string', 'IAMDatabaseAuthenticationEnabled': True|False, 'ProcessorFeatures': [ { 'Name': 'string', 'Value': 'string' }, ], 'DbiResourceId': 'string', 'TagList': [ { 'Key': 'string', 'Value': 'string' }, ], 'OriginalSnapshotCreateTime': datetime(2015, 1, 1), 'SnapshotDatabaseTime': datetime(2015, 1, 1), 'SnapshotTarget': 'string', 'StorageThroughput': 123, 'DBSystemId': 'string', 'DedicatedLogVolume': True|False, 'MultiTenant': True|False, 'SnapshotAvailabilityZone': 'string' } } **Response Structure** * *(dict) --* * **DBSnapshot** *(dict) --* Contains the details of an Amazon RDS DB snapshot. This data type is used as a response element in the "DescribeDBSnapshots" action. * **DBSnapshotIdentifier** *(string) --* Specifies the identifier for the DB snapshot. * **DBInstanceIdentifier** *(string) --* Specifies the DB instance identifier of the DB instance this DB snapshot was created from. * **SnapshotCreateTime** *(datetime) --* Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied. * **Engine** *(string) --* Specifies the name of the database engine. * **AllocatedStorage** *(integer) --* Specifies the allocated storage size in gibibytes (GiB). * **Status** *(string) --* Specifies the status of this DB snapshot. * **Port** *(integer) --* Specifies the port that the database engine was listening on at the time of the snapshot. * **AvailabilityZone** *(string) --* Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot. * **VpcId** *(string) --* Provides the VPC ID associated with the DB snapshot. * **InstanceCreateTime** *(datetime) --* Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created. * **MasterUsername** *(string) --* Provides the master username for the DB snapshot. * **EngineVersion** *(string) --* Specifies the version of the database engine. * **LicenseModel** *(string) --* License model information for the restored DB instance. * **SnapshotType** *(string) --* Provides the type of the DB snapshot. * **Iops** *(integer) --* Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot. * **OptionGroupName** *(string) --* Provides the option group name for the DB snapshot. * **PercentProgress** *(integer) --* The percentage of the estimated data that has been transferred. * **SourceRegion** *(string) --* The Amazon Web Services Region that the DB snapshot was created in or copied from. * **SourceDBSnapshotIdentifier** *(string) --* The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has a value in the case of a cross-account or cross-Region copy. * **StorageType** *(string) --* Specifies the storage type associated with DB snapshot. * **TdeCredentialArn** *(string) --* The ARN from the key store with which to associate the instance for TDE encryption. * **Encrypted** *(boolean) --* Indicates whether the DB snapshot is encrypted. * **KmsKeyId** *(string) --* If "Encrypted" is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. * **DBSnapshotArn** *(string) --* The Amazon Resource Name (ARN) for the DB snapshot. * **Timezone** *(string) --* The time zone of the DB snapshot. In most cases, the "Timezone" element is empty. "Timezone" content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified. * **IAMDatabaseAuthenticationEnabled** *(boolean) --* Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled. * **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: * "CreateDBInstance" * "ModifyDBInstance" * "RestoreDBInstanceFromDBSnapshot" * "RestoreDBInstanceFromS3" * "RestoreDBInstanceToPointInTime" 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: * "DescribeDBInstances" * "DescribeDBSnapshots" * "DescribeValidDBInstanceModifications" If you call "DescribeDBInstances", "ProcessorFeature" returns non-null values only if the following conditions are met: * You are accessing an Oracle DB instance. * Your Oracle DB instance class supports configuring the number of CPU cores and threads per core. * The current number CPU cores and threads is set to a non-default value. For more information, see Configuring the processor for a DB instance class in RDS for Oracle 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. * **DbiResourceId** *(string) --* The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region. * **TagList** *(list) --* A list of tags. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **Key** *(string) --* A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **Value** *(string) --* A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **OriginalSnapshotCreateTime** *(datetime) --* Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied. * **SnapshotDatabaseTime** *(datetime) --* The timestamp of the most recent transaction applied to the database that you're backing up. Thus, if you restore a snapshot, SnapshotDatabaseTime is the most recent transaction in the restored DB instance. In contrast, originalSnapshotCreateTime specifies the system time that the snapshot completed. If you back up a read replica, you can determine the replica lag by comparing SnapshotDatabaseTime with originalSnapshotCreateTime. For example, if originalSnapshotCreateTime is two hours later than SnapshotDatabaseTime, then the replica lag is two hours. * **SnapshotTarget** *(string) --* Specifies where manual snapshots are stored: Dedicated Local Zones, Amazon Web Services Outposts or the Amazon Web Services Region. * **StorageThroughput** *(integer) --* Specifies the storage throughput for the DB snapshot. * **DBSystemId** *(string) --* The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. The Oracle SID is also the name of your CDB. * **DedicatedLogVolume** *(boolean) --* Indicates whether the DB instance has a dedicated log volume (DLV) enabled. * **MultiTenant** *(boolean) --* Indicates whether the snapshot is of a DB instance using the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE). * **SnapshotAvailabilityZone** *(string) --* Specifies the name of the Availability Zone where RDS stores the DB snapshot. This value is valid only for snapshots that RDS stores on a Dedicated Local Zone. **Exceptions** * "RDS.Client.exceptions.DBSnapshotNotFoundFault" RDS / Client / describe_account_attributes describe_account_attributes *************************** RDS.Client.describe_account_attributes() Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value. This command doesn't take any parameters. See also: AWS API Documentation **Request Syntax** response = client.describe_account_attributes() Return type: dict Returns: **Response Syntax** { 'AccountQuotas': [ { 'AccountQuotaName': 'string', 'Used': 123, 'Max': 123 }, ] } **Response Structure** * *(dict) --* Data returned by the **DescribeAccountAttributes** action. * **AccountQuotas** *(list) --* 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. * *(dict) --* Describes a quota for an Amazon Web Services account. The following are account quotas: * "AllocatedStorage" - The total allocated storage per account, in GiB. The used value is the total allocated storage in the account, in GiB. * "AuthorizationsPerDBSecurityGroup" - The number of ingress rules per DB security group. The used value is the highest number of ingress rules in a DB security group in the account. Other DB security groups in the account might have a lower number of ingress rules. * "CustomEndpointsPerDBCluster" - The number of custom endpoints per DB cluster. The used value is the highest number of custom endpoints in a DB clusters in the account. Other DB clusters in the account might have a lower number of custom endpoints. * "DBClusterParameterGroups" - The number of DB cluster parameter groups per account, excluding default parameter groups. The used value is the count of nondefault DB cluster parameter groups in the account. * "DBClusterRoles" - The number of associated Amazon Web Services Identity and Access Management (IAM) roles per DB cluster. The used value is the highest number of associated IAM roles for a DB cluster in the account. Other DB clusters in the account might have a lower number of associated IAM roles. * "DBClusters" - The number of DB clusters per account. The used value is the count of DB clusters in the account. * "DBInstanceRoles" - The number of associated IAM roles per DB instance. The used value is the highest number of associated IAM roles for a DB instance in the account. Other DB instances in the account might have a lower number of associated IAM roles. * "DBInstances" - The number of DB instances per account. The used value is the count of the DB instances in the account. Amazon RDS DB instances, Amazon Aurora DB instances, Amazon Neptune instances, and Amazon DocumentDB instances apply to this quota. * "DBParameterGroups" - The number of DB parameter groups per account, excluding default parameter groups. The used value is the count of nondefault DB parameter groups in the account. * "DBSecurityGroups" - The number of DB security groups (not VPC security groups) per account, excluding the default security group. The used value is the count of nondefault DB security groups in the account. * "DBSubnetGroups" - The number of DB subnet groups per account. The used value is the count of the DB subnet groups in the account. * "EventSubscriptions" - The number of event subscriptions per account. The used value is the count of the event subscriptions in the account. * "ManualClusterSnapshots" - The number of manual DB cluster snapshots per account. The used value is the count of the manual DB cluster snapshots in the account. * "ManualSnapshots" - The number of manual DB instance snapshots per account. The used value is the count of the manual DB instance snapshots in the account. * "OptionGroups" - The number of DB option groups per account, excluding default option groups. The used value is the count of nondefault DB option groups in the account. * "ReadReplicasPerMaster" - The number of read replicas per DB instance. The used value is the highest number of read replicas for a DB instance in the account. Other DB instances in the account might have a lower number of read replicas. * "ReservedDBInstances" - The number of reserved DB instances per account. The used value is the count of the active reserved DB instances in the account. * "SubnetsPerDBSubnetGroup" - The number of subnets per DB subnet group. The used value is highest number of subnets for a DB subnet group in the account. Other DB subnet groups in the account might have a lower number of subnets. For more information, see Quotas for Amazon RDS in the *Amazon RDS User Guide* and Quotas for Amazon Aurora in the *Amazon Aurora User Guide*. * **AccountQuotaName** *(string) --* The name of the Amazon RDS quota for this Amazon Web Services account. * **Used** *(integer) --* The amount currently used toward the quota maximum. * **Max** *(integer) --* The maximum allowed value for the quota. **Examples** This example lists account attributes. response = client.describe_account_attributes( ) print(response) Expected Output: { 'ResponseMetadata': { '...': '...', }, } RDS / Client / create_event_subscription create_event_subscription ************************* RDS.Client.create_event_subscription(**kwargs) Creates an RDS event notification subscription. This operation requires a topic Amazon Resource Name (ARN) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console. You can specify the type of source ( "SourceType") that you want to be notified of and provide a list of RDS sources ( "SourceIds") that triggers the events. You can also provide a list of event categories ( "EventCategories") for events that you want to be notified of. For example, you can specify "SourceType" = "db- instance", "SourceIds" = "mydbinstance1", "mydbinstance2" and "EventCategories" = "Availability", "Backup". If you specify both the "SourceType" and "SourceIds", such as "SourceType" = "db-instance" and "SourceIds" = "myDBInstance1", you are notified of all the "db-instance" events for the specified source. If you specify a "SourceType" but do not specify "SourceIds", you receive notice of the events for that source type for all your RDS sources. If you don't specify either the SourceType or the "SourceIds", you are notified of events generated from all RDS sources belonging to your customer account. For more information about subscribing to an event for RDS DB engines, see Subscribing to Amazon RDS event notification in the *Amazon RDS User Guide*. For more information about subscribing to an event for Aurora DB engines, see Subscribing to Amazon RDS event notification in the *Amazon Aurora User Guide*. 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' }, ] ) Parameters: * **SubscriptionName** (*string*) -- **[REQUIRED]** The name of the subscription. Constraints: The name must be less than 255 characters. * **SnsTopicArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the SNS topic created for event notification. SNS automatically creates the ARN when you create a topic and subscribe to it. Note: RDS doesn't support FIFO (first in, first out) topics. For more information, see Message ordering and deduplication (FIFO topics) in the *Amazon Simple Notification Service Developer Guide*. * **SourceType** (*string*) -- The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you set this parameter to "db-instance". For RDS Proxy events, specify "db-proxy". If this value isn't specified, all events are returned. Valid Values: `` db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db- proxy | zero-etl | custom-engine-version | blue-green- deployment`` * **EventCategories** (*list*) -- A list of event categories for a particular source type ( "SourceType") that you want to subscribe to. You can see a list of the categories for a given source type in the "Amazon RDS event categories and event messages" section of the Amazon RDS User Guide or the Amazon Aurora User Guide. You can also see this list by using the "DescribeEventCategories" operation. * *(string) --* * **SourceIds** (*list*) -- 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: * If "SourceIds" are supplied, "SourceType" must also be provided. * If the source type is a DB instance, a "DBInstanceIdentifier" value must be supplied. * If the source type is a DB cluster, a "DBClusterIdentifier" value must be supplied. * If the source type is a DB parameter group, a "DBParameterGroupName" value must be supplied. * If the source type is a DB security group, a "DBSecurityGroupName" value must be supplied. * If the source type is a DB snapshot, a "DBSnapshotIdentifier" value must be supplied. * If the source type is a DB cluster snapshot, a "DBClusterSnapshotIdentifier" value must be supplied. * If the source type is an RDS Proxy, a "DBProxyName" value must be supplied. * *(string) --* * **Enabled** (*boolean*) -- Specifies whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active. * **Tags** (*list*) -- A list of tags. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **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}_.:/=+\-@]*)$"). Return type: dict Returns: **Response Syntax** { 'EventSubscription': { 'CustomerAwsId': 'string', 'CustSubscriptionId': 'string', 'SnsTopicArn': 'string', 'Status': 'string', 'SubscriptionCreationTime': 'string', 'SourceType': 'string', 'SourceIdsList': [ 'string', ], 'EventCategoriesList': [ 'string', ], 'Enabled': True|False, 'EventSubscriptionArn': 'string' } } **Response Structure** * *(dict) --* * **EventSubscription** *(dict) --* Contains the results of a successful invocation of the "DescribeEventSubscriptions" action. * **CustomerAwsId** *(string) --* The Amazon Web Services customer account associated with the RDS event notification subscription. * **CustSubscriptionId** *(string) --* The RDS event notification subscription Id. * **SnsTopicArn** *(string) --* The topic ARN of the RDS event notification subscription. * **Status** *(string) --* The status of the RDS event notification subscription. Constraints: Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist The status "no-permission" indicates that RDS no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created. * **SubscriptionCreationTime** *(string) --* The time the RDS event notification subscription was created. * **SourceType** *(string) --* The source type for the RDS event notification subscription. * **SourceIdsList** *(list) --* A list of source IDs for the RDS event notification subscription. * *(string) --* * **EventCategoriesList** *(list) --* A list of event categories for the RDS event notification subscription. * *(string) --* * **Enabled** *(boolean) --* Specifies whether the subscription is enabled. True indicates the subscription is enabled. * **EventSubscriptionArn** *(string) --* The Amazon Resource Name (ARN) for the event subscription. **Exceptions** * "RDS.Client.exceptions.EventSubscriptionQuotaExceededFault" * "RDS.Client.exceptions.SubscriptionAlreadyExistFault" * "RDS.Client.exceptions.SNSInvalidTopicFault" * "RDS.Client.exceptions.SNSNoAuthorizationFault" * "RDS.Client.exceptions.SNSTopicArnNotFoundFault" * "RDS.Client.exceptions.SubscriptionCategoryNotFoundFault" * "RDS.Client.exceptions.SourceNotFoundFault" **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: { 'EventSubscription': { }, 'ResponseMetadata': { '...': '...', }, } RDS / Client / create_db_cluster_endpoint create_db_cluster_endpoint ************************** RDS.Client.create_db_cluster_endpoint(**kwargs) Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster. Note: This action applies only to Aurora DB clusters. See also: AWS API Documentation **Request Syntax** response = client.create_db_cluster_endpoint( DBClusterIdentifier='string', DBClusterEndpointIdentifier='string', EndpointType='string', StaticMembers=[ 'string', ], ExcludedMembers=[ 'string', ], Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **DBClusterIdentifier** (*string*) -- **[REQUIRED]** The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string. * **DBClusterEndpointIdentifier** (*string*) -- **[REQUIRED]** The identifier to use for the new endpoint. This parameter is stored as a lowercase string. * **EndpointType** (*string*) -- **[REQUIRED]** The type of the endpoint, one of: "READER", "WRITER", "ANY". * **StaticMembers** (*list*) -- List of DB instance identifiers that are part of the custom endpoint group. * *(string) --* * **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. This parameter is relevant only if the list of static members is empty. * *(string) --* * **Tags** (*list*) -- The tags to be assigned to the Amazon RDS resource. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **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}_.:/=+\-@]*)$"). Return type: dict Returns: **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: * "CreateDBClusterEndpoint" * "DescribeDBClusterEndpoints" * "ModifyDBClusterEndpoint" * "DeleteDBClusterEndpoint" 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", "inactive", "modifying". The "inactive" state applies to an endpoint that can't be used for a certain kind of cluster, such as a "writer" endpoint for a read-only secondary cluster in a global database. * **EndpointType** *(string) --* The type of the endpoint. One of: "READER", "WRITER", "CUSTOM". * **CustomEndpointType** *(string) --* The type associated with a custom endpoint. One of: "READER", "WRITER", "ANY". * **StaticMembers** *(list) --* List of DB instance identifiers that are part of the custom endpoint group. * *(string) --* * **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. * *(string) --* * **DBClusterEndpointArn** *(string) --* The Amazon Resource Name (ARN) for the endpoint. **Exceptions** * "RDS.Client.exceptions.DBClusterEndpointQuotaExceededFault" * "RDS.Client.exceptions.DBClusterEndpointAlreadyExistsFault" * "RDS.Client.exceptions.DBClusterNotFoundFault" * "RDS.Client.exceptions.InvalidDBClusterStateFault" * "RDS.Client.exceptions.DBInstanceNotFoundFault" * "RDS.Client.exceptions.InvalidDBInstanceStateFault" RDS / Client / stop_activity_stream stop_activity_stream ******************** RDS.Client.stop_activity_stream(**kwargs) Stops a database activity stream that was started using the Amazon Web Services console, the "start-activity-stream" CLI command, or the "StartActivityStream" operation. For more information, see Monitoring Amazon Aurora with Database Activity Streams in the *Amazon Aurora User Guide* or Monitoring Amazon RDS with Database Activity Streams in the *Amazon RDS User Guide*. See also: AWS API Documentation **Request Syntax** response = client.stop_activity_stream( ResourceArn='string', ApplyImmediately=True|False ) Parameters: * **ResourceArn** (*string*) -- **[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". * **ApplyImmediately** (*boolean*) -- Specifies whether or not the database activity stream is to stop as soon as possible, regardless of the maintenance window for the database. Return type: dict Returns: **Response Syntax** { 'KmsKeyId': 'string', 'KinesisStreamName': 'string', 'Status': 'stopped'|'starting'|'started'|'stopping' } **Response Structure** * *(dict) --* * **KmsKeyId** *(string) --* The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. * **KinesisStreamName** *(string) --* The name of the Amazon Kinesis data stream used for the database activity stream. * **Status** *(string) --* The status of the database activity stream. **Exceptions** * "RDS.Client.exceptions.InvalidDBInstanceStateFault" * "RDS.Client.exceptions.InvalidDBClusterStateFault" * "RDS.Client.exceptions.ResourceNotFoundFault" * "RDS.Client.exceptions.DBClusterNotFoundFault" * "RDS.Client.exceptions.DBInstanceNotFoundFault" RDS / Client / create_tenant_database create_tenant_database ********************** RDS.Client.create_tenant_database(**kwargs) Creates a tenant database in a DB instance that uses the multi- tenant configuration. Only RDS for Oracle container database (CDB) instances are supported. See also: AWS API Documentation **Request Syntax** response = client.create_tenant_database( DBInstanceIdentifier='string', TenantDBName='string', MasterUsername='string', MasterUserPassword='string', CharacterSetName='string', NcharCharacterSetName='string', ManageMasterUserPassword=True|False, MasterUserSecretKmsKeyId='string', Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **DBInstanceIdentifier** (*string*) -- **[REQUIRED]** The user-supplied DB instance identifier. RDS creates your tenant database in this DB instance. This parameter isn't case-sensitive. * **TenantDBName** (*string*) -- **[REQUIRED]** The user-supplied name of the tenant database that you want to create in your DB instance. This parameter has the same constraints as "DBName" in "CreateDBInstance". * **MasterUsername** (*string*) -- **[REQUIRED]** The name for the master user account in your tenant database. RDS creates this user account in the tenant database and grants privileges to the master user. This parameter is case- sensitive. Constraints: * Must be 1 to 16 letters, numbers, or underscores. * First character must be a letter. * Can't be a reserved word for the chosen database engine. * **MasterUserPassword** (*string*) -- The password for the master user in your tenant database. Constraints: * Must be 8 to 30 characters. * Can include any printable ASCII character except forward slash ( "/"), double quote ( """), at symbol ( "@"), ampersand ( "&"), or single quote ( "'"). * Can't be specified when "ManageMasterUserPassword" is enabled. * **CharacterSetName** (*string*) -- The character set for your tenant database. If you don't specify a value, the character set name defaults to "AL32UTF8". * **NcharCharacterSetName** (*string*) -- The "NCHAR" value for the tenant database. * **ManageMasterUserPassword** (*boolean*) -- Specifies whether to manage the master user password with Amazon Web Services Secrets Manager. For more information, see Password management with Amazon Web Services Secrets Manager in the *Amazon RDS User Guide.* Constraints: * Can't manage the master user password with Amazon Web Services Secrets Manager if "MasterUserPassword" is specified. * **MasterUserSecretKmsKeyId** (*string*) -- The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager. This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB instance. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN. If you don't specify "MasterUserSecretKmsKeyId", then the "aws/secretsmanager" KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the "aws/secretsmanager" KMS key to encrypt the secret, and you must use a customer managed KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region. * **Tags** (*list*) -- A list of tags. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **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}_.:/=+\-@]*)$"). Return type: dict Returns: **Response Syntax** { 'TenantDatabase': { 'TenantDatabaseCreateTime': datetime(2015, 1, 1), 'DBInstanceIdentifier': 'string', 'TenantDBName': 'string', 'Status': 'string', 'MasterUsername': 'string', 'DbiResourceId': 'string', 'TenantDatabaseResourceId': 'string', 'TenantDatabaseARN': 'string', 'CharacterSetName': 'string', 'NcharCharacterSetName': 'string', 'DeletionProtection': True|False, 'PendingModifiedValues': { 'MasterUserPassword': 'string', 'TenantDBName': 'string' }, 'MasterUserSecret': { 'SecretArn': 'string', 'SecretStatus': 'string', 'KmsKeyId': 'string' }, 'TagList': [ { 'Key': 'string', 'Value': 'string' }, ] } } **Response Structure** * *(dict) --* * **TenantDatabase** *(dict) --* A tenant database in the DB instance. This data type is an element in the response to the "DescribeTenantDatabases" action. * **TenantDatabaseCreateTime** *(datetime) --* The creation time of the tenant database. * **DBInstanceIdentifier** *(string) --* The ID of the DB instance that contains the tenant database. * **TenantDBName** *(string) --* The database name of the tenant database. * **Status** *(string) --* The status of the tenant database. * **MasterUsername** *(string) --* The master username of the tenant database. * **DbiResourceId** *(string) --* The Amazon Web Services Region-unique, immutable identifier for the DB instance. * **TenantDatabaseResourceId** *(string) --* The Amazon Web Services Region-unique, immutable identifier for the tenant database. * **TenantDatabaseARN** *(string) --* The Amazon Resource Name (ARN) for the tenant database. * **CharacterSetName** *(string) --* The character set of the tenant database. * **NcharCharacterSetName** *(string) --* The "NCHAR" character set name of the tenant database. * **DeletionProtection** *(boolean) --* Specifies whether deletion protection is enabled for the DB instance. * **PendingModifiedValues** *(dict) --* Information about pending changes for a tenant database. * **MasterUserPassword** *(string) --* The master password for the tenant database. * **TenantDBName** *(string) --* The name of the tenant database. * **MasterUserSecret** *(dict) --* Contains the secret managed by RDS in Amazon Web Services Secrets Manager for the master user password. For more information, see Password management with Amazon Web Services Secrets Manager in the *Amazon RDS User Guide* and Password management with Amazon Web Services Secrets Manager in the *Amazon Aurora User Guide.* * **SecretArn** *(string) --* The Amazon Resource Name (ARN) of the secret. * **SecretStatus** *(string) --* The status of the secret. The possible status values include the following: * "creating" - The secret is being created. * "active" - The secret is available for normal use and rotation. * "rotating" - The secret is being rotated. * "impaired" - The secret can be used to access database credentials, but it can't be rotated. A secret might have this status if, for example, permissions are changed so that RDS can no longer access either the secret or the KMS key for the secret. When a secret has this status, you can correct the condition that caused the status. Alternatively, modify the DB instance to turn off automatic management of database credentials, and then modify the DB instance again to turn on automatic management of database credentials. * **KmsKeyId** *(string) --* The Amazon Web Services KMS key identifier that is used to encrypt the secret. * **TagList** *(list) --* A list of tags. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **Key** *(string) --* A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **Value** *(string) --* A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). **Exceptions** * "RDS.Client.exceptions.DBInstanceNotFoundFault" * "RDS.Client.exceptions.InvalidDBInstanceStateFault" * "RDS.Client.exceptions.TenantDatabaseAlreadyExistsFault" * "RDS.Client.exceptions.TenantDatabaseQuotaExceededFault" * "RDS.Client.exceptions.KMSKeyNotAccessibleFault" RDS / Client / copy_db_snapshot copy_db_snapshot **************** RDS.Client.copy_db_snapshot(**kwargs) Copies the specified DB snapshot. The source DB snapshot must be in the "available" state. You can copy a snapshot from one Amazon Web Services Region to another. In that case, the Amazon Web Services Region where you call the "CopyDBSnapshot" operation is the destination Amazon Web Services Region for the DB snapshot copy. This command doesn't apply to RDS Custom. For more information about copying snapshots, see Copying a DB Snapshot in the *Amazon RDS User Guide*. See also: AWS API Documentation **Request Syntax** response = client.copy_db_snapshot( SourceDBSnapshotIdentifier='string', TargetDBSnapshotIdentifier='string', KmsKeyId='string', Tags=[ { 'Key': 'string', 'Value': 'string' }, ], CopyTags=True|False, OptionGroupName='string', TargetCustomAvailabilityZone='string', CopyOptionGroup=True|False, SnapshotAvailabilityZone='string', SnapshotTarget='string', SourceRegion='string' ) Parameters: * **SourceDBSnapshotIdentifier** (*string*) -- **[REQUIRED]** The identifier for the source DB snapshot. If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB snapshot identifier. For example, you might specify "rds:mysql- instance1-snapshot-20130805". If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB snapshot ARN. For example, you might specify "arn:aws:rds:us- west-2:123456789012:snapshot:mysql- instance1-snapshot-20130805". If you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot. If you are copying an encrypted snapshot this parameter must be in the ARN format for the source Amazon Web Services Region. Constraints: * Must specify a valid system snapshot in the "available" state. Example: "rds:mydb-2012-04-02-00-01" Example: "arn:aws:rds:us-west-2:123456789012:snapshot:mysql- instance1-snapshot-20130805" * **TargetDBSnapshotIdentifier** (*string*) -- **[REQUIRED]** The identifier for the copy of the snapshot. Constraints: * Can't be null, empty, or blank * Must contain from 1 to 255 letters, numbers, or hyphens * First character must be a letter * Can't end with a hyphen or contain two consecutive hyphens Example: "my-db-snapshot" * **KmsKeyId** (*string*) -- The Amazon Web Services KMS key identifier for an encrypted DB snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you copy an encrypted DB snapshot from your Amazon Web Services account, you can specify a value for this parameter to encrypt the copy with a new KMS key. If you don't specify a value for this parameter, then the copy of the DB snapshot is encrypted with the same Amazon Web Services KMS key as the source DB snapshot. If you copy an encrypted DB snapshot that is shared from another Amazon Web Services account, then you must specify a value for this parameter. If you specify this parameter when you copy an unencrypted snapshot, the copy is encrypted. If you copy an encrypted snapshot to a different Amazon Web Services Region, then you must specify an Amazon Web Services KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region that they are created in, and you can't use KMS keys from one Amazon Web Services Region in another Amazon Web Services Region. * **Tags** (*list*) -- A list of tags. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **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}_.:/=+\-@]*)$"). * **CopyTags** (*boolean*) -- Specifies whether to copy all tags from the source DB snapshot to the target DB snapshot. By default, tags aren't copied. * **PreSignedUrl** (*string*) -- When you are copying a snapshot from one Amazon Web Services GovCloud (US) Region to another, the URL that contains a Signature Version 4 signed request for the "CopyDBSnapshot" API operation in the source Amazon Web Services Region that contains the source DB snapshot to copy. This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other Amazon Web Services Regions. You must specify this parameter when you copy an encrypted DB snapshot from another Amazon Web Services Region by using the Amazon RDS API. Don't specify "PreSignedUrl" when you are copying an encrypted DB snapshot in the same Amazon Web Services Region. The presigned URL must be a valid request for the "CopyDBClusterSnapshot" API operation that can run in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to copy. The presigned URL request must contain the following parameter values: * "DestinationRegion" - The Amazon Web Services Region that the encrypted DB snapshot is copied to. This Amazon Web Services Region is the same one where the "CopyDBSnapshot" operation is called that contains this presigned URL. For example, if you copy an encrypted DB snapshot from the us- west-2 Amazon Web Services Region to the us-east-1 Amazon Web Services Region, then you call the "CopyDBSnapshot" operation in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the "CopyDBSnapshot" operation in the us-west-2 Amazon Web Services Region. For this example, the "DestinationRegion" in the presigned URL must be set to the us-east-1 Amazon Web Services Region. * "KmsKeyId" - The KMS key identifier for the KMS key to use to encrypt the copy of the DB snapshot in the destination Amazon Web Services Region. This is the same identifier for both the "CopyDBSnapshot" operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL. * "SourceDBSnapshotIdentifier" - The DB snapshot identifier for the encrypted snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an encrypted DB snapshot from the us-west-2 Amazon Web Services Region, then your "SourceDBSnapshotIdentifier" looks like the following example: "arn:aws:rds:us- west-2:123456789012:snapshot:mysql- instance1-snapshot-20161115". To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process. Note: If you are using an Amazon Web Services SDK tool or the CLI, you can specify "SourceRegion" (or "--source-region" for the CLI) instead of specifying "PreSignedUrl" manually. Specifying "SourceRegion" autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region. Please note that this parameter is automatically populated if it is not provided. Including this parameter is not required * **OptionGroupName** (*string*) -- The name of an option group to associate with the copy of the snapshot. Specify this option if you are copying a snapshot from one Amazon Web Services Region to another, and your DB instance uses a nondefault option group. If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, you must specify this option when copying across Amazon Web Services Regions. For more information, see Option group considerations in the *Amazon RDS User Guide*. * **TargetCustomAvailabilityZone** (*string*) -- The external custom Availability Zone (CAZ) identifier for the target CAZ. Example: "rds-caz-aiqhTgQv". * **CopyOptionGroup** (*boolean*) -- Specifies whether to copy the DB option group associated with the source DB snapshot to the target Amazon Web Services account and associate with the target DB snapshot. The associated option group can be copied only with cross-account snapshot copy calls. * **SnapshotAvailabilityZone** (*string*) -- Specifies the name of the Availability Zone where RDS stores the DB snapshot. This value is valid only for snapshots that RDS stores on a Dedicated Local Zone. * **SnapshotTarget** (*string*) -- Configures the location where RDS will store copied snapshots. Valid Values: * "local" (Dedicated Local Zone) * "outposts" (Amazon Web Services Outposts) * "region" (Amazon Web Services Region) * **SourceRegion** (*string*) -- The ID of the region that contains the snapshot to be copied. Return type: dict Returns: **Response Syntax** { 'DBSnapshot': { 'DBSnapshotIdentifier': 'string', 'DBInstanceIdentifier': 'string', 'SnapshotCreateTime': datetime(2015, 1, 1), 'Engine': 'string', 'AllocatedStorage': 123, 'Status': 'string', 'Port': 123, 'AvailabilityZone': 'string', 'VpcId': 'string', 'InstanceCreateTime': datetime(2015, 1, 1), 'MasterUsername': 'string', 'EngineVersion': 'string', 'LicenseModel': 'string', 'SnapshotType': 'string', 'Iops': 123, 'OptionGroupName': 'string', 'PercentProgress': 123, 'SourceRegion': 'string', 'SourceDBSnapshotIdentifier': 'string', 'StorageType': 'string', 'TdeCredentialArn': 'string', 'Encrypted': True|False, 'KmsKeyId': 'string', 'DBSnapshotArn': 'string', 'Timezone': 'string', 'IAMDatabaseAuthenticationEnabled': True|False, 'ProcessorFeatures': [ { 'Name': 'string', 'Value': 'string' }, ], 'DbiResourceId': 'string', 'TagList': [ { 'Key': 'string', 'Value': 'string' }, ], 'OriginalSnapshotCreateTime': datetime(2015, 1, 1), 'SnapshotDatabaseTime': datetime(2015, 1, 1), 'SnapshotTarget': 'string', 'StorageThroughput': 123, 'DBSystemId': 'string', 'DedicatedLogVolume': True|False, 'MultiTenant': True|False, 'SnapshotAvailabilityZone': 'string' } } **Response Structure** * *(dict) --* * **DBSnapshot** *(dict) --* Contains the details of an Amazon RDS DB snapshot. This data type is used as a response element in the "DescribeDBSnapshots" action. * **DBSnapshotIdentifier** *(string) --* Specifies the identifier for the DB snapshot. * **DBInstanceIdentifier** *(string) --* Specifies the DB instance identifier of the DB instance this DB snapshot was created from. * **SnapshotCreateTime** *(datetime) --* Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied. * **Engine** *(string) --* Specifies the name of the database engine. * **AllocatedStorage** *(integer) --* Specifies the allocated storage size in gibibytes (GiB). * **Status** *(string) --* Specifies the status of this DB snapshot. * **Port** *(integer) --* Specifies the port that the database engine was listening on at the time of the snapshot. * **AvailabilityZone** *(string) --* Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot. * **VpcId** *(string) --* Provides the VPC ID associated with the DB snapshot. * **InstanceCreateTime** *(datetime) --* Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created. * **MasterUsername** *(string) --* Provides the master username for the DB snapshot. * **EngineVersion** *(string) --* Specifies the version of the database engine. * **LicenseModel** *(string) --* License model information for the restored DB instance. * **SnapshotType** *(string) --* Provides the type of the DB snapshot. * **Iops** *(integer) --* Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot. * **OptionGroupName** *(string) --* Provides the option group name for the DB snapshot. * **PercentProgress** *(integer) --* The percentage of the estimated data that has been transferred. * **SourceRegion** *(string) --* The Amazon Web Services Region that the DB snapshot was created in or copied from. * **SourceDBSnapshotIdentifier** *(string) --* The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has a value in the case of a cross-account or cross-Region copy. * **StorageType** *(string) --* Specifies the storage type associated with DB snapshot. * **TdeCredentialArn** *(string) --* The ARN from the key store with which to associate the instance for TDE encryption. * **Encrypted** *(boolean) --* Indicates whether the DB snapshot is encrypted. * **KmsKeyId** *(string) --* If "Encrypted" is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. * **DBSnapshotArn** *(string) --* The Amazon Resource Name (ARN) for the DB snapshot. * **Timezone** *(string) --* The time zone of the DB snapshot. In most cases, the "Timezone" element is empty. "Timezone" content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified. * **IAMDatabaseAuthenticationEnabled** *(boolean) --* Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled. * **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: * "CreateDBInstance" * "ModifyDBInstance" * "RestoreDBInstanceFromDBSnapshot" * "RestoreDBInstanceFromS3" * "RestoreDBInstanceToPointInTime" 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: * "DescribeDBInstances" * "DescribeDBSnapshots" * "DescribeValidDBInstanceModifications" If you call "DescribeDBInstances", "ProcessorFeature" returns non-null values only if the following conditions are met: * You are accessing an Oracle DB instance. * Your Oracle DB instance class supports configuring the number of CPU cores and threads per core. * The current number CPU cores and threads is set to a non-default value. For more information, see Configuring the processor for a DB instance class in RDS for Oracle 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. * **DbiResourceId** *(string) --* The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region. * **TagList** *(list) --* A list of tags. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **Key** *(string) --* A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **Value** *(string) --* A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **OriginalSnapshotCreateTime** *(datetime) --* Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied. * **SnapshotDatabaseTime** *(datetime) --* The timestamp of the most recent transaction applied to the database that you're backing up. Thus, if you restore a snapshot, SnapshotDatabaseTime is the most recent transaction in the restored DB instance. In contrast, originalSnapshotCreateTime specifies the system time that the snapshot completed. If you back up a read replica, you can determine the replica lag by comparing SnapshotDatabaseTime with originalSnapshotCreateTime. For example, if originalSnapshotCreateTime is two hours later than SnapshotDatabaseTime, then the replica lag is two hours. * **SnapshotTarget** *(string) --* Specifies where manual snapshots are stored: Dedicated Local Zones, Amazon Web Services Outposts or the Amazon Web Services Region. * **StorageThroughput** *(integer) --* Specifies the storage throughput for the DB snapshot. * **DBSystemId** *(string) --* The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. The Oracle SID is also the name of your CDB. * **DedicatedLogVolume** *(boolean) --* Indicates whether the DB instance has a dedicated log volume (DLV) enabled. * **MultiTenant** *(boolean) --* Indicates whether the snapshot is of a DB instance using the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE). * **SnapshotAvailabilityZone** *(string) --* Specifies the name of the Availability Zone where RDS stores the DB snapshot. This value is valid only for snapshots that RDS stores on a Dedicated Local Zone. **Exceptions** * "RDS.Client.exceptions.DBSnapshotAlreadyExistsFault" * "RDS.Client.exceptions.DBSnapshotNotFoundFault" * "RDS.Client.exceptions.InvalidDBSnapshotStateFault" * "RDS.Client.exceptions.SnapshotQuotaExceededFault" * "RDS.Client.exceptions.KMSKeyNotAccessibleFault" * "RDS.Client.exceptions.CustomAvailabilityZoneNotFoundFault" **Examples** This example copies a DB snapshot. response = client.copy_db_snapshot( SourceDBSnapshotIdentifier='mydbsnapshot', TargetDBSnapshotIdentifier='mydbsnapshot-copy', ) print(response) Expected Output: { 'DBSnapshot': { }, 'ResponseMetadata': { '...': '...', }, } RDS / Client / modify_db_parameter_group modify_db_parameter_group ************************* RDS.Client.modify_db_parameter_group(**kwargs) Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: "ParameterName", "ParameterValue", and "ApplyMethod". A maximum of 20 parameters can be modified in a single request. Warning: After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the modify operation 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', ] }, ] ) Parameters: * **DBParameterGroupName** (*string*) -- **[REQUIRED]** The name of the DB parameter group. Constraints: * If supplied, must match the name of an existing "DBParameterGroup". * **Parameters** (*list*) -- **[REQUIRED]** An array of parameter names, values, and the application methods for the parameter update. At least one parameter name, value, and application method must be supplied; later arguments are optional. A maximum of 20 parameters can be modified in a single request. Valid Values (for the application method): "immediate | pending-reboot" You can use the "immediate" value with dynamic parameters only. You can use the "pending-reboot" value for both dynamic and static parameters. When the application method is "immediate", changes to dynamic parameters are applied immediately to the DB instances associated with the parameter group. When the application method is "pending-reboot", changes to dynamic and static parameters are applied after a reboot without failover to the DB instances associated with the parameter group. Note: You can't use "pending-reboot" with dynamic parameters on RDS for SQL Server DB instances. Use "immediate". For more information on modifying DB parameters, see Working with DB parameter groups in the *Amazon RDS User Guide*. * *(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) --* The name of the parameter. * **ParameterValue** *(string) --* The value of the parameter. * **Description** *(string) --* Provides a description of the parameter. * **Source** *(string) --* 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. * *(string) --* Return type: dict Returns: **Response Syntax** { 'DBParameterGroupName': 'string' } **Response Structure** * *(dict) --* Contains the result of a successful invocation of the "ModifyDBParameterGroup" or "ResetDBParameterGroup" operation. * **DBParameterGroupName** *(string) --* The name of the DB parameter group. **Exceptions** * "RDS.Client.exceptions.DBParameterGroupNotFoundFault" * "RDS.Client.exceptions.InvalidDBParameterGroupStateFault" **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': { '...': '...', }, } RDS / Client / modify_global_cluster modify_global_cluster ********************* RDS.Client.modify_global_cluster(**kwargs) Modifies a setting for an Amazon Aurora global database 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 operation only applies to Aurora global database clusters. See also: AWS API Documentation **Request Syntax** response = client.modify_global_cluster( GlobalClusterIdentifier='string', NewGlobalClusterIdentifier='string', DeletionProtection=True|False, EngineVersion='string', AllowMajorVersionUpgrade=True|False ) Parameters: * **GlobalClusterIdentifier** (*string*) -- The cluster identifier for the global cluster to modify. This parameter isn't case-sensitive. Constraints: * Must match the identifier of an existing global database cluster. * **NewGlobalClusterIdentifier** (*string*) -- The new cluster identifier for the global database cluster. This value is stored as a lowercase string. Constraints: * Must contain from 1 to 63 letters, numbers, or hyphens. * The first character must be a letter. * Can't end with a hyphen or contain two consecutive hyphens. Example: "my-cluster2" * **DeletionProtection** (*boolean*) -- Specifies whether to enable deletion protection for the global database cluster. The global database cluster can't be deleted when deletion protection is enabled. * **EngineVersion** (*string*) -- The version number of the database engine to which you want to upgrade. To list all of the available engine versions for "aurora- mysql" (for MySQL-based Aurora global databases), use the following command: "aws rds describe-db-engine-versions --engine aurora-mysql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'" To list all of the available engine versions for "aurora- postgresql" (for PostgreSQL-based Aurora global databases), use the following command: "aws rds describe-db-engine-versions --engine aurora- postgresql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'" * **AllowMajorVersionUpgrade** (*boolean*) -- Specifies whether to allow major version upgrades. Constraints: Must be enabled if you specify a value for the "EngineVersion" parameter that's a different major version than the global cluster's current version. If you upgrade the major version of a global database, the cluster and DB instance parameter groups are set to the default parameter groups for the new version. Apply any custom parameter groups after completing the upgrade. Return type: dict Returns: **Response Syntax** { 'GlobalCluster': { 'GlobalClusterIdentifier': 'string', 'GlobalClusterResourceId': 'string', 'GlobalClusterArn': 'string', 'Status': 'string', 'Engine': 'string', 'EngineVersion': 'string', 'EngineLifecycleSupport': 'string', 'DatabaseName': 'string', 'StorageEncrypted': True|False, 'DeletionProtection': True|False, 'GlobalClusterMembers': [ { 'DBClusterArn': 'string', 'Readers': [ 'string', ], 'IsWriter': True|False, 'GlobalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'unknown', 'SynchronizationStatus': 'connected'|'pending-resync' }, ], 'Endpoint': 'string', 'FailoverState': { 'Status': 'pending'|'failing-over'|'cancelling', 'FromDbClusterArn': 'string', 'ToDbClusterArn': 'string', 'IsDataLossAllowed': True|False }, 'TagList': [ { 'Key': 'string', 'Value': 'string' }, ] } } **Response Structure** * *(dict) --* * **GlobalCluster** *(dict) --* A data type representing an Aurora global database. * **GlobalClusterIdentifier** *(string) --* Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster. * **GlobalClusterResourceId** *(string) --* The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB cluster is accessed. * **GlobalClusterArn** *(string) --* The Amazon Resource Name (ARN) for the global database cluster. * **Status** *(string) --* Specifies the current state of this global database cluster. * **Engine** *(string) --* The Aurora database engine used by the global database cluster. * **EngineVersion** *(string) --* Indicates the database engine version. * **EngineLifecycleSupport** *(string) --* The lifecycle type for the global cluster. For more information, see CreateGlobalCluster. * **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 primary and secondary clusters within the global database cluster. * *(dict) --* A data structure with information about any primary and secondary clusters associated with a global cluster (Aurora global database). * **DBClusterArn** *(string) --* The Amazon Resource Name (ARN) for each Aurora DB cluster in the global cluster. * **Readers** *(list) --* The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the global cluster. * *(string) --* * **IsWriter** *(boolean) --* Indicates whether the Aurora DB cluster is the primary cluster (that is, has read-write capability) for the global cluster with which it is associated. * **GlobalWriteForwardingStatus** *(string) --* The status of write forwarding for a secondary cluster in the global cluster. * **SynchronizationStatus** *(string) --* The status of synchronization of each Aurora DB cluster in the global cluster. * **Endpoint** *(string) --* The writer endpoint for the new global database cluster. This endpoint always points to the writer DB instance in the current primary cluster. * **FailoverState** *(dict) --* A data object containing all properties for the current state of an in-process or pending switchover or failover process for this global cluster (Aurora global database). This object is empty unless the "SwitchoverGlobalCluster" or "FailoverGlobalCluster" operation was called on this global cluster. * **Status** *(string) --* The current status of the global cluster. Possible values are as follows: * pending – The service received a request to switch over or fail over the global cluster. The global cluster's primary DB cluster and the specified secondary DB cluster are being verified before the operation starts. * failing-over – Aurora is promoting the chosen secondary Aurora DB cluster to become the new primary DB cluster to fail over the global cluster. * cancelling – The request to switch over or fail over the global cluster was cancelled and the primary Aurora DB cluster and the selected secondary Aurora DB cluster are returning to their previous states. * switching-over – This status covers the range of Aurora internal operations that take place during the switchover process, such as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB cluster, and synchronizing replicas. * **FromDbClusterArn** *(string) --* The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being demoted, and which is associated with this state. * **ToDbClusterArn** *(string) --* The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being promoted, and which is associated with this state. * **IsDataLossAllowed** *(boolean) --* Indicates whether the operation is a global switchover or a global failover. If data loss is allowed, then the operation is a global failover. Otherwise, it's a switchover. * **TagList** *(list) --* A list of tags. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **Key** *(string) --* A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **Value** *(string) --* A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). **Exceptions** * "RDS.Client.exceptions.GlobalClusterNotFoundFault" * "RDS.Client.exceptions.GlobalClusterAlreadyExistsFault" * "RDS.Client.exceptions.InvalidGlobalClusterStateFault" * "RDS.Client.exceptions.InvalidDBClusterStateFault" * "RDS.Client.exceptions.InvalidDBInstanceStateFault" RDS / Client / describe_db_clusters describe_db_clusters ******************** RDS.Client.describe_db_clusters(**kwargs) Describes existing Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the *Amazon Aurora User Guide*. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the *Amazon RDS User Guide*. This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances. See also: AWS API Documentation **Request Syntax** response = client.describe_db_clusters( DBClusterIdentifier='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], MaxRecords=123, Marker='string', IncludeShared=True|False ) Parameters: * **DBClusterIdentifier** (*string*) -- The user-supplied DB cluster identifier or the Amazon Resource Name (ARN) of the DB cluster. If this parameter is specified, information for only the specific DB cluster is returned. This parameter isn't case-sensitive. Constraints: * If supplied, must match an existing DB cluster identifier. * **Filters** (*list*) -- A filter that specifies one or more DB clusters to describe. Supported Filters: * "clone-group-id" - Accepts clone group identifiers. The results list only includes information about the DB clusters associated with these clone groups. * "db-cluster-id" - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB clusters identified by these ARNs. * "db-cluster-resource-id" - Accepts DB cluster resource identifiers. The results list will only include information about the DB clusters identified by these DB cluster resource identifiers. * "domain" - Accepts Active Directory directory IDs. The results list only includes information about the DB clusters associated with these domains. * "engine" - Accepts engine names. The results list only includes information about the DB clusters for these engines. * *(dict) --* 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: * "DescribeDBClusterBacktracks" * "DescribeDBClusterEndpoints" * "DescribeDBClusters" * "DescribeDBInstances" * "DescribeDBRecommendations" * "DescribeDBShardGroups" * "DescribePendingMaintenanceActions" * **Name** *(string) --* **[REQUIRED]** The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* **[REQUIRED]** One or more filter values. Filter values are case- sensitive. * *(string) --* * **MaxRecords** (*integer*) -- 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 * **Marker** (*string*) -- An optional pagination token provided by a previous "DescribeDBClusters" request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by "MaxRecords". * **IncludeShared** (*boolean*) -- Specifies whether the output includes information about clusters shared from other Amazon Web Services accounts. Return type: dict Returns: **Response Syntax** { 'Marker': 'string', 'DBClusters': [ { 'AllocatedStorage': 123, 'AvailabilityZones': [ 'string', ], 'BackupRetentionPeriod': 123, 'CharacterSetName': 'string', 'DatabaseName': 'string', 'DBClusterIdentifier': 'string', 'DBClusterParameterGroup': 'string', 'DBSubnetGroup': 'string', 'Status': 'string', 'AutomaticRestartTime': datetime(2015, 1, 1), 'PercentProgress': 'string', 'EarliestRestorableTime': datetime(2015, 1, 1), 'Endpoint': 'string', 'ReaderEndpoint': 'string', 'CustomEndpoints': [ 'string', ], 'MultiAZ': True|False, 'Engine': 'string', 'EngineVersion': 'string', 'LatestRestorableTime': datetime(2015, 1, 1), 'Port': 123, 'MasterUsername': 'string', 'DBClusterOptionGroupMemberships': [ { 'DBClusterOptionGroupName': 'string', 'Status': 'string' }, ], 'PreferredBackupWindow': 'string', 'PreferredMaintenanceWindow': 'string', 'ReplicationSourceIdentifier': 'string', 'ReadReplicaIdentifiers': [ 'string', ], 'StatusInfos': [ { 'StatusType': 'string', 'Normal': True|False, 'Status': 'string', 'Message': 'string' }, ], 'DBClusterMembers': [ { 'DBInstanceIdentifier': 'string', 'IsClusterWriter': True|False, 'DBClusterParameterGroupStatus': 'string', 'PromotionTier': 123 }, ], 'VpcSecurityGroups': [ { 'VpcSecurityGroupId': 'string', 'Status': 'string' }, ], 'HostedZoneId': 'string', 'StorageEncrypted': True|False, 'KmsKeyId': 'string', 'DbClusterResourceId': 'string', 'DBClusterArn': 'string', 'AssociatedRoles': [ { 'RoleArn': 'string', 'Status': 'string', 'FeatureName': 'string' }, ], 'IAMDatabaseAuthenticationEnabled': True|False, 'CloneGroupId': 'string', 'ClusterCreateTime': datetime(2015, 1, 1), 'EarliestBacktrackTime': datetime(2015, 1, 1), 'BacktrackWindow': 123, 'BacktrackConsumedChangeRecords': 123, 'EnabledCloudwatchLogsExports': [ 'string', ], 'Capacity': 123, 'EngineMode': 'string', 'ScalingConfigurationInfo': { 'MinCapacity': 123, 'MaxCapacity': 123, 'AutoPause': True|False, 'SecondsUntilAutoPause': 123, 'TimeoutAction': 'string', 'SecondsBeforeTimeout': 123 }, 'RdsCustomClusterConfiguration': { 'InterconnectSubnetId': 'string', 'TransitGatewayMulticastDomainId': 'string', 'ReplicaMode': 'open-read-only'|'mounted' }, 'DeletionProtection': True|False, 'HttpEndpointEnabled': True|False, 'ActivityStreamMode': 'sync'|'async', 'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping', 'ActivityStreamKmsKeyId': 'string', 'ActivityStreamKinesisStreamName': 'string', 'CopyTagsToSnapshot': True|False, 'CrossAccountClone': True|False, 'DomainMemberships': [ { 'Domain': 'string', 'Status': 'string', 'FQDN': 'string', 'IAMRoleName': 'string', 'OU': 'string', 'AuthSecretArn': 'string', 'DnsIps': [ 'string', ] }, ], 'TagList': [ { 'Key': 'string', 'Value': 'string' }, ], 'GlobalClusterIdentifier': 'string', 'GlobalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'unknown', 'GlobalWriteForwardingRequested': True|False, 'PendingModifiedValues': { 'PendingCloudwatchLogsExports': { 'LogTypesToEnable': [ 'string', ], 'LogTypesToDisable': [ 'string', ] }, 'DBClusterIdentifier': 'string', 'MasterUserPassword': 'string', 'IAMDatabaseAuthenticationEnabled': True|False, 'EngineVersion': 'string', 'BackupRetentionPeriod': 123, 'AllocatedStorage': 123, 'RdsCustomClusterConfiguration': { 'InterconnectSubnetId': 'string', 'TransitGatewayMulticastDomainId': 'string', 'ReplicaMode': 'open-read-only'|'mounted' }, 'Iops': 123, 'StorageType': 'string', 'CertificateDetails': { 'CAIdentifier': 'string', 'ValidTill': datetime(2015, 1, 1) } }, 'DBClusterInstanceClass': 'string', 'StorageType': 'string', 'Iops': 123, 'PubliclyAccessible': True|False, 'AutoMinorVersionUpgrade': True|False, 'MonitoringInterval': 123, 'MonitoringRoleArn': 'string', 'DatabaseInsightsMode': 'standard'|'advanced', 'PerformanceInsightsEnabled': True|False, 'PerformanceInsightsKMSKeyId': 'string', 'PerformanceInsightsRetentionPeriod': 123, 'ServerlessV2ScalingConfiguration': { 'MinCapacity': 123.0, 'MaxCapacity': 123.0, 'SecondsUntilAutoPause': 123 }, 'ServerlessV2PlatformVersion': 'string', 'NetworkType': 'string', 'DBSystemId': 'string', 'MasterUserSecret': { 'SecretArn': 'string', 'SecretStatus': 'string', 'KmsKeyId': 'string' }, 'IOOptimizedNextAllowedModificationTime': datetime(2015, 1, 1), 'LocalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'requested', 'AwsBackupRecoveryPointArn': 'string', 'LimitlessDatabase': { 'Status': 'active'|'not-in-use'|'enabled'|'disabled'|'enabling'|'disabling'|'modifying-max-capacity'|'error', 'MinRequiredACU': 123.0 }, 'StorageThroughput': 123, 'ClusterScalabilityType': 'standard'|'limitless', 'CertificateDetails': { 'CAIdentifier': 'string', 'ValidTill': datetime(2015, 1, 1) }, 'EngineLifecycleSupport': 'string' }, ] } **Response Structure** * *(dict) --* Contains the result of a successful invocation of the "DescribeDBClusters" action. * **Marker** *(string) --* A pagination token that can be used in a later "DescribeDBClusters" request. * **DBClusters** *(list) --* Contains a list of DB clusters for the user. * *(dict) --* Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster. For an Amazon Aurora DB cluster, this data type is used as a response element in the operations "CreateDBCluster", "DeleteDBCluster", "DescribeDBClusters", "FailoverDBCluster", "ModifyDBCluster", "PromoteReadReplicaDBCluster", "RestoreDBClusterFromS3", "RestoreDBClusterFromSnapshot", "RestoreDBClusterToPointInTime", "StartDBCluster", and "StopDBCluster". For a Multi-AZ DB cluster, this data type is used as a response element in the operations "CreateDBCluster", "DeleteDBCluster", "DescribeDBClusters", "FailoverDBCluster", "ModifyDBCluster", "RebootDBCluster", "RestoreDBClusterFromSnapshot", and "RestoreDBClusterToPointInTime". For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the *Amazon Aurora User Guide.* For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the *Amazon RDS User Guide.* * **AllocatedStorage** *(integer) --* "AllocatedStorage" specifies the allocated storage size in gibibytes (GiB). For Aurora, "AllocatedStorage" can vary because Aurora DB cluster storage size adjusts as needed. * **AvailabilityZones** *(list) --* The list of Availability Zones (AZs) where instances in the DB cluster can be created. * *(string) --* * **BackupRetentionPeriod** *(integer) --* 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) --* The name of the initial database that was specified for the DB cluster when it was created, if one was provided. This same name is returned for the life of the DB cluster. * **DBClusterIdentifier** *(string) --* The user-supplied identifier for the DB cluster. This identifier is the unique key that identifies a DB cluster. * **DBClusterParameterGroup** *(string) --* The name of the DB cluster parameter group for the DB cluster. * **DBSubnetGroup** *(string) --* Information about the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group. * **Status** *(string) --* The current state of this DB cluster. * **AutomaticRestartTime** *(datetime) --* The time when a stopped DB cluster is restarted automatically. * **PercentProgress** *(string) --* 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) --* 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) --* The custom endpoints associated with the DB cluster. * *(string) --* * **MultiAZ** *(boolean) --* Indicates whether the DB cluster has instances in multiple Availability Zones. * **Engine** *(string) --* The database engine used for this DB cluster. * **EngineVersion** *(string) --* The version of the database engine. * **LatestRestorableTime** *(datetime) --* The latest time to which a database can be restored with point-in-time restore. * **Port** *(integer) --* The port that the database engine is listening on. * **MasterUsername** *(string) --* The master username for the DB cluster. * **DBClusterOptionGroupMemberships** *(list) --* 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) --* The daily time range during which automated backups are created if automated backups are enabled, as determined by the "BackupRetentionPeriod". * **PreferredMaintenanceWindow** *(string) --* The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). * **ReplicationSourceIdentifier** *(string) --* The identifier of the source DB cluster if this DB cluster is a read replica. * **ReadReplicaIdentifiers** *(list) --* Contains one or more identifiers of the read replicas associated with this DB cluster. * *(string) --* * **StatusInfos** *(list) --* Reserved for future use. * *(dict) --* Reserved for future use. * **StatusType** *(string) --* Reserved for future use. * **Normal** *(boolean) --* Reserved for future use. * **Status** *(string) --* Reserved for future use. * **Message** *(string) --* Reserved for future use. * **DBClusterMembers** *(list) --* The list of DB 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) --* Indicates whether the cluster member is the primary DB instance for the DB cluster. * **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) --* The list of VPC security groups that the DB cluster belongs to. * *(dict) --* This data type is used as a response element for queries on VPC security group membership. * **VpcSecurityGroupId** *(string) --* The name of the VPC security group. * **Status** *(string) --* The membership status of the VPC security group. Currently, the only valid status is "active". * **HostedZoneId** *(string) --* The ID that Amazon Route 53 assigns when you create a hosted zone. * **StorageEncrypted** *(boolean) --* Indicates whether the DB cluster is encrypted. * **KmsKeyId** *(string) --* If "StorageEncrypted" is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. * **DbClusterResourceId** *(string) --* The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the KMS key for the DB cluster is accessed. * **DBClusterArn** *(string) --* The Amazon Resource Name (ARN) for the DB cluster. * **AssociatedRoles** *(list) --* A list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf. * *(dict) --* Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB cluster. * **RoleArn** *(string) --* The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster. * **Status** *(string) --* Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values: * "ACTIVE" - the IAM role ARN is associated with the DB cluster and can be used to access other Amazon Web Services on your behalf. * "PENDING" - the IAM role ARN is being associated with the DB cluster. * "INVALID" - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other Amazon Web Services on your behalf. * **FeatureName** *(string) --* The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion. * **IAMDatabaseAuthenticationEnabled** *(boolean) --* Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled. * **CloneGroupId** *(string) --* The ID of the clone group with which the DB cluster is associated. For newly created clusters, the ID is typically null. If you clone a DB cluster when the ID is null, the operation populates the ID value for the source cluster and the clone because both clusters become part of the same clone group. Even if you delete the clone cluster, the clone group ID remains for the lifetime of the source cluster to show that it was used in a cloning operation. For PITR, the clone group ID is inherited from the source cluster. For snapshot restore operations, the clone group ID isn't inherited from the source cluster. * **ClusterCreateTime** *(datetime) --* 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.* * *(string) --* * **Capacity** *(integer) --* The current capacity of an Aurora Serverless v1 DB cluster. The capacity is "0" (zero) when the cluster is paused. For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the *Amazon Aurora User Guide*. * **EngineMode** *(string) --* The DB engine mode of the DB cluster, either "provisioned" or "serverless". For more information, see CreateDBCluster. * **ScalingConfigurationInfo** *(dict) --* The scaling configuration for an Aurora DB cluster in "serverless" DB engine mode. For more information, see Using Amazon Aurora Serverless v1 in the *Amazon Aurora User Guide*. * **MinCapacity** *(integer) --* The minimum capacity for an Aurora DB cluster in "serverless" DB engine mode. * **MaxCapacity** *(integer) --* The maximum capacity for an Aurora DB cluster in "serverless" DB engine mode. * **AutoPause** *(boolean) --* Indicates whether automatic pause is allowed for the Aurora DB cluster in "serverless" DB engine mode. When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes. * **SecondsUntilAutoPause** *(integer) --* The remaining amount of time, in seconds, before the Aurora DB cluster in "serverless" mode is paused. A DB cluster can be paused only when it's idle (it has no connections). * **TimeoutAction** *(string) --* The action that occurs when Aurora times out while attempting to change the capacity of an Aurora Serverless v1 cluster. The value is either "ForceApplyCapacityChange" or "RollbackCapacityChange". "ForceApplyCapacityChange", the default, sets the capacity to the specified value as soon as possible. "RollbackCapacityChange" ignores the capacity change if a scaling point isn't found in the timeout period. * **SecondsBeforeTimeout** *(integer) --* The number of seconds before scaling times out. What happens when an attempted scaling action times out is determined by the "TimeoutAction" setting. * **RdsCustomClusterConfiguration** *(dict) --* Reserved for future use. * **InterconnectSubnetId** *(string) --* Reserved for future use. * **TransitGatewayMulticastDomainId** *(string) --* Reserved for future use. * **ReplicaMode** *(string) --* Reserved for future use. * **DeletionProtection** *(boolean) --* Indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. * **HttpEndpointEnabled** *(boolean) --* Indicates whether the HTTP endpoint is enabled for an Aurora DB cluster. When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the DB cluster. You can also query your database from inside the RDS console with the RDS query editor. For more information, see Using RDS Data API in the *Amazon Aurora User Guide*. * **ActivityStreamMode** *(string) --* The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously. * **ActivityStreamStatus** *(string) --* The status of the database activity stream. * **ActivityStreamKmsKeyId** *(string) --* The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. * **ActivityStreamKinesisStreamName** *(string) --* The name of the Amazon Kinesis data stream used for the database activity stream. * **CopyTagsToSnapshot** *(boolean) --* Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster. * **CrossAccountClone** *(boolean) --* Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account. * **DomainMemberships** *(list) --* The Active Directory Domain membership records associated with the DB cluster. * *(dict) --* An Active Directory Domain membership record associated with the DB instance or cluster. * **Domain** *(string) --* The identifier of the Active Directory Domain. * **Status** *(string) --* The status of the Active Directory Domain membership for the DB instance or cluster. Values include "joined", "pending-join", "failed", and so on. * **FQDN** *(string) --* The fully qualified domain name (FQDN) of the Active Directory Domain. * **IAMRoleName** *(string) --* The name of the IAM role used when making API calls to the Directory Service. * **OU** *(string) --* The Active Directory organizational unit for the DB instance or cluster. * **AuthSecretArn** *(string) --* The ARN for the Secrets Manager secret with the credentials for the user that's a member of the domain. * **DnsIps** *(list) --* The IPv4 DNS IP addresses of the primary and secondary Active Directory domain controllers. * *(string) --* * **TagList** *(list) --* A list of tags. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **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}_.:/=+\-@]*)$"). * **GlobalClusterIdentifier** *(string) --* Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster. * **GlobalWriteForwardingStatus** *(string) --* The status of write forwarding for a secondary cluster in an Aurora global database. * **GlobalWriteForwardingRequested** *(boolean) --* Indicates whether write forwarding is enabled for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of "GlobalWriteForwardingStatus" to confirm that the request has completed before using the write forwarding feature for this cluster. * **PendingModifiedValues** *(dict) --* Information about pending changes to the DB cluster. This information is returned only when there are pending changes. Specific changes are identified by subelements. * **PendingCloudwatchLogsExports** *(dict) --* A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated. * **LogTypesToEnable** *(list) --* Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs. * *(string) --* * **LogTypesToDisable** *(list) --* Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs. * *(string) --* * **DBClusterIdentifier** *(string) --* The DBClusterIdentifier value for the DB cluster. * **MasterUserPassword** *(string) --* The master credentials for the DB cluster. * **IAMDatabaseAuthenticationEnabled** *(boolean) --* Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled. * **EngineVersion** *(string) --* The database engine version. * **BackupRetentionPeriod** *(integer) --* The number of days for which automatic DB snapshots are retained. * **AllocatedStorage** *(integer) --* The allocated storage size in gibibytes (GiB) for all database engines except Amazon Aurora. For Aurora, "AllocatedStorage" always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed. * **RdsCustomClusterConfiguration** *(dict) --* Reserved for future use. * **InterconnectSubnetId** *(string) --* Reserved for future use. * **TransitGatewayMulticastDomainId** *(string) --* Reserved for future use. * **ReplicaMode** *(string) --* Reserved for future use. * **Iops** *(integer) --* The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters. * **StorageType** *(string) --* The storage type for the DB cluster. * **CertificateDetails** *(dict) --* The details of the DB instance’s server certificate. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the *Amazon RDS User Guide* and Using SSL/TLS to encrypt a connection to a DB cluster in the *Amazon Aurora User Guide*. * **CAIdentifier** *(string) --* The CA identifier of the CA certificate used for the DB instance's server certificate. * **ValidTill** *(datetime) --* The expiration date of the DB instance’s server certificate. * **DBClusterInstanceClass** *(string) --* The name of the compute and memory capacity class of the DB instance. This setting is only for non-Aurora Multi-AZ DB clusters. * **StorageType** *(string) --* The storage type associated with the DB cluster. * **Iops** *(integer) --* The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters. * **PubliclyAccessible** *(boolean) --* Indicates whether the DB cluster is publicly accessible. When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it. When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address. For more information, see CreateDBCluster. This setting is only for non-Aurora Multi-AZ DB clusters. * **AutoMinorVersionUpgrade** *(boolean) --* Indicates whether minor version patches are applied automatically. This setting is for Aurora DB clusters and Multi-AZ DB clusters. For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version. * **MonitoringInterval** *(integer) --* The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. This setting is only for -Aurora DB clusters and Multi- AZ DB clusters. * **MonitoringRoleArn** *(string) --* The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. This setting is only for Aurora DB clusters and Multi-AZ DB clusters. * **DatabaseInsightsMode** *(string) --* The mode of Database Insights that is enabled for the DB cluster. * **PerformanceInsightsEnabled** *(boolean) --* Indicates whether Performance Insights is enabled for the DB cluster. This setting is only for Aurora DB clusters and Multi-AZ DB clusters. * **PerformanceInsightsKMSKeyId** *(string) --* The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. This setting is only for Aurora DB clusters and Multi-AZ DB clusters. * **PerformanceInsightsRetentionPeriod** *(integer) --* The number of days to retain Performance Insights data. This setting is only for Aurora DB clusters and Multi-AZ DB clusters. Valid Values: * "7" * *month* * 31, where *month* is a number of months from 1-23. Examples: "93" (3 months * 31), "341" (11 months * 31), "589" (19 months * 31) * "731" Default: "7" days * **ServerlessV2ScalingConfiguration** *(dict) --* The scaling configuration for an Aurora Serverless v2 DB cluster. For more information, see Using Amazon Aurora Serverless v2 in the *Amazon Aurora User Guide*. * **MinCapacity** *(float) --* The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. For Aurora versions that support the Aurora Serverless v2 auto-pause feature, the smallest value that you can use is 0. For versions that don't support Aurora Serverless v2 auto-pause, the smallest value that you can use is 0.5. * **MaxCapacity** *(float) --* The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 32, 32.5, 33, and so on. The largest value that you can use is 256 for recent Aurora versions, or 128 for older versions. You can check the attributes of your engine version or platform version to determine the specific maximum capacity supported. * **SecondsUntilAutoPause** *(integer) --* The number of seconds an Aurora Serverless v2 DB instance must be idle before Aurora attempts to automatically pause it. This property is only shown when the minimum capacity for the cluster is set to 0 ACUs. Changing the minimum capacity to a nonzero value removes this property. If you later change the minimum capacity back to 0 ACUs, this property is reset to its default value unless you specify it again. This value ranges between 300 seconds (five minutes) and 86,400 seconds (one day). The default is 300 seconds. * **ServerlessV2PlatformVersion** *(string) --* The version of the Aurora Serverless V2 platform used by the DB cluster. For more information, see Using Aurora Serverless v2 in the *Amazon Aurora User Guide*. * **NetworkType** *(string) --* The network type of the DB instance. The network type is determined by the "DBSubnetGroup" specified for the DB cluster. A "DBSubnetGroup" can support only the IPv4 protocol or the IPv4 and the IPv6 protocols ( "DUAL"). For more information, see Working with a DB instance in a VPC in the *Amazon Aurora User Guide.* This setting is only for Aurora DB clusters. Valid Values: "IPV4 | DUAL" * **DBSystemId** *(string) --* Reserved for future use. * **MasterUserSecret** *(dict) --* The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password. For more information, see Password management with Amazon Web Services Secrets Manager in the *Amazon RDS User Guide* and Password management with Amazon Web Services Secrets Manager in the *Amazon Aurora User Guide.* * **SecretArn** *(string) --* The Amazon Resource Name (ARN) of the secret. * **SecretStatus** *(string) --* The status of the secret. The possible status values include the following: * "creating" - The secret is being created. * "active" - The secret is available for normal use and rotation. * "rotating" - The secret is being rotated. * "impaired" - The secret can be used to access database credentials, but it can't be rotated. A secret might have this status if, for example, permissions are changed so that RDS can no longer access either the secret or the KMS key for the secret. When a secret has this status, you can correct the condition that caused the status. Alternatively, modify the DB instance to turn off automatic management of database credentials, and then modify the DB instance again to turn on automatic management of database credentials. * **KmsKeyId** *(string) --* The Amazon Web Services KMS key identifier that is used to encrypt the secret. * **IOOptimizedNextAllowedModificationTime** *(datetime) --* The next time you can modify the DB cluster to use the "aurora-iopt1" storage type. This setting is only for Aurora DB clusters. * **LocalWriteForwardingStatus** *(string) --* Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it. * **AwsBackupRecoveryPointArn** *(string) --* The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup. * **LimitlessDatabase** *(dict) --* The details for Aurora Limitless Database. * **Status** *(string) --* The status of Aurora Limitless Database. * **MinRequiredACU** *(float) --* The minimum required capacity for Aurora Limitless Database in Aurora capacity units (ACUs). * **StorageThroughput** *(integer) --* The storage throughput for the DB cluster. The throughput is automatically set based on the IOPS that you provision, and is not configurable. This setting is only for non-Aurora Multi-AZ DB clusters. * **ClusterScalabilityType** *(string) --* The scalability mode of the Aurora DB cluster. When set to "limitless", the cluster operates as an Aurora Limitless Database. When set to "standard" (the default), the cluster uses normal DB instance creation. * **CertificateDetails** *(dict) --* The details of the DB instance’s server certificate. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the *Amazon RDS User Guide* and Using SSL/TLS to encrypt a connection to a DB cluster in the *Amazon Aurora User Guide*. * **CAIdentifier** *(string) --* The CA identifier of the CA certificate used for the DB instance's server certificate. * **ValidTill** *(datetime) --* The expiration date of the DB instance’s server certificate. * **EngineLifecycleSupport** *(string) --* The lifecycle type for the DB cluster. For more information, see CreateDBCluster. **Exceptions** * "RDS.Client.exceptions.DBClusterNotFoundFault" **Examples** This example lists settings for the specified DB cluster. response = client.describe_db_clusters( DBClusterIdentifier='mynewdbcluster', ) print(response) Expected Output: { 'ResponseMetadata': { '...': '...', }, } RDS / Client / failover_db_cluster failover_db_cluster ******************* RDS.Client.failover_db_cluster(**kwargs) Forces a failover for a DB cluster. For an Aurora DB cluster, failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer). For a Multi-AZ DB cluster, after RDS terminates the primary DB instance, the internal monitoring system detects that the primary DB instance is unhealthy and promotes a readable standby (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer). Failover times are typically less than 35 seconds. An Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists, when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readable standby DB instance when the primary DB instance fails. To simulate a failure of a primary instance for testing, you can force a failover. Because each instance in a DB cluster has its own endpoint address, make sure to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the *Amazon Aurora User Guide*. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the *Amazon RDS User Guide*. See also: AWS API Documentation **Request Syntax** response = client.failover_db_cluster( DBClusterIdentifier='string', TargetDBInstanceIdentifier='string' ) Parameters: * **DBClusterIdentifier** (*string*) -- **[REQUIRED]** The identifier of the DB cluster to force a failover for. This parameter isn't case-sensitive. Constraints: * Must match the identifier of an existing DB cluster. * **TargetDBInstanceIdentifier** (*string*) -- The name of the DB instance to promote to the primary DB instance. Specify the DB instance identifier for an Aurora Replica or a Multi-AZ readable standby in the DB cluster, for example "mydbcluster-replica1". This setting isn't supported for RDS for MySQL Multi-AZ DB clusters. Return type: dict Returns: **Response Syntax** { 'DBCluster': { 'AllocatedStorage': 123, 'AvailabilityZones': [ 'string', ], 'BackupRetentionPeriod': 123, 'CharacterSetName': 'string', 'DatabaseName': 'string', 'DBClusterIdentifier': 'string', 'DBClusterParameterGroup': 'string', 'DBSubnetGroup': 'string', 'Status': 'string', 'AutomaticRestartTime': datetime(2015, 1, 1), 'PercentProgress': 'string', 'EarliestRestorableTime': datetime(2015, 1, 1), 'Endpoint': 'string', 'ReaderEndpoint': 'string', 'CustomEndpoints': [ 'string', ], 'MultiAZ': True|False, 'Engine': 'string', 'EngineVersion': 'string', 'LatestRestorableTime': datetime(2015, 1, 1), 'Port': 123, 'MasterUsername': 'string', 'DBClusterOptionGroupMemberships': [ { 'DBClusterOptionGroupName': 'string', 'Status': 'string' }, ], 'PreferredBackupWindow': 'string', 'PreferredMaintenanceWindow': 'string', 'ReplicationSourceIdentifier': 'string', 'ReadReplicaIdentifiers': [ 'string', ], 'StatusInfos': [ { 'StatusType': 'string', 'Normal': True|False, 'Status': 'string', 'Message': 'string' }, ], 'DBClusterMembers': [ { 'DBInstanceIdentifier': 'string', 'IsClusterWriter': True|False, 'DBClusterParameterGroupStatus': 'string', 'PromotionTier': 123 }, ], 'VpcSecurityGroups': [ { 'VpcSecurityGroupId': 'string', 'Status': 'string' }, ], 'HostedZoneId': 'string', 'StorageEncrypted': True|False, 'KmsKeyId': 'string', 'DbClusterResourceId': 'string', 'DBClusterArn': 'string', 'AssociatedRoles': [ { 'RoleArn': 'string', 'Status': 'string', 'FeatureName': 'string' }, ], 'IAMDatabaseAuthenticationEnabled': True|False, 'CloneGroupId': 'string', 'ClusterCreateTime': datetime(2015, 1, 1), 'EarliestBacktrackTime': datetime(2015, 1, 1), 'BacktrackWindow': 123, 'BacktrackConsumedChangeRecords': 123, 'EnabledCloudwatchLogsExports': [ 'string', ], 'Capacity': 123, 'EngineMode': 'string', 'ScalingConfigurationInfo': { 'MinCapacity': 123, 'MaxCapacity': 123, 'AutoPause': True|False, 'SecondsUntilAutoPause': 123, 'TimeoutAction': 'string', 'SecondsBeforeTimeout': 123 }, 'RdsCustomClusterConfiguration': { 'InterconnectSubnetId': 'string', 'TransitGatewayMulticastDomainId': 'string', 'ReplicaMode': 'open-read-only'|'mounted' }, 'DeletionProtection': True|False, 'HttpEndpointEnabled': True|False, 'ActivityStreamMode': 'sync'|'async', 'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping', 'ActivityStreamKmsKeyId': 'string', 'ActivityStreamKinesisStreamName': 'string', 'CopyTagsToSnapshot': True|False, 'CrossAccountClone': True|False, 'DomainMemberships': [ { 'Domain': 'string', 'Status': 'string', 'FQDN': 'string', 'IAMRoleName': 'string', 'OU': 'string', 'AuthSecretArn': 'string', 'DnsIps': [ 'string', ] }, ], 'TagList': [ { 'Key': 'string', 'Value': 'string' }, ], 'GlobalClusterIdentifier': 'string', 'GlobalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'unknown', 'GlobalWriteForwardingRequested': True|False, 'PendingModifiedValues': { 'PendingCloudwatchLogsExports': { 'LogTypesToEnable': [ 'string', ], 'LogTypesToDisable': [ 'string', ] }, 'DBClusterIdentifier': 'string', 'MasterUserPassword': 'string', 'IAMDatabaseAuthenticationEnabled': True|False, 'EngineVersion': 'string', 'BackupRetentionPeriod': 123, 'AllocatedStorage': 123, 'RdsCustomClusterConfiguration': { 'InterconnectSubnetId': 'string', 'TransitGatewayMulticastDomainId': 'string', 'ReplicaMode': 'open-read-only'|'mounted' }, 'Iops': 123, 'StorageType': 'string', 'CertificateDetails': { 'CAIdentifier': 'string', 'ValidTill': datetime(2015, 1, 1) } }, 'DBClusterInstanceClass': 'string', 'StorageType': 'string', 'Iops': 123, 'PubliclyAccessible': True|False, 'AutoMinorVersionUpgrade': True|False, 'MonitoringInterval': 123, 'MonitoringRoleArn': 'string', 'DatabaseInsightsMode': 'standard'|'advanced', 'PerformanceInsightsEnabled': True|False, 'PerformanceInsightsKMSKeyId': 'string', 'PerformanceInsightsRetentionPeriod': 123, 'ServerlessV2ScalingConfiguration': { 'MinCapacity': 123.0, 'MaxCapacity': 123.0, 'SecondsUntilAutoPause': 123 }, 'ServerlessV2PlatformVersion': 'string', 'NetworkType': 'string', 'DBSystemId': 'string', 'MasterUserSecret': { 'SecretArn': 'string', 'SecretStatus': 'string', 'KmsKeyId': 'string' }, 'IOOptimizedNextAllowedModificationTime': datetime(2015, 1, 1), 'LocalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'requested', 'AwsBackupRecoveryPointArn': 'string', 'LimitlessDatabase': { 'Status': 'active'|'not-in-use'|'enabled'|'disabled'|'enabling'|'disabling'|'modifying-max-capacity'|'error', 'MinRequiredACU': 123.0 }, 'StorageThroughput': 123, 'ClusterScalabilityType': 'standard'|'limitless', 'CertificateDetails': { 'CAIdentifier': 'string', 'ValidTill': datetime(2015, 1, 1) }, 'EngineLifecycleSupport': 'string' } } **Response Structure** * *(dict) --* * **DBCluster** *(dict) --* Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster. For an Amazon Aurora DB cluster, this data type is used as a response element in the operations "CreateDBCluster", "DeleteDBCluster", "DescribeDBClusters", "FailoverDBCluster", "ModifyDBCluster", "PromoteReadReplicaDBCluster", "RestoreDBClusterFromS3", "RestoreDBClusterFromSnapshot", "RestoreDBClusterToPointInTime", "StartDBCluster", and "StopDBCluster". For a Multi-AZ DB cluster, this data type is used as a response element in the operations "CreateDBCluster", "DeleteDBCluster", "DescribeDBClusters", "FailoverDBCluster", "ModifyDBCluster", "RebootDBCluster", "RestoreDBClusterFromSnapshot", and "RestoreDBClusterToPointInTime". For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the *Amazon Aurora User Guide.* For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the *Amazon RDS User Guide.* * **AllocatedStorage** *(integer) --* "AllocatedStorage" specifies the allocated storage size in gibibytes (GiB). For Aurora, "AllocatedStorage" can vary because Aurora DB cluster storage size adjusts as needed. * **AvailabilityZones** *(list) --* The list of Availability Zones (AZs) where instances in the DB cluster can be created. * *(string) --* * **BackupRetentionPeriod** *(integer) --* 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) --* The name of the initial database that was specified for the DB cluster when it was created, if one was provided. This same name is returned for the life of the DB cluster. * **DBClusterIdentifier** *(string) --* The user-supplied identifier for the DB cluster. This identifier is the unique key that identifies a DB cluster. * **DBClusterParameterGroup** *(string) --* The name of the DB cluster parameter group for the DB cluster. * **DBSubnetGroup** *(string) --* Information about the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group. * **Status** *(string) --* The current state of this DB cluster. * **AutomaticRestartTime** *(datetime) --* The time when a stopped DB cluster is restarted automatically. * **PercentProgress** *(string) --* 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) --* 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) --* The custom endpoints associated with the DB cluster. * *(string) --* * **MultiAZ** *(boolean) --* Indicates whether the DB cluster has instances in multiple Availability Zones. * **Engine** *(string) --* The database engine used for this DB cluster. * **EngineVersion** *(string) --* The version of the database engine. * **LatestRestorableTime** *(datetime) --* The latest time to which a database can be restored with point-in-time restore. * **Port** *(integer) --* The port that the database engine is listening on. * **MasterUsername** *(string) --* The master username for the DB cluster. * **DBClusterOptionGroupMemberships** *(list) --* 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) --* The daily time range during which automated backups are created if automated backups are enabled, as determined by the "BackupRetentionPeriod". * **PreferredMaintenanceWindow** *(string) --* The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). * **ReplicationSourceIdentifier** *(string) --* The identifier of the source DB cluster if this DB cluster is a read replica. * **ReadReplicaIdentifiers** *(list) --* Contains one or more identifiers of the read replicas associated with this DB cluster. * *(string) --* * **StatusInfos** *(list) --* Reserved for future use. * *(dict) --* Reserved for future use. * **StatusType** *(string) --* Reserved for future use. * **Normal** *(boolean) --* Reserved for future use. * **Status** *(string) --* Reserved for future use. * **Message** *(string) --* Reserved for future use. * **DBClusterMembers** *(list) --* The list of DB 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) --* Indicates whether the cluster member is the primary DB instance for the DB cluster. * **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) --* The list of VPC security groups that the DB cluster belongs to. * *(dict) --* This data type is used as a response element for queries on VPC security group membership. * **VpcSecurityGroupId** *(string) --* The name of the VPC security group. * **Status** *(string) --* The membership status of the VPC security group. Currently, the only valid status is "active". * **HostedZoneId** *(string) --* The ID that Amazon Route 53 assigns when you create a hosted zone. * **StorageEncrypted** *(boolean) --* Indicates whether the DB cluster is encrypted. * **KmsKeyId** *(string) --* If "StorageEncrypted" is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. * **DbClusterResourceId** *(string) --* The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the KMS key for the DB cluster is accessed. * **DBClusterArn** *(string) --* The Amazon Resource Name (ARN) for the DB cluster. * **AssociatedRoles** *(list) --* A list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf. * *(dict) --* Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB cluster. * **RoleArn** *(string) --* The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster. * **Status** *(string) --* Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values: * "ACTIVE" - the IAM role ARN is associated with the DB cluster and can be used to access other Amazon Web Services on your behalf. * "PENDING" - the IAM role ARN is being associated with the DB cluster. * "INVALID" - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other Amazon Web Services on your behalf. * **FeatureName** *(string) --* The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion. * **IAMDatabaseAuthenticationEnabled** *(boolean) --* Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled. * **CloneGroupId** *(string) --* The ID of the clone group with which the DB cluster is associated. For newly created clusters, the ID is typically null. If you clone a DB cluster when the ID is null, the operation populates the ID value for the source cluster and the clone because both clusters become part of the same clone group. Even if you delete the clone cluster, the clone group ID remains for the lifetime of the source cluster to show that it was used in a cloning operation. For PITR, the clone group ID is inherited from the source cluster. For snapshot restore operations, the clone group ID isn't inherited from the source cluster. * **ClusterCreateTime** *(datetime) --* 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.* * *(string) --* * **Capacity** *(integer) --* The current capacity of an Aurora Serverless v1 DB cluster. The capacity is "0" (zero) when the cluster is paused. For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the *Amazon Aurora User Guide*. * **EngineMode** *(string) --* The DB engine mode of the DB cluster, either "provisioned" or "serverless". For more information, see CreateDBCluster. * **ScalingConfigurationInfo** *(dict) --* The scaling configuration for an Aurora DB cluster in "serverless" DB engine mode. For more information, see Using Amazon Aurora Serverless v1 in the *Amazon Aurora User Guide*. * **MinCapacity** *(integer) --* The minimum capacity for an Aurora DB cluster in "serverless" DB engine mode. * **MaxCapacity** *(integer) --* The maximum capacity for an Aurora DB cluster in "serverless" DB engine mode. * **AutoPause** *(boolean) --* Indicates whether automatic pause is allowed for the Aurora DB cluster in "serverless" DB engine mode. When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes. * **SecondsUntilAutoPause** *(integer) --* The remaining amount of time, in seconds, before the Aurora DB cluster in "serverless" mode is paused. A DB cluster can be paused only when it's idle (it has no connections). * **TimeoutAction** *(string) --* The action that occurs when Aurora times out while attempting to change the capacity of an Aurora Serverless v1 cluster. The value is either "ForceApplyCapacityChange" or "RollbackCapacityChange". "ForceApplyCapacityChange", the default, sets the capacity to the specified value as soon as possible. "RollbackCapacityChange" ignores the capacity change if a scaling point isn't found in the timeout period. * **SecondsBeforeTimeout** *(integer) --* The number of seconds before scaling times out. What happens when an attempted scaling action times out is determined by the "TimeoutAction" setting. * **RdsCustomClusterConfiguration** *(dict) --* Reserved for future use. * **InterconnectSubnetId** *(string) --* Reserved for future use. * **TransitGatewayMulticastDomainId** *(string) --* Reserved for future use. * **ReplicaMode** *(string) --* Reserved for future use. * **DeletionProtection** *(boolean) --* Indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. * **HttpEndpointEnabled** *(boolean) --* Indicates whether the HTTP endpoint is enabled for an Aurora DB cluster. When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the DB cluster. You can also query your database from inside the RDS console with the RDS query editor. For more information, see Using RDS Data API in the *Amazon Aurora User Guide*. * **ActivityStreamMode** *(string) --* The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously. * **ActivityStreamStatus** *(string) --* The status of the database activity stream. * **ActivityStreamKmsKeyId** *(string) --* The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. * **ActivityStreamKinesisStreamName** *(string) --* The name of the Amazon Kinesis data stream used for the database activity stream. * **CopyTagsToSnapshot** *(boolean) --* Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster. * **CrossAccountClone** *(boolean) --* Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account. * **DomainMemberships** *(list) --* The Active Directory Domain membership records associated with the DB cluster. * *(dict) --* An Active Directory Domain membership record associated with the DB instance or cluster. * **Domain** *(string) --* The identifier of the Active Directory Domain. * **Status** *(string) --* The status of the Active Directory Domain membership for the DB instance or cluster. Values include "joined", "pending-join", "failed", and so on. * **FQDN** *(string) --* The fully qualified domain name (FQDN) of the Active Directory Domain. * **IAMRoleName** *(string) --* The name of the IAM role used when making API calls to the Directory Service. * **OU** *(string) --* The Active Directory organizational unit for the DB instance or cluster. * **AuthSecretArn** *(string) --* The ARN for the Secrets Manager secret with the credentials for the user that's a member of the domain. * **DnsIps** *(list) --* The IPv4 DNS IP addresses of the primary and secondary Active Directory domain controllers. * *(string) --* * **TagList** *(list) --* A list of tags. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **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}_.:/=+\-@]*)$"). * **GlobalClusterIdentifier** *(string) --* Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster. * **GlobalWriteForwardingStatus** *(string) --* The status of write forwarding for a secondary cluster in an Aurora global database. * **GlobalWriteForwardingRequested** *(boolean) --* Indicates whether write forwarding is enabled for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of "GlobalWriteForwardingStatus" to confirm that the request has completed before using the write forwarding feature for this cluster. * **PendingModifiedValues** *(dict) --* Information about pending changes to the DB cluster. This information is returned only when there are pending changes. Specific changes are identified by subelements. * **PendingCloudwatchLogsExports** *(dict) --* A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated. * **LogTypesToEnable** *(list) --* Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs. * *(string) --* * **LogTypesToDisable** *(list) --* Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs. * *(string) --* * **DBClusterIdentifier** *(string) --* The DBClusterIdentifier value for the DB cluster. * **MasterUserPassword** *(string) --* The master credentials for the DB cluster. * **IAMDatabaseAuthenticationEnabled** *(boolean) --* Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled. * **EngineVersion** *(string) --* The database engine version. * **BackupRetentionPeriod** *(integer) --* The number of days for which automatic DB snapshots are retained. * **AllocatedStorage** *(integer) --* The allocated storage size in gibibytes (GiB) for all database engines except Amazon Aurora. For Aurora, "AllocatedStorage" always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed. * **RdsCustomClusterConfiguration** *(dict) --* Reserved for future use. * **InterconnectSubnetId** *(string) --* Reserved for future use. * **TransitGatewayMulticastDomainId** *(string) --* Reserved for future use. * **ReplicaMode** *(string) --* Reserved for future use. * **Iops** *(integer) --* The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters. * **StorageType** *(string) --* The storage type for the DB cluster. * **CertificateDetails** *(dict) --* The details of the DB instance’s server certificate. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the *Amazon RDS User Guide* and Using SSL/TLS to encrypt a connection to a DB cluster in the *Amazon Aurora User Guide*. * **CAIdentifier** *(string) --* The CA identifier of the CA certificate used for the DB instance's server certificate. * **ValidTill** *(datetime) --* The expiration date of the DB instance’s server certificate. * **DBClusterInstanceClass** *(string) --* The name of the compute and memory capacity class of the DB instance. This setting is only for non-Aurora Multi-AZ DB clusters. * **StorageType** *(string) --* The storage type associated with the DB cluster. * **Iops** *(integer) --* The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters. * **PubliclyAccessible** *(boolean) --* Indicates whether the DB cluster is publicly accessible. When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it. When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address. For more information, see CreateDBCluster. This setting is only for non-Aurora Multi-AZ DB clusters. * **AutoMinorVersionUpgrade** *(boolean) --* Indicates whether minor version patches are applied automatically. This setting is for Aurora DB clusters and Multi-AZ DB clusters. For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version. * **MonitoringInterval** *(integer) --* The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. This setting is only for -Aurora DB clusters and Multi-AZ DB clusters. * **MonitoringRoleArn** *(string) --* The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. This setting is only for Aurora DB clusters and Multi-AZ DB clusters. * **DatabaseInsightsMode** *(string) --* The mode of Database Insights that is enabled for the DB cluster. * **PerformanceInsightsEnabled** *(boolean) --* Indicates whether Performance Insights is enabled for the DB cluster. This setting is only for Aurora DB clusters and Multi-AZ DB clusters. * **PerformanceInsightsKMSKeyId** *(string) --* The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. This setting is only for Aurora DB clusters and Multi-AZ DB clusters. * **PerformanceInsightsRetentionPeriod** *(integer) --* The number of days to retain Performance Insights data. This setting is only for Aurora DB clusters and Multi-AZ DB clusters. Valid Values: * "7" * *month* * 31, where *month* is a number of months from 1-23. Examples: "93" (3 months * 31), "341" (11 months * 31), "589" (19 months * 31) * "731" Default: "7" days * **ServerlessV2ScalingConfiguration** *(dict) --* The scaling configuration for an Aurora Serverless v2 DB cluster. For more information, see Using Amazon Aurora Serverless v2 in the *Amazon Aurora User Guide*. * **MinCapacity** *(float) --* The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. For Aurora versions that support the Aurora Serverless v2 auto-pause feature, the smallest value that you can use is 0. For versions that don't support Aurora Serverless v2 auto-pause, the smallest value that you can use is 0.5. * **MaxCapacity** *(float) --* The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 32, 32.5, 33, and so on. The largest value that you can use is 256 for recent Aurora versions, or 128 for older versions. You can check the attributes of your engine version or platform version to determine the specific maximum capacity supported. * **SecondsUntilAutoPause** *(integer) --* The number of seconds an Aurora Serverless v2 DB instance must be idle before Aurora attempts to automatically pause it. This property is only shown when the minimum capacity for the cluster is set to 0 ACUs. Changing the minimum capacity to a nonzero value removes this property. If you later change the minimum capacity back to 0 ACUs, this property is reset to its default value unless you specify it again. This value ranges between 300 seconds (five minutes) and 86,400 seconds (one day). The default is 300 seconds. * **ServerlessV2PlatformVersion** *(string) --* The version of the Aurora Serverless V2 platform used by the DB cluster. For more information, see Using Aurora Serverless v2 in the *Amazon Aurora User Guide*. * **NetworkType** *(string) --* The network type of the DB instance. The network type is determined by the "DBSubnetGroup" specified for the DB cluster. A "DBSubnetGroup" can support only the IPv4 protocol or the IPv4 and the IPv6 protocols ( "DUAL"). For more information, see Working with a DB instance in a VPC in the *Amazon Aurora User Guide.* This setting is only for Aurora DB clusters. Valid Values: "IPV4 | DUAL" * **DBSystemId** *(string) --* Reserved for future use. * **MasterUserSecret** *(dict) --* The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password. For more information, see Password management with Amazon Web Services Secrets Manager in the *Amazon RDS User Guide* and Password management with Amazon Web Services Secrets Manager in the *Amazon Aurora User Guide.* * **SecretArn** *(string) --* The Amazon Resource Name (ARN) of the secret. * **SecretStatus** *(string) --* The status of the secret. The possible status values include the following: * "creating" - The secret is being created. * "active" - The secret is available for normal use and rotation. * "rotating" - The secret is being rotated. * "impaired" - The secret can be used to access database credentials, but it can't be rotated. A secret might have this status if, for example, permissions are changed so that RDS can no longer access either the secret or the KMS key for the secret. When a secret has this status, you can correct the condition that caused the status. Alternatively, modify the DB instance to turn off automatic management of database credentials, and then modify the DB instance again to turn on automatic management of database credentials. * **KmsKeyId** *(string) --* The Amazon Web Services KMS key identifier that is used to encrypt the secret. * **IOOptimizedNextAllowedModificationTime** *(datetime) --* The next time you can modify the DB cluster to use the "aurora-iopt1" storage type. This setting is only for Aurora DB clusters. * **LocalWriteForwardingStatus** *(string) --* Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it. * **AwsBackupRecoveryPointArn** *(string) --* The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup. * **LimitlessDatabase** *(dict) --* The details for Aurora Limitless Database. * **Status** *(string) --* The status of Aurora Limitless Database. * **MinRequiredACU** *(float) --* The minimum required capacity for Aurora Limitless Database in Aurora capacity units (ACUs). * **StorageThroughput** *(integer) --* The storage throughput for the DB cluster. The throughput is automatically set based on the IOPS that you provision, and is not configurable. This setting is only for non-Aurora Multi-AZ DB clusters. * **ClusterScalabilityType** *(string) --* The scalability mode of the Aurora DB cluster. When set to "limitless", the cluster operates as an Aurora Limitless Database. When set to "standard" (the default), the cluster uses normal DB instance creation. * **CertificateDetails** *(dict) --* The details of the DB instance’s server certificate. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the *Amazon RDS User Guide* and Using SSL/TLS to encrypt a connection to a DB cluster in the *Amazon Aurora User Guide*. * **CAIdentifier** *(string) --* The CA identifier of the CA certificate used for the DB instance's server certificate. * **ValidTill** *(datetime) --* The expiration date of the DB instance’s server certificate. * **EngineLifecycleSupport** *(string) --* The lifecycle type for the DB cluster. For more information, see CreateDBCluster. **Exceptions** * "RDS.Client.exceptions.DBClusterNotFoundFault" * "RDS.Client.exceptions.InvalidDBClusterStateFault" * "RDS.Client.exceptions.InvalidDBInstanceStateFault" **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: { 'DBCluster': { }, 'ResponseMetadata': { '...': '...', }, } RDS / Client / modify_db_cluster_parameter_group modify_db_cluster_parameter_group ********************************* RDS.Client.modify_db_cluster_parameter_group(**kwargs) Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: "ParameterName", "ParameterValue", and "ApplyMethod". A maximum of 20 parameters can be modified in a single request. Warning: After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create operation before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the "character_set_database" parameter. You can use the *Parameter Groups* option of the Amazon RDS console or the "DescribeDBClusterParameters" operation to verify that your DB cluster parameter group has been created or modified.If the modified DB cluster parameter group is used by an Aurora Serverless v1 cluster, Aurora applies the update immediately. The cluster restart might interrupt your workload. In that case, your application must reopen any connections and retry any transactions that were active when the parameter changes took effect. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the *Amazon Aurora User Guide*. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the *Amazon RDS User Guide.* See also: AWS API Documentation **Request Syntax** response = client.modify_db_cluster_parameter_group( DBClusterParameterGroupName='string', Parameters=[ { 'ParameterName': 'string', 'ParameterValue': 'string', 'Description': 'string', 'Source': 'string', 'ApplyType': 'string', 'DataType': 'string', 'AllowedValues': 'string', 'IsModifiable': True|False, 'MinimumEngineVersion': 'string', 'ApplyMethod': 'immediate'|'pending-reboot', 'SupportedEngineModes': [ 'string', ] }, ] ) Parameters: * **DBClusterParameterGroupName** (*string*) -- **[REQUIRED]** The name of the DB cluster parameter group to modify. * **Parameters** (*list*) -- **[REQUIRED]** A list of parameters in the DB cluster parameter group to modify. Valid Values (for the application method): "immediate | pending-reboot" Note: You can use the "immediate" value with dynamic parameters only. You can use the "pending-reboot" value for both dynamic and static parameters.When the application method is "immediate", changes to dynamic parameters are applied immediately to the DB clusters associated with the parameter group. When the application method is "pending-reboot", changes to dynamic and static parameters are applied after a reboot without failover to the DB clusters associated with the parameter group. * *(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) --* The name of the parameter. * **ParameterValue** *(string) --* The value of the parameter. * **Description** *(string) --* Provides a description of the parameter. * **Source** *(string) --* 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. * *(string) --* Return type: dict Returns: **Response Syntax** { 'DBClusterParameterGroupName': 'string' } **Response Structure** * *(dict) --* * **DBClusterParameterGroupName** *(string) --* The name of the DB cluster parameter group. Constraints: * Must be 1 to 255 letters or numbers. * First character must be a letter * Can't end with a hyphen or contain two consecutive hyphens Note: This value is stored as a lowercase string. **Exceptions** * "RDS.Client.exceptions.DBParameterGroupNotFoundFault" * "RDS.Client.exceptions.InvalidDBParameterGroupStateFault" **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': { '...': '...', }, } RDS / Client / reset_db_parameter_group reset_db_parameter_group ************************ RDS.Client.reset_db_parameter_group(**kwargs) Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters, provide a list of the following: "ParameterName" and "ApplyMethod". To reset the entire DB parameter group, specify the "DBParameterGroup" name and "ResetAllParameters" parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to "pending-reboot" to take effect on the next DB instance restart or "RebootDBInstance" request. See also: AWS API Documentation **Request Syntax** response = client.reset_db_parameter_group( DBParameterGroupName='string', ResetAllParameters=True|False, Parameters=[ { 'ParameterName': 'string', 'ParameterValue': 'string', 'Description': 'string', 'Source': 'string', 'ApplyType': 'string', 'DataType': 'string', 'AllowedValues': 'string', 'IsModifiable': True|False, 'MinimumEngineVersion': 'string', 'ApplyMethod': 'immediate'|'pending-reboot', 'SupportedEngineModes': [ 'string', ] }, ] ) Parameters: * **DBParameterGroupName** (*string*) -- **[REQUIRED]** The name of the DB parameter group. Constraints: * Must match the name of an existing "DBParameterGroup". * **ResetAllParameters** (*boolean*) -- Specifies whether to reset all parameters in the DB parameter group to default values. By default, all parameters in the DB parameter group are reset to default values. * **Parameters** (*list*) -- 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" * *(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) --* The name of the parameter. * **ParameterValue** *(string) --* The value of the parameter. * **Description** *(string) --* Provides a description of the parameter. * **Source** *(string) --* 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. * *(string) --* Return type: dict Returns: **Response Syntax** { 'DBParameterGroupName': 'string' } **Response Structure** * *(dict) --* Contains the result of a successful invocation of the "ModifyDBParameterGroup" or "ResetDBParameterGroup" operation. * **DBParameterGroupName** *(string) --* The name of the DB parameter group. **Exceptions** * "RDS.Client.exceptions.InvalidDBParameterGroupStateFault" * "RDS.Client.exceptions.DBParameterGroupNotFoundFault" **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': { '...': '...', }, } RDS / Client / delete_db_parameter_group delete_db_parameter_group ************************* RDS.Client.delete_db_parameter_group(**kwargs) Deletes a specified DB parameter group. The DB parameter group to be deleted can't be associated with any DB instances. See also: AWS API Documentation **Request Syntax** response = client.delete_db_parameter_group( DBParameterGroupName='string' ) Parameters: **DBParameterGroupName** (*string*) -- **[REQUIRED]** The name of the DB parameter group. Constraints: * Must be the name of an existing DB parameter group * You can't delete a default DB parameter group * Can't be associated with any DB instances Returns: None **Exceptions** * "RDS.Client.exceptions.InvalidDBParameterGroupStateFault" * "RDS.Client.exceptions.DBParameterGroupNotFoundFault" **Examples** The following example deletes a DB parameter group. response = client.delete_db_parameter_group( DBParameterGroupName='mydbparamgroup3', ) print(response) Expected Output: { 'ResponseMetadata': { '...': '...', }, } RDS / Client / create_custom_db_engine_version create_custom_db_engine_version ******************************* RDS.Client.create_custom_db_engine_version(**kwargs) Creates a custom DB engine version (CEV). See also: AWS API Documentation **Request Syntax** response = client.create_custom_db_engine_version( Engine='string', EngineVersion='string', DatabaseInstallationFilesS3BucketName='string', DatabaseInstallationFilesS3Prefix='string', ImageId='string', KMSKeyId='string', Description='string', Manifest='string', Tags=[ { 'Key': 'string', 'Value': 'string' }, ], SourceCustomDbEngineVersionIdentifier='string', UseAwsProvidedLatestImage=True|False ) Parameters: * **Engine** (*string*) -- **[REQUIRED]** The database engine. RDS Custom for Oracle supports the following values: * "custom-oracle-ee" * "custom-oracle-ee-cdb" * "custom-oracle-se2" * "custom-oracle-se2-cdb" * **EngineVersion** (*string*) -- **[REQUIRED]** The name of your CEV. The name format is 19.*customized_string*. For example, a valid CEV name is "19.my_cev1". This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of "Engine" and "EngineVersion" is unique per customer per Region. * **DatabaseInstallationFilesS3BucketName** (*string*) -- The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is "my-custom-installation-files". * **DatabaseInstallationFilesS3Prefix** (*string*) -- The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is "123456789012/cev1". If this setting isn't specified, no prefix is assumed. * **ImageId** (*string*) -- The ID of the Amazon Machine Image (AMI). For RDS Custom for SQL Server, an AMI ID is required to create a CEV. For RDS Custom for Oracle, the default is the most recent AMI available, but you can specify an AMI ID that was used in a different Oracle CEV. Find the AMIs used by your CEVs by calling the DescribeDBEngineVersions operation. * **KMSKeyId** (*string*) -- The Amazon Web Services KMS key identifier for an encrypted CEV. A symmetric encryption KMS key is required for RDS Custom, but optional for Amazon RDS. If you have an existing symmetric encryption KMS key in your account, you can use it with RDS Custom. No further action is necessary. If you don't already have a symmetric encryption KMS key in your account, follow the instructions in Creating a symmetric encryption KMS key in the *Amazon Web Services Key Management Service Developer Guide*. You can choose the same symmetric encryption key when you create a CEV and a DB instance, or choose different keys. * **Description** (*string*) -- An optional description of your CEV. * **Manifest** (*string*) -- The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed. The following JSON fields are valid: MediaImportTemplateVersion Version of the CEV manifest. The date is in the format "YYYY- MM-DD". databaseInstallationFileNames Ordered list of installation files for the CEV. opatchFileNames Ordered list of OPatch installers used for the Oracle DB engine. psuRuPatchFileNames The PSU and RU patches for this CEV. OtherPatchFileNames The patches that are not in the list of PSU and RU patches. Amazon RDS applies these patches after applying the PSU and RU patches. For more information, see Creating the CEV manifest in the *Amazon RDS User Guide*. * **Tags** (*list*) -- A list of tags. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **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}_.:/=+\-@]*)$"). * **SourceCustomDbEngineVersionIdentifier** (*string*) -- The ARN of a CEV to use as a source for creating a new CEV. You can specify a different Amazon Machine Imagine (AMI) by using either "Source" or "UseAwsProvidedLatestImage". You can't specify a different JSON manifest when you specify "SourceCustomDbEngineVersionIdentifier". * **UseAwsProvidedLatestImage** (*boolean*) -- Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV. If you specify "UseAwsProvidedLatestImage", you can't also specify "ImageId". Return type: dict Returns: **Response Syntax** { 'Engine': 'string', 'EngineVersion': 'string', 'DBParameterGroupFamily': 'string', 'DBEngineDescription': 'string', 'DBEngineVersionDescription': 'string', 'DefaultCharacterSet': { 'CharacterSetName': 'string', 'CharacterSetDescription': 'string' }, 'Image': { 'ImageId': 'string', 'Status': 'string' }, 'DBEngineMediaType': 'string', 'SupportedCharacterSets': [ { 'CharacterSetName': 'string', 'CharacterSetDescription': 'string' }, ], 'SupportedNcharCharacterSets': [ { 'CharacterSetName': 'string', 'CharacterSetDescription': 'string' }, ], 'ValidUpgradeTarget': [ { 'Engine': 'string', 'EngineVersion': 'string', 'Description': 'string', 'AutoUpgrade': True|False, 'IsMajorVersionUpgrade': True|False, 'SupportedEngineModes': [ 'string', ], 'SupportsParallelQuery': True|False, 'SupportsGlobalDatabases': True|False, 'SupportsBabelfish': True|False, 'SupportsLimitlessDatabase': True|False, 'SupportsLocalWriteForwarding': True|False, 'SupportsIntegrations': True|False }, ], 'SupportedTimezones': [ { 'TimezoneName': 'string' }, ], 'ExportableLogTypes': [ 'string', ], 'SupportsLogExportsToCloudwatchLogs': True|False, 'SupportsReadReplica': True|False, 'SupportedEngineModes': [ 'string', ], 'SupportedFeatureNames': [ 'string', ], 'Status': 'string', 'SupportsParallelQuery': True|False, 'SupportsGlobalDatabases': True|False, 'MajorEngineVersion': 'string', 'DatabaseInstallationFilesS3BucketName': 'string', 'DatabaseInstallationFilesS3Prefix': 'string', 'DBEngineVersionArn': 'string', 'KMSKeyId': 'string', 'CreateTime': datetime(2015, 1, 1), 'TagList': [ { 'Key': 'string', 'Value': 'string' }, ], 'SupportsBabelfish': True|False, 'CustomDBEngineVersionManifest': 'string', 'SupportsLimitlessDatabase': True|False, 'SupportsCertificateRotationWithoutRestart': True|False, 'SupportedCACertificateIdentifiers': [ 'string', ], 'SupportsLocalWriteForwarding': True|False, 'SupportsIntegrations': True|False, 'ServerlessV2FeaturesSupport': { 'MinCapacity': 123.0, 'MaxCapacity': 123.0 } } **Response Structure** * *(dict) --* This data type is used as a response element in the action "DescribeDBEngineVersions". * **Engine** *(string) --* The name of the database engine. * **EngineVersion** *(string) --* The version number of the database engine. * **DBParameterGroupFamily** *(string) --* The name of the DB parameter group family for the database engine. * **DBEngineDescription** *(string) --* The description of the database engine. * **DBEngineVersionDescription** *(string) --* The description of the database engine version. * **DefaultCharacterSet** *(dict) --* The default character set for new instances of this engine version, if the "CharacterSetName" parameter of the CreateDBInstance API isn't specified. * **CharacterSetName** *(string) --* The name of the character set. * **CharacterSetDescription** *(string) --* The description of the character set. * **Image** *(dict) --* The EC2 image * **ImageId** *(string) --* A value that indicates the ID of the AMI. * **Status** *(string) --* A value that indicates the status of a custom engine version (CEV). * **DBEngineMediaType** *(string) --* A value that indicates the source media provider of the AMI based on the usage operation. Applicable for RDS Custom for SQL Server. * **SupportedCharacterSets** *(list) --* A list of the character sets supported by this engine for the "CharacterSetName" parameter of the "CreateDBInstance" operation. * *(dict) --* This data type is used as a response element in the action "DescribeDBEngineVersions". * **CharacterSetName** *(string) --* The name of the character set. * **CharacterSetDescription** *(string) --* The description of the character set. * **SupportedNcharCharacterSets** *(list) --* A list of the character sets supported by the Oracle DB engine for the "NcharCharacterSetName" parameter of the "CreateDBInstance" operation. * *(dict) --* This data type is used as a response element in the action "DescribeDBEngineVersions". * **CharacterSetName** *(string) --* The name of the character set. * **CharacterSetDescription** *(string) --* The description of the character set. * **ValidUpgradeTarget** *(list) --* A list of engine versions that this database engine version can be upgraded to. * *(dict) --* The version of the database engine that a DB instance can be upgraded to. * **Engine** *(string) --* The name of the upgrade target database engine. * **EngineVersion** *(string) --* The version number of the upgrade target database engine. * **Description** *(string) --* The version of the database engine that a DB instance can be upgraded to. * **AutoUpgrade** *(boolean) --* Indicates whether the target version is applied to any source DB instances that have "AutoMinorVersionUpgrade" set to true. This parameter is dynamic, and is set by RDS. * **IsMajorVersionUpgrade** *(boolean) --* Indicates whether upgrading to the target version requires upgrading the major version of the database engine. * **SupportedEngineModes** *(list) --* A list of the supported DB engine modes for the target engine version. * *(string) --* * **SupportsParallelQuery** *(boolean) --* Indicates whether you can use Aurora parallel query with the target engine version. * **SupportsGlobalDatabases** *(boolean) --* Indicates whether you can use Aurora global databases with the target engine version. * **SupportsBabelfish** *(boolean) --* Indicates whether you can use Babelfish for Aurora PostgreSQL with the target engine version. * **SupportsLimitlessDatabase** *(boolean) --* Indicates whether the DB engine version supports Aurora Limitless Database. * **SupportsLocalWriteForwarding** *(boolean) --* Indicates whether the target engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances. Valid for: Aurora DB clusters only * **SupportsIntegrations** *(boolean) --* Indicates whether the DB engine version supports zero- ETL integrations with Amazon Redshift. * **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. * *(string) --* * **SupportsLogExportsToCloudwatchLogs** *(boolean) --* 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. * *(string) --* * **SupportedFeatureNames** *(list) --* A list of features supported by the DB engine. The supported features vary by DB engine and DB engine version. To determine the supported features for a specific DB engine and DB engine version using the CLI, use the following command: "aws rds describe-db-engine-versions --engine --engine-version " For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, use the following command: "aws rds describe-db-engine-versions --engine postgres --engine-version 13.3" The supported features are listed under "SupportedFeatureNames" in the output. * *(string) --* * **Status** *(string) --* The status of the DB engine version, either "available" or "deprecated". * **SupportsParallelQuery** *(boolean) --* Indicates whether you can use Aurora parallel query with a specific DB engine version. * **SupportsGlobalDatabases** *(boolean) --* Indicates whether you can use Aurora global databases with a specific DB engine version. * **MajorEngineVersion** *(string) --* The major engine version of the CEV. * **DatabaseInstallationFilesS3BucketName** *(string) --* The name of the Amazon S3 bucket that contains your database installation files. * **DatabaseInstallationFilesS3Prefix** *(string) --* The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed. * **DBEngineVersionArn** *(string) --* The ARN of the custom engine version. * **KMSKeyId** *(string) --* The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS. * **CreateTime** *(datetime) --* The creation time of the DB engine version. * **TagList** *(list) --* A list of tags. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **Key** *(string) --* A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **Value** *(string) --* A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **SupportsBabelfish** *(boolean) --* Indicates whether the engine version supports Babelfish for Aurora PostgreSQL. * **CustomDBEngineVersionManifest** *(string) --* JSON string that lists the installation files and parameters that RDS Custom uses to create a custom engine version (CEV). RDS Custom applies the patches in the order in which they're listed in the manifest. You can set the Oracle home, Oracle base, and UNIX/Linux user and group using the installation parameters. For more information, see JSON fields in the CEV manifest in the *Amazon RDS User Guide*. * **SupportsLimitlessDatabase** *(boolean) --* Indicates whether the DB engine version supports Aurora Limitless Database. * **SupportsCertificateRotationWithoutRestart** *(boolean) --* Indicates whether the engine version supports rotating the server certificate without rebooting the DB instance. * **SupportedCACertificateIdentifiers** *(list) --* A list of the supported CA certificate identifiers. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the *Amazon RDS User Guide* and Using SSL/TLS to encrypt a connection to a DB cluster in the *Amazon Aurora User Guide*. * *(string) --* * **SupportsLocalWriteForwarding** *(boolean) --* Indicates whether the DB engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances. Valid for: Aurora DB clusters only * **SupportsIntegrations** *(boolean) --* Indicates whether the DB engine version supports zero-ETL integrations with Amazon Redshift. * **ServerlessV2FeaturesSupport** *(dict) --* Specifies any Aurora Serverless v2 properties or limits that differ between Aurora engine versions. You can test the values of this attribute when deciding which Aurora version to use in a new or upgraded DB cluster. You can also retrieve the version of an existing DB cluster and check whether that version supports certain Aurora Serverless v2 features before you attempt to use those features. * **MinCapacity** *(float) --* If the minimum capacity is 0 ACUs, the engine version or platform version supports the automatic pause/resume feature of Aurora Serverless v2. * **MaxCapacity** *(float) --* Specifies the upper Aurora Serverless v2 capacity limit for a particular engine version or platform version. Depending on the engine version, the maximum capacity for an Aurora Serverless v2 cluster might be "256" or "128". **Exceptions** * "RDS.Client.exceptions.CustomDBEngineVersionAlreadyExistsFault" * "RDS.Client.exceptions.CustomDBEngineVersionQuotaExceededFault" * "RDS.Client.exceptions.Ec2ImagePropertiesNotSupportedFault" * "RDS.Client.exceptions.KMSKeyNotAccessibleFault" * "RDS.Client.exceptions.CreateCustomDBEngineVersionFault" RDS / Client / close close ***** RDS.Client.close() Closes underlying endpoint connections. RDS / Client / promote_read_replica_db_cluster promote_read_replica_db_cluster ******************************* RDS.Client.promote_read_replica_db_cluster(**kwargs) Promotes a read replica DB cluster to a standalone DB cluster. See also: AWS API Documentation **Request Syntax** response = client.promote_read_replica_db_cluster( DBClusterIdentifier='string' ) Parameters: **DBClusterIdentifier** (*string*) -- **[REQUIRED]** The identifier of the DB cluster read replica to promote. This parameter isn't case-sensitive. Constraints: * Must match the identifier of an existing DB cluster read replica. Example: "my-cluster-replica1" Return type: dict Returns: **Response Syntax** { 'DBCluster': { 'AllocatedStorage': 123, 'AvailabilityZones': [ 'string', ], 'BackupRetentionPeriod': 123, 'CharacterSetName': 'string', 'DatabaseName': 'string', 'DBClusterIdentifier': 'string', 'DBClusterParameterGroup': 'string', 'DBSubnetGroup': 'string', 'Status': 'string', 'AutomaticRestartTime': datetime(2015, 1, 1), 'PercentProgress': 'string', 'EarliestRestorableTime': datetime(2015, 1, 1), 'Endpoint': 'string', 'ReaderEndpoint': 'string', 'CustomEndpoints': [ 'string', ], 'MultiAZ': True|False, 'Engine': 'string', 'EngineVersion': 'string', 'LatestRestorableTime': datetime(2015, 1, 1), 'Port': 123, 'MasterUsername': 'string', 'DBClusterOptionGroupMemberships': [ { 'DBClusterOptionGroupName': 'string', 'Status': 'string' }, ], 'PreferredBackupWindow': 'string', 'PreferredMaintenanceWindow': 'string', 'ReplicationSourceIdentifier': 'string', 'ReadReplicaIdentifiers': [ 'string', ], 'StatusInfos': [ { 'StatusType': 'string', 'Normal': True|False, 'Status': 'string', 'Message': 'string' }, ], 'DBClusterMembers': [ { 'DBInstanceIdentifier': 'string', 'IsClusterWriter': True|False, 'DBClusterParameterGroupStatus': 'string', 'PromotionTier': 123 }, ], 'VpcSecurityGroups': [ { 'VpcSecurityGroupId': 'string', 'Status': 'string' }, ], 'HostedZoneId': 'string', 'StorageEncrypted': True|False, 'KmsKeyId': 'string', 'DbClusterResourceId': 'string', 'DBClusterArn': 'string', 'AssociatedRoles': [ { 'RoleArn': 'string', 'Status': 'string', 'FeatureName': 'string' }, ], 'IAMDatabaseAuthenticationEnabled': True|False, 'CloneGroupId': 'string', 'ClusterCreateTime': datetime(2015, 1, 1), 'EarliestBacktrackTime': datetime(2015, 1, 1), 'BacktrackWindow': 123, 'BacktrackConsumedChangeRecords': 123, 'EnabledCloudwatchLogsExports': [ 'string', ], 'Capacity': 123, 'EngineMode': 'string', 'ScalingConfigurationInfo': { 'MinCapacity': 123, 'MaxCapacity': 123, 'AutoPause': True|False, 'SecondsUntilAutoPause': 123, 'TimeoutAction': 'string', 'SecondsBeforeTimeout': 123 }, 'RdsCustomClusterConfiguration': { 'InterconnectSubnetId': 'string', 'TransitGatewayMulticastDomainId': 'string', 'ReplicaMode': 'open-read-only'|'mounted' }, 'DeletionProtection': True|False, 'HttpEndpointEnabled': True|False, 'ActivityStreamMode': 'sync'|'async', 'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping', 'ActivityStreamKmsKeyId': 'string', 'ActivityStreamKinesisStreamName': 'string', 'CopyTagsToSnapshot': True|False, 'CrossAccountClone': True|False, 'DomainMemberships': [ { 'Domain': 'string', 'Status': 'string', 'FQDN': 'string', 'IAMRoleName': 'string', 'OU': 'string', 'AuthSecretArn': 'string', 'DnsIps': [ 'string', ] }, ], 'TagList': [ { 'Key': 'string', 'Value': 'string' }, ], 'GlobalClusterIdentifier': 'string', 'GlobalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'unknown', 'GlobalWriteForwardingRequested': True|False, 'PendingModifiedValues': { 'PendingCloudwatchLogsExports': { 'LogTypesToEnable': [ 'string', ], 'LogTypesToDisable': [ 'string', ] }, 'DBClusterIdentifier': 'string', 'MasterUserPassword': 'string', 'IAMDatabaseAuthenticationEnabled': True|False, 'EngineVersion': 'string', 'BackupRetentionPeriod': 123, 'AllocatedStorage': 123, 'RdsCustomClusterConfiguration': { 'InterconnectSubnetId': 'string', 'TransitGatewayMulticastDomainId': 'string', 'ReplicaMode': 'open-read-only'|'mounted' }, 'Iops': 123, 'StorageType': 'string', 'CertificateDetails': { 'CAIdentifier': 'string', 'ValidTill': datetime(2015, 1, 1) } }, 'DBClusterInstanceClass': 'string', 'StorageType': 'string', 'Iops': 123, 'PubliclyAccessible': True|False, 'AutoMinorVersionUpgrade': True|False, 'MonitoringInterval': 123, 'MonitoringRoleArn': 'string', 'DatabaseInsightsMode': 'standard'|'advanced', 'PerformanceInsightsEnabled': True|False, 'PerformanceInsightsKMSKeyId': 'string', 'PerformanceInsightsRetentionPeriod': 123, 'ServerlessV2ScalingConfiguration': { 'MinCapacity': 123.0, 'MaxCapacity': 123.0, 'SecondsUntilAutoPause': 123 }, 'ServerlessV2PlatformVersion': 'string', 'NetworkType': 'string', 'DBSystemId': 'string', 'MasterUserSecret': { 'SecretArn': 'string', 'SecretStatus': 'string', 'KmsKeyId': 'string' }, 'IOOptimizedNextAllowedModificationTime': datetime(2015, 1, 1), 'LocalWriteForwardingStatus': 'enabled'|'disabled'|'enabling'|'disabling'|'requested', 'AwsBackupRecoveryPointArn': 'string', 'LimitlessDatabase': { 'Status': 'active'|'not-in-use'|'enabled'|'disabled'|'enabling'|'disabling'|'modifying-max-capacity'|'error', 'MinRequiredACU': 123.0 }, 'StorageThroughput': 123, 'ClusterScalabilityType': 'standard'|'limitless', 'CertificateDetails': { 'CAIdentifier': 'string', 'ValidTill': datetime(2015, 1, 1) }, 'EngineLifecycleSupport': 'string' } } **Response Structure** * *(dict) --* * **DBCluster** *(dict) --* Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster. For an Amazon Aurora DB cluster, this data type is used as a response element in the operations "CreateDBCluster", "DeleteDBCluster", "DescribeDBClusters", "FailoverDBCluster", "ModifyDBCluster", "PromoteReadReplicaDBCluster", "RestoreDBClusterFromS3", "RestoreDBClusterFromSnapshot", "RestoreDBClusterToPointInTime", "StartDBCluster", and "StopDBCluster". For a Multi-AZ DB cluster, this data type is used as a response element in the operations "CreateDBCluster", "DeleteDBCluster", "DescribeDBClusters", "FailoverDBCluster", "ModifyDBCluster", "RebootDBCluster", "RestoreDBClusterFromSnapshot", and "RestoreDBClusterToPointInTime". For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the *Amazon Aurora User Guide.* For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the *Amazon RDS User Guide.* * **AllocatedStorage** *(integer) --* "AllocatedStorage" specifies the allocated storage size in gibibytes (GiB). For Aurora, "AllocatedStorage" can vary because Aurora DB cluster storage size adjusts as needed. * **AvailabilityZones** *(list) --* The list of Availability Zones (AZs) where instances in the DB cluster can be created. * *(string) --* * **BackupRetentionPeriod** *(integer) --* 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) --* The name of the initial database that was specified for the DB cluster when it was created, if one was provided. This same name is returned for the life of the DB cluster. * **DBClusterIdentifier** *(string) --* The user-supplied identifier for the DB cluster. This identifier is the unique key that identifies a DB cluster. * **DBClusterParameterGroup** *(string) --* The name of the DB cluster parameter group for the DB cluster. * **DBSubnetGroup** *(string) --* Information about the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group. * **Status** *(string) --* The current state of this DB cluster. * **AutomaticRestartTime** *(datetime) --* The time when a stopped DB cluster is restarted automatically. * **PercentProgress** *(string) --* 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) --* 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) --* The custom endpoints associated with the DB cluster. * *(string) --* * **MultiAZ** *(boolean) --* Indicates whether the DB cluster has instances in multiple Availability Zones. * **Engine** *(string) --* The database engine used for this DB cluster. * **EngineVersion** *(string) --* The version of the database engine. * **LatestRestorableTime** *(datetime) --* The latest time to which a database can be restored with point-in-time restore. * **Port** *(integer) --* The port that the database engine is listening on. * **MasterUsername** *(string) --* The master username for the DB cluster. * **DBClusterOptionGroupMemberships** *(list) --* 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) --* The daily time range during which automated backups are created if automated backups are enabled, as determined by the "BackupRetentionPeriod". * **PreferredMaintenanceWindow** *(string) --* The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). * **ReplicationSourceIdentifier** *(string) --* The identifier of the source DB cluster if this DB cluster is a read replica. * **ReadReplicaIdentifiers** *(list) --* Contains one or more identifiers of the read replicas associated with this DB cluster. * *(string) --* * **StatusInfos** *(list) --* Reserved for future use. * *(dict) --* Reserved for future use. * **StatusType** *(string) --* Reserved for future use. * **Normal** *(boolean) --* Reserved for future use. * **Status** *(string) --* Reserved for future use. * **Message** *(string) --* Reserved for future use. * **DBClusterMembers** *(list) --* The list of DB 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) --* Indicates whether the cluster member is the primary DB instance for the DB cluster. * **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) --* The list of VPC security groups that the DB cluster belongs to. * *(dict) --* This data type is used as a response element for queries on VPC security group membership. * **VpcSecurityGroupId** *(string) --* The name of the VPC security group. * **Status** *(string) --* The membership status of the VPC security group. Currently, the only valid status is "active". * **HostedZoneId** *(string) --* The ID that Amazon Route 53 assigns when you create a hosted zone. * **StorageEncrypted** *(boolean) --* Indicates whether the DB cluster is encrypted. * **KmsKeyId** *(string) --* If "StorageEncrypted" is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. * **DbClusterResourceId** *(string) --* The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the KMS key for the DB cluster is accessed. * **DBClusterArn** *(string) --* The Amazon Resource Name (ARN) for the DB cluster. * **AssociatedRoles** *(list) --* A list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf. * *(dict) --* Describes an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB cluster. * **RoleArn** *(string) --* The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster. * **Status** *(string) --* Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values: * "ACTIVE" - the IAM role ARN is associated with the DB cluster and can be used to access other Amazon Web Services on your behalf. * "PENDING" - the IAM role ARN is being associated with the DB cluster. * "INVALID" - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other Amazon Web Services on your behalf. * **FeatureName** *(string) --* The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion. * **IAMDatabaseAuthenticationEnabled** *(boolean) --* Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled. * **CloneGroupId** *(string) --* The ID of the clone group with which the DB cluster is associated. For newly created clusters, the ID is typically null. If you clone a DB cluster when the ID is null, the operation populates the ID value for the source cluster and the clone because both clusters become part of the same clone group. Even if you delete the clone cluster, the clone group ID remains for the lifetime of the source cluster to show that it was used in a cloning operation. For PITR, the clone group ID is inherited from the source cluster. For snapshot restore operations, the clone group ID isn't inherited from the source cluster. * **ClusterCreateTime** *(datetime) --* 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.* * *(string) --* * **Capacity** *(integer) --* The current capacity of an Aurora Serverless v1 DB cluster. The capacity is "0" (zero) when the cluster is paused. For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the *Amazon Aurora User Guide*. * **EngineMode** *(string) --* The DB engine mode of the DB cluster, either "provisioned" or "serverless". For more information, see CreateDBCluster. * **ScalingConfigurationInfo** *(dict) --* The scaling configuration for an Aurora DB cluster in "serverless" DB engine mode. For more information, see Using Amazon Aurora Serverless v1 in the *Amazon Aurora User Guide*. * **MinCapacity** *(integer) --* The minimum capacity for an Aurora DB cluster in "serverless" DB engine mode. * **MaxCapacity** *(integer) --* The maximum capacity for an Aurora DB cluster in "serverless" DB engine mode. * **AutoPause** *(boolean) --* Indicates whether automatic pause is allowed for the Aurora DB cluster in "serverless" DB engine mode. When the value is set to false for an Aurora Serverless v1 DB cluster, the DB cluster automatically resumes. * **SecondsUntilAutoPause** *(integer) --* The remaining amount of time, in seconds, before the Aurora DB cluster in "serverless" mode is paused. A DB cluster can be paused only when it's idle (it has no connections). * **TimeoutAction** *(string) --* The action that occurs when Aurora times out while attempting to change the capacity of an Aurora Serverless v1 cluster. The value is either "ForceApplyCapacityChange" or "RollbackCapacityChange". "ForceApplyCapacityChange", the default, sets the capacity to the specified value as soon as possible. "RollbackCapacityChange" ignores the capacity change if a scaling point isn't found in the timeout period. * **SecondsBeforeTimeout** *(integer) --* The number of seconds before scaling times out. What happens when an attempted scaling action times out is determined by the "TimeoutAction" setting. * **RdsCustomClusterConfiguration** *(dict) --* Reserved for future use. * **InterconnectSubnetId** *(string) --* Reserved for future use. * **TransitGatewayMulticastDomainId** *(string) --* Reserved for future use. * **ReplicaMode** *(string) --* Reserved for future use. * **DeletionProtection** *(boolean) --* Indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. * **HttpEndpointEnabled** *(boolean) --* Indicates whether the HTTP endpoint is enabled for an Aurora DB cluster. When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the DB cluster. You can also query your database from inside the RDS console with the RDS query editor. For more information, see Using RDS Data API in the *Amazon Aurora User Guide*. * **ActivityStreamMode** *(string) --* The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously. * **ActivityStreamStatus** *(string) --* The status of the database activity stream. * **ActivityStreamKmsKeyId** *(string) --* The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. * **ActivityStreamKinesisStreamName** *(string) --* The name of the Amazon Kinesis data stream used for the database activity stream. * **CopyTagsToSnapshot** *(boolean) --* Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster. * **CrossAccountClone** *(boolean) --* Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account. * **DomainMemberships** *(list) --* The Active Directory Domain membership records associated with the DB cluster. * *(dict) --* An Active Directory Domain membership record associated with the DB instance or cluster. * **Domain** *(string) --* The identifier of the Active Directory Domain. * **Status** *(string) --* The status of the Active Directory Domain membership for the DB instance or cluster. Values include "joined", "pending-join", "failed", and so on. * **FQDN** *(string) --* The fully qualified domain name (FQDN) of the Active Directory Domain. * **IAMRoleName** *(string) --* The name of the IAM role used when making API calls to the Directory Service. * **OU** *(string) --* The Active Directory organizational unit for the DB instance or cluster. * **AuthSecretArn** *(string) --* The ARN for the Secrets Manager secret with the credentials for the user that's a member of the domain. * **DnsIps** *(list) --* The IPv4 DNS IP addresses of the primary and secondary Active Directory domain controllers. * *(string) --* * **TagList** *(list) --* A list of tags. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **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}_.:/=+\-@]*)$"). * **GlobalClusterIdentifier** *(string) --* Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster. * **GlobalWriteForwardingStatus** *(string) --* The status of write forwarding for a secondary cluster in an Aurora global database. * **GlobalWriteForwardingRequested** *(boolean) --* Indicates whether write forwarding is enabled for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of "GlobalWriteForwardingStatus" to confirm that the request has completed before using the write forwarding feature for this cluster. * **PendingModifiedValues** *(dict) --* Information about pending changes to the DB cluster. This information is returned only when there are pending changes. Specific changes are identified by subelements. * **PendingCloudwatchLogsExports** *(dict) --* A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated. * **LogTypesToEnable** *(list) --* Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs. * *(string) --* * **LogTypesToDisable** *(list) --* Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs. * *(string) --* * **DBClusterIdentifier** *(string) --* The DBClusterIdentifier value for the DB cluster. * **MasterUserPassword** *(string) --* The master credentials for the DB cluster. * **IAMDatabaseAuthenticationEnabled** *(boolean) --* Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled. * **EngineVersion** *(string) --* The database engine version. * **BackupRetentionPeriod** *(integer) --* The number of days for which automatic DB snapshots are retained. * **AllocatedStorage** *(integer) --* The allocated storage size in gibibytes (GiB) for all database engines except Amazon Aurora. For Aurora, "AllocatedStorage" always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed. * **RdsCustomClusterConfiguration** *(dict) --* Reserved for future use. * **InterconnectSubnetId** *(string) --* Reserved for future use. * **TransitGatewayMulticastDomainId** *(string) --* Reserved for future use. * **ReplicaMode** *(string) --* Reserved for future use. * **Iops** *(integer) --* The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters. * **StorageType** *(string) --* The storage type for the DB cluster. * **CertificateDetails** *(dict) --* The details of the DB instance’s server certificate. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the *Amazon RDS User Guide* and Using SSL/TLS to encrypt a connection to a DB cluster in the *Amazon Aurora User Guide*. * **CAIdentifier** *(string) --* The CA identifier of the CA certificate used for the DB instance's server certificate. * **ValidTill** *(datetime) --* The expiration date of the DB instance’s server certificate. * **DBClusterInstanceClass** *(string) --* The name of the compute and memory capacity class of the DB instance. This setting is only for non-Aurora Multi-AZ DB clusters. * **StorageType** *(string) --* The storage type associated with the DB cluster. * **Iops** *(integer) --* The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters. * **PubliclyAccessible** *(boolean) --* Indicates whether the DB cluster is publicly accessible. When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it. When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address. For more information, see CreateDBCluster. This setting is only for non-Aurora Multi-AZ DB clusters. * **AutoMinorVersionUpgrade** *(boolean) --* Indicates whether minor version patches are applied automatically. This setting is for Aurora DB clusters and Multi-AZ DB clusters. For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version. * **MonitoringInterval** *(integer) --* The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. This setting is only for -Aurora DB clusters and Multi-AZ DB clusters. * **MonitoringRoleArn** *(string) --* The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. This setting is only for Aurora DB clusters and Multi-AZ DB clusters. * **DatabaseInsightsMode** *(string) --* The mode of Database Insights that is enabled for the DB cluster. * **PerformanceInsightsEnabled** *(boolean) --* Indicates whether Performance Insights is enabled for the DB cluster. This setting is only for Aurora DB clusters and Multi-AZ DB clusters. * **PerformanceInsightsKMSKeyId** *(string) --* The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. This setting is only for Aurora DB clusters and Multi-AZ DB clusters. * **PerformanceInsightsRetentionPeriod** *(integer) --* The number of days to retain Performance Insights data. This setting is only for Aurora DB clusters and Multi-AZ DB clusters. Valid Values: * "7" * *month* * 31, where *month* is a number of months from 1-23. Examples: "93" (3 months * 31), "341" (11 months * 31), "589" (19 months * 31) * "731" Default: "7" days * **ServerlessV2ScalingConfiguration** *(dict) --* The scaling configuration for an Aurora Serverless v2 DB cluster. For more information, see Using Amazon Aurora Serverless v2 in the *Amazon Aurora User Guide*. * **MinCapacity** *(float) --* The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. For Aurora versions that support the Aurora Serverless v2 auto-pause feature, the smallest value that you can use is 0. For versions that don't support Aurora Serverless v2 auto-pause, the smallest value that you can use is 0.5. * **MaxCapacity** *(float) --* The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 32, 32.5, 33, and so on. The largest value that you can use is 256 for recent Aurora versions, or 128 for older versions. You can check the attributes of your engine version or platform version to determine the specific maximum capacity supported. * **SecondsUntilAutoPause** *(integer) --* The number of seconds an Aurora Serverless v2 DB instance must be idle before Aurora attempts to automatically pause it. This property is only shown when the minimum capacity for the cluster is set to 0 ACUs. Changing the minimum capacity to a nonzero value removes this property. If you later change the minimum capacity back to 0 ACUs, this property is reset to its default value unless you specify it again. This value ranges between 300 seconds (five minutes) and 86,400 seconds (one day). The default is 300 seconds. * **ServerlessV2PlatformVersion** *(string) --* The version of the Aurora Serverless V2 platform used by the DB cluster. For more information, see Using Aurora Serverless v2 in the *Amazon Aurora User Guide*. * **NetworkType** *(string) --* The network type of the DB instance. The network type is determined by the "DBSubnetGroup" specified for the DB cluster. A "DBSubnetGroup" can support only the IPv4 protocol or the IPv4 and the IPv6 protocols ( "DUAL"). For more information, see Working with a DB instance in a VPC in the *Amazon Aurora User Guide.* This setting is only for Aurora DB clusters. Valid Values: "IPV4 | DUAL" * **DBSystemId** *(string) --* Reserved for future use. * **MasterUserSecret** *(dict) --* The secret managed by RDS in Amazon Web Services Secrets Manager for the master user password. For more information, see Password management with Amazon Web Services Secrets Manager in the *Amazon RDS User Guide* and Password management with Amazon Web Services Secrets Manager in the *Amazon Aurora User Guide.* * **SecretArn** *(string) --* The Amazon Resource Name (ARN) of the secret. * **SecretStatus** *(string) --* The status of the secret. The possible status values include the following: * "creating" - The secret is being created. * "active" - The secret is available for normal use and rotation. * "rotating" - The secret is being rotated. * "impaired" - The secret can be used to access database credentials, but it can't be rotated. A secret might have this status if, for example, permissions are changed so that RDS can no longer access either the secret or the KMS key for the secret. When a secret has this status, you can correct the condition that caused the status. Alternatively, modify the DB instance to turn off automatic management of database credentials, and then modify the DB instance again to turn on automatic management of database credentials. * **KmsKeyId** *(string) --* The Amazon Web Services KMS key identifier that is used to encrypt the secret. * **IOOptimizedNextAllowedModificationTime** *(datetime) --* The next time you can modify the DB cluster to use the "aurora-iopt1" storage type. This setting is only for Aurora DB clusters. * **LocalWriteForwardingStatus** *(string) --* Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it. * **AwsBackupRecoveryPointArn** *(string) --* The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup. * **LimitlessDatabase** *(dict) --* The details for Aurora Limitless Database. * **Status** *(string) --* The status of Aurora Limitless Database. * **MinRequiredACU** *(float) --* The minimum required capacity for Aurora Limitless Database in Aurora capacity units (ACUs). * **StorageThroughput** *(integer) --* The storage throughput for the DB cluster. The throughput is automatically set based on the IOPS that you provision, and is not configurable. This setting is only for non-Aurora Multi-AZ DB clusters. * **ClusterScalabilityType** *(string) --* The scalability mode of the Aurora DB cluster. When set to "limitless", the cluster operates as an Aurora Limitless Database. When set to "standard" (the default), the cluster uses normal DB instance creation. * **CertificateDetails** *(dict) --* The details of the DB instance’s server certificate. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the *Amazon RDS User Guide* and Using SSL/TLS to encrypt a connection to a DB cluster in the *Amazon Aurora User Guide*. * **CAIdentifier** *(string) --* The CA identifier of the CA certificate used for the DB instance's server certificate. * **ValidTill** *(datetime) --* The expiration date of the DB instance’s server certificate. * **EngineLifecycleSupport** *(string) --* The lifecycle type for the DB cluster. For more information, see CreateDBCluster. **Exceptions** * "RDS.Client.exceptions.DBClusterNotFoundFault" * "RDS.Client.exceptions.InvalidDBClusterStateFault" RDS / Client / describe_db_subnet_groups describe_db_subnet_groups ************************* RDS.Client.describe_db_subnet_groups(**kwargs) Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup. For an overview of CIDR ranges, go to the Wikipedia Tutorial. See also: AWS API Documentation **Request Syntax** response = client.describe_db_subnet_groups( DBSubnetGroupName='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], MaxRecords=123, Marker='string' ) Parameters: * **DBSubnetGroupName** (*string*) -- The name of the DB subnet group to return details for. * **Filters** (*list*) -- This parameter isn't currently supported. * *(dict) --* 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: * "DescribeDBClusterBacktracks" * "DescribeDBClusterEndpoints" * "DescribeDBClusters" * "DescribeDBInstances" * "DescribeDBRecommendations" * "DescribeDBShardGroups" * "DescribePendingMaintenanceActions" * **Name** *(string) --* **[REQUIRED]** The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* **[REQUIRED]** One or more filter values. Filter values are case- sensitive. * *(string) --* * **MaxRecords** (*integer*) -- 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. * **Marker** (*string*) -- An optional pagination token provided by a previous DescribeDBSubnetGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by "MaxRecords". Return type: dict Returns: **Response Syntax** { 'Marker': 'string', 'DBSubnetGroups': [ { 'DBSubnetGroupName': 'string', 'DBSubnetGroupDescription': 'string', 'VpcId': 'string', 'SubnetGroupStatus': 'string', 'Subnets': [ { 'SubnetIdentifier': 'string', 'SubnetAvailabilityZone': { 'Name': 'string' }, 'SubnetOutpost': { 'Arn': 'string' }, 'SubnetStatus': 'string' }, ], 'DBSubnetGroupArn': 'string', 'SupportedNetworkTypes': [ 'string', ] }, ] } **Response Structure** * *(dict) --* Contains the result of a successful invocation of the "DescribeDBSubnetGroups" action. * **Marker** *(string) --* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by "MaxRecords". * **DBSubnetGroups** *(list) --* A list of "DBSubnetGroup" instances. * *(dict) --* Contains the details of an Amazon RDS DB subnet group. This data type is used as a response element in the "DescribeDBSubnetGroups" action. * **DBSubnetGroupName** *(string) --* The name of the DB subnet group. * **DBSubnetGroupDescription** *(string) --* Provides the description of the DB subnet group. * **VpcId** *(string) --* Provides the VpcId of the DB subnet group. * **SubnetGroupStatus** *(string) --* Provides the status of the DB subnet group. * **Subnets** *(list) --* Contains a list of "Subnet" elements. The list of subnets shown here might not reflect the current state of your VPC. For the most up-to-date information, we recommend checking your VPC configuration directly. * *(dict) --* This data type is used as a response element for the "DescribeDBSubnetGroups" operation. * **SubnetIdentifier** *(string) --* The identifier of the subnet. * **SubnetAvailabilityZone** *(dict) --* Contains Availability Zone information. This data type is used as an element in the "OrderableDBInstanceOption" data type. * **Name** *(string) --* The name of the Availability Zone. * **SubnetOutpost** *(dict) --* If the subnet is associated with an Outpost, this value specifies the Outpost. For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the *Amazon RDS User Guide.* * **Arn** *(string) --* The Amazon Resource Name (ARN) of the Outpost. * **SubnetStatus** *(string) --* The status of the subnet. * **DBSubnetGroupArn** *(string) --* The Amazon Resource Name (ARN) for the DB subnet group. * **SupportedNetworkTypes** *(list) --* The network type of the DB subnet group. Valid values: * "IPV4" * "DUAL" A "DBSubnetGroup" can support only the IPv4 protocol or the IPv4 and the IPv6 protocols ( "DUAL"). For more information, see Working with a DB instance in a VPC in the *Amazon RDS User Guide.* * *(string) --* **Exceptions** * "RDS.Client.exceptions.DBSubnetGroupNotFoundFault" **Examples** This example lists information about the specified DB subnet group. response = client.describe_db_subnet_groups( DBSubnetGroupName='mydbsubnetgroup', ) print(response) Expected Output: { 'ResponseMetadata': { '...': '...', }, } RDS / Client / describe_db_proxy_endpoints describe_db_proxy_endpoints *************************** RDS.Client.describe_db_proxy_endpoints(**kwargs) Returns information about DB proxy endpoints. See also: AWS API Documentation **Request Syntax** response = client.describe_db_proxy_endpoints( DBProxyName='string', DBProxyEndpointName='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], Marker='string', MaxRecords=123 ) Parameters: * **DBProxyName** (*string*) -- The name of the DB proxy whose endpoints you want to describe. If you omit this parameter, the output includes information about all DB proxy endpoints associated with all your DB proxies. * **DBProxyEndpointName** (*string*) -- The name of a DB proxy endpoint to describe. If you omit this parameter, the output includes information about all DB proxy endpoints associated with the specified proxy. * **Filters** (*list*) -- This parameter is not currently supported. * *(dict) --* 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: * "DescribeDBClusterBacktracks" * "DescribeDBClusterEndpoints" * "DescribeDBClusters" * "DescribeDBInstances" * "DescribeDBRecommendations" * "DescribeDBShardGroups" * "DescribePendingMaintenanceActions" * **Name** *(string) --* **[REQUIRED]** The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* **[REQUIRED]** One or more filter values. Filter values are case- sensitive. * *(string) --* * **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". * **MaxRecords** (*integer*) -- 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. Return type: dict Returns: **Response Syntax** { 'DBProxyEndpoints': [ { 'DBProxyEndpointName': 'string', 'DBProxyEndpointArn': 'string', 'DBProxyName': 'string', 'Status': 'available'|'modifying'|'incompatible-network'|'insufficient-resource-limits'|'creating'|'deleting', 'VpcId': 'string', 'VpcSecurityGroupIds': [ 'string', ], 'VpcSubnetIds': [ 'string', ], 'Endpoint': 'string', 'CreatedDate': datetime(2015, 1, 1), 'TargetRole': 'READ_WRITE'|'READ_ONLY', 'IsDefault': True|False }, ], 'Marker': 'string' } **Response Structure** * *(dict) --* * **DBProxyEndpoints** *(list) --* The list of "ProxyEndpoint" objects returned by the API operation. * *(dict) --* The data structure representing an endpoint associated with a DB proxy. RDS automatically creates one endpoint for each DB proxy. For Aurora DB clusters, you can associate additional endpoints with the same DB proxy. These endpoints can be read/write or read-only. They can also reside in different VPCs than the associated DB proxy. This data type is used as a response element in the "DescribeDBProxyEndpoints" operation. * **DBProxyEndpointName** *(string) --* The name for the DB proxy endpoint. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens. * **DBProxyEndpointArn** *(string) --* The Amazon Resource Name (ARN) for the DB proxy endpoint. * **DBProxyName** *(string) --* The identifier for the DB proxy that is associated with this DB proxy endpoint. * **Status** *(string) --* The current status of this DB proxy endpoint. A status of "available" means the endpoint is ready to handle requests. Other values indicate that you must wait for the endpoint to be ready, or take some action to resolve an issue. * **VpcId** *(string) --* Provides the VPC ID of the DB proxy endpoint. * **VpcSecurityGroupIds** *(list) --* Provides a list of VPC security groups that the DB proxy endpoint belongs to. * *(string) --* * **VpcSubnetIds** *(list) --* The EC2 subnet IDs for the DB proxy endpoint. * *(string) --* * **Endpoint** *(string) --* The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application. * **CreatedDate** *(datetime) --* The date and time when the DB proxy endpoint was first created. * **TargetRole** *(string) --* A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations. * **IsDefault** *(boolean) --* Indicates whether this endpoint is the default endpoint for the associated DB proxy. Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be either read/write or read-only. * **Marker** *(string) --* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by "MaxRecords". **Exceptions** * "RDS.Client.exceptions.DBProxyNotFoundFault" * "RDS.Client.exceptions.DBProxyEndpointNotFoundFault" RDS / Client / describe_db_instance_automated_backups describe_db_instance_automated_backups ************************************** RDS.Client.describe_db_instance_automated_backups(**kwargs) Displays backups for both current and deleted instances. For example, use this operation to find details about automated backups for previously deleted instances. Current instances with retention periods greater than zero (0) are returned for both the "DescribeDBInstanceAutomatedBackups" and "DescribeDBInstances" operations. All parameters are optional. See also: AWS API Documentation **Request Syntax** response = client.describe_db_instance_automated_backups( DbiResourceId='string', DBInstanceIdentifier='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], MaxRecords=123, Marker='string', DBInstanceAutomatedBackupsArn='string' ) Parameters: * **DbiResourceId** (*string*) -- The resource ID of the DB instance that is the source of the automated backup. This parameter isn't case-sensitive. * **DBInstanceIdentifier** (*string*) -- (Optional) The user- supplied instance identifier. If this parameter is specified, it must match the identifier of an existing DB instance. It returns information from the specific DB instance's automated backup. This parameter isn't case-sensitive. * **Filters** (*list*) -- A filter that specifies which resources to return based on status. Supported filters are the following: * "status" * "active" - Automated backups for current instances. * "creating" - Automated backups that are waiting for the first automated snapshot to be available. * "retained" - Automated backups for deleted instances and after backup replication is stopped. * "db-instance-id" - Accepts DB instance identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance automated backups identified by these ARNs. * "dbi-resource-id" - Accepts DB resource identifiers and Amazon Resource Names (ARNs). The results list includes only information about the DB instance resources identified by these ARNs. Returns all resources by default. The status for each resource is specified in the response. * *(dict) --* 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: * "DescribeDBClusterBacktracks" * "DescribeDBClusterEndpoints" * "DescribeDBClusters" * "DescribeDBInstances" * "DescribeDBRecommendations" * "DescribeDBShardGroups" * "DescribePendingMaintenanceActions" * **Name** *(string) --* **[REQUIRED]** The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* **[REQUIRED]** One or more filter values. Filter values are case- sensitive. * *(string) --* * **MaxRecords** (*integer*) -- 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. * **Marker** (*string*) -- The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to "MaxRecords". * **DBInstanceAutomatedBackupsArn** (*string*) -- The Amazon Resource Name (ARN) of the replicated automated backups, for example, "arn:aws:rds:us-east-1:123456789012 :auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE". This setting doesn't apply to RDS Custom. Return type: dict Returns: **Response Syntax** { 'Marker': 'string', 'DBInstanceAutomatedBackups': [ { 'DBInstanceArn': 'string', 'DbiResourceId': 'string', 'Region': 'string', 'DBInstanceIdentifier': 'string', 'RestoreWindow': { 'EarliestTime': datetime(2015, 1, 1), 'LatestTime': datetime(2015, 1, 1) }, 'AllocatedStorage': 123, 'Status': 'string', 'Port': 123, 'AvailabilityZone': 'string', 'VpcId': 'string', 'InstanceCreateTime': datetime(2015, 1, 1), 'MasterUsername': 'string', 'Engine': 'string', 'EngineVersion': 'string', 'LicenseModel': 'string', 'Iops': 123, 'OptionGroupName': 'string', 'TdeCredentialArn': 'string', 'Encrypted': True|False, 'StorageType': 'string', 'KmsKeyId': 'string', 'Timezone': 'string', 'IAMDatabaseAuthenticationEnabled': True|False, 'BackupRetentionPeriod': 123, 'DBInstanceAutomatedBackupsArn': 'string', 'DBInstanceAutomatedBackupsReplications': [ { 'DBInstanceAutomatedBackupsArn': 'string' }, ], 'BackupTarget': 'string', 'StorageThroughput': 123, 'AwsBackupRecoveryPointArn': 'string', 'DedicatedLogVolume': True|False, 'MultiTenant': 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 consists of system backups, transaction logs, and the database instance properties that existed at the time you deleted the source instance. * **DBInstanceArn** *(string) --* The Amazon Resource Name (ARN) for the automated backups. * **DbiResourceId** *(string) --* The resource ID for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region. * **Region** *(string) --* The Amazon Web Services Region associated with the automated backup. * **DBInstanceIdentifier** *(string) --* The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region. * **RestoreWindow** *(dict) --* The earliest and latest time a DB 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) --* The allocated storage size for the the automated backup in gibibytes (GiB). * **Status** *(string) --* A list of status information for an automated backup: * "active" - Automated backups for current instances. * "retained" - Automated backups for deleted instances. * "creating" - Automated backups that are waiting for the first automated snapshot to be available. * **Port** *(integer) --* The port number that the automated backup used for connections. Default: Inherits from the source DB instance Valid Values: "1150-65535" * **AvailabilityZone** *(string) --* The Availability Zone that the automated backup was created in. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones. * **VpcId** *(string) --* The VPC ID associated with the DB instance. * **InstanceCreateTime** *(datetime) --* The date and time when the DB instance was created. * **MasterUsername** *(string) --* The master user name 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) --* The 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) --* Indicates whether the automated backup is encrypted. * **StorageType** *(string) --* The storage type associated with the automated backup. * **KmsKeyId** *(string) --* The Amazon Web Services KMS key ID for an automated backup. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. * **Timezone** *(string) --* The time zone of the automated backup. In most cases, the "Timezone" element is empty. "Timezone" content appears only for Microsoft SQL Server DB instances that were created with a time zone specified. * **IAMDatabaseAuthenticationEnabled** *(boolean) --* True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false. * **BackupRetentionPeriod** *(integer) --* The retention period for the automated backups. * **DBInstanceAutomatedBackupsArn** *(string) --* The Amazon Resource Name (ARN) for the replicated automated backups. * **DBInstanceAutomatedBackupsReplications** *(list) --* The list of replications to different Amazon Web Services Regions associated with the automated backup. * *(dict) --* Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties. * **DBInstanceAutomatedBackupsArn** *(string) --* The Amazon Resource Name (ARN) of the replicated automated backups. * **BackupTarget** *(string) --* The location where automated backups are stored: Dedicated Local Zones, Amazon Web Services Outposts or the Amazon Web Services Region. * **StorageThroughput** *(integer) --* The storage throughput for the automated backup. * **AwsBackupRecoveryPointArn** *(string) --* The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup. * **DedicatedLogVolume** *(boolean) --* Indicates whether the DB instance has a dedicated log volume (DLV) enabled. * **MultiTenant** *(boolean) --* Specifies whether the automatic backup is for a DB instance in the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE). **Exceptions** * "RDS.Client.exceptions.DBInstanceAutomatedBackupNotFoundFault" RDS / Client / describe_export_tasks describe_export_tasks ********************* RDS.Client.describe_export_tasks(**kwargs) Returns information about a snapshot or cluster export to Amazon S3. This API operation supports pagination. See also: AWS API Documentation **Request Syntax** response = client.describe_export_tasks( ExportTaskIdentifier='string', SourceArn='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], Marker='string', MaxRecords=123, SourceType='SNAPSHOT'|'CLUSTER' ) Parameters: * **ExportTaskIdentifier** (*string*) -- The identifier of the snapshot or cluster export task to be described. * **SourceArn** (*string*) -- The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3. * **Filters** (*list*) -- Filters specify one or more snapshot or cluster exports to describe. The filters are specified as name-value pairs that define what to include in the output. Filter names and values are case-sensitive. Supported filters include the following: * "export-task-identifier" - An identifier for the snapshot or cluster export task. * "s3-bucket" - The Amazon S3 bucket the data is exported to. * "source-arn" - The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3. * "status" - The status of the export task. Must be lowercase. Valid statuses are the following: * "canceled" * "canceling" * "complete" * "failed" * "in_progress" * "starting" * *(dict) --* 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: * "DescribeDBClusterBacktracks" * "DescribeDBClusterEndpoints" * "DescribeDBClusters" * "DescribeDBInstances" * "DescribeDBRecommendations" * "DescribeDBShardGroups" * "DescribePendingMaintenanceActions" * **Name** *(string) --* **[REQUIRED]** The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* **[REQUIRED]** One or more filter values. Filter values are case- sensitive. * *(string) --* * **Marker** (*string*) -- An optional pagination token provided by a previous "DescribeExportTasks" request. If you specify this parameter, the response includes only records beyond the marker, up to the value specified by the "MaxRecords" parameter. * **MaxRecords** (*integer*) -- The maximum number of records to include in the response. If more records exist than the specified value, a pagination token called a marker is included in the response. You can use the marker in a later "DescribeExportTasks" request to retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100. * **SourceType** (*string*) -- The type of source for the export. Return type: dict Returns: **Response Syntax** { 'Marker': 'string', 'ExportTasks': [ { 'ExportTaskIdentifier': 'string', 'SourceArn': 'string', 'ExportOnly': [ 'string', ], 'SnapshotTime': datetime(2015, 1, 1), 'TaskStartTime': datetime(2015, 1, 1), 'TaskEndTime': datetime(2015, 1, 1), 'S3Bucket': 'string', 'S3Prefix': 'string', 'IamRoleArn': 'string', 'KmsKeyId': 'string', 'Status': 'string', 'PercentProgress': 123, 'TotalExtractedDataInGB': 123, 'FailureCause': 'string', 'WarningMessage': 'string', 'SourceType': 'SNAPSHOT'|'CLUSTER' }, ] } **Response Structure** * *(dict) --* * **Marker** *(string) --* A pagination token that can be used in a later "DescribeExportTasks" request. A marker is used for pagination to identify the location to begin output for the next response of "DescribeExportTasks". * **ExportTasks** *(list) --* Information about an export of a snapshot or cluster to Amazon S3. * *(dict) --* Contains the details of a snapshot or cluster export to Amazon S3. This data type is used as a response element in the "DescribeExportTasks" operation. * **ExportTaskIdentifier** *(string) --* A unique identifier for the snapshot or cluster export task. This ID isn't an identifier for the Amazon S3 bucket where the data is exported. * **SourceArn** *(string) --* The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3. * **ExportOnly** *(list) --* The data exported from the snapshot or cluster. Valid Values: * "database" - Export all the data from a specified database. * "database.table" *table-name* - Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL. * "database.schema" *schema-name* - Export a database schema of the snapshot or cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL. * "database.schema.table" *table-name* - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL. * *(string) --* * **SnapshotTime** *(datetime) --* The time when the snapshot was created. * **TaskStartTime** *(datetime) --* The time when the snapshot or cluster export task started. * **TaskEndTime** *(datetime) --* The time when the snapshot or cluster export task ended. * **S3Bucket** *(string) --* The Amazon S3 bucket where the snapshot or cluster is exported to. * **S3Prefix** *(string) --* The Amazon S3 bucket prefix that is the file name and path of the exported data. * **IamRoleArn** *(string) --* The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot or cluster. * **KmsKeyId** *(string) --* The key identifier of the Amazon Web Services KMS key that is used to encrypt the data when it's exported to Amazon S3. The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the export must have encryption and decryption permissions to use this KMS key. * **Status** *(string) --* The progress status of the export task. The status can be one of the following: * "CANCELED" * "CANCELING" * "COMPLETE" * "FAILED" * "IN_PROGRESS" * "STARTING" * **PercentProgress** *(integer) --* The progress of the snapshot or cluster export task as a percentage. * **TotalExtractedDataInGB** *(integer) --* The total amount of data exported, in gigabytes. * **FailureCause** *(string) --* The reason the export failed, if it failed. * **WarningMessage** *(string) --* A warning about the snapshot or cluster export task. * **SourceType** *(string) --* The type of source for the export. **Exceptions** * "RDS.Client.exceptions.ExportTaskNotFoundFault" RDS / Client / create_db_cluster_parameter_group create_db_cluster_parameter_group ********************************* RDS.Client.create_db_cluster_parameter_group(**kwargs) Creates a new DB cluster parameter group. Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster. A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using "ModifyDBClusterParameterGroup". Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using "ModifyDBCluster". When you associate a new DB cluster parameter group with a running Aurora DB cluster, reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect. When you associate a new DB cluster parameter group with a running Multi-AZ DB cluster, reboot the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect. Warning: After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the "character_set_database" parameter. You can use the *Parameter Groups* option of the Amazon RDS console or the "DescribeDBClusterParameters" operation to verify that your DB cluster parameter group has been created or modified. For more information on Amazon Aurora, see What is Amazon Aurora? in the *Amazon Aurora User Guide*. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the *Amazon RDS User Guide*. See also: AWS API Documentation **Request Syntax** response = client.create_db_cluster_parameter_group( DBClusterParameterGroupName='string', DBParameterGroupFamily='string', Description='string', Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **DBClusterParameterGroupName** (*string*) -- **[REQUIRED]** The name of the DB cluster parameter group. Constraints: * Must not match the name of an existing DB cluster parameter group. Note: This value is stored as a lowercase string. * **DBParameterGroupFamily** (*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: "aurora-mysql5.7", "aurora-mysql8.0" **Aurora PostgreSQL** Example: "aurora-postgresql14" **RDS for MySQL** Example: "mysql8.0" **RDS for PostgreSQL** Example: "postgres13" To list all of the available parameter group families for a DB engine, use the following command: "aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine " For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command: "aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine aurora- postgresql" Note: The output contains duplicates. The following are the valid DB engine values: * "aurora-mysql" * "aurora-postgresql" * "mysql" * "postgres" * **Description** (*string*) -- **[REQUIRED]** The description for the DB cluster parameter group. * **Tags** (*list*) -- Tags to assign to the DB cluster parameter group. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **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}_.:/=+\-@]*)$"). Return type: dict Returns: **Response Syntax** { 'DBClusterParameterGroup': { 'DBClusterParameterGroupName': 'string', 'DBParameterGroupFamily': 'string', 'Description': 'string', 'DBClusterParameterGroupArn': 'string' } } **Response Structure** * *(dict) --* * **DBClusterParameterGroup** *(dict) --* Contains the details of an Amazon RDS DB cluster parameter group. This data type is used as a response element in the "DescribeDBClusterParameterGroups" action. * **DBClusterParameterGroupName** *(string) --* The name of the DB cluster parameter group. * **DBParameterGroupFamily** *(string) --* The name of the DB parameter group family that this DB cluster parameter group is compatible with. * **Description** *(string) --* Provides the customer-specified description for this DB cluster parameter group. * **DBClusterParameterGroupArn** *(string) --* The Amazon Resource Name (ARN) for the DB cluster parameter group. **Exceptions** * "RDS.Client.exceptions.DBParameterGroupQuotaExceededFault" * "RDS.Client.exceptions.DBParameterGroupAlreadyExistsFault" **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: { 'DBClusterParameterGroup': { }, 'ResponseMetadata': { '...': '...', }, } RDS / Client / describe_db_snapshot_tenant_databases describe_db_snapshot_tenant_databases ************************************* RDS.Client.describe_db_snapshot_tenant_databases(**kwargs) Describes the tenant databases that exist in a DB snapshot. This command only applies to RDS for Oracle DB instances in the multi- tenant configuration. You can use this command to inspect the tenant databases within a snapshot before restoring it. You can't directly interact with the tenant databases in a DB snapshot. If you restore a snapshot that was taken from DB instance using the multi-tenant configuration, you restore all its tenant databases. See also: AWS API Documentation **Request Syntax** response = client.describe_db_snapshot_tenant_databases( DBInstanceIdentifier='string', DBSnapshotIdentifier='string', SnapshotType='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], MaxRecords=123, Marker='string', DbiResourceId='string' ) Parameters: * **DBInstanceIdentifier** (*string*) -- The ID of the DB instance used to create the DB snapshots. This parameter isn't case-sensitive. Constraints: * If supplied, must match the identifier of an existing "DBInstance". * **DBSnapshotIdentifier** (*string*) -- The ID of a DB snapshot that contains the tenant databases to describe. This value is stored as a lowercase string. Constraints: * If you specify this parameter, the value must match the ID of an existing DB snapshot. * If you specify an automatic snapshot, you must also specify "SnapshotType". * **SnapshotType** (*string*) -- The type of DB snapshots to be returned. You can specify one of the following values: * "automated" – All DB snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account. * "manual" – All DB snapshots that have been taken by my Amazon Web Services account. * "shared" – All manual DB snapshots that have been shared to my Amazon Web Services account. * "public" – All DB snapshots that have been marked as public. * "awsbackup" – All DB snapshots managed by the Amazon Web Services Backup service. * **Filters** (*list*) -- A filter that specifies one or more tenant databases to describe. Supported filters: * "tenant-db-name" - Tenant database names. The results list only includes information about the tenant databases that match these tenant DB names. * "tenant-database-resource-id" - Tenant database resource identifiers. The results list only includes information about the tenant databases contained within the DB snapshots. * "dbi-resource-id" - DB instance resource identifiers. The results list only includes information about snapshots containing tenant databases contained within the DB instances identified by these resource identifiers. * "db-instance-id" - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). * "db-snapshot-id" - Accepts DB snapshot identifiers. * "snapshot-type" - Accepts types of DB snapshots. * *(dict) --* 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: * "DescribeDBClusterBacktracks" * "DescribeDBClusterEndpoints" * "DescribeDBClusters" * "DescribeDBInstances" * "DescribeDBRecommendations" * "DescribeDBShardGroups" * "DescribePendingMaintenanceActions" * **Name** *(string) --* **[REQUIRED]** The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* **[REQUIRED]** One or more filter values. Filter values are case- sensitive. * *(string) --* * **MaxRecords** (*integer*) -- 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. * **Marker** (*string*) -- An optional pagination token provided by a previous "DescribeDBSnapshotTenantDatabases" request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by "MaxRecords". * **DbiResourceId** (*string*) -- A specific DB resource identifier to describe. Return type: dict Returns: **Response Syntax** { 'Marker': 'string', 'DBSnapshotTenantDatabases': [ { 'DBSnapshotIdentifier': 'string', 'DBInstanceIdentifier': 'string', 'DbiResourceId': 'string', 'EngineName': 'string', 'SnapshotType': 'string', 'TenantDatabaseCreateTime': datetime(2015, 1, 1), 'TenantDBName': 'string', 'MasterUsername': 'string', 'TenantDatabaseResourceId': 'string', 'CharacterSetName': 'string', 'DBSnapshotTenantDatabaseARN': 'string', 'NcharCharacterSetName': 'string', 'TagList': [ { 'Key': 'string', 'Value': 'string' }, ] }, ] } **Response Structure** * *(dict) --* * **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". * **DBSnapshotTenantDatabases** *(list) --* A list of DB snapshot tenant databases. * *(dict) --* Contains the details of a tenant database in a snapshot of a DB instance. * **DBSnapshotIdentifier** *(string) --* The identifier for the snapshot of the DB instance. * **DBInstanceIdentifier** *(string) --* The ID for the DB instance that contains the tenant databases. * **DbiResourceId** *(string) --* The resource identifier of the source CDB instance. This identifier can't be changed and is unique to an Amazon Web Services Region. * **EngineName** *(string) --* The name of the database engine. * **SnapshotType** *(string) --* The type of DB snapshot. * **TenantDatabaseCreateTime** *(datetime) --* The time the DB snapshot was taken, specified in Coordinated Universal Time (UTC). If you copy the snapshot, the creation time changes. * **TenantDBName** *(string) --* The name of the tenant database. * **MasterUsername** *(string) --* The master username of the tenant database. * **TenantDatabaseResourceId** *(string) --* The resource ID of the tenant database. * **CharacterSetName** *(string) --* The name of the character set of a tenant database. * **DBSnapshotTenantDatabaseARN** *(string) --* The Amazon Resource Name (ARN) for the snapshot tenant database. * **NcharCharacterSetName** *(string) --* The "NCHAR" character set name of the tenant database. * **TagList** *(list) --* A list of tags. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **Key** *(string) --* A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **Value** *(string) --* A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). **Exceptions** * "RDS.Client.exceptions.DBSnapshotNotFoundFault" RDS / Client / reboot_db_instance reboot_db_instance ****************** RDS.Client.reboot_db_instance(**kwargs) You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect. Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting. For more information about rebooting, see Rebooting a DB Instance in the *Amazon RDS User Guide.* This command doesn't apply to RDS Custom. If your DB instance is part of a Multi-AZ DB cluster, you can reboot the DB cluster with the "RebootDBCluster" operation. See also: AWS API Documentation **Request Syntax** response = client.reboot_db_instance( DBInstanceIdentifier='string', ForceFailover=True|False ) Parameters: * **DBInstanceIdentifier** (*string*) -- **[REQUIRED]** The DB instance identifier. This parameter is stored as a lowercase string. Constraints: * Must match the identifier of an existing DBInstance. * **ForceFailover** (*boolean*) -- Specifies 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. Return type: dict Returns: **Response Syntax** { 'DBInstance': { 'DBInstanceIdentifier': 'string', 'DBInstanceClass': 'string', 'Engine': 'string', 'DBInstanceStatus': 'string', 'AutomaticRestartTime': datetime(2015, 1, 1), 'MasterUsername': 'string', 'DBName': 'string', 'Endpoint': { 'Address': 'string', 'Port': 123, 'HostedZoneId': 'string' }, 'AllocatedStorage': 123, 'InstanceCreateTime': datetime(2015, 1, 1), 'PreferredBackupWindow': 'string', 'BackupRetentionPeriod': 123, 'DBSecurityGroups': [ { 'DBSecurityGroupName': 'string', 'Status': 'string' }, ], 'VpcSecurityGroups': [ { 'VpcSecurityGroupId': 'string', 'Status': 'string' }, ], 'DBParameterGroups': [ { 'DBParameterGroupName': 'string', 'ParameterApplyStatus': 'string' }, ], 'AvailabilityZone': 'string', 'DBSubnetGroup': { 'DBSubnetGroupName': 'string', 'DBSubnetGroupDescription': 'string', 'VpcId': 'string', 'SubnetGroupStatus': 'string', 'Subnets': [ { 'SubnetIdentifier': 'string', 'SubnetAvailabilityZone': { 'Name': 'string' }, 'SubnetOutpost': { 'Arn': 'string' }, 'SubnetStatus': 'string' }, ], 'DBSubnetGroupArn': 'string', 'SupportedNetworkTypes': [ 'string', ] }, 'PreferredMaintenanceWindow': 'string', 'PendingModifiedValues': { 'DBInstanceClass': 'string', 'AllocatedStorage': 123, 'MasterUserPassword': 'string', 'Port': 123, 'BackupRetentionPeriod': 123, 'MultiAZ': True|False, 'EngineVersion': 'string', 'LicenseModel': 'string', 'Iops': 123, 'DBInstanceIdentifier': 'string', 'StorageType': 'string', 'CACertificateIdentifier': 'string', 'DBSubnetGroupName': 'string', 'PendingCloudwatchLogsExports': { 'LogTypesToEnable': [ 'string', ], 'LogTypesToDisable': [ 'string', ] }, 'ProcessorFeatures': [ { 'Name': 'string', 'Value': 'string' }, ], 'IAMDatabaseAuthenticationEnabled': True|False, 'AutomationMode': 'full'|'all-paused', 'ResumeFullAutomationModeTime': datetime(2015, 1, 1), 'StorageThroughput': 123, 'Engine': 'string', 'DedicatedLogVolume': True|False, 'MultiTenant': True|False }, 'LatestRestorableTime': datetime(2015, 1, 1), 'MultiAZ': True|False, 'EngineVersion': 'string', 'AutoMinorVersionUpgrade': True|False, 'ReadReplicaSourceDBInstanceIdentifier': 'string', 'ReadReplicaDBInstanceIdentifiers': [ 'string', ], 'ReadReplicaDBClusterIdentifiers': [ 'string', ], 'ReplicaMode': 'open-read-only'|'mounted', 'LicenseModel': 'string', 'Iops': 123, 'OptionGroupMemberships': [ { 'OptionGroupName': 'string', 'Status': 'string' }, ], 'CharacterSetName': 'string', 'NcharCharacterSetName': 'string', 'SecondaryAvailabilityZone': 'string', 'PubliclyAccessible': True|False, 'StatusInfos': [ { 'StatusType': 'string', 'Normal': True|False, 'Status': 'string', 'Message': 'string' }, ], 'StorageType': 'string', 'TdeCredentialArn': 'string', 'DbInstancePort': 123, 'DBClusterIdentifier': 'string', 'StorageEncrypted': True|False, 'KmsKeyId': 'string', 'DbiResourceId': 'string', 'CACertificateIdentifier': 'string', 'DomainMemberships': [ { 'Domain': 'string', 'Status': 'string', 'FQDN': 'string', 'IAMRoleName': 'string', 'OU': 'string', 'AuthSecretArn': 'string', 'DnsIps': [ 'string', ] }, ], 'CopyTagsToSnapshot': True|False, 'MonitoringInterval': 123, 'EnhancedMonitoringResourceArn': 'string', 'MonitoringRoleArn': 'string', 'PromotionTier': 123, 'DBInstanceArn': 'string', 'Timezone': 'string', 'IAMDatabaseAuthenticationEnabled': True|False, 'DatabaseInsightsMode': 'standard'|'advanced', 'PerformanceInsightsEnabled': True|False, 'PerformanceInsightsKMSKeyId': 'string', 'PerformanceInsightsRetentionPeriod': 123, 'EnabledCloudwatchLogsExports': [ 'string', ], 'ProcessorFeatures': [ { 'Name': 'string', 'Value': 'string' }, ], 'DeletionProtection': True|False, 'AssociatedRoles': [ { 'RoleArn': 'string', 'FeatureName': 'string', 'Status': 'string' }, ], 'ListenerEndpoint': { 'Address': 'string', 'Port': 123, 'HostedZoneId': 'string' }, 'MaxAllocatedStorage': 123, 'TagList': [ { 'Key': 'string', 'Value': 'string' }, ], 'DBInstanceAutomatedBackupsReplications': [ { 'DBInstanceAutomatedBackupsArn': 'string' }, ], 'CustomerOwnedIpEnabled': True|False, 'AwsBackupRecoveryPointArn': 'string', 'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping', 'ActivityStreamKmsKeyId': 'string', 'ActivityStreamKinesisStreamName': 'string', 'ActivityStreamMode': 'sync'|'async', 'ActivityStreamEngineNativeAuditFieldsIncluded': True|False, 'AutomationMode': 'full'|'all-paused', 'ResumeFullAutomationModeTime': datetime(2015, 1, 1), 'CustomIamInstanceProfile': 'string', 'BackupTarget': 'string', 'NetworkType': 'string', 'ActivityStreamPolicyStatus': 'locked'|'unlocked'|'locking-policy'|'unlocking-policy', 'StorageThroughput': 123, 'DBSystemId': 'string', 'MasterUserSecret': { 'SecretArn': 'string', 'SecretStatus': 'string', 'KmsKeyId': 'string' }, 'CertificateDetails': { 'CAIdentifier': 'string', 'ValidTill': datetime(2015, 1, 1) }, 'ReadReplicaSourceDBClusterIdentifier': 'string', 'PercentProgress': 'string', 'DedicatedLogVolume': True|False, 'IsStorageConfigUpgradeAvailable': True|False, 'MultiTenant': True|False, 'EngineLifecycleSupport': 'string' } } **Response Structure** * *(dict) --* * **DBInstance** *(dict) --* Contains the details of an Amazon RDS DB instance. This data type is used as a response element in the operations "CreateDBInstance", "CreateDBInstanceReadReplica", "DeleteDBInstance", "DescribeDBInstances", "ModifyDBInstance", "PromoteReadReplica", "RebootDBInstance", "RestoreDBInstanceFromDBSnapshot", "RestoreDBInstanceFromS3", "RestoreDBInstanceToPointInTime", "StartDBInstance", and "StopDBInstance". * **DBInstanceIdentifier** *(string) --* The user-supplied database identifier. This identifier is the unique key that identifies a DB instance. * **DBInstanceClass** *(string) --* The name of the compute and memory capacity class of the DB instance. * **Engine** *(string) --* The database engine used for this DB instance. * **DBInstanceStatus** *(string) --* The current state of this database. For information about DB instance statuses, see Viewing DB instance status in the *Amazon RDS User Guide.* * **AutomaticRestartTime** *(datetime) --* The time when a stopped DB instance is restarted automatically. * **MasterUsername** *(string) --* The master username for the DB instance. * **DBName** *(string) --* The initial database name that you provided (if required) when you created the DB instance. This name is returned for the life of your DB instance. For an RDS for Oracle CDB instance, the name identifies the PDB rather than the CDB. * **Endpoint** *(dict) --* The connection endpoint for the DB instance. Note: The endpoint might not be shown for instances with the status of "creating". * **Address** *(string) --* Specifies the DNS address of the DB instance. * **Port** *(integer) --* Specifies the port that the database engine is listening on. * **HostedZoneId** *(string) --* Specifies the ID that Amazon Route 53 assigns when you create a hosted zone. * **AllocatedStorage** *(integer) --* The amount of storage in gibibytes (GiB) allocated for the DB instance. * **InstanceCreateTime** *(datetime) --* The date and time when the DB instance was created. * **PreferredBackupWindow** *(string) --* The daily time range during which automated backups are created if automated backups are enabled, as determined by the "BackupRetentionPeriod". * **BackupRetentionPeriod** *(integer) --* 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: * "ModifyDBInstance" * "RebootDBInstance" * "RestoreDBInstanceFromDBSnapshot" * "RestoreDBInstanceToPointInTime" * **DBSecurityGroupName** *(string) --* The name of the DB security group. * **Status** *(string) --* The status of the DB security group. * **VpcSecurityGroups** *(list) --* The list of Amazon EC2 VPC security groups that the DB instance belongs to. * *(dict) --* This data type is used as a response element for queries on VPC security group membership. * **VpcSecurityGroupId** *(string) --* The name of the VPC security group. * **Status** *(string) --* The membership status of the VPC security group. Currently, the only valid status is "active". * **DBParameterGroups** *(list) --* 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: * "CreateDBInstance" * "CreateDBInstanceReadReplica" * "DeleteDBInstance" * "ModifyDBInstance" * "RebootDBInstance" * "RestoreDBInstanceFromDBSnapshot" * **DBParameterGroupName** *(string) --* The name of the DB parameter group. * **ParameterApplyStatus** *(string) --* The status of parameter updates. Valid values are: * "applying": The parameter group change is being applied to the database. * "failed-to-apply": The parameter group is in an invalid state. * "in-sync": The parameter group change is synchronized with the database. * "pending-database-upgrade": The parameter group change will be applied after the DB instance is upgraded. * "pending-reboot": The parameter group change will be applied after the DB instance reboots. * **AvailabilityZone** *(string) --* The name of the Availability Zone where the DB instance is located. * **DBSubnetGroup** *(dict) --* Information about 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. The list of subnets shown here might not reflect the current state of your VPC. For the most up-to-date information, we recommend checking your VPC configuration directly. * *(dict) --* This data type is used as a response element for the "DescribeDBSubnetGroups" operation. * **SubnetIdentifier** *(string) --* The identifier of the subnet. * **SubnetAvailabilityZone** *(dict) --* Contains Availability Zone information. This data type is used as an element in the "OrderableDBInstanceOption" data type. * **Name** *(string) --* The name of the Availability Zone. * **SubnetOutpost** *(dict) --* If the subnet is associated with an Outpost, this value specifies the Outpost. For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the *Amazon RDS User Guide.* * **Arn** *(string) --* The Amazon Resource Name (ARN) of the Outpost. * **SubnetStatus** *(string) --* The status of the subnet. * **DBSubnetGroupArn** *(string) --* The Amazon Resource Name (ARN) for the DB subnet group. * **SupportedNetworkTypes** *(list) --* The network type of the DB subnet group. Valid values: * "IPV4" * "DUAL" A "DBSubnetGroup" can support only the IPv4 protocol or the IPv4 and the IPv6 protocols ( "DUAL"). For more information, see Working with a DB instance in a VPC in the *Amazon RDS User Guide.* * *(string) --* * **PreferredMaintenanceWindow** *(string) --* The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). * **PendingModifiedValues** *(dict) --* Information about pending changes to the DB instance. This information is returned only when there are pending changes. Specific changes are identified by subelements. * **DBInstanceClass** *(string) --* The name of the compute and memory capacity class for the DB instance. * **AllocatedStorage** *(integer) --* The allocated storage size for the DB instance specified in gibibytes (GiB). * **MasterUserPassword** *(string) --* The master credentials for the DB instance. * **Port** *(integer) --* The port for the DB instance. * **BackupRetentionPeriod** *(integer) --* The number of days for which automated backups are retained. * **MultiAZ** *(boolean) --* Indicates whether the Single-AZ DB instance will change to a Multi-AZ deployment. * **EngineVersion** *(string) --* The database engine version. * **LicenseModel** *(string) --* The license model for the DB instance. Valid values: "license-included" | "bring-your-own- license" | "general-public-license" * **Iops** *(integer) --* The Provisioned IOPS value for the DB instance. * **DBInstanceIdentifier** *(string) --* The database identifier for the DB instance. * **StorageType** *(string) --* The storage type of the DB instance. * **CACertificateIdentifier** *(string) --* The identifier of the CA certificate for the DB instance. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the *Amazon RDS User Guide* and Using SSL/TLS to encrypt a connection to a DB cluster in the *Amazon Aurora User Guide*. * **DBSubnetGroupName** *(string) --* The DB subnet group for the DB instance. * **PendingCloudwatchLogsExports** *(dict) --* A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated. * **LogTypesToEnable** *(list) --* Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs. * *(string) --* * **LogTypesToDisable** *(list) --* Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs. * *(string) --* * **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: * "CreateDBInstance" * "ModifyDBInstance" * "RestoreDBInstanceFromDBSnapshot" * "RestoreDBInstanceFromS3" * "RestoreDBInstanceToPointInTime" 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: * "DescribeDBInstances" * "DescribeDBSnapshots" * "DescribeValidDBInstanceModifications" If you call "DescribeDBInstances", "ProcessorFeature" returns non-null values only if the following conditions are met: * You are accessing an Oracle DB instance. * Your Oracle DB instance class supports configuring the number of CPU cores and threads per core. * The current number CPU cores and threads is set to a non-default value. For more information, see Configuring the processor for a DB instance class in RDS for Oracle 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. * **IAMDatabaseAuthenticationEnabled** *(boolean) --* Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled. * **AutomationMode** *(string) --* The automation mode of the RDS Custom DB instance: "full" or "all-paused". If "full", the DB instance automates monitoring and instance recovery. If "all- paused", the instance pauses automation for the duration set by "--resume-full-automation-mode-minutes". * **ResumeFullAutomationModeTime** *(datetime) --* The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440. * **StorageThroughput** *(integer) --* The storage throughput of the DB instance. * **Engine** *(string) --* The database engine of the DB instance. * **DedicatedLogVolume** *(boolean) --* Indicates whether the DB instance has a dedicated log volume (DLV) enabled.> * **MultiTenant** *(boolean) --* Indicates whether the DB instance will change to the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE). * **LatestRestorableTime** *(datetime) --* The latest time to which a database in this DB instance can be restored with point-in-time restore. * **MultiAZ** *(boolean) --* Indicates whether the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom DB instances. * **EngineVersion** *(string) --* The version of the database engine. * **AutoMinorVersionUpgrade** *(boolean) --* Indicates whether minor version patches are applied automatically. For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version. * **ReadReplicaSourceDBInstanceIdentifier** *(string) --* The identifier of the source DB instance if this DB instance is a read replica. * **ReadReplicaDBInstanceIdentifiers** *(list) --* The identifiers of the read replicas associated with this DB instance. * *(string) --* * **ReadReplicaDBClusterIdentifiers** *(list) --* The identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn't contain information about cross-Region Aurora read replicas. Note: Currently, each RDS DB instance can have only one Aurora read replica. * *(string) --* * **ReplicaMode** *(string) --* The open mode of a Db2 or an Oracle read replica. The default is "open-read-only". For more information, see Working with read replicas for Amazon RDS for Db2 and Working with read replicas for Amazon RDS for Oracle in the *Amazon RDS User Guide*. Note: This attribute is only supported in RDS for Db2, RDS for Oracle, and RDS Custom for Oracle. * **LicenseModel** *(string) --* The license model information for this DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. * **Iops** *(integer) --* The Provisioned IOPS (I/O operations per second) value for the DB instance. * **OptionGroupMemberships** *(list) --* The list of option group memberships for this DB instance. * *(dict) --* Provides information on the option groups the DB instance is a member of. * **OptionGroupName** *(string) --* The name of the option group that the instance belongs to. * **Status** *(string) --* The status of the DB instance's option group membership. Valid values are: "in-sync", "pending- apply", "pending-removal", "pending-maintenance- apply", "pending-maintenance-removal", "applying", "removing", and "failed". * **CharacterSetName** *(string) --* If present, specifies the name of the character set that this instance is associated with. * **NcharCharacterSetName** *(string) --* The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2. * **SecondaryAvailabilityZone** *(string) --* If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support. * **PubliclyAccessible** *(boolean) --* Indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it. When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance. * **StatusInfos** *(list) --* The status of a read replica. If the DB instance isn't a read replica, the value is blank. * *(dict) --* Provides a list of status information for a DB instance. * **StatusType** *(string) --* This value is currently "read replication." * **Normal** *(boolean) --* Indicates whether the instance is operating normally (TRUE) or is in an error state (FALSE). * **Status** *(string) --* The 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) --* The storage type associated with the DB instance. * **TdeCredentialArn** *(string) --* The ARN from the key store with which the instance is associated for TDE encryption. * **DbInstancePort** *(integer) --* 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, indicates the name of the DB cluster that the DB instance is a member of. * **StorageEncrypted** *(boolean) --* Indicates whether the DB instance is encrypted. * **KmsKeyId** *(string) --* If "StorageEncrypted" is enabled, the Amazon Web Services KMS key identifier for the encrypted DB instance. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. * **DbiResourceId** *(string) --* The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB instance is accessed. * **CACertificateIdentifier** *(string) --* The identifier of the CA certificate for this DB instance. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the *Amazon RDS User Guide* and Using SSL/TLS to encrypt a connection to a DB cluster in the *Amazon Aurora User Guide*. * **DomainMemberships** *(list) --* The Active Directory Domain membership records associated with the DB instance. * *(dict) --* An Active Directory Domain membership record associated with the DB instance or cluster. * **Domain** *(string) --* The identifier of the Active Directory Domain. * **Status** *(string) --* The status of the Active Directory Domain membership for the DB instance or cluster. Values include "joined", "pending-join", "failed", and so on. * **FQDN** *(string) --* The fully qualified domain name (FQDN) of the Active Directory Domain. * **IAMRoleName** *(string) --* The name of the IAM role used when making API calls to the Directory Service. * **OU** *(string) --* The Active Directory organizational unit for the DB instance or cluster. * **AuthSecretArn** *(string) --* The ARN for the Secrets Manager secret with the credentials for the user that's a member of the domain. * **DnsIps** *(list) --* The IPv4 DNS IP addresses of the primary and secondary Active Directory domain controllers. * *(string) --* * **CopyTagsToSnapshot** *(boolean) --* Indicates whether tags are copied from the DB instance to snapshots of the DB instance. This setting doesn't apply to Amazon Aurora DB instances. 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) --* The order of priority 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 RDS for Db2 and RDS for SQL Server DB instances that were created with a time zone specified. * **IAMDatabaseAuthenticationEnabled** *(boolean) --* Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled for the DB instance. For a list of engine versions that support IAM database authentication, see IAM database authentication in the *Amazon RDS User Guide* and IAM database authentication in Aurora in the *Amazon Aurora User Guide*. * **DatabaseInsightsMode** *(string) --* The mode of Database Insights that is enabled for the instance. * **PerformanceInsightsEnabled** *(boolean) --* Indicates whether Performance Insights is enabled for the DB instance. * **PerformanceInsightsKMSKeyId** *(string) --* The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. * **PerformanceInsightsRetentionPeriod** *(integer) --* The number of days to retain Performance Insights data. Valid Values: * "7" * *month* * 31, where *month* is a number of months from 1-23. Examples: "93" (3 months * 31), "341" (11 months * 31), "589" (19 months * 31) * "731" Default: "7" days * **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 Monitoring Amazon RDS log files in the *Amazon RDS User Guide.* * *(string) --* * **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: * "CreateDBInstance" * "ModifyDBInstance" * "RestoreDBInstanceFromDBSnapshot" * "RestoreDBInstanceFromS3" * "RestoreDBInstanceToPointInTime" 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: * "DescribeDBInstances" * "DescribeDBSnapshots" * "DescribeValidDBInstanceModifications" If you call "DescribeDBInstances", "ProcessorFeature" returns non-null values only if the following conditions are met: * You are accessing an Oracle DB instance. * Your Oracle DB instance class supports configuring the number of CPU cores and threads per core. * The current number CPU cores and threads is set to a non-default value. For more information, see Configuring the processor for a DB instance class in RDS for Oracle 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. * **DeletionProtection** *(boolean) --* Indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance. * **AssociatedRoles** *(list) --* The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance. * *(dict) --* Information about an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance. * **RoleArn** *(string) --* The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance. * **FeatureName** *(string) --* The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see "DBEngineVersion". * **Status** *(string) --* Information about the state of association between the IAM role and the DB instance. The Status property returns one of the following values: * "ACTIVE" - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf. * "PENDING" - the IAM role ARN is being associated with the DB instance. * "INVALID" - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf. * **ListenerEndpoint** *(dict) --* The listener connection endpoint for SQL Server Always On. * **Address** *(string) --* Specifies the DNS address of the DB instance. * **Port** *(integer) --* Specifies the port that the database engine is listening on. * **HostedZoneId** *(string) --* Specifies the ID that Amazon Route 53 assigns when you create a hosted zone. * **MaxAllocatedStorage** *(integer) --* The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. * **TagList** *(list) --* A list of tags. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **Key** *(string) --* A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **Value** *(string) --* A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **DBInstanceAutomatedBackupsReplications** *(list) --* The list of replicated automated backups associated with the DB instance. * *(dict) --* Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties. * **DBInstanceAutomatedBackupsArn** *(string) --* The Amazon Resource Name (ARN) of the replicated automated backups. * **CustomerOwnedIpEnabled** *(boolean) --* Indicates whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance. A >>*<>*< * **MultiTenant** *(boolean) --* Indicates whether the DB instance will change to the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE). * **LatestRestorableTime** *(datetime) --* The latest time to which a database in this DB instance can be restored with point-in-time restore. * **MultiAZ** *(boolean) --* Indicates whether the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom DB instances. * **EngineVersion** *(string) --* The version of the database engine. * **AutoMinorVersionUpgrade** *(boolean) --* Indicates whether minor version patches are applied automatically. For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version. * **ReadReplicaSourceDBInstanceIdentifier** *(string) --* The identifier of the source DB instance if this DB instance is a read replica. * **ReadReplicaDBInstanceIdentifiers** *(list) --* The identifiers of the read replicas associated with this DB instance. * *(string) --* * **ReadReplicaDBClusterIdentifiers** *(list) --* The identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn't contain information about cross-Region Aurora read replicas. Note: Currently, each RDS DB instance can have only one Aurora read replica. * *(string) --* * **ReplicaMode** *(string) --* The open mode of a Db2 or an Oracle read replica. The default is "open-read-only". For more information, see Working with read replicas for Amazon RDS for Db2 and Working with read replicas for Amazon RDS for Oracle in the *Amazon RDS User Guide*. Note: This attribute is only supported in RDS for Db2, RDS for Oracle, and RDS Custom for Oracle. * **LicenseModel** *(string) --* The license model information for this DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. * **Iops** *(integer) --* The Provisioned IOPS (I/O operations per second) value for the DB instance. * **OptionGroupMemberships** *(list) --* The list of option group memberships for this DB instance. * *(dict) --* Provides information on the option groups the DB instance is a member of. * **OptionGroupName** *(string) --* The name of the option group that the instance belongs to. * **Status** *(string) --* The status of the DB instance's option group membership. Valid values are: "in-sync", "pending- apply", "pending-removal", "pending-maintenance- apply", "pending-maintenance-removal", "applying", "removing", and "failed". * **CharacterSetName** *(string) --* If present, specifies the name of the character set that this instance is associated with. * **NcharCharacterSetName** *(string) --* The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2. * **SecondaryAvailabilityZone** *(string) --* If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support. * **PubliclyAccessible** *(boolean) --* Indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it. When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance. * **StatusInfos** *(list) --* The status of a read replica. If the DB instance isn't a read replica, the value is blank. * *(dict) --* Provides a list of status information for a DB instance. * **StatusType** *(string) --* This value is currently "read replication." * **Normal** *(boolean) --* Indicates whether the instance is operating normally (TRUE) or is in an error state (FALSE). * **Status** *(string) --* The 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) --* The storage type associated with the DB instance. * **TdeCredentialArn** *(string) --* The ARN from the key store with which the instance is associated for TDE encryption. * **DbInstancePort** *(integer) --* 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, indicates the name of the DB cluster that the DB instance is a member of. * **StorageEncrypted** *(boolean) --* Indicates whether the DB instance is encrypted. * **KmsKeyId** *(string) --* If "StorageEncrypted" is enabled, the Amazon Web Services KMS key identifier for the encrypted DB instance. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. * **DbiResourceId** *(string) --* The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB instance is accessed. * **CACertificateIdentifier** *(string) --* The identifier of the CA certificate for this DB instance. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the *Amazon RDS User Guide* and Using SSL/TLS to encrypt a connection to a DB cluster in the *Amazon Aurora User Guide*. * **DomainMemberships** *(list) --* The Active Directory Domain membership records associated with the DB instance. * *(dict) --* An Active Directory Domain membership record associated with the DB instance or cluster. * **Domain** *(string) --* The identifier of the Active Directory Domain. * **Status** *(string) --* The status of the Active Directory Domain membership for the DB instance or cluster. Values include "joined", "pending-join", "failed", and so on. * **FQDN** *(string) --* The fully qualified domain name (FQDN) of the Active Directory Domain. * **IAMRoleName** *(string) --* The name of the IAM role used when making API calls to the Directory Service. * **OU** *(string) --* The Active Directory organizational unit for the DB instance or cluster. * **AuthSecretArn** *(string) --* The ARN for the Secrets Manager secret with the credentials for the user that's a member of the domain. * **DnsIps** *(list) --* The IPv4 DNS IP addresses of the primary and secondary Active Directory domain controllers. * *(string) --* * **CopyTagsToSnapshot** *(boolean) --* Indicates whether tags are copied from the DB instance to snapshots of the DB instance. This setting doesn't apply to Amazon Aurora DB instances. 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) --* The order of priority 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 RDS for Db2 and RDS for SQL Server DB instances that were created with a time zone specified. * **IAMDatabaseAuthenticationEnabled** *(boolean) --* Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled for the DB instance. For a list of engine versions that support IAM database authentication, see IAM database authentication in the *Amazon RDS User Guide* and IAM database authentication in Aurora in the *Amazon Aurora User Guide*. * **DatabaseInsightsMode** *(string) --* The mode of Database Insights that is enabled for the instance. * **PerformanceInsightsEnabled** *(boolean) --* Indicates whether Performance Insights is enabled for the DB instance. * **PerformanceInsightsKMSKeyId** *(string) --* The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. * **PerformanceInsightsRetentionPeriod** *(integer) --* The number of days to retain Performance Insights data. Valid Values: * "7" * *month* * 31, where *month* is a number of months from 1-23. Examples: "93" (3 months * 31), "341" (11 months * 31), "589" (19 months * 31) * "731" Default: "7" days * **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 Monitoring Amazon RDS log files in the *Amazon RDS User Guide.* * *(string) --* * **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: * "CreateDBInstance" * "ModifyDBInstance" * "RestoreDBInstanceFromDBSnapshot" * "RestoreDBInstanceFromS3" * "RestoreDBInstanceToPointInTime" 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: * "DescribeDBInstances" * "DescribeDBSnapshots" * "DescribeValidDBInstanceModifications" If you call "DescribeDBInstances", "ProcessorFeature" returns non-null values only if the following conditions are met: * You are accessing an Oracle DB instance. * Your Oracle DB instance class supports configuring the number of CPU cores and threads per core. * The current number CPU cores and threads is set to a non-default value. For more information, see Configuring the processor for a DB instance class in RDS for Oracle 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. * **DeletionProtection** *(boolean) --* Indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance. * **AssociatedRoles** *(list) --* The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance. * *(dict) --* Information about an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance. * **RoleArn** *(string) --* The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance. * **FeatureName** *(string) --* The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see "DBEngineVersion". * **Status** *(string) --* Information about the state of association between the IAM role and the DB instance. The Status property returns one of the following values: * "ACTIVE" - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf. * "PENDING" - the IAM role ARN is being associated with the DB instance. * "INVALID" - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf. * **ListenerEndpoint** *(dict) --* The listener connection endpoint for SQL Server Always On. * **Address** *(string) --* Specifies the DNS address of the DB instance. * **Port** *(integer) --* Specifies the port that the database engine is listening on. * **HostedZoneId** *(string) --* Specifies the ID that Amazon Route 53 assigns when you create a hosted zone. * **MaxAllocatedStorage** *(integer) --* The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. * **TagList** *(list) --* A list of tags. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **Key** *(string) --* A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **Value** *(string) --* A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **DBInstanceAutomatedBackupsReplications** *(list) --* The list of replicated automated backups associated with the DB instance. * *(dict) --* Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties. * **DBInstanceAutomatedBackupsArn** *(string) --* The Amazon Resource Name (ARN) of the replicated automated backups. * **CustomerOwnedIpEnabled** *(boolean) --* Indicates whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance. A >>*<>*< * **MultiTenant** *(boolean) --* Indicates whether the DB instance will change to the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE). * **LatestRestorableTime** *(datetime) --* The latest time to which a database in this DB instance can be restored with point-in-time restore. * **MultiAZ** *(boolean) --* Indicates whether the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom DB instances. * **EngineVersion** *(string) --* The version of the database engine. * **AutoMinorVersionUpgrade** *(boolean) --* Indicates whether minor version patches are applied automatically. For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version. * **ReadReplicaSourceDBInstanceIdentifier** *(string) --* The identifier of the source DB instance if this DB instance is a read replica. * **ReadReplicaDBInstanceIdentifiers** *(list) --* The identifiers of the read replicas associated with this DB instance. * *(string) --* * **ReadReplicaDBClusterIdentifiers** *(list) --* The identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn't contain information about cross-Region Aurora read replicas. Note: Currently, each RDS DB instance can have only one Aurora read replica. * *(string) --* * **ReplicaMode** *(string) --* The open mode of a Db2 or an Oracle read replica. The default is "open-read-only". For more information, see Working with read replicas for Amazon RDS for Db2 and Working with read replicas for Amazon RDS for Oracle in the *Amazon RDS User Guide*. Note: This attribute is only supported in RDS for Db2, RDS for Oracle, and RDS Custom for Oracle. * **LicenseModel** *(string) --* The license model information for this DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. * **Iops** *(integer) --* The Provisioned IOPS (I/O operations per second) value for the DB instance. * **OptionGroupMemberships** *(list) --* The list of option group memberships for this DB instance. * *(dict) --* Provides information on the option groups the DB instance is a member of. * **OptionGroupName** *(string) --* The name of the option group that the instance belongs to. * **Status** *(string) --* The status of the DB instance's option group membership. Valid values are: "in-sync", "pending- apply", "pending-removal", "pending-maintenance- apply", "pending-maintenance-removal", "applying", "removing", and "failed". * **CharacterSetName** *(string) --* If present, specifies the name of the character set that this instance is associated with. * **NcharCharacterSetName** *(string) --* The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2. * **SecondaryAvailabilityZone** *(string) --* If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support. * **PubliclyAccessible** *(boolean) --* Indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it. When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance. * **StatusInfos** *(list) --* The status of a read replica. If the DB instance isn't a read replica, the value is blank. * *(dict) --* Provides a list of status information for a DB instance. * **StatusType** *(string) --* This value is currently "read replication." * **Normal** *(boolean) --* Indicates whether the instance is operating normally (TRUE) or is in an error state (FALSE). * **Status** *(string) --* The 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) --* The storage type associated with the DB instance. * **TdeCredentialArn** *(string) --* The ARN from the key store with which the instance is associated for TDE encryption. * **DbInstancePort** *(integer) --* 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, indicates the name of the DB cluster that the DB instance is a member of. * **StorageEncrypted** *(boolean) --* Indicates whether the DB instance is encrypted. * **KmsKeyId** *(string) --* If "StorageEncrypted" is enabled, the Amazon Web Services KMS key identifier for the encrypted DB instance. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. * **DbiResourceId** *(string) --* The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB instance is accessed. * **CACertificateIdentifier** *(string) --* The identifier of the CA certificate for this DB instance. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the *Amazon RDS User Guide* and Using SSL/TLS to encrypt a connection to a DB cluster in the *Amazon Aurora User Guide*. * **DomainMemberships** *(list) --* The Active Directory Domain membership records associated with the DB instance. * *(dict) --* An Active Directory Domain membership record associated with the DB instance or cluster. * **Domain** *(string) --* The identifier of the Active Directory Domain. * **Status** *(string) --* The status of the Active Directory Domain membership for the DB instance or cluster. Values include "joined", "pending-join", "failed", and so on. * **FQDN** *(string) --* The fully qualified domain name (FQDN) of the Active Directory Domain. * **IAMRoleName** *(string) --* The name of the IAM role used when making API calls to the Directory Service. * **OU** *(string) --* The Active Directory organizational unit for the DB instance or cluster. * **AuthSecretArn** *(string) --* The ARN for the Secrets Manager secret with the credentials for the user that's a member of the domain. * **DnsIps** *(list) --* The IPv4 DNS IP addresses of the primary and secondary Active Directory domain controllers. * *(string) --* * **CopyTagsToSnapshot** *(boolean) --* Indicates whether tags are copied from the DB instance to snapshots of the DB instance. This setting doesn't apply to Amazon Aurora DB instances. 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) --* The order of priority 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 RDS for Db2 and RDS for SQL Server DB instances that were created with a time zone specified. * **IAMDatabaseAuthenticationEnabled** *(boolean) --* Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled for the DB instance. For a list of engine versions that support IAM database authentication, see IAM database authentication in the *Amazon RDS User Guide* and IAM database authentication in Aurora in the *Amazon Aurora User Guide*. * **DatabaseInsightsMode** *(string) --* The mode of Database Insights that is enabled for the instance. * **PerformanceInsightsEnabled** *(boolean) --* Indicates whether Performance Insights is enabled for the DB instance. * **PerformanceInsightsKMSKeyId** *(string) --* The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. * **PerformanceInsightsRetentionPeriod** *(integer) --* The number of days to retain Performance Insights data. Valid Values: * "7" * *month* * 31, where *month* is a number of months from 1-23. Examples: "93" (3 months * 31), "341" (11 months * 31), "589" (19 months * 31) * "731" Default: "7" days * **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 Monitoring Amazon RDS log files in the *Amazon RDS User Guide.* * *(string) --* * **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: * "CreateDBInstance" * "ModifyDBInstance" * "RestoreDBInstanceFromDBSnapshot" * "RestoreDBInstanceFromS3" * "RestoreDBInstanceToPointInTime" 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: * "DescribeDBInstances" * "DescribeDBSnapshots" * "DescribeValidDBInstanceModifications" If you call "DescribeDBInstances", "ProcessorFeature" returns non-null values only if the following conditions are met: * You are accessing an Oracle DB instance. * Your Oracle DB instance class supports configuring the number of CPU cores and threads per core. * The current number CPU cores and threads is set to a non-default value. For more information, see Configuring the processor for a DB instance class in RDS for Oracle 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. * **DeletionProtection** *(boolean) --* Indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance. * **AssociatedRoles** *(list) --* The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance. * *(dict) --* Information about an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance. * **RoleArn** *(string) --* The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance. * **FeatureName** *(string) --* The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see "DBEngineVersion". * **Status** *(string) --* Information about the state of association between the IAM role and the DB instance. The Status property returns one of the following values: * "ACTIVE" - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf. * "PENDING" - the IAM role ARN is being associated with the DB instance. * "INVALID" - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf. * **ListenerEndpoint** *(dict) --* The listener connection endpoint for SQL Server Always On. * **Address** *(string) --* Specifies the DNS address of the DB instance. * **Port** *(integer) --* Specifies the port that the database engine is listening on. * **HostedZoneId** *(string) --* Specifies the ID that Amazon Route 53 assigns when you create a hosted zone. * **MaxAllocatedStorage** *(integer) --* The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. * **TagList** *(list) --* A list of tags. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **Key** *(string) --* A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **Value** *(string) --* A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **DBInstanceAutomatedBackupsReplications** *(list) --* The list of replicated automated backups associated with the DB instance. * *(dict) --* Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties. * **DBInstanceAutomatedBackupsArn** *(string) --* The Amazon Resource Name (ARN) of the replicated automated backups. * **CustomerOwnedIpEnabled** *(boolean) --* Indicates whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance. A >>*<>*< * **MultiTenant** *(boolean) --* Indicates whether the DB instance will change to the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE). * **LatestRestorableTime** *(datetime) --* The latest time to which a database in this DB instance can be restored with point-in-time restore. * **MultiAZ** *(boolean) --* Indicates whether the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom DB instances. * **EngineVersion** *(string) --* The version of the database engine. * **AutoMinorVersionUpgrade** *(boolean) --* Indicates whether minor version patches are applied automatically. For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version. * **ReadReplicaSourceDBInstanceIdentifier** *(string) --* The identifier of the source DB instance if this DB instance is a read replica. * **ReadReplicaDBInstanceIdentifiers** *(list) --* The identifiers of the read replicas associated with this DB instance. * *(string) --* * **ReadReplicaDBClusterIdentifiers** *(list) --* The identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn't contain information about cross-Region Aurora read replicas. Note: Currently, each RDS DB instance can have only one Aurora read replica. * *(string) --* * **ReplicaMode** *(string) --* The open mode of a Db2 or an Oracle read replica. The default is "open-read-only". For more information, see Working with read replicas for Amazon RDS for Db2 and Working with read replicas for Amazon RDS for Oracle in the *Amazon RDS User Guide*. Note: This attribute is only supported in RDS for Db2, RDS for Oracle, and RDS Custom for Oracle. * **LicenseModel** *(string) --* The license model information for this DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. * **Iops** *(integer) --* The Provisioned IOPS (I/O operations per second) value for the DB instance. * **OptionGroupMemberships** *(list) --* The list of option group memberships for this DB instance. * *(dict) --* Provides information on the option groups the DB instance is a member of. * **OptionGroupName** *(string) --* The name of the option group that the instance belongs to. * **Status** *(string) --* The status of the DB instance's option group membership. Valid values are: "in-sync", "pending- apply", "pending-removal", "pending-maintenance- apply", "pending-maintenance-removal", "applying", "removing", and "failed". * **CharacterSetName** *(string) --* If present, specifies the name of the character set that this instance is associated with. * **NcharCharacterSetName** *(string) --* The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2. * **SecondaryAvailabilityZone** *(string) --* If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support. * **PubliclyAccessible** *(boolean) --* Indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it. When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance. * **StatusInfos** *(list) --* The status of a read replica. If the DB instance isn't a read replica, the value is blank. * *(dict) --* Provides a list of status information for a DB instance. * **StatusType** *(string) --* This value is currently "read replication." * **Normal** *(boolean) --* Indicates whether the instance is operating normally (TRUE) or is in an error state (FALSE). * **Status** *(string) --* The 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) --* The storage type associated with the DB instance. * **TdeCredentialArn** *(string) --* The ARN from the key store with which the instance is associated for TDE encryption. * **DbInstancePort** *(integer) --* 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, indicates the name of the DB cluster that the DB instance is a member of. * **StorageEncrypted** *(boolean) --* Indicates whether the DB instance is encrypted. * **KmsKeyId** *(string) --* If "StorageEncrypted" is enabled, the Amazon Web Services KMS key identifier for the encrypted DB instance. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. * **DbiResourceId** *(string) --* The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB instance is accessed. * **CACertificateIdentifier** *(string) --* The identifier of the CA certificate for this DB instance. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the *Amazon RDS User Guide* and Using SSL/TLS to encrypt a connection to a DB cluster in the *Amazon Aurora User Guide*. * **DomainMemberships** *(list) --* The Active Directory Domain membership records associated with the DB instance. * *(dict) --* An Active Directory Domain membership record associated with the DB instance or cluster. * **Domain** *(string) --* The identifier of the Active Directory Domain. * **Status** *(string) --* The status of the Active Directory Domain membership for the DB instance or cluster. Values include "joined", "pending-join", "failed", and so on. * **FQDN** *(string) --* The fully qualified domain name (FQDN) of the Active Directory Domain. * **IAMRoleName** *(string) --* The name of the IAM role used when making API calls to the Directory Service. * **OU** *(string) --* The Active Directory organizational unit for the DB instance or cluster. * **AuthSecretArn** *(string) --* The ARN for the Secrets Manager secret with the credentials for the user that's a member of the domain. * **DnsIps** *(list) --* The IPv4 DNS IP addresses of the primary and secondary Active Directory domain controllers. * *(string) --* * **CopyTagsToSnapshot** *(boolean) --* Indicates whether tags are copied from the DB instance to snapshots of the DB instance. This setting doesn't apply to Amazon Aurora DB instances. 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) --* The order of priority 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 RDS for Db2 and RDS for SQL Server DB instances that were created with a time zone specified. * **IAMDatabaseAuthenticationEnabled** *(boolean) --* Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled for the DB instance. For a list of engine versions that support IAM database authentication, see IAM database authentication in the *Amazon RDS User Guide* and IAM database authentication in Aurora in the *Amazon Aurora User Guide*. * **DatabaseInsightsMode** *(string) --* The mode of Database Insights that is enabled for the instance. * **PerformanceInsightsEnabled** *(boolean) --* Indicates whether Performance Insights is enabled for the DB instance. * **PerformanceInsightsKMSKeyId** *(string) --* The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. * **PerformanceInsightsRetentionPeriod** *(integer) --* The number of days to retain Performance Insights data. Valid Values: * "7" * *month* * 31, where *month* is a number of months from 1-23. Examples: "93" (3 months * 31), "341" (11 months * 31), "589" (19 months * 31) * "731" Default: "7" days * **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 Monitoring Amazon RDS log files in the *Amazon RDS User Guide.* * *(string) --* * **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: * "CreateDBInstance" * "ModifyDBInstance" * "RestoreDBInstanceFromDBSnapshot" * "RestoreDBInstanceFromS3" * "RestoreDBInstanceToPointInTime" 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: * "DescribeDBInstances" * "DescribeDBSnapshots" * "DescribeValidDBInstanceModifications" If you call "DescribeDBInstances", "ProcessorFeature" returns non-null values only if the following conditions are met: * You are accessing an Oracle DB instance. * Your Oracle DB instance class supports configuring the number of CPU cores and threads per core. * The current number CPU cores and threads is set to a non-default value. For more information, see Configuring the processor for a DB instance class in RDS for Oracle 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. * **DeletionProtection** *(boolean) --* Indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance. * **AssociatedRoles** *(list) --* The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance. * *(dict) --* Information about an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance. * **RoleArn** *(string) --* The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance. * **FeatureName** *(string) --* The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see "DBEngineVersion". * **Status** *(string) --* Information about the state of association between the IAM role and the DB instance. The Status property returns one of the following values: * "ACTIVE" - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf. * "PENDING" - the IAM role ARN is being associated with the DB instance. * "INVALID" - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf. * **ListenerEndpoint** *(dict) --* The listener connection endpoint for SQL Server Always On. * **Address** *(string) --* Specifies the DNS address of the DB instance. * **Port** *(integer) --* Specifies the port that the database engine is listening on. * **HostedZoneId** *(string) --* Specifies the ID that Amazon Route 53 assigns when you create a hosted zone. * **MaxAllocatedStorage** *(integer) --* The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. * **TagList** *(list) --* A list of tags. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **Key** *(string) --* A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **Value** *(string) --* A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **DBInstanceAutomatedBackupsReplications** *(list) --* The list of replicated automated backups associated with the DB instance. * *(dict) --* Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties. * **DBInstanceAutomatedBackupsArn** *(string) --* The Amazon Resource Name (ARN) of the replicated automated backups. * **CustomerOwnedIpEnabled** *(boolean) --* Indicates whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance. A >>*<>*< --engine-version " For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, use the following command: "aws rds describe-db-engine-versions --engine postgres --engine-version 13.3" The supported features are listed under "SupportedFeatureNames" in the output. * *(string) --* * **Status** *(string) --* The status of the DB engine version, either "available" or "deprecated". * **SupportsParallelQuery** *(boolean) --* Indicates whether you can use Aurora parallel query with a specific DB engine version. * **SupportsGlobalDatabases** *(boolean) --* Indicates whether you can use Aurora global databases with a specific DB engine version. * **MajorEngineVersion** *(string) --* The major engine version of the CEV. * **DatabaseInstallationFilesS3BucketName** *(string) --* The name of the Amazon S3 bucket that contains your database installation files. * **DatabaseInstallationFilesS3Prefix** *(string) --* The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed. * **DBEngineVersionArn** *(string) --* The ARN of the custom engine version. * **KMSKeyId** *(string) --* The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS. * **CreateTime** *(datetime) --* The creation time of the DB engine version. * **TagList** *(list) --* A list of tags. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **Key** *(string) --* A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **Value** *(string) --* A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **SupportsBabelfish** *(boolean) --* Indicates whether the engine version supports Babelfish for Aurora PostgreSQL. * **CustomDBEngineVersionManifest** *(string) --* JSON string that lists the installation files and parameters that RDS Custom uses to create a custom engine version (CEV). RDS Custom applies the patches in the order in which they're listed in the manifest. You can set the Oracle home, Oracle base, and UNIX/Linux user and group using the installation parameters. For more information, see JSON fields in the CEV manifest in the *Amazon RDS User Guide*. * **SupportsLimitlessDatabase** *(boolean) --* Indicates whether the DB engine version supports Aurora Limitless Database. * **SupportsCertificateRotationWithoutRestart** *(boolean) --* Indicates whether the engine version supports rotating the server certificate without rebooting the DB instance. * **SupportedCACertificateIdentifiers** *(list) --* A list of the supported CA certificate identifiers. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the *Amazon RDS User Guide* and Using SSL/TLS to encrypt a connection to a DB cluster in the *Amazon Aurora User Guide*. * *(string) --* * **SupportsLocalWriteForwarding** *(boolean) --* Indicates whether the DB engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances. Valid for: Aurora DB clusters only * **SupportsIntegrations** *(boolean) --* Indicates whether the DB engine version supports zero- ETL integrations with Amazon Redshift. * **ServerlessV2FeaturesSupport** *(dict) --* Specifies any Aurora Serverless v2 properties or limits that differ between Aurora engine versions. You can test the values of this attribute when deciding which Aurora version to use in a new or upgraded DB cluster. You can also retrieve the version of an existing DB cluster and check whether that version supports certain Aurora Serverless v2 features before you attempt to use those features. * **MinCapacity** *(float) --* If the minimum capacity is 0 ACUs, the engine version or platform version supports the automatic pause/resume feature of Aurora Serverless v2. * **MaxCapacity** *(float) --* Specifies the upper Aurora Serverless v2 capacity limit for a particular engine version or platform version. Depending on the engine version, the maximum capacity for an Aurora Serverless v2 cluster might be "256" or "128". **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': { '...': '...', }, } RDS / Client / describe_db_parameter_groups describe_db_parameter_groups **************************** RDS.Client.describe_db_parameter_groups(**kwargs) Returns a list of "DBParameterGroup" descriptions. If a "DBParameterGroupName" is specified, the list will contain only the description of the specified DB parameter group. See also: AWS API Documentation **Request Syntax** response = client.describe_db_parameter_groups( DBParameterGroupName='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], MaxRecords=123, Marker='string' ) Parameters: * **DBParameterGroupName** (*string*) -- The name of a specific DB parameter group to return details for. Constraints: * If supplied, must match the name of an existing DBClusterParameterGroup. * **Filters** (*list*) -- This parameter isn't currently supported. * *(dict) --* 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: * "DescribeDBClusterBacktracks" * "DescribeDBClusterEndpoints" * "DescribeDBClusters" * "DescribeDBInstances" * "DescribeDBRecommendations" * "DescribeDBShardGroups" * "DescribePendingMaintenanceActions" * **Name** *(string) --* **[REQUIRED]** The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* **[REQUIRED]** One or more filter values. Filter values are case- sensitive. * *(string) --* * **MaxRecords** (*integer*) -- 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. * **Marker** (*string*) -- An optional pagination token provided by a previous "DescribeDBParameterGroups" request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by "MaxRecords". Return type: dict Returns: **Response Syntax** { 'Marker': 'string', 'DBParameterGroups': [ { 'DBParameterGroupName': 'string', 'DBParameterGroupFamily': 'string', 'Description': 'string', 'DBParameterGroupArn': 'string' }, ] } **Response Structure** * *(dict) --* Contains the result of a successful invocation of the "DescribeDBParameterGroups" action. * **Marker** *(string) --* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by "MaxRecords". * **DBParameterGroups** *(list) --* A list of "DBParameterGroup" instances. * *(dict) --* Contains the details of an Amazon RDS DB parameter group. This data type is used as a response element in the "DescribeDBParameterGroups" action. * **DBParameterGroupName** *(string) --* The name of the DB parameter group. * **DBParameterGroupFamily** *(string) --* The name of the DB parameter group family that this DB parameter group is compatible with. * **Description** *(string) --* Provides the customer-specified description for this DB parameter group. * **DBParameterGroupArn** *(string) --* The Amazon Resource Name (ARN) for the DB parameter group. **Exceptions** * "RDS.Client.exceptions.DBParameterGroupNotFoundFault" **Examples** This example lists information about the specified DB parameter group. response = client.describe_db_parameter_groups( DBParameterGroupName='mymysqlparametergroup', ) print(response) Expected Output: { 'ResponseMetadata': { '...': '...', }, } RDS / Client / delete_db_cluster_parameter_group delete_db_cluster_parameter_group ********************************* RDS.Client.delete_db_cluster_parameter_group(**kwargs) Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters. For more information on Amazon Aurora, see What is Amazon Aurora? in the *Amazon Aurora User Guide*. For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the *Amazon RDS User Guide*. See also: AWS API Documentation **Request Syntax** response = client.delete_db_cluster_parameter_group( DBClusterParameterGroupName='string' ) Parameters: **DBClusterParameterGroupName** (*string*) -- **[REQUIRED]** The name of the DB cluster parameter group. Constraints: * Must be the name of an existing DB cluster parameter group. * You can't delete a default DB cluster parameter group. * Can't be associated with any DB clusters. Returns: None **Exceptions** * "RDS.Client.exceptions.InvalidDBParameterGroupStateFault" * "RDS.Client.exceptions.DBParameterGroupNotFoundFault" **Examples** This example deletes the specified DB cluster parameter group. response = client.delete_db_cluster_parameter_group( DBClusterParameterGroupName='mydbclusterparametergroup', ) print(response) Expected Output: { 'ResponseMetadata': { '...': '...', }, } RDS / Client / start_export_task start_export_task ***************** RDS.Client.start_export_task(**kwargs) Starts an export of DB snapshot or DB cluster data to Amazon S3. The provided IAM role must have access to the S3 bucket. You can't export snapshot data from RDS Custom DB instances. For more information, see Supported Regions and DB engines for exporting snapshots to S3 in Amazon RDS. For more information on exporting DB snapshot data, see Exporting DB snapshot data to Amazon S3 in the *Amazon RDS User Guide* or Exporting DB cluster snapshot data to Amazon S3 in the *Amazon Aurora User Guide*. For more information on exporting DB cluster data, see Exporting DB cluster data to Amazon S3 in the *Amazon Aurora User Guide*. See also: AWS API Documentation **Request Syntax** response = client.start_export_task( ExportTaskIdentifier='string', SourceArn='string', S3BucketName='string', IamRoleArn='string', KmsKeyId='string', S3Prefix='string', ExportOnly=[ 'string', ] ) Parameters: * **ExportTaskIdentifier** (*string*) -- **[REQUIRED]** A unique identifier for the export task. This ID isn't an identifier for the Amazon S3 bucket where the data is to be exported. * **SourceArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the snapshot or cluster to export to Amazon S3. * **S3BucketName** (*string*) -- **[REQUIRED]** The name of the Amazon S3 bucket to export the snapshot or cluster data to. * **IamRoleArn** (*string*) -- **[REQUIRED]** The name of the IAM role to use for writing to the Amazon S3 bucket when exporting a snapshot or cluster. In the IAM policy attached to your IAM role, include the following required actions to allow the transfer of files from Amazon RDS or Amazon Aurora to an S3 bucket: * s3:PutObject* * s3:GetObject* * s3:ListBucket * s3:DeleteObject* * s3:GetBucketLocation In the policy, include the resources to identify the S3 bucket and objects in the bucket. The following list of resources shows the Amazon Resource Name (ARN) format for accessing S3: * "arn:aws:s3:::your-s3-bucket" * "arn:aws:s3:::your-s3-bucket/*" * **KmsKeyId** (*string*) -- **[REQUIRED]** The ID of the Amazon Web Services KMS key to use to encrypt the data exported to Amazon S3. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. The caller of this operation must be authorized to run the following operations. These can be set in the Amazon Web Services KMS key policy: * kms:CreateGrant * kms:DescribeKey * **S3Prefix** (*string*) -- The Amazon S3 bucket prefix to use as the file name and path of the exported data. * **ExportOnly** (*list*) -- The data to be exported from the snapshot or cluster. If this parameter isn't provided, all of the data is exported. Valid Values: * "database" - Export all the data from a specified database. * "database.table" *table-name* - Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL. * "database.schema" *schema-name* - Export a database schema of the snapshot or cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL. * "database.schema.table" *table-name* - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL. * *(string) --* Return type: dict Returns: **Response Syntax** { 'ExportTaskIdentifier': 'string', 'SourceArn': 'string', 'ExportOnly': [ 'string', ], 'SnapshotTime': datetime(2015, 1, 1), 'TaskStartTime': datetime(2015, 1, 1), 'TaskEndTime': datetime(2015, 1, 1), 'S3Bucket': 'string', 'S3Prefix': 'string', 'IamRoleArn': 'string', 'KmsKeyId': 'string', 'Status': 'string', 'PercentProgress': 123, 'TotalExtractedDataInGB': 123, 'FailureCause': 'string', 'WarningMessage': 'string', 'SourceType': 'SNAPSHOT'|'CLUSTER' } **Response Structure** * *(dict) --* Contains the details of a snapshot or cluster export to Amazon S3. This data type is used as a response element in the "DescribeExportTasks" operation. * **ExportTaskIdentifier** *(string) --* A unique identifier for the snapshot or cluster export task. This ID isn't an identifier for the Amazon S3 bucket where the data is exported. * **SourceArn** *(string) --* The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3. * **ExportOnly** *(list) --* The data exported from the snapshot or cluster. Valid Values: * "database" - Export all the data from a specified database. * "database.table" *table-name* - Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL. * "database.schema" *schema-name* - Export a database schema of the snapshot or cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL. * "database.schema.table" *table-name* - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL. * *(string) --* * **SnapshotTime** *(datetime) --* The time when the snapshot was created. * **TaskStartTime** *(datetime) --* The time when the snapshot or cluster export task started. * **TaskEndTime** *(datetime) --* The time when the snapshot or cluster export task ended. * **S3Bucket** *(string) --* The Amazon S3 bucket where the snapshot or cluster is exported to. * **S3Prefix** *(string) --* The Amazon S3 bucket prefix that is the file name and path of the exported data. * **IamRoleArn** *(string) --* The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot or cluster. * **KmsKeyId** *(string) --* The key identifier of the Amazon Web Services KMS key that is used to encrypt the data when it's exported to Amazon S3. The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the export must have encryption and decryption permissions to use this KMS key. * **Status** *(string) --* The progress status of the export task. The status can be one of the following: * "CANCELED" * "CANCELING" * "COMPLETE" * "FAILED" * "IN_PROGRESS" * "STARTING" * **PercentProgress** *(integer) --* The progress of the snapshot or cluster export task as a percentage. * **TotalExtractedDataInGB** *(integer) --* The total amount of data exported, in gigabytes. * **FailureCause** *(string) --* The reason the export failed, if it failed. * **WarningMessage** *(string) --* A warning about the snapshot or cluster export task. * **SourceType** *(string) --* The type of source for the export. **Exceptions** * "RDS.Client.exceptions.DBSnapshotNotFoundFault" * "RDS.Client.exceptions.DBClusterSnapshotNotFoundFault" * "RDS.Client.exceptions.DBClusterNotFoundFault" * "RDS.Client.exceptions.ExportTaskAlreadyExistsFault" * "RDS.Client.exceptions.InvalidS3BucketFault" * "RDS.Client.exceptions.IamRoleNotFoundFault" * "RDS.Client.exceptions.IamRoleMissingPermissionsFault" * "RDS.Client.exceptions.InvalidExportOnlyFault" * "RDS.Client.exceptions.KMSKeyNotAccessibleFault" * "RDS.Client.exceptions.InvalidExportSourceStateFault" RDS / Client / describe_db_proxy_targets describe_db_proxy_targets ************************* RDS.Client.describe_db_proxy_targets(**kwargs) Returns information about "DBProxyTarget" objects. This API supports pagination. See also: AWS API Documentation **Request Syntax** response = client.describe_db_proxy_targets( DBProxyName='string', TargetGroupName='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], Marker='string', MaxRecords=123 ) Parameters: * **DBProxyName** (*string*) -- **[REQUIRED]** The identifier of the "DBProxyTarget" to describe. * **TargetGroupName** (*string*) -- The identifier of the "DBProxyTargetGroup" to describe. * **Filters** (*list*) -- This parameter is not currently supported. * *(dict) --* 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: * "DescribeDBClusterBacktracks" * "DescribeDBClusterEndpoints" * "DescribeDBClusters" * "DescribeDBInstances" * "DescribeDBRecommendations" * "DescribeDBShardGroups" * "DescribePendingMaintenanceActions" * **Name** *(string) --* **[REQUIRED]** The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* **[REQUIRED]** One or more filter values. Filter values are case- sensitive. * *(string) --* * **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". * **MaxRecords** (*integer*) -- 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. Return type: dict Returns: **Response Syntax** { 'Targets': [ { 'TargetArn': 'string', 'Endpoint': 'string', 'TrackedClusterId': 'string', 'RdsResourceId': 'string', 'Port': 123, 'Type': 'RDS_INSTANCE'|'RDS_SERVERLESS_ENDPOINT'|'TRACKED_CLUSTER', 'Role': 'READ_WRITE'|'READ_ONLY'|'UNKNOWN', 'TargetHealth': { 'State': 'REGISTERING'|'AVAILABLE'|'UNAVAILABLE', 'Reason': 'UNREACHABLE'|'CONNECTION_FAILED'|'AUTH_FAILURE'|'PENDING_PROXY_CAPACITY'|'INVALID_REPLICATION_STATE', 'Description': 'string' } }, ], 'Marker': 'string' } **Response Structure** * *(dict) --* * **Targets** *(list) --* An arbitrary number of "DBProxyTarget" objects, containing details of the corresponding targets. * *(dict) --* Contains the details for an RDS Proxy target. It represents an RDS DB instance or Aurora DB cluster that the proxy can connect to. One or more targets are associated with an RDS Proxy target group. This data type is used as a response element in the "DescribeDBProxyTargets" action. * **TargetArn** *(string) --* The Amazon Resource Name (ARN) for the RDS DB instance or Aurora DB cluster. * **Endpoint** *(string) --* The writer endpoint for the RDS DB instance or Aurora DB cluster. * **TrackedClusterId** *(string) --* The DB cluster identifier when the target represents an Aurora DB cluster. This field is blank when the target represents an RDS DB instance. * **RdsResourceId** *(string) --* The identifier representing the target. It can be the instance identifier for an RDS DB instance, or the cluster identifier for an Aurora DB cluster. * **Port** *(integer) --* The port that the RDS Proxy uses to connect to the target RDS DB instance or Aurora DB cluster. * **Type** *(string) --* Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents. * **Role** *(string) --* A value that indicates whether the target of the proxy can be used for read/write or read-only operations. * **TargetHealth** *(dict) --* Information about the connection health of the RDS Proxy target. * **State** *(string) --* The current state of the connection health lifecycle for the RDS Proxy target. The following is a typical lifecycle example for the states of an RDS Proxy target: "registering" > "unavailable" > "available" > "unavailable" > "available" * **Reason** *(string) --* The reason for the current health "State" of the RDS Proxy target. * **Description** *(string) --* A description of the health of the RDS Proxy target. If the "State" is "AVAILABLE", a description is not included. * **Marker** *(string) --* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by "MaxRecords". **Exceptions** * "RDS.Client.exceptions.DBProxyNotFoundFault" * "RDS.Client.exceptions.DBProxyTargetNotFoundFault" * "RDS.Client.exceptions.DBProxyTargetGroupNotFoundFault" * "RDS.Client.exceptions.InvalidDBProxyStateFault" RDS / Client / create_db_subnet_group create_db_subnet_group ********************** RDS.Client.create_db_subnet_group(**kwargs) Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region. See also: AWS API Documentation **Request Syntax** response = client.create_db_subnet_group( DBSubnetGroupName='string', DBSubnetGroupDescription='string', SubnetIds=[ 'string', ], Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **DBSubnetGroupName** (*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. * First character must be a letter. Example: "mydbsubnetgroup" * **DBSubnetGroupDescription** (*string*) -- **[REQUIRED]** The description for the DB subnet group. * **SubnetIds** (*list*) -- **[REQUIRED]** The EC2 Subnet IDs for the DB subnet group. * *(string) --* * **Tags** (*list*) -- Tags to assign to the DB subnet group. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **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}_.:/=+\-@]*)$"). Return type: dict Returns: **Response Syntax** { 'DBSubnetGroup': { 'DBSubnetGroupName': 'string', 'DBSubnetGroupDescription': 'string', 'VpcId': 'string', 'SubnetGroupStatus': 'string', 'Subnets': [ { 'SubnetIdentifier': 'string', 'SubnetAvailabilityZone': { 'Name': 'string' }, 'SubnetOutpost': { 'Arn': 'string' }, 'SubnetStatus': 'string' }, ], 'DBSubnetGroupArn': 'string', 'SupportedNetworkTypes': [ 'string', ] } } **Response Structure** * *(dict) --* * **DBSubnetGroup** *(dict) --* Contains the details of an Amazon RDS DB subnet group. This data type is used as a response element in the "DescribeDBSubnetGroups" action. * **DBSubnetGroupName** *(string) --* The name of the DB subnet group. * **DBSubnetGroupDescription** *(string) --* Provides the description of the DB subnet group. * **VpcId** *(string) --* Provides the VpcId of the DB subnet group. * **SubnetGroupStatus** *(string) --* Provides the status of the DB subnet group. * **Subnets** *(list) --* Contains a list of "Subnet" elements. The list of subnets shown here might not reflect the current state of your VPC. For the most up-to-date information, we recommend checking your VPC configuration directly. * *(dict) --* This data type is used as a response element for the "DescribeDBSubnetGroups" operation. * **SubnetIdentifier** *(string) --* The identifier of the subnet. * **SubnetAvailabilityZone** *(dict) --* Contains Availability Zone information. This data type is used as an element in the "OrderableDBInstanceOption" data type. * **Name** *(string) --* The name of the Availability Zone. * **SubnetOutpost** *(dict) --* If the subnet is associated with an Outpost, this value specifies the Outpost. For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the *Amazon RDS User Guide.* * **Arn** *(string) --* The Amazon Resource Name (ARN) of the Outpost. * **SubnetStatus** *(string) --* The status of the subnet. * **DBSubnetGroupArn** *(string) --* The Amazon Resource Name (ARN) for the DB subnet group. * **SupportedNetworkTypes** *(list) --* The network type of the DB subnet group. Valid values: * "IPV4" * "DUAL" A "DBSubnetGroup" can support only the IPv4 protocol or the IPv4 and the IPv6 protocols ( "DUAL"). For more information, see Working with a DB instance in a VPC in the *Amazon RDS User Guide.* * *(string) --* **Exceptions** * "RDS.Client.exceptions.DBSubnetGroupAlreadyExistsFault" * "RDS.Client.exceptions.DBSubnetGroupQuotaExceededFault" * "RDS.Client.exceptions.DBSubnetQuotaExceededFault" * "RDS.Client.exceptions.DBSubnetGroupDoesNotCoverEnoughAZs" * "RDS.Client.exceptions.InvalidSubnet" **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: { 'DBSubnetGroup': { }, 'ResponseMetadata': { '...': '...', }, } RDS / Client / describe_db_proxies describe_db_proxies ******************* RDS.Client.describe_db_proxies(**kwargs) Returns information about DB proxies. See also: AWS API Documentation **Request Syntax** response = client.describe_db_proxies( DBProxyName='string', Filters=[ { 'Name': 'string', 'Values': [ 'string', ] }, ], Marker='string', MaxRecords=123 ) Parameters: * **DBProxyName** (*string*) -- The name of the DB proxy. If you omit this parameter, the output includes information about all DB proxies owned by your Amazon Web Services account ID. * **Filters** (*list*) -- This parameter is not currently supported. * *(dict) --* 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: * "DescribeDBClusterBacktracks" * "DescribeDBClusterEndpoints" * "DescribeDBClusters" * "DescribeDBInstances" * "DescribeDBRecommendations" * "DescribeDBShardGroups" * "DescribePendingMaintenanceActions" * **Name** *(string) --* **[REQUIRED]** The name of the filter. Filter names are case-sensitive. * **Values** *(list) --* **[REQUIRED]** One or more filter values. Filter values are case- sensitive. * *(string) --* * **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". * **MaxRecords** (*integer*) -- 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. Return type: dict Returns: **Response Syntax** { 'DBProxies': [ { 'DBProxyName': 'string', 'DBProxyArn': 'string', 'Status': 'available'|'modifying'|'incompatible-network'|'insufficient-resource-limits'|'creating'|'deleting'|'suspended'|'suspending'|'reactivating', 'EngineFamily': 'string', 'VpcId': 'string', 'VpcSecurityGroupIds': [ 'string', ], 'VpcSubnetIds': [ 'string', ], 'Auth': [ { 'Description': 'string', 'UserName': 'string', 'AuthScheme': 'SECRETS', 'SecretArn': 'string', 'IAMAuth': 'DISABLED'|'REQUIRED'|'ENABLED', 'ClientPasswordAuthType': 'MYSQL_NATIVE_PASSWORD'|'MYSQL_CACHING_SHA2_PASSWORD'|'POSTGRES_SCRAM_SHA_256'|'POSTGRES_MD5'|'SQL_SERVER_AUTHENTICATION' }, ], 'RoleArn': 'string', 'Endpoint': 'string', 'RequireTLS': True|False, 'IdleClientTimeout': 123, 'DebugLogging': True|False, 'CreatedDate': datetime(2015, 1, 1), 'UpdatedDate': datetime(2015, 1, 1) }, ], 'Marker': 'string' } **Response Structure** * *(dict) --* * **DBProxies** *(list) --* A return value representing an arbitrary number of "DBProxy" data structures. * *(dict) --* The data structure representing a proxy managed by the RDS Proxy. This data type is used as a response element in the "DescribeDBProxies" action. * **DBProxyName** *(string) --* The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region. * **DBProxyArn** *(string) --* The Amazon Resource Name (ARN) for the proxy. * **Status** *(string) --* The current status of this proxy. A status of "available" means the proxy is ready to handle requests. Other values indicate that you must wait for the proxy to be ready, or take some action to resolve an issue. * **EngineFamily** *(string) --* The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. "MYSQL" supports Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases. "POSTGRESQL" supports Aurora PostgreSQL and RDS for PostgreSQL databases. "SQLSERVER" supports RDS for Microsoft SQL Server databases. * **VpcId** *(string) --* Provides the VPC ID of the DB proxy. * **VpcSecurityGroupIds** *(list) --* Provides a list of VPC security groups that the proxy belongs to. * *(string) --* * **VpcSubnetIds** *(list) --* The EC2 subnet IDs for the proxy. * *(string) --* * **Auth** *(list) --* One or more data structures specifying the authorization mechanism to connect to the associated RDS DB instance or Aurora DB cluster. * *(dict) --* Returns the details of authentication used by a proxy to log in as a specific database user. * **Description** *(string) --* A user-specified description about the authentication used by a proxy to log in as a specific database user. * **UserName** *(string) --* The name of the database user to which the proxy connects. * **AuthScheme** *(string) --* The type of authentication that the proxy uses for connections from the proxy to the underlying database. * **SecretArn** *(string) --* The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster. These secrets are stored within Amazon Secrets Manager. * **IAMAuth** *(string) --* Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. * **ClientPasswordAuthType** *(string) --* The type of authentication the proxy uses for connections from clients. * **RoleArn** *(string) --* The Amazon Resource Name (ARN) for the IAM role that the proxy uses to access Amazon Secrets Manager. * **Endpoint** *(string) --* The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application. * **RequireTLS** *(boolean) --* Indicates whether Transport Layer Security (TLS) encryption is required for connections to the proxy. * **IdleClientTimeout** *(integer) --* The number of seconds a connection to the proxy can have no activity before the proxy drops the client connection. The proxy keeps the underlying database connection open and puts it back into the connection pool for reuse by later connection requests. Default: 1800 (30 minutes) Constraints: 1 to 28,800 * **DebugLogging** *(boolean) --* Indicates whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs. * **CreatedDate** *(datetime) --* The date and time when the proxy was first created. * **UpdatedDate** *(datetime) --* The date and time when the proxy was last updated. * **Marker** *(string) --* An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by "MaxRecords". **Exceptions** * "RDS.Client.exceptions.DBProxyNotFoundFault" RDS / Client / remove_role_from_db_instance remove_role_from_db_instance **************************** RDS.Client.remove_role_from_db_instance(**kwargs) Disassociates an Amazon Web Services Identity and Access Management (IAM) role from a DB instance. See also: AWS API Documentation **Request Syntax** response = client.remove_role_from_db_instance( DBInstanceIdentifier='string', RoleArn='string', FeatureName='string' ) Parameters: * **DBInstanceIdentifier** (*string*) -- **[REQUIRED]** The name of the DB instance to disassociate the IAM role from. * **RoleArn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the IAM role to disassociate from the DB instance, for example, "arn:aws:iam::123456789012:role/AccessRole". * **FeatureName** (*string*) -- **[REQUIRED]** The name of the feature for the DB instance that the IAM role is to be disassociated from. For information about supported feature names, see "DBEngineVersion". Returns: None **Exceptions** * "RDS.Client.exceptions.DBInstanceNotFoundFault" * "RDS.Client.exceptions.DBInstanceRoleNotFoundFault" * "RDS.Client.exceptions.InvalidDBInstanceStateFault" RDS / Client / create_db_parameter_group create_db_parameter_group ************************* RDS.Client.create_db_parameter_group(**kwargs) Creates a new DB parameter group. A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using "ModifyDBParameterGroup". Once you've created a DB parameter group, you need to associate it with your DB instance using "ModifyDBInstance". When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect. This command doesn't apply to RDS Custom. See also: AWS API Documentation **Request Syntax** response = client.create_db_parameter_group( DBParameterGroupName='string', DBParameterGroupFamily='string', Description='string', Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **DBParameterGroupName** (*string*) -- **[REQUIRED]** The name of the DB parameter group. Constraints: * Must be 1 to 255 letters, numbers, or hyphens. * First character must be a letter * Can't end with a hyphen or contain two consecutive hyphens Note: This value is stored as a lowercase string. * **DBParameterGroupFamily** (*string*) -- **[REQUIRED]** The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family. To list all of the available parameter group families for a DB engine, use the following command: "aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine " For example, to list all of the available parameter group families for the MySQL DB engine, use the following command: "aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine mysql" Note: The output contains duplicates. The following are the valid DB engine values: * "aurora-mysql" * "aurora-postgresql" * "db2-ae" * "db2-se" * "mysql" * "oracle-ee" * "oracle-ee-cdb" * "oracle-se2" * "oracle-se2-cdb" * "postgres" * "sqlserver-ee" * "sqlserver-se" * "sqlserver-ex" * "sqlserver-web" * **Description** (*string*) -- **[REQUIRED]** The description for the DB parameter group. * **Tags** (*list*) -- Tags to assign to the DB parameter group. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **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}_.:/=+\-@]*)$"). Return type: dict Returns: **Response Syntax** { 'DBParameterGroup': { 'DBParameterGroupName': 'string', 'DBParameterGroupFamily': 'string', 'Description': 'string', 'DBParameterGroupArn': 'string' } } **Response Structure** * *(dict) --* * **DBParameterGroup** *(dict) --* Contains the details of an Amazon RDS DB parameter group. This data type is used as a response element in the "DescribeDBParameterGroups" action. * **DBParameterGroupName** *(string) --* The name of the DB parameter group. * **DBParameterGroupFamily** *(string) --* The name of the DB parameter group family that this DB parameter group is compatible with. * **Description** *(string) --* Provides the customer-specified description for this DB parameter group. * **DBParameterGroupArn** *(string) --* The Amazon Resource Name (ARN) for the DB parameter group. **Exceptions** * "RDS.Client.exceptions.DBParameterGroupQuotaExceededFault" * "RDS.Client.exceptions.DBParameterGroupAlreadyExistsFault" **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: { 'DBParameterGroup': { }, 'ResponseMetadata': { '...': '...', }, } RDS / Client / start_db_instance start_db_instance ***************** RDS.Client.start_db_instance(**kwargs) Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the "StopDBInstance" operation. For more information, see Starting an Amazon RDS DB instance That Was Previously Stopped in the *Amazon RDS User Guide.* Note: This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora DB clusters, use "StartDBCluster" instead. See also: AWS API Documentation **Request Syntax** response = client.start_db_instance( DBInstanceIdentifier='string' ) Parameters: **DBInstanceIdentifier** (*string*) -- **[REQUIRED]** The user-supplied instance identifier. Return type: dict Returns: **Response Syntax** { 'DBInstance': { 'DBInstanceIdentifier': 'string', 'DBInstanceClass': 'string', 'Engine': 'string', 'DBInstanceStatus': 'string', 'AutomaticRestartTime': datetime(2015, 1, 1), 'MasterUsername': 'string', 'DBName': 'string', 'Endpoint': { 'Address': 'string', 'Port': 123, 'HostedZoneId': 'string' }, 'AllocatedStorage': 123, 'InstanceCreateTime': datetime(2015, 1, 1), 'PreferredBackupWindow': 'string', 'BackupRetentionPeriod': 123, 'DBSecurityGroups': [ { 'DBSecurityGroupName': 'string', 'Status': 'string' }, ], 'VpcSecurityGroups': [ { 'VpcSecurityGroupId': 'string', 'Status': 'string' }, ], 'DBParameterGroups': [ { 'DBParameterGroupName': 'string', 'ParameterApplyStatus': 'string' }, ], 'AvailabilityZone': 'string', 'DBSubnetGroup': { 'DBSubnetGroupName': 'string', 'DBSubnetGroupDescription': 'string', 'VpcId': 'string', 'SubnetGroupStatus': 'string', 'Subnets': [ { 'SubnetIdentifier': 'string', 'SubnetAvailabilityZone': { 'Name': 'string' }, 'SubnetOutpost': { 'Arn': 'string' }, 'SubnetStatus': 'string' }, ], 'DBSubnetGroupArn': 'string', 'SupportedNetworkTypes': [ 'string', ] }, 'PreferredMaintenanceWindow': 'string', 'PendingModifiedValues': { 'DBInstanceClass': 'string', 'AllocatedStorage': 123, 'MasterUserPassword': 'string', 'Port': 123, 'BackupRetentionPeriod': 123, 'MultiAZ': True|False, 'EngineVersion': 'string', 'LicenseModel': 'string', 'Iops': 123, 'DBInstanceIdentifier': 'string', 'StorageType': 'string', 'CACertificateIdentifier': 'string', 'DBSubnetGroupName': 'string', 'PendingCloudwatchLogsExports': { 'LogTypesToEnable': [ 'string', ], 'LogTypesToDisable': [ 'string', ] }, 'ProcessorFeatures': [ { 'Name': 'string', 'Value': 'string' }, ], 'IAMDatabaseAuthenticationEnabled': True|False, 'AutomationMode': 'full'|'all-paused', 'ResumeFullAutomationModeTime': datetime(2015, 1, 1), 'StorageThroughput': 123, 'Engine': 'string', 'DedicatedLogVolume': True|False, 'MultiTenant': True|False }, 'LatestRestorableTime': datetime(2015, 1, 1), 'MultiAZ': True|False, 'EngineVersion': 'string', 'AutoMinorVersionUpgrade': True|False, 'ReadReplicaSourceDBInstanceIdentifier': 'string', 'ReadReplicaDBInstanceIdentifiers': [ 'string', ], 'ReadReplicaDBClusterIdentifiers': [ 'string', ], 'ReplicaMode': 'open-read-only'|'mounted', 'LicenseModel': 'string', 'Iops': 123, 'OptionGroupMemberships': [ { 'OptionGroupName': 'string', 'Status': 'string' }, ], 'CharacterSetName': 'string', 'NcharCharacterSetName': 'string', 'SecondaryAvailabilityZone': 'string', 'PubliclyAccessible': True|False, 'StatusInfos': [ { 'StatusType': 'string', 'Normal': True|False, 'Status': 'string', 'Message': 'string' }, ], 'StorageType': 'string', 'TdeCredentialArn': 'string', 'DbInstancePort': 123, 'DBClusterIdentifier': 'string', 'StorageEncrypted': True|False, 'KmsKeyId': 'string', 'DbiResourceId': 'string', 'CACertificateIdentifier': 'string', 'DomainMemberships': [ { 'Domain': 'string', 'Status': 'string', 'FQDN': 'string', 'IAMRoleName': 'string', 'OU': 'string', 'AuthSecretArn': 'string', 'DnsIps': [ 'string', ] }, ], 'CopyTagsToSnapshot': True|False, 'MonitoringInterval': 123, 'EnhancedMonitoringResourceArn': 'string', 'MonitoringRoleArn': 'string', 'PromotionTier': 123, 'DBInstanceArn': 'string', 'Timezone': 'string', 'IAMDatabaseAuthenticationEnabled': True|False, 'DatabaseInsightsMode': 'standard'|'advanced', 'PerformanceInsightsEnabled': True|False, 'PerformanceInsightsKMSKeyId': 'string', 'PerformanceInsightsRetentionPeriod': 123, 'EnabledCloudwatchLogsExports': [ 'string', ], 'ProcessorFeatures': [ { 'Name': 'string', 'Value': 'string' }, ], 'DeletionProtection': True|False, 'AssociatedRoles': [ { 'RoleArn': 'string', 'FeatureName': 'string', 'Status': 'string' }, ], 'ListenerEndpoint': { 'Address': 'string', 'Port': 123, 'HostedZoneId': 'string' }, 'MaxAllocatedStorage': 123, 'TagList': [ { 'Key': 'string', 'Value': 'string' }, ], 'DBInstanceAutomatedBackupsReplications': [ { 'DBInstanceAutomatedBackupsArn': 'string' }, ], 'CustomerOwnedIpEnabled': True|False, 'AwsBackupRecoveryPointArn': 'string', 'ActivityStreamStatus': 'stopped'|'starting'|'started'|'stopping', 'ActivityStreamKmsKeyId': 'string', 'ActivityStreamKinesisStreamName': 'string', 'ActivityStreamMode': 'sync'|'async', 'ActivityStreamEngineNativeAuditFieldsIncluded': True|False, 'AutomationMode': 'full'|'all-paused', 'ResumeFullAutomationModeTime': datetime(2015, 1, 1), 'CustomIamInstanceProfile': 'string', 'BackupTarget': 'string', 'NetworkType': 'string', 'ActivityStreamPolicyStatus': 'locked'|'unlocked'|'locking-policy'|'unlocking-policy', 'StorageThroughput': 123, 'DBSystemId': 'string', 'MasterUserSecret': { 'SecretArn': 'string', 'SecretStatus': 'string', 'KmsKeyId': 'string' }, 'CertificateDetails': { 'CAIdentifier': 'string', 'ValidTill': datetime(2015, 1, 1) }, 'ReadReplicaSourceDBClusterIdentifier': 'string', 'PercentProgress': 'string', 'DedicatedLogVolume': True|False, 'IsStorageConfigUpgradeAvailable': True|False, 'MultiTenant': True|False, 'EngineLifecycleSupport': 'string' } } **Response Structure** * *(dict) --* * **DBInstance** *(dict) --* Contains the details of an Amazon RDS DB instance. This data type is used as a response element in the operations "CreateDBInstance", "CreateDBInstanceReadReplica", "DeleteDBInstance", "DescribeDBInstances", "ModifyDBInstance", "PromoteReadReplica", "RebootDBInstance", "RestoreDBInstanceFromDBSnapshot", "RestoreDBInstanceFromS3", "RestoreDBInstanceToPointInTime", "StartDBInstance", and "StopDBInstance". * **DBInstanceIdentifier** *(string) --* The user-supplied database identifier. This identifier is the unique key that identifies a DB instance. * **DBInstanceClass** *(string) --* The name of the compute and memory capacity class of the DB instance. * **Engine** *(string) --* The database engine used for this DB instance. * **DBInstanceStatus** *(string) --* The current state of this database. For information about DB instance statuses, see Viewing DB instance status in the *Amazon RDS User Guide.* * **AutomaticRestartTime** *(datetime) --* The time when a stopped DB instance is restarted automatically. * **MasterUsername** *(string) --* The master username for the DB instance. * **DBName** *(string) --* The initial database name that you provided (if required) when you created the DB instance. This name is returned for the life of your DB instance. For an RDS for Oracle CDB instance, the name identifies the PDB rather than the CDB. * **Endpoint** *(dict) --* The connection endpoint for the DB instance. Note: The endpoint might not be shown for instances with the status of "creating". * **Address** *(string) --* Specifies the DNS address of the DB instance. * **Port** *(integer) --* Specifies the port that the database engine is listening on. * **HostedZoneId** *(string) --* Specifies the ID that Amazon Route 53 assigns when you create a hosted zone. * **AllocatedStorage** *(integer) --* The amount of storage in gibibytes (GiB) allocated for the DB instance. * **InstanceCreateTime** *(datetime) --* The date and time when the DB instance was created. * **PreferredBackupWindow** *(string) --* The daily time range during which automated backups are created if automated backups are enabled, as determined by the "BackupRetentionPeriod". * **BackupRetentionPeriod** *(integer) --* 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: * "ModifyDBInstance" * "RebootDBInstance" * "RestoreDBInstanceFromDBSnapshot" * "RestoreDBInstanceToPointInTime" * **DBSecurityGroupName** *(string) --* The name of the DB security group. * **Status** *(string) --* The status of the DB security group. * **VpcSecurityGroups** *(list) --* The list of Amazon EC2 VPC security groups that the DB instance belongs to. * *(dict) --* This data type is used as a response element for queries on VPC security group membership. * **VpcSecurityGroupId** *(string) --* The name of the VPC security group. * **Status** *(string) --* The membership status of the VPC security group. Currently, the only valid status is "active". * **DBParameterGroups** *(list) --* 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: * "CreateDBInstance" * "CreateDBInstanceReadReplica" * "DeleteDBInstance" * "ModifyDBInstance" * "RebootDBInstance" * "RestoreDBInstanceFromDBSnapshot" * **DBParameterGroupName** *(string) --* The name of the DB parameter group. * **ParameterApplyStatus** *(string) --* The status of parameter updates. Valid values are: * "applying": The parameter group change is being applied to the database. * "failed-to-apply": The parameter group is in an invalid state. * "in-sync": The parameter group change is synchronized with the database. * "pending-database-upgrade": The parameter group change will be applied after the DB instance is upgraded. * "pending-reboot": The parameter group change will be applied after the DB instance reboots. * **AvailabilityZone** *(string) --* The name of the Availability Zone where the DB instance is located. * **DBSubnetGroup** *(dict) --* Information about 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. The list of subnets shown here might not reflect the current state of your VPC. For the most up-to-date information, we recommend checking your VPC configuration directly. * *(dict) --* This data type is used as a response element for the "DescribeDBSubnetGroups" operation. * **SubnetIdentifier** *(string) --* The identifier of the subnet. * **SubnetAvailabilityZone** *(dict) --* Contains Availability Zone information. This data type is used as an element in the "OrderableDBInstanceOption" data type. * **Name** *(string) --* The name of the Availability Zone. * **SubnetOutpost** *(dict) --* If the subnet is associated with an Outpost, this value specifies the Outpost. For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts in the *Amazon RDS User Guide.* * **Arn** *(string) --* The Amazon Resource Name (ARN) of the Outpost. * **SubnetStatus** *(string) --* The status of the subnet. * **DBSubnetGroupArn** *(string) --* The Amazon Resource Name (ARN) for the DB subnet group. * **SupportedNetworkTypes** *(list) --* The network type of the DB subnet group. Valid values: * "IPV4" * "DUAL" A "DBSubnetGroup" can support only the IPv4 protocol or the IPv4 and the IPv6 protocols ( "DUAL"). For more information, see Working with a DB instance in a VPC in the *Amazon RDS User Guide.* * *(string) --* * **PreferredMaintenanceWindow** *(string) --* The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). * **PendingModifiedValues** *(dict) --* Information about pending changes to the DB instance. This information is returned only when there are pending changes. Specific changes are identified by subelements. * **DBInstanceClass** *(string) --* The name of the compute and memory capacity class for the DB instance. * **AllocatedStorage** *(integer) --* The allocated storage size for the DB instance specified in gibibytes (GiB). * **MasterUserPassword** *(string) --* The master credentials for the DB instance. * **Port** *(integer) --* The port for the DB instance. * **BackupRetentionPeriod** *(integer) --* The number of days for which automated backups are retained. * **MultiAZ** *(boolean) --* Indicates whether the Single-AZ DB instance will change to a Multi-AZ deployment. * **EngineVersion** *(string) --* The database engine version. * **LicenseModel** *(string) --* The license model for the DB instance. Valid values: "license-included" | "bring-your-own- license" | "general-public-license" * **Iops** *(integer) --* The Provisioned IOPS value for the DB instance. * **DBInstanceIdentifier** *(string) --* The database identifier for the DB instance. * **StorageType** *(string) --* The storage type of the DB instance. * **CACertificateIdentifier** *(string) --* The identifier of the CA certificate for the DB instance. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the *Amazon RDS User Guide* and Using SSL/TLS to encrypt a connection to a DB cluster in the *Amazon Aurora User Guide*. * **DBSubnetGroupName** *(string) --* The DB subnet group for the DB instance. * **PendingCloudwatchLogsExports** *(dict) --* A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated. * **LogTypesToEnable** *(list) --* Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs. * *(string) --* * **LogTypesToDisable** *(list) --* Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs. * *(string) --* * **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: * "CreateDBInstance" * "ModifyDBInstance" * "RestoreDBInstanceFromDBSnapshot" * "RestoreDBInstanceFromS3" * "RestoreDBInstanceToPointInTime" 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: * "DescribeDBInstances" * "DescribeDBSnapshots" * "DescribeValidDBInstanceModifications" If you call "DescribeDBInstances", "ProcessorFeature" returns non-null values only if the following conditions are met: * You are accessing an Oracle DB instance. * Your Oracle DB instance class supports configuring the number of CPU cores and threads per core. * The current number CPU cores and threads is set to a non-default value. For more information, see Configuring the processor for a DB instance class in RDS for Oracle 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. * **IAMDatabaseAuthenticationEnabled** *(boolean) --* Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled. * **AutomationMode** *(string) --* The automation mode of the RDS Custom DB instance: "full" or "all-paused". If "full", the DB instance automates monitoring and instance recovery. If "all- paused", the instance pauses automation for the duration set by "--resume-full-automation-mode-minutes". * **ResumeFullAutomationModeTime** *(datetime) --* The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440. * **StorageThroughput** *(integer) --* The storage throughput of the DB instance. * **Engine** *(string) --* The database engine of the DB instance. * **DedicatedLogVolume** *(boolean) --* Indicates whether the DB instance has a dedicated log volume (DLV) enabled.> * **MultiTenant** *(boolean) --* Indicates whether the DB instance will change to the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE). * **LatestRestorableTime** *(datetime) --* The latest time to which a database in this DB instance can be restored with point-in-time restore. * **MultiAZ** *(boolean) --* Indicates whether the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom DB instances. * **EngineVersion** *(string) --* The version of the database engine. * **AutoMinorVersionUpgrade** *(boolean) --* Indicates whether minor version patches are applied automatically. For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version. * **ReadReplicaSourceDBInstanceIdentifier** *(string) --* The identifier of the source DB instance if this DB instance is a read replica. * **ReadReplicaDBInstanceIdentifiers** *(list) --* The identifiers of the read replicas associated with this DB instance. * *(string) --* * **ReadReplicaDBClusterIdentifiers** *(list) --* The identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn't contain information about cross-Region Aurora read replicas. Note: Currently, each RDS DB instance can have only one Aurora read replica. * *(string) --* * **ReplicaMode** *(string) --* The open mode of a Db2 or an Oracle read replica. The default is "open-read-only". For more information, see Working with read replicas for Amazon RDS for Db2 and Working with read replicas for Amazon RDS for Oracle in the *Amazon RDS User Guide*. Note: This attribute is only supported in RDS for Db2, RDS for Oracle, and RDS Custom for Oracle. * **LicenseModel** *(string) --* The license model information for this DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. * **Iops** *(integer) --* The Provisioned IOPS (I/O operations per second) value for the DB instance. * **OptionGroupMemberships** *(list) --* The list of option group memberships for this DB instance. * *(dict) --* Provides information on the option groups the DB instance is a member of. * **OptionGroupName** *(string) --* The name of the option group that the instance belongs to. * **Status** *(string) --* The status of the DB instance's option group membership. Valid values are: "in-sync", "pending- apply", "pending-removal", "pending-maintenance- apply", "pending-maintenance-removal", "applying", "removing", and "failed". * **CharacterSetName** *(string) --* If present, specifies the name of the character set that this instance is associated with. * **NcharCharacterSetName** *(string) --* The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2. * **SecondaryAvailabilityZone** *(string) --* If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support. * **PubliclyAccessible** *(boolean) --* Indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it. When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance. * **StatusInfos** *(list) --* The status of a read replica. If the DB instance isn't a read replica, the value is blank. * *(dict) --* Provides a list of status information for a DB instance. * **StatusType** *(string) --* This value is currently "read replication." * **Normal** *(boolean) --* Indicates whether the instance is operating normally (TRUE) or is in an error state (FALSE). * **Status** *(string) --* The 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) --* The storage type associated with the DB instance. * **TdeCredentialArn** *(string) --* The ARN from the key store with which the instance is associated for TDE encryption. * **DbInstancePort** *(integer) --* 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, indicates the name of the DB cluster that the DB instance is a member of. * **StorageEncrypted** *(boolean) --* Indicates whether the DB instance is encrypted. * **KmsKeyId** *(string) --* If "StorageEncrypted" is enabled, the Amazon Web Services KMS key identifier for the encrypted DB instance. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. * **DbiResourceId** *(string) --* The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB instance is accessed. * **CACertificateIdentifier** *(string) --* The identifier of the CA certificate for this DB instance. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the *Amazon RDS User Guide* and Using SSL/TLS to encrypt a connection to a DB cluster in the *Amazon Aurora User Guide*. * **DomainMemberships** *(list) --* The Active Directory Domain membership records associated with the DB instance. * *(dict) --* An Active Directory Domain membership record associated with the DB instance or cluster. * **Domain** *(string) --* The identifier of the Active Directory Domain. * **Status** *(string) --* The status of the Active Directory Domain membership for the DB instance or cluster. Values include "joined", "pending-join", "failed", and so on. * **FQDN** *(string) --* The fully qualified domain name (FQDN) of the Active Directory Domain. * **IAMRoleName** *(string) --* The name of the IAM role used when making API calls to the Directory Service. * **OU** *(string) --* The Active Directory organizational unit for the DB instance or cluster. * **AuthSecretArn** *(string) --* The ARN for the Secrets Manager secret with the credentials for the user that's a member of the domain. * **DnsIps** *(list) --* The IPv4 DNS IP addresses of the primary and secondary Active Directory domain controllers. * *(string) --* * **CopyTagsToSnapshot** *(boolean) --* Indicates whether tags are copied from the DB instance to snapshots of the DB instance. This setting doesn't apply to Amazon Aurora DB instances. 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) --* The order of priority 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 RDS for Db2 and RDS for SQL Server DB instances that were created with a time zone specified. * **IAMDatabaseAuthenticationEnabled** *(boolean) --* Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled for the DB instance. For a list of engine versions that support IAM database authentication, see IAM database authentication in the *Amazon RDS User Guide* and IAM database authentication in Aurora in the *Amazon Aurora User Guide*. * **DatabaseInsightsMode** *(string) --* The mode of Database Insights that is enabled for the instance. * **PerformanceInsightsEnabled** *(boolean) --* Indicates whether Performance Insights is enabled for the DB instance. * **PerformanceInsightsKMSKeyId** *(string) --* The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. * **PerformanceInsightsRetentionPeriod** *(integer) --* The number of days to retain Performance Insights data. Valid Values: * "7" * *month* * 31, where *month* is a number of months from 1-23. Examples: "93" (3 months * 31), "341" (11 months * 31), "589" (19 months * 31) * "731" Default: "7" days * **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 Monitoring Amazon RDS log files in the *Amazon RDS User Guide.* * *(string) --* * **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: * "CreateDBInstance" * "ModifyDBInstance" * "RestoreDBInstanceFromDBSnapshot" * "RestoreDBInstanceFromS3" * "RestoreDBInstanceToPointInTime" 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: * "DescribeDBInstances" * "DescribeDBSnapshots" * "DescribeValidDBInstanceModifications" If you call "DescribeDBInstances", "ProcessorFeature" returns non-null values only if the following conditions are met: * You are accessing an Oracle DB instance. * Your Oracle DB instance class supports configuring the number of CPU cores and threads per core. * The current number CPU cores and threads is set to a non-default value. For more information, see Configuring the processor for a DB instance class in RDS for Oracle 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. * **DeletionProtection** *(boolean) --* Indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance. * **AssociatedRoles** *(list) --* The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance. * *(dict) --* Information about an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance. * **RoleArn** *(string) --* The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance. * **FeatureName** *(string) --* The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see "DBEngineVersion". * **Status** *(string) --* Information about the state of association between the IAM role and the DB instance. The Status property returns one of the following values: * "ACTIVE" - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf. * "PENDING" - the IAM role ARN is being associated with the DB instance. * "INVALID" - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf. * **ListenerEndpoint** *(dict) --* The listener connection endpoint for SQL Server Always On. * **Address** *(string) --* Specifies the DNS address of the DB instance. * **Port** *(integer) --* Specifies the port that the database engine is listening on. * **HostedZoneId** *(string) --* Specifies the ID that Amazon Route 53 assigns when you create a hosted zone. * **MaxAllocatedStorage** *(integer) --* The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. * **TagList** *(list) --* A list of tags. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **Key** *(string) --* A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **Value** *(string) --* A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **DBInstanceAutomatedBackupsReplications** *(list) --* The list of replicated automated backups associated with the DB instance. * *(dict) --* Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties. * **DBInstanceAutomatedBackupsArn** *(string) --* The Amazon Resource Name (ARN) of the replicated automated backups. * **CustomerOwnedIpEnabled** *(boolean) --* Indicates whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance. A >>*<>*< * **MultiTenant** *(boolean) --* Indicates whether the DB instance will change to the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE). * **LatestRestorableTime** *(datetime) --* The latest time to which a database in this DB instance can be restored with point-in-time restore. * **MultiAZ** *(boolean) --* Indicates whether the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom DB instances. * **EngineVersion** *(string) --* The version of the database engine. * **AutoMinorVersionUpgrade** *(boolean) --* Indicates whether minor version patches are applied automatically. For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version. * **ReadReplicaSourceDBInstanceIdentifier** *(string) --* The identifier of the source DB instance if this DB instance is a read replica. * **ReadReplicaDBInstanceIdentifiers** *(list) --* The identifiers of the read replicas associated with this DB instance. * *(string) --* * **ReadReplicaDBClusterIdentifiers** *(list) --* The identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn't contain information about cross-Region Aurora read replicas. Note: Currently, each RDS DB instance can have only one Aurora read replica. * *(string) --* * **ReplicaMode** *(string) --* The open mode of a Db2 or an Oracle read replica. The default is "open-read-only". For more information, see Working with read replicas for Amazon RDS for Db2 and Working with read replicas for Amazon RDS for Oracle in the *Amazon RDS User Guide*. Note: This attribute is only supported in RDS for Db2, RDS for Oracle, and RDS Custom for Oracle. * **LicenseModel** *(string) --* The license model information for this DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. * **Iops** *(integer) --* The Provisioned IOPS (I/O operations per second) value for the DB instance. * **OptionGroupMemberships** *(list) --* The list of option group memberships for this DB instance. * *(dict) --* Provides information on the option groups the DB instance is a member of. * **OptionGroupName** *(string) --* The name of the option group that the instance belongs to. * **Status** *(string) --* The status of the DB instance's option group membership. Valid values are: "in-sync", "pending- apply", "pending-removal", "pending-maintenance- apply", "pending-maintenance-removal", "applying", "removing", and "failed". * **CharacterSetName** *(string) --* If present, specifies the name of the character set that this instance is associated with. * **NcharCharacterSetName** *(string) --* The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2. * **SecondaryAvailabilityZone** *(string) --* If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support. * **PubliclyAccessible** *(boolean) --* Indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it. When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance. * **StatusInfos** *(list) --* The status of a read replica. If the DB instance isn't a read replica, the value is blank. * *(dict) --* Provides a list of status information for a DB instance. * **StatusType** *(string) --* This value is currently "read replication." * **Normal** *(boolean) --* Indicates whether the instance is operating normally (TRUE) or is in an error state (FALSE). * **Status** *(string) --* The 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) --* The storage type associated with the DB instance. * **TdeCredentialArn** *(string) --* The ARN from the key store with which the instance is associated for TDE encryption. * **DbInstancePort** *(integer) --* 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, indicates the name of the DB cluster that the DB instance is a member of. * **StorageEncrypted** *(boolean) --* Indicates whether the DB instance is encrypted. * **KmsKeyId** *(string) --* If "StorageEncrypted" is enabled, the Amazon Web Services KMS key identifier for the encrypted DB instance. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. * **DbiResourceId** *(string) --* The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB instance is accessed. * **CACertificateIdentifier** *(string) --* The identifier of the CA certificate for this DB instance. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the *Amazon RDS User Guide* and Using SSL/TLS to encrypt a connection to a DB cluster in the *Amazon Aurora User Guide*. * **DomainMemberships** *(list) --* The Active Directory Domain membership records associated with the DB instance. * *(dict) --* An Active Directory Domain membership record associated with the DB instance or cluster. * **Domain** *(string) --* The identifier of the Active Directory Domain. * **Status** *(string) --* The status of the Active Directory Domain membership for the DB instance or cluster. Values include "joined", "pending-join", "failed", and so on. * **FQDN** *(string) --* The fully qualified domain name (FQDN) of the Active Directory Domain. * **IAMRoleName** *(string) --* The name of the IAM role used when making API calls to the Directory Service. * **OU** *(string) --* The Active Directory organizational unit for the DB instance or cluster. * **AuthSecretArn** *(string) --* The ARN for the Secrets Manager secret with the credentials for the user that's a member of the domain. * **DnsIps** *(list) --* The IPv4 DNS IP addresses of the primary and secondary Active Directory domain controllers. * *(string) --* * **CopyTagsToSnapshot** *(boolean) --* Indicates whether tags are copied from the DB instance to snapshots of the DB instance. This setting doesn't apply to Amazon Aurora DB instances. 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) --* The order of priority 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 RDS for Db2 and RDS for SQL Server DB instances that were created with a time zone specified. * **IAMDatabaseAuthenticationEnabled** *(boolean) --* Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled for the DB instance. For a list of engine versions that support IAM database authentication, see IAM database authentication in the *Amazon RDS User Guide* and IAM database authentication in Aurora in the *Amazon Aurora User Guide*. * **DatabaseInsightsMode** *(string) --* The mode of Database Insights that is enabled for the instance. * **PerformanceInsightsEnabled** *(boolean) --* Indicates whether Performance Insights is enabled for the DB instance. * **PerformanceInsightsKMSKeyId** *(string) --* The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. * **PerformanceInsightsRetentionPeriod** *(integer) --* The number of days to retain Performance Insights data. Valid Values: * "7" * *month* * 31, where *month* is a number of months from 1-23. Examples: "93" (3 months * 31), "341" (11 months * 31), "589" (19 months * 31) * "731" Default: "7" days * **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 Monitoring Amazon RDS log files in the *Amazon RDS User Guide.* * *(string) --* * **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: * "CreateDBInstance" * "ModifyDBInstance" * "RestoreDBInstanceFromDBSnapshot" * "RestoreDBInstanceFromS3" * "RestoreDBInstanceToPointInTime" 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: * "DescribeDBInstances" * "DescribeDBSnapshots" * "DescribeValidDBInstanceModifications" If you call "DescribeDBInstances", "ProcessorFeature" returns non-null values only if the following conditions are met: * You are accessing an Oracle DB instance. * Your Oracle DB instance class supports configuring the number of CPU cores and threads per core. * The current number CPU cores and threads is set to a non-default value. For more information, see Configuring the processor for a DB instance class in RDS for Oracle 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. * **DeletionProtection** *(boolean) --* Indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance. * **AssociatedRoles** *(list) --* The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance. * *(dict) --* Information about an Amazon Web Services Identity and Access Management (IAM) role that is associated with a DB instance. * **RoleArn** *(string) --* The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance. * **FeatureName** *(string) --* The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see "DBEngineVersion". * **Status** *(string) --* Information about the state of association between the IAM role and the DB instance. The Status property returns one of the following values: * "ACTIVE" - the IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf. * "PENDING" - the IAM role ARN is being associated with the DB instance. * "INVALID" - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf. * **ListenerEndpoint** *(dict) --* The listener connection endpoint for SQL Server Always On. * **Address** *(string) --* Specifies the DNS address of the DB instance. * **Port** *(integer) --* Specifies the port that the database engine is listening on. * **HostedZoneId** *(string) --* Specifies the ID that Amazon Route 53 assigns when you create a hosted zone. * **MaxAllocatedStorage** *(integer) --* The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. * **TagList** *(list) --* A list of tags. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * *(dict) --* Metadata assigned to an Amazon RDS resource consisting of a key-value pair. For more information, see Tagging Amazon RDS resources in the *Amazon RDS User Guide* or Tagging Amazon Aurora and Amazon RDS resources in the *Amazon Aurora User Guide*. * **Key** *(string) --* A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **Value** *(string) --* A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$"). * **DBInstanceAutomatedBackupsReplications** *(list) --* The list of replicated automated backups associated with the DB instance. * *(dict) --* Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties. * **DBInstanceAutomatedBackupsArn** *(string) --* The Amazon Resource Name (ARN) of the replicated automated backups. * **CustomerOwnedIpEnabled** *(boolean) --* Indicates whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance. A >>*<>*<