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
API Operations collapse
-
#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 aDBProxyTargetGroup
. -
#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_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_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.
-
#promote_read_replica_db_cluster(params = {}) ⇒ Types::PromoteReadReplicaDBClusterResult
Promotes a read replica DB cluster to a standalone DB cluster.
-
#purchase_reserved_db_instances_offering(params = {}) ⇒ Types::PurchaseReservedDBInstancesOfferingResult
Purchases a reserved DB instance offering.
-
#reboot_db_cluster(params = {}) ⇒ Types::RebootDBClusterResult
You might need to reboot your DB cluster, usually for maintenance reasons.
-
#reboot_db_instance(params = {}) ⇒ Types::RebootDBInstanceResult
You might need to reboot your DB instance, usually for maintenance reasons.
-
#reboot_db_shard_group(params = {}) ⇒ Types::DBShardGroup
You might need to reboot your DB shard group, usually for maintenance reasons.
-
#register_db_proxy_targets(params = {}) ⇒ Types::RegisterDBProxyTargetsResponse
Associate one or more
DBProxyTarget
data structures with aDBProxyTargetGroup
. -
#remove_from_global_cluster(params = {}) ⇒ Types::RemoveFromGlobalClusterResult
Detaches an Aurora secondary cluster from an Aurora global database cluster.
-
#remove_role_from_db_cluster(params = {}) ⇒ Struct
Removes the asssociation of an Amazon Web Services Identity and Access Management (IAM) role from a DB cluster.
-
#remove_role_from_db_instance(params = {}) ⇒ Struct
Disassociates an Amazon Web Services Identity and Access Management (IAM) role from a DB instance.
-
#remove_source_identifier_from_subscription(params = {}) ⇒ Types::RemoveSourceIdentifierFromSubscriptionResult
Removes a source identifier from an existing RDS event notification subscription.
-
#remove_tags_from_resource(params = {}) ⇒ Struct
Removes metadata tags from an Amazon RDS resource.
-
#reset_db_cluster_parameter_group(params = {}) ⇒ Types::DBClusterParameterGroupNameMessage
Modifies the parameters of a DB cluster parameter group to the default value.
-
#reset_db_parameter_group(params = {}) ⇒ Types::DBParameterGroupNameMessage
Modifies the parameters of a DB parameter group to the engine/system default value.
-
#restore_db_cluster_from_s3(params = {}) ⇒ Types::RestoreDBClusterFromS3Result
Creates an Amazon Aurora DB cluster from MySQL data stored in an Amazon S3 bucket.
-
#restore_db_cluster_from_snapshot(params = {}) ⇒ Types::RestoreDBClusterFromSnapshotResult
Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
-
#restore_db_cluster_to_point_in_time(params = {}) ⇒ Types::RestoreDBClusterToPointInTimeResult
Restores a DB cluster to an arbitrary point in time.
-
#restore_db_instance_from_db_snapshot(params = {}) ⇒ Types::RestoreDBInstanceFromDBSnapshotResult
Creates a new DB instance from a DB snapshot.
-
#restore_db_instance_from_s3(params = {}) ⇒ Types::RestoreDBInstanceFromS3Result
Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files.
-
#restore_db_instance_to_point_in_time(params = {}) ⇒ Types::RestoreDBInstanceToPointInTimeResult
Restores a DB instance to an arbitrary point in time.
-
#revoke_db_security_group_ingress(params = {}) ⇒ Types::RevokeDBSecurityGroupIngressResult
Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC security groups.
-
#start_activity_stream(params = {}) ⇒ Types::StartActivityStreamResponse
Starts a database activity stream to monitor activity on the database.
-
#start_db_cluster(params = {}) ⇒ Types::StartDBClusterResult
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. -
#start_db_instance(params = {}) ⇒ Types::StartDBInstanceResult
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. -
#start_db_instance_automated_backups_replication(params = {}) ⇒ Types::StartDBInstanceAutomatedBackupsReplicationResult
Enables replication of automated backups to a different Amazon Web Services Region.
-
#start_export_task(params = {}) ⇒ Types::ExportTask
Starts an export of DB snapshot or DB cluster data to Amazon S3.
-
#stop_activity_stream(params = {}) ⇒ Types::StopActivityStreamResponse
Stops a database activity stream that was started using the Amazon Web Services console, the
start-activity-stream
CLI command, or theStartActivityStream
operation. -
#stop_db_cluster(params = {}) ⇒ Types::StopDBClusterResult
Stops an Amazon Aurora DB cluster.
-
#stop_db_instance(params = {}) ⇒ Types::StopDBInstanceResult
Stops an Amazon RDS DB instance.
-
#stop_db_instance_automated_backups_replication(params = {}) ⇒ Types::StopDBInstanceAutomatedBackupsReplicationResult
Stops automated backup replication for a DB instance.
-
#switchover_blue_green_deployment(params = {}) ⇒ Types::SwitchoverBlueGreenDeploymentResponse
Switches over a blue/green deployment.
-
#switchover_global_cluster(params = {}) ⇒ Types::SwitchoverGlobalClusterResult
Switches over the specified secondary DB cluster to be the new primary DB cluster in the global database cluster.
-
#switchover_read_replica(params = {}) ⇒ Types::SwitchoverReadReplicaResult
Switches over an Oracle standby database in an Oracle Data Guard environment, making it the new primary database.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
-
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
446 447 448 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 446 def initialize(*args) super end |
Instance Method Details
#add_role_to_db_cluster(params = {}) ⇒ Struct
Associates an Identity and Access Management (IAM) role with a DB cluster.
492 493 494 495 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 492 def add_role_to_db_cluster(params = {}, = {}) req = build_request(:add_role_to_db_cluster, params) req.send_request() end |
#add_role_to_db_instance(params = {}) ⇒ Struct
Associates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance.
available
.
This command doesn't apply to RDS Custom.
544 545 546 547 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 544 def add_role_to_db_instance(params = {}, = {}) req = build_request(:add_role_to_db_instance, params) req.send_request() end |
#add_source_identifier_to_subscription(params = {}) ⇒ Types::AddSourceIdentifierToSubscriptionResult
Adds a source identifier to an existing RDS event notification subscription.
644 645 646 647 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 644 def add_source_identifier_to_subscription(params = {}, = {}) req = build_request(:add_source_identifier_to_subscription, params) req.send_request() end |
#add_tags_to_resource(params = {}) ⇒ Struct
Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in a Condition statement in an IAM policy for Amazon RDS.
For an overview on tagging your relational database resources, see Tagging Amazon RDS Resources or Tagging Amazon Aurora and Amazon RDS Resources.
708 709 710 711 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 708 def (params = {}, = {}) req = build_request(:add_tags_to_resource, params) req.send_request() end |
#apply_pending_maintenance_action(params = {}) ⇒ Types::ApplyPendingMaintenanceActionResult
Applies a pending maintenance action to a resource (for example, to a DB instance).
815 816 817 818 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 815 def apply_pending_maintenance_action(params = {}, = {}) req = build_request(:apply_pending_maintenance_action, params) req.send_request() end |
#authorize_db_security_group_ingress(params = {}) ⇒ Types::AuthorizeDBSecurityGroupIngressResult
Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).
You can't authorize ingress from an EC2 security group in one Amazon Web Services Region to an Amazon RDS DB instance in another. You can't authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
928 929 930 931 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 928 def (params = {}, = {}) req = build_request(:authorize_db_security_group_ingress, params) req.send_request() end |
#backtrack_db_cluster(params = {}) ⇒ Types::DBClusterBacktrack
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.
1027 1028 1029 1030 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 1027 def backtrack_db_cluster(params = {}, = {}) req = build_request(:backtrack_db_cluster, params) req.send_request() end |
#cancel_export_task(params = {}) ⇒ Types::ExportTask
Cancels an export task in progress that is exporting a snapshot or cluster to Amazon S3. Any data that has already been written to the S3 bucket isn't removed.
1111 1112 1113 1114 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 1111 def cancel_export_task(params = {}, = {}) req = build_request(:cancel_export_task, params) req.send_request() end |
#copy_db_cluster_parameter_group(params = {}) ⇒ Types::CopyDBClusterParameterGroupResult
Copies the specified DB cluster parameter group.
1221 1222 1223 1224 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 1221 def copy_db_cluster_parameter_group(params = {}, = {}) req = build_request(:copy_db_cluster_parameter_group, params) req.send_request() end |
#copy_db_cluster_snapshot(params = {}) ⇒ Types::CopyDBClusterSnapshotResult
Copies a snapshot of a DB cluster.
To copy a DB cluster snapshot from a shared manual DB cluster
snapshot, SourceDBClusterSnapshotIdentifier
must be the Amazon
Resource Name (ARN) of the shared DB cluster snapshot.
You can copy an encrypted DB cluster snapshot from another Amazon Web
Services Region. In that case, the Amazon Web Services Region where
you call the CopyDBClusterSnapshot
operation is the destination
Amazon Web Services Region for the encrypted DB cluster snapshot to be
copied to. To copy an encrypted DB cluster snapshot from another
Amazon Web Services Region, you must provide the following values:
KmsKeyId
- The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region.TargetDBClusterSnapshotIdentifier
- The identifier for the new copy of the DB cluster snapshot in the destination Amazon Web Services Region.SourceDBClusterSnapshotIdentifier
- The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the ARN format for the source Amazon Web Services Region and is the same value as theSourceDBClusterSnapshotIdentifier
in the presigned URL.
To cancel the copy operation once it is in progress, delete the target
DB cluster snapshot identified by TargetDBClusterSnapshotIdentifier
while that DB cluster snapshot is in "copying" status.
For more information on copying encrypted Amazon Aurora DB cluster snapshots from one Amazon Web Services Region to another, see Copying a Snapshot in the Amazon Aurora User Guide.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
1512 1513 1514 1515 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 1512 def copy_db_cluster_snapshot(params = {}, = {}) req = build_request(:copy_db_cluster_snapshot, params) req.send_request() end |
#copy_db_parameter_group(params = {}) ⇒ Types::CopyDBParameterGroupResult
Copies the specified DB parameter group.
1620 1621 1622 1623 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 1620 def copy_db_parameter_group(params = {}, = {}) req = build_request(:copy_db_parameter_group, params) req.send_request() end |
#copy_db_snapshot(params = {}) ⇒ Types::CopyDBSnapshotResult
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.
1939 1940 1941 1942 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 1939 def copy_db_snapshot(params = {}, = {}) req = build_request(:copy_db_snapshot, params) req.send_request() end |
#copy_option_group(params = {}) ⇒ Types::CopyOptionGroupResult
Copies the specified option group.
2068 2069 2070 2071 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 2068 def copy_option_group(params = {}, = {}) req = build_request(:copy_option_group, params) req.send_request() end |
#create_blue_green_deployment(params = {}) ⇒ Types::CreateBlueGreenDeploymentResponse
Creates a blue/green deployment.
A blue/green deployment creates a staging environment that copies the production environment. In a blue/green deployment, the blue environment is the current production environment. The green environment is the staging environment, and it stays in sync with the current production environment.
You can make changes to the databases in the green environment without affecting production workloads. For example, you can upgrade the major or minor DB engine version, change database parameters, or make schema changes in the staging environment. You can thoroughly test changes in the green environment. When ready, you can switch over the environments to promote the green environment to be the new production environment. The switchover typically takes under a minute.
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.
2368 2369 2370 2371 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 2368 def create_blue_green_deployment(params = {}, = {}) req = build_request(:create_blue_green_deployment, params) req.send_request() end |
#create_custom_db_engine_version(params = {}) ⇒ Types::DBEngineVersion
Creates a custom DB engine version (CEV).
2626 2627 2628 2629 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 2626 def create_custom_db_engine_version(params = {}, = {}) req = build_request(:create_custom_db_engine_version, params) req.send_request() end |
#create_db_cluster(params = {}) ⇒ Types::CreateDBClusterResult
Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.
If you create an Aurora DB cluster, the request creates an empty cluster. You must explicitly create the writer instance for your DB cluster using the CreateDBInstance operation. If you create a Multi-AZ DB cluster, the request creates a writer and two reader DB instances for you, each in a different Availability Zone.
You can use the ReplicationSourceIdentifier
parameter to create an
Amazon Aurora DB cluster as a read replica of another DB cluster or
Amazon RDS for MySQL or PostgreSQL DB instance. For more information
about Amazon Aurora, see What is Amazon Aurora? in the Amazon
Aurora User Guide.
You can also use the ReplicationSourceIdentifier
parameter to create
a Multi-AZ DB cluster read replica with an RDS for MySQL or PostgreSQL
DB instance as the source. For more information about Multi-AZ DB
clusters, see Multi-AZ DB cluster deployments in the Amazon RDS
User Guide.
3932 3933 3934 3935 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 3932 def create_db_cluster(params = {}, = {}) req = build_request(:create_db_cluster, params) req.send_request() end |
#create_db_cluster_endpoint(params = {}) ⇒ Types::DBClusterEndpoint
Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.
4049 4050 4051 4052 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 4049 def create_db_cluster_endpoint(params = {}, = {}) req = build_request(:create_db_cluster_endpoint, params) req.send_request() end |
#create_db_cluster_parameter_group(params = {}) ⇒ Types::CreateDBClusterParameterGroupResult
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.
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.
4220 4221 4222 4223 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 4220 def create_db_cluster_parameter_group(params = {}, = {}) req = build_request(:create_db_cluster_parameter_group, params) req.send_request() end |
#create_db_cluster_snapshot(params = {}) ⇒ Types::CreateDBClusterSnapshotResult
Creates a snapshot of a DB cluster.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
4359 4360 4361 4362 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 4359 def create_db_cluster_snapshot(params = {}, = {}) req = build_request(:create_db_cluster_snapshot, params) req.send_request() end |
#create_db_instance(params = {}) ⇒ Types::CreateDBInstanceResult
Creates a new DB instance.
The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster. For an Aurora DB cluster, you can call this operation multiple times to add more than one DB instance to the cluster.
For more information about creating an RDS DB instance, see Creating an Amazon RDS DB instance in the Amazon RDS User Guide.
For more information about creating a DB instance in an Aurora DB cluster, see Creating an Amazon Aurora DB cluster in the Amazon Aurora User Guide.
6045 6046 6047 6048 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 6045 def create_db_instance(params = {}, = {}) req = build_request(:create_db_instance, params) req.send_request() end |
#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. You can create a read replica for a DB instance running Db2, 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 Aurora doesn't support this operation. To create a DB instance
for an Aurora DB cluster, use the CreateDBInstance
operation.
All read replica DB instances are created 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.
Your source DB instance or cluster must have backup retention enabled.
6998 6999 7000 7001 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 6998 def create_db_instance_read_replica(params = {}, = {}) req = build_request(:create_db_instance_read_replica, params) req.send_request() end |
#create_db_parameter_group(params = {}) ⇒ Types::CreateDBParameterGroupResult
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.
After you create a DB parameter group, you should wait at least 5
minutes before creating your first DB instance that uses that DB
parameter group as the default parameter group. This allows Amazon RDS
to fully complete the create action before the parameter group is used
as the default for a new DB instance. This is especially important for
parameters that are critical when creating the default database for a
DB instance, such as the character set for the default database
defined by the character_set_database
parameter. You can use the
Parameter Groups option of the Amazon RDS console or the
DescribeDBParameters command to verify that your DB parameter group
has been created or modified.
7156 7157 7158 7159 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 7156 def create_db_parameter_group(params = {}, = {}) req = build_request(:create_db_parameter_group, params) req.send_request() end |
#create_db_proxy(params = {}) ⇒ Types::CreateDBProxyResponse
Creates a new DB proxy.
7277 7278 7279 7280 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 7277 def create_db_proxy(params = {}, = {}) req = build_request(:create_db_proxy, params) req.send_request() end |
#create_db_proxy_endpoint(params = {}) ⇒ Types::CreateDBProxyEndpointResponse
Creates a DBProxyEndpoint
. Only applies to proxies that are
associated with Aurora DB clusters. You can use DB proxy endpoints to
specify read/write or read-only access to the DB cluster. You can also
use DB proxy endpoints to access a DB proxy through a different VPC
than the proxy's default VPC.
7363 7364 7365 7366 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 7363 def create_db_proxy_endpoint(params = {}, = {}) req = build_request(:create_db_proxy_endpoint, params) req.send_request() end |
#create_db_security_group(params = {}) ⇒ Types::CreateDBSecurityGroupResult
Creates a new DB security group. DB security groups control access to a DB instance.
A DB security group controls access to EC2-Classic DB instances that are not in a VPC.
7464 7465 7466 7467 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 7464 def create_db_security_group(params = {}, = {}) req = build_request(:create_db_security_group, params) req.send_request() end |
#create_db_shard_group(params = {}) ⇒ Types::DBShardGroup
Creates a new DB shard group for Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group.
Valid for: Aurora DB clusters only
7599 7600 7601 7602 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 7599 def create_db_shard_group(params = {}, = {}) req = build_request(:create_db_shard_group, params) req.send_request() end |
#create_db_snapshot(params = {}) ⇒ Types::CreateDBSnapshotResult
Creates a snapshot of a DB instance. The source DB instance must be in
the available
or storage-optimization
state.
7748 7749 7750 7751 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 7748 def create_db_snapshot(params = {}, = {}) req = build_request(:create_db_snapshot, params) req.send_request() end |
#create_db_subnet_group(params = {}) ⇒ Types::CreateDBSubnetGroupResult
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.
7866 7867 7868 7869 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 7866 def create_db_subnet_group(params = {}, = {}) req = build_request(:create_db_subnet_group, params) req.send_request() end |
#create_event_subscription(params = {}) ⇒ Types::CreateEventSubscriptionResult
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.
8073 8074 8075 8076 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 8073 def create_event_subscription(params = {}, = {}) req = build_request(:create_event_subscription, params) req.send_request() end |
#create_global_cluster(params = {}) ⇒ Types::CreateGlobalClusterResult
Creates an Aurora global database spread across multiple Amazon Web Services Regions. The global database contains a single primary cluster with read-write capability, and a read-only secondary cluster that receives data from the primary cluster through high-speed replication performed by the Aurora storage subsystem.
You can create a global database that is initially empty, and then create the primary and secondary DB clusters in the global database. Or you can specify an existing Aurora cluster during the create operation, and this cluster becomes the primary cluster of the global database.