Class: Aws::RDS::Client

Inherits:

Seahorse::Client::Base

• Object
• Seahorse::Client::Base
• Aws::RDS::Client

Includes:

ClientStubs

Defined in:

gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb

Overview

An API client for RDS. To construct a client, you need to configure a :region and :credentials.

client = Aws::RDS::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations

• #add_role_to_db_cluster(params = {}) ⇒ Struct

  Associates an Identity and Access Management (IAM) role with a DB cluster.

• #add_role_to_db_instance(params = {}) ⇒ Struct

  Associates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance.

• #add_source_identifier_to_subscription(params = {}) ⇒ Types::AddSourceIdentifierToSubscriptionResult

  Adds a source identifier to an existing RDS event notification subscription.

• #add_tags_to_resource(params = {}) ⇒ Struct

  Adds metadata tags to an Amazon RDS resource.

• #apply_pending_maintenance_action(params = {}) ⇒ Types::ApplyPendingMaintenanceActionResult

  Applies a pending maintenance action to a resource (for example, to a DB instance).

• #authorize_db_security_group_ingress(params = {}) ⇒ Types::AuthorizeDBSecurityGroupIngressResult

  Enables ingress to a DBSecurityGroup using one of two forms of authorization.

• #backtrack_db_cluster(params = {}) ⇒ Types::DBClusterBacktrack

  Backtracks a DB cluster to a specific time, without creating a new DB cluster.

• #cancel_export_task(params = {}) ⇒ Types::ExportTask

  Cancels an export task in progress that is exporting a snapshot or cluster to Amazon S3.

• #copy_db_cluster_parameter_group(params = {}) ⇒ Types::CopyDBClusterParameterGroupResult

  Copies the specified DB cluster parameter group.

• #copy_db_cluster_snapshot(params = {}) ⇒ Types::CopyDBClusterSnapshotResult

  Copies a snapshot of a DB cluster.

• #copy_db_parameter_group(params = {}) ⇒ Types::CopyDBParameterGroupResult

  Copies the specified DB parameter group.

• #copy_db_snapshot(params = {}) ⇒ Types::CopyDBSnapshotResult

  Copies the specified DB snapshot.

• #copy_option_group(params = {}) ⇒ Types::CopyOptionGroupResult

  Copies the specified option group.

• #create_blue_green_deployment(params = {}) ⇒ Types::CreateBlueGreenDeploymentResponse

  Creates a blue/green deployment.

• #create_custom_db_engine_version(params = {}) ⇒ Types::DBEngineVersion

  Creates a custom DB engine version (CEV).

• #create_db_cluster(params = {}) ⇒ Types::CreateDBClusterResult

  Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.

• #create_db_cluster_endpoint(params = {}) ⇒ Types::DBClusterEndpoint

  Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.

• #create_db_cluster_parameter_group(params = {}) ⇒ Types::CreateDBClusterParameterGroupResult

  Creates a new DB cluster parameter group.

• #create_db_cluster_snapshot(params = {}) ⇒ Types::CreateDBClusterSnapshotResult

  Creates a snapshot of a DB cluster.

• #create_db_instance(params = {}) ⇒ Types::CreateDBInstanceResult

  Creates a new DB instance.

• #create_db_instance_read_replica(params = {}) ⇒ Types::CreateDBInstanceReadReplicaResult

  Creates a new DB instance that acts as a read replica for an existing source DB instance or Multi-AZ DB cluster.

• #create_db_parameter_group(params = {}) ⇒ Types::CreateDBParameterGroupResult

  Creates a new DB parameter group.

• #create_db_proxy(params = {}) ⇒ Types::CreateDBProxyResponse

  Creates a new DB proxy.

• #create_db_proxy_endpoint(params = {}) ⇒ Types::CreateDBProxyEndpointResponse

  Creates a DBProxyEndpoint.

• #create_db_security_group(params = {}) ⇒ Types::CreateDBSecurityGroupResult

  Creates a new DB security group.

• #create_db_shard_group(params = {}) ⇒ Types::DBShardGroup

  Creates a new DB shard group for Aurora Limitless Database.

• #create_db_snapshot(params = {}) ⇒ Types::CreateDBSnapshotResult

  Creates a snapshot of a DB instance.

• #create_db_subnet_group(params = {}) ⇒ Types::CreateDBSubnetGroupResult

  Creates a new DB subnet group.

• #create_event_subscription(params = {}) ⇒ Types::CreateEventSubscriptionResult

  Creates an RDS event notification subscription.

• #create_global_cluster(params = {}) ⇒ Types::CreateGlobalClusterResult

  Creates an Aurora global database spread across multiple Amazon Web Services Regions.

• #create_integration(params = {}) ⇒ Types::Integration

  Creates a zero-ETL integration with Amazon Redshift.

• #create_option_group(params = {}) ⇒ Types::CreateOptionGroupResult

  Creates a new option group.

• #create_tenant_database(params = {}) ⇒ Types::CreateTenantDatabaseResult

  Creates a tenant database in a DB instance that uses the multi-tenant configuration.

• #delete_blue_green_deployment(params = {}) ⇒ Types::DeleteBlueGreenDeploymentResponse

  Deletes a blue/green deployment.

• #delete_custom_db_engine_version(params = {}) ⇒ Types::DBEngineVersion

  Deletes a custom engine version.

• #delete_db_cluster(params = {}) ⇒ Types::DeleteDBClusterResult

  The DeleteDBCluster action deletes a previously provisioned DB cluster.

• #delete_db_cluster_automated_backup(params = {}) ⇒ Types::DeleteDBClusterAutomatedBackupResult

  Deletes automated backups using the DbClusterResourceId value of the source DB cluster or the Amazon Resource Name (ARN) of the automated backups.

• #delete_db_cluster_endpoint(params = {}) ⇒ Types::DBClusterEndpoint

  Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster.

• #delete_db_cluster_parameter_group(params = {}) ⇒ Struct

  Deletes a specified DB cluster parameter group.

• #delete_db_cluster_snapshot(params = {}) ⇒ Types::DeleteDBClusterSnapshotResult

  Deletes a DB cluster snapshot.

• #delete_db_instance(params = {}) ⇒ Types::DeleteDBInstanceResult

  Deletes a previously provisioned DB instance.

• #delete_db_instance_automated_backup(params = {}) ⇒ Types::DeleteDBInstanceAutomatedBackupResult

  Deletes automated backups using the DbiResourceId value of the source DB instance or the Amazon Resource Name (ARN) of the automated backups.

• #delete_db_parameter_group(params = {}) ⇒ Struct

  Deletes a specified DB parameter group.

• #delete_db_proxy(params = {}) ⇒ Types::DeleteDBProxyResponse

  Deletes an existing DB proxy.

• #delete_db_proxy_endpoint(params = {}) ⇒ Types::DeleteDBProxyEndpointResponse

  Deletes a DBProxyEndpoint.

• #delete_db_security_group(params = {}) ⇒ Struct

  Deletes a DB security group.

• #delete_db_shard_group(params = {}) ⇒ Types::DBShardGroup

  Deletes an Aurora Limitless Database DB shard group.

• #delete_db_snapshot(params = {}) ⇒ Types::DeleteDBSnapshotResult

  Deletes a DB snapshot.

• #delete_db_subnet_group(params = {}) ⇒ Struct

  Deletes a DB subnet group.

• #delete_event_subscription(params = {}) ⇒ Types::DeleteEventSubscriptionResult

  Deletes an RDS event notification subscription.

• #delete_global_cluster(params = {}) ⇒ Types::DeleteGlobalClusterResult

  Deletes a global database cluster.

• #delete_integration(params = {}) ⇒ Types::Integration

  Deletes a zero-ETL integration with Amazon Redshift.

• #delete_option_group(params = {}) ⇒ Struct

  Deletes an existing option group.

• #delete_tenant_database(params = {}) ⇒ Types::DeleteTenantDatabaseResult

  Deletes a tenant database from your DB instance.

• #deregister_db_proxy_targets(params = {}) ⇒ Struct

  Remove the association between one or more DBProxyTarget data structures and a DBProxyTargetGroup.

• #describe_account_attributes(params = {}) ⇒ Types::AccountAttributesMessage

  Lists all of the attributes for a customer account.

• #describe_blue_green_deployments(params = {}) ⇒ Types::DescribeBlueGreenDeploymentsResponse

  Describes one or more blue/green deployments.

• #describe_certificates(params = {}) ⇒ Types::CertificateMessage

  Lists the set of certificate authority (CA) certificates provided by Amazon RDS for this Amazon Web Services account.

• #describe_db_cluster_automated_backups(params = {}) ⇒ Types::DBClusterAutomatedBackupMessage

  Displays backups for both current and deleted DB clusters.

• #describe_db_cluster_backtracks(params = {}) ⇒ Types::DBClusterBacktrackMessage

  Returns information about backtracks for a DB cluster.

• #describe_db_cluster_endpoints(params = {}) ⇒ Types::DBClusterEndpointMessage

  Returns information about endpoints for an Amazon Aurora DB cluster.

• #describe_db_cluster_parameter_groups(params = {}) ⇒ Types::DBClusterParameterGroupsMessage

  Returns a list of DBClusterParameterGroup descriptions.

• #describe_db_cluster_parameters(params = {}) ⇒ Types::DBClusterParameterGroupDetails

  Returns the detailed parameter list for a particular DB cluster parameter group.

• #describe_db_cluster_snapshot_attributes(params = {}) ⇒ Types::DescribeDBClusterSnapshotAttributesResult

  Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.

• #describe_db_cluster_snapshots(params = {}) ⇒ Types::DBClusterSnapshotMessage

  Returns information about DB cluster snapshots.

• #describe_db_clusters(params = {}) ⇒ Types::DBClusterMessage

  Describes existing Amazon Aurora DB clusters and Multi-AZ DB clusters.

• #describe_db_engine_versions(params = {}) ⇒ Types::DBEngineVersionMessage

  Describes the properties of specific versions of DB engines.

• #describe_db_instance_automated_backups(params = {}) ⇒ Types::DBInstanceAutomatedBackupMessage

  Displays backups for both current and deleted instances.

• #describe_db_instances(params = {}) ⇒ Types::DBInstanceMessage

  Describes provisioned RDS instances.

• #describe_db_log_files(params = {}) ⇒ Types::DescribeDBLogFilesResponse

  Returns a list of DB log files for the DB instance.

• #describe_db_major_engine_versions(params = {}) ⇒ Types::DescribeDBMajorEngineVersionsResponse

  Describes the properties of specific major versions of DB engines.

• #describe_db_parameter_groups(params = {}) ⇒ Types::DBParameterGroupsMessage

  Returns a list of DBParameterGroup descriptions.

• #describe_db_parameters(params = {}) ⇒ Types::DBParameterGroupDetails

  Returns the detailed parameter list for a particular DB parameter group.

• #describe_db_proxies(params = {}) ⇒ Types::DescribeDBProxiesResponse

  Returns information about DB proxies.

• #describe_db_proxy_endpoints(params = {}) ⇒ Types::DescribeDBProxyEndpointsResponse

  Returns information about DB proxy endpoints.

• #describe_db_proxy_target_groups(params = {}) ⇒ Types::DescribeDBProxyTargetGroupsResponse

  Returns information about DB proxy target groups, represented by DBProxyTargetGroup data structures.

• #describe_db_proxy_targets(params = {}) ⇒ Types::DescribeDBProxyTargetsResponse

  Returns information about DBProxyTarget objects.

• #describe_db_recommendations(params = {}) ⇒ Types::DBRecommendationsMessage

  Describes the recommendations to resolve the issues for your DB instances, DB clusters, and DB parameter groups.

• #describe_db_security_groups(params = {}) ⇒ Types::DBSecurityGroupMessage

  Returns a list of DBSecurityGroup descriptions.

• #describe_db_shard_groups(params = {}) ⇒ Types::DescribeDBShardGroupsResponse

  Describes existing Aurora Limitless Database DB shard groups.

• #describe_db_snapshot_attributes(params = {}) ⇒ Types::DescribeDBSnapshotAttributesResult

  Returns a list of DB snapshot attribute names and values for a manual DB snapshot.

• #describe_db_snapshot_tenant_databases(params = {}) ⇒ Types::DBSnapshotTenantDatabasesMessage

  Describes the tenant databases that exist in a DB snapshot.

• #describe_db_snapshots(params = {}) ⇒ Types::DBSnapshotMessage

  Returns information about DB snapshots.

• #describe_db_subnet_groups(params = {}) ⇒ Types::DBSubnetGroupMessage

  Returns a list of DBSubnetGroup descriptions.

• #describe_engine_default_cluster_parameters(params = {}) ⇒ Types::DescribeEngineDefaultClusterParametersResult

  Returns the default engine and system parameter information for the cluster database engine.

• #describe_engine_default_parameters(params = {}) ⇒ Types::DescribeEngineDefaultParametersResult

  Returns the default engine and system parameter information for the specified database engine.

• #describe_event_categories(params = {}) ⇒ Types::EventCategoriesMessage

  Displays a list of categories for all event source types, or, if specified, for a specified source type.

• #describe_event_subscriptions(params = {}) ⇒ Types::EventSubscriptionsMessage

  Lists all the subscription descriptions for a customer account.

• #describe_events(params = {}) ⇒ Types::EventsMessage

  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.

• #describe_export_tasks(params = {}) ⇒ Types::ExportTasksMessage

  Returns information about a snapshot or cluster export to Amazon S3.

• #describe_global_clusters(params = {}) ⇒ Types::GlobalClustersMessage

  Returns information about Aurora global database clusters.

• #describe_integrations(params = {}) ⇒ Types::DescribeIntegrationsResponse

  Describe one or more zero-ETL integrations with Amazon Redshift.

• #describe_option_group_options(params = {}) ⇒ Types::OptionGroupOptionsMessage

  Describes all available options for the specified engine.

• #describe_option_groups(params = {}) ⇒ Types::OptionGroups

  Describes the available option groups.

• #describe_orderable_db_instance_options(params = {}) ⇒ Types::OrderableDBInstanceOptionsMessage

  Describes the orderable DB instance options for a specified DB engine.

• #describe_pending_maintenance_actions(params = {}) ⇒ Types::PendingMaintenanceActionsMessage

  Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.

• #describe_reserved_db_instances(params = {}) ⇒ Types::ReservedDBInstanceMessage

  Returns information about reserved DB instances for this account, or about a specified reserved DB instance.

• #describe_reserved_db_instances_offerings(params = {}) ⇒ Types::ReservedDBInstancesOfferingMessage

  Lists available reserved DB instance offerings.

• #describe_serverless_v2_platform_versions(params = {}) ⇒ Types::ServerlessV2PlatformVersionsMessage

  Describes the properties of specific platform versions for Aurora Serverless v2.

• #describe_source_regions(params = {}) ⇒ Types::SourceRegionMessage

  Returns a list of the source Amazon Web Services Regions where the current Amazon Web Services Region can create a read replica, copy a DB snapshot from, or replicate automated backups from.

• #describe_tenant_databases(params = {}) ⇒ Types::TenantDatabasesMessage

  Describes the tenant databases in a DB instance that uses the multi-tenant configuration.

• #describe_valid_db_instance_modifications(params = {}) ⇒ Types::DescribeValidDBInstanceModificationsResult

  You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance.

• #disable_http_endpoint(params = {}) ⇒ Types::DisableHttpEndpointResponse

  Disables the HTTP endpoint for the specified DB cluster.

• #download_db_log_file_portion(params = {}) ⇒ Types::DownloadDBLogFilePortionDetails

  Downloads all or a portion of the specified log file, up to 1 MB in size.

• #enable_http_endpoint(params = {}) ⇒ Types::EnableHttpEndpointResponse

  Enables the HTTP endpoint for the DB cluster.

• #failover_db_cluster(params = {}) ⇒ Types::FailoverDBClusterResult

  Forces a failover for a DB cluster.

• #failover_global_cluster(params = {}) ⇒ Types::FailoverGlobalClusterResult

  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.

• #list_tags_for_resource(params = {}) ⇒ Types::TagListMessage

  Lists all tags on an Amazon RDS resource.

• #modify_activity_stream(params = {}) ⇒ Types::ModifyActivityStreamResponse

  Changes the audit policy state of a database activity stream to either locked (default) or unlocked.

• #modify_certificates(params = {}) ⇒ Types::ModifyCertificatesResult

  Override the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS) certificate for Amazon RDS for new DB instances, or remove the override.

• #modify_current_db_cluster_capacity(params = {}) ⇒ Types::DBClusterCapacityInfo

  Set the capacity of an Aurora Serverless v1 DB cluster to a specific value.

• #modify_custom_db_engine_version(params = {}) ⇒ Types::DBEngineVersion

  Modifies the status of a custom engine version (CEV).

• #modify_db_cluster(params = {}) ⇒ Types::ModifyDBClusterResult

  Modifies the settings of an Amazon Aurora DB cluster or a Multi-AZ DB cluster.

• #modify_db_cluster_endpoint(params = {}) ⇒ Types::DBClusterEndpoint

  Modifies the properties of an endpoint in an Amazon Aurora DB cluster.

• #modify_db_cluster_parameter_group(params = {}) ⇒ Types::DBClusterParameterGroupNameMessage

  Modifies the parameters of a DB cluster parameter group.

• #modify_db_cluster_snapshot_attribute(params = {}) ⇒ Types::ModifyDBClusterSnapshotAttributeResult

  Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.

• #modify_db_instance(params = {}) ⇒ Types::ModifyDBInstanceResult

  Modifies settings for a DB instance.

• #modify_db_parameter_group(params = {}) ⇒ Types::DBParameterGroupNameMessage

  Modifies the parameters of a DB parameter group.

• #modify_db_proxy(params = {}) ⇒ Types::ModifyDBProxyResponse

  Changes the settings for an existing DB proxy.

• #modify_db_proxy_endpoint(params = {}) ⇒ Types::ModifyDBProxyEndpointResponse

  Changes the settings for an existing DB proxy endpoint.

• #modify_db_proxy_target_group(params = {}) ⇒ Types::ModifyDBProxyTargetGroupResponse

  Modifies the properties of a DBProxyTargetGroup.

• #modify_db_recommendation(params = {}) ⇒ Types::DBRecommendationMessage

  Updates the recommendation status and recommended action status for the specified recommendation.

• #modify_db_shard_group(params = {}) ⇒ Types::DBShardGroup

  Modifies the settings of an Aurora Limitless Database DB shard group.

• #modify_db_snapshot(params = {}) ⇒ Types::ModifyDBSnapshotResult

  Updates a manual DB snapshot with a new engine version.

• #modify_db_snapshot_attribute(params = {}) ⇒ Types::ModifyDBSnapshotAttributeResult

  Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.

• #modify_db_subnet_group(params = {}) ⇒ Types::ModifyDBSubnetGroupResult

  Modifies an existing DB subnet group.

• #modify_event_subscription(params = {}) ⇒ Types::ModifyEventSubscriptionResult

  Modifies an existing RDS event notification subscription.

• #modify_global_cluster(params = {}) ⇒ Types::ModifyGlobalClusterResult

  Modifies a setting for an Amazon Aurora global database cluster.

• #modify_integration(params = {}) ⇒ Types::Integration

  Modifies a zero-ETL integration with Amazon Redshift.

• #modify_option_group(params = {}) ⇒ Types::ModifyOptionGroupResult

  Modifies an existing option group.

• #modify_tenant_database(params = {}) ⇒ Types::ModifyTenantDatabaseResult

  Modifies an existing tenant database in a DB instance.

• #promote_read_replica(params = {}) ⇒ Types::PromoteReadReplicaResult

  Promotes a read replica DB instance to a standalone DB instance.