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 from an Amazon Aurora DB cluster.
-
#add_role_to_db_instance(params = {}) ⇒ Struct
Associates an AWS 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 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_custom_availability_zone(params = {}) ⇒ Types::CreateCustomAvailabilityZoneResult
Creates a custom Availability Zone (AZ).
-
#create_db_cluster(params = {}) ⇒ Types::CreateDBClusterResult
Creates a new Amazon Aurora 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.
-
#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_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 AWS Regions.
-
#create_option_group(params = {}) ⇒ Types::CreateOptionGroupResult
Creates a new option group.
-
#delete_custom_availability_zone(params = {}) ⇒ Types::DeleteCustomAvailabilityZoneResult
Deletes a custom Availability Zone (AZ).
-
#delete_db_cluster(params = {}) ⇒ Types::DeleteDBClusterResult
The DeleteDBCluster action deletes a previously provisioned DB cluster.
-
#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
The DeleteDBInstance action 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_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_installation_media(params = {}) ⇒ Types::InstallationMedia
Deletes the installation medium for a DB engine that requires an on-premises customer provided license, such as Microsoft SQL Server.
-
#delete_option_group(params = {}) ⇒ Struct
Deletes an existing option group.
-
#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_certificates(params = {}) ⇒ Types::CertificateMessage
Lists the set of CA certificates provided by Amazon RDS for this AWS account.
-
#describe_custom_availability_zones(params = {}) ⇒ Types::CustomAvailabilityZoneMessage
Returns information about custom Availability Zones (AZs).
-
#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
Returns information about provisioned Aurora DB clusters.
-
#describe_db_engine_versions(params = {}) ⇒ Types::DBEngineVersionMessage
Returns a list of the available DB engines.
-
#describe_db_instance_automated_backups(params = {}) ⇒ Types::DBInstanceAutomatedBackupMessage
Displays backups for both current and deleted instances.
-
#describe_db_instances(params = {}) ⇒ Types::DBInstanceMessage
Returns information about 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_security_groups(params = {}) ⇒ Types::DBSecurityGroupMessage
Returns a list of
DBSecurityGroup
descriptions. -
#describe_db_snapshot_attributes(params = {}) ⇒ Types::DescribeDBSnapshotAttributesResult
Returns a list of DB snapshot attribute names and values for a manual 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, and DB cluster snapshots for the past 14 days.
-
#describe_export_tasks(params = {}) ⇒ Types::ExportTasksMessage
Returns information about a snapshot export to Amazon S3.
-
#describe_global_clusters(params = {}) ⇒ Types::GlobalClustersMessage
Returns information about Aurora global database clusters.
-
#describe_installation_media(params = {}) ⇒ Types::InstallationMediaMessage
Describes the available installation media for a DB engine that requires an on-premises customer provided license, such as Microsoft SQL Server.
-
#describe_option_group_options(params = {}) ⇒ Types::OptionGroupOptionsMessage
Describes all available options.
-
#describe_option_groups(params = {}) ⇒ Types::OptionGroups
Describes the available option groups.
-
#describe_orderable_db_instance_options(params = {}) ⇒ Types::OrderableDBInstanceOptionsMessage
Returns a list of orderable DB instance options for the specified 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 AWS Regions where the current AWS Region can create a read replica, copy a DB snapshot from, or replicate automated backups from.
-
#describe_valid_db_instance_modifications(params = {}) ⇒ Types::DescribeValidDBInstanceModificationsResult
You can call
DescribeValidDBInstanceModifications
to learn what modifications you can make to your DB instance. -
#download_db_log_file_portion(params = {}) ⇒ Types::DownloadDBLogFilePortionDetails
Downloads all or a portion of the specified log file, up to 1 MB in size.
-
#failover_db_cluster(params = {}) ⇒ Types::FailoverDBClusterResult
Forces a failover for a DB cluster.
-
#failover_global_cluster(params = {}) ⇒ Types::FailoverGlobalClusterResult
Initiates the failover process for an Aurora global database (GlobalCluster).
-
#import_installation_media(params = {}) ⇒ Types::InstallationMedia
Imports the installation media for a DB engine that requires an on-premises customer provided license, such as SQL Server.
-
#list_tags_for_resource(params = {}) ⇒ Types::TagListMessage
Lists all tags on an Amazon RDS resource.
-
#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 temporarily, or remove the override.
-
#modify_current_db_cluster_capacity(params = {}) ⇒ Types::DBClusterCapacityInfo
Set the capacity of an Aurora Serverless DB cluster to a specific value.
-
#modify_db_cluster(params = {}) ⇒ Types::ModifyDBClusterResult
Modify a setting for an Amazon Aurora 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_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
Modify a setting for an Amazon Aurora global cluster.
-
#modify_option_group(params = {}) ⇒ Types::ModifyOptionGroupResult
Modifies an existing option group.
-
#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_instance(params = {}) ⇒ Types::RebootDBInstanceResult
You might need to reboot your DB instance, 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
Disassociates an AWS Identity and Access Management (IAM) role from an Amazon Aurora DB cluster.
-
#remove_role_from_db_instance(params = {}) ⇒ Struct
Disassociates an AWS 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 AWS console, the stop-db-cluster AWS CLI command, or the StopDBCluster action.
-
#start_db_instance(params = {}) ⇒ Types::StartDBInstanceResult
Starts an Amazon RDS DB instance that was stopped using the AWS console, the stop-db-instance AWS CLI command, or the StopDBInstance action.
-
#start_db_instance_automated_backups_replication(params = {}) ⇒ Types::StartDBInstanceAutomatedBackupsReplicationResult
Enables replication of automated backups to a different AWS Region.
-
#start_export_task(params = {}) ⇒ Types::ExportTask
Starts an export of a snapshot to Amazon S3.
-
#stop_activity_stream(params = {}) ⇒ Types::StopActivityStreamResponse
Stops a database activity stream that was started using the AWS console, the
start-activity-stream
AWS CLI command, or theStartActivityStream
action. -
#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.
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.
326 327 328 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 326 def initialize(*args) super end |
Instance Method Details
#add_role_to_db_cluster(params = {}) ⇒ Struct
Associates an Identity and Access Management (IAM) role from an Amazon Aurora DB cluster. For more information, see Authorizing Amazon Aurora MySQL to Access Other AWS Services on Your Behalf in the Amazon Aurora User Guide.
372 373 374 375 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 372 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 AWS Identity and Access Management (IAM) role with a DB instance.
available
.
411 412 413 414 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 411 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.
492 493 494 495 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 492 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 Amazon RDS resources, see Tagging Amazon RDS Resources.
554 555 556 557 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 554 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).
635 636 637 638 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 635 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).
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
737 738 739 740 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 737 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.
836 837 838 839 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 836 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 to Amazon S3. Any data that has already been written to the S3 bucket isn't removed.
895 896 897 898 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 895 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.
994 995 996 997 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 994 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 AWS Region.
In that case, the AWS Region where you call the
CopyDBClusterSnapshot
action is the destination AWS Region for the
encrypted DB cluster snapshot to be copied to. To copy an encrypted DB
cluster snapshot from another AWS Region, you must provide the
following values:
KmsKeyId
- The AWS Key Management System (AWS KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region.PreSignedUrl
- A URL that contains a Signature Version 4 signed request for theCopyDBClusterSnapshot
action to be called in the source AWS Region where the DB cluster snapshot is copied from. The pre-signed URL must be a valid request for theCopyDBClusterSnapshot
API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied.The pre-signed URL request must contain the following parameter values:
KmsKeyId
- The AWS KMS key identifier for the customer master key (CMK) to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. This is the same identifier for both theCopyDBClusterSnapshot
action that is called in the destination AWS Region, and the action contained in the pre-signed URL.DestinationRegion
- The name of the AWS Region that the DB cluster snapshot is to be created in.SourceDBClusterSnapshotIdentifier
- The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS Region, then yourSourceDBClusterSnapshotIdentifier
looks like the following example:arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115
.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.
If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion
(or--source-region
for the AWS CLI) instead of specifyingPreSignedUrl
manually. SpecifyingSourceRegion
autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source AWS Region.TargetDBClusterSnapshotIdentifier
- The identifier for the new copy of the DB cluster snapshot in the destination AWS 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 AWS Region and is the same value as theSourceDBClusterSnapshotIdentifier
in the pre-signed 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 DB cluster snapshots from one AWS Region to another, see Copying a Snapshot in the Amazon Aurora User Guide.
For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.
1287 1288 1289 1290 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 1287 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.
1381 1382 1383 1384 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 1381 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 AWS Region to another. In that case,
the AWS Region where you call the CopyDBSnapshot
action is the
destination AWS Region for the DB snapshot copy.
For more information about copying snapshots, see Copying a DB Snapshot in the Amazon RDS User Guide.
1639 1640 1641 1642 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 1639 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.
1753 1754 1755 1756 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 1753 def copy_option_group(params = {}, = {}) req = build_request(:copy_option_group, params) req.send_request() end |
#create_custom_availability_zone(params = {}) ⇒ Types::CreateCustomAvailabilityZoneResult
Creates a custom Availability Zone (AZ).
A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster.
For more information about RDS on VMware, see the RDS on VMware User Guide.
1818 1819 1820 1821 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 1818 def create_custom_availability_zone(params = {}, = {}) req = build_request(:create_custom_availability_zone, params) req.send_request() end |
#create_db_cluster(params = {}) ⇒ Types::CreateDBClusterResult
Creates a new Amazon Aurora DB cluster.
You can use the ReplicationSourceIdentifier
parameter to create the
DB cluster as a read replica of another DB cluster or Amazon RDS MySQL
DB instance. For cross-region replication where the DB cluster
identified by ReplicationSourceIdentifier
is encrypted, you must
also specify the PreSignedUrl
parameter.
For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.
2433 2434 2435 2436 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 2433 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.
2516 2517 2518 2519 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 2516 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 DB cluster, you need to reboot the DB instances in the
DB cluster without failover for the new DB cluster parameter group and
associated settings to take effect.
After you create a DB cluster parameter group, you should wait at
least 5 minutes before creating your first DB cluster that uses that
DB cluster parameter group as the default parameter group. This allows
Amazon RDS to fully complete the create action before the DB cluster
parameter group is used as the default for a new DB cluster. This is
especially important for parameters that are critical when creating
the default database for a DB cluster, such as the character set for
the default database defined by the character_set_database
parameter. You can use the Parameter Groups option of the Amazon
RDS console or the DescribeDBClusterParameters
action to verify
that your DB cluster parameter group has been created or modified.
For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.
2641 2642 2643 2644 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 2641 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.
2752 2753 2754 2755 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 2752 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.
3877 3878 3879 3880 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 3877 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. You can create a read replica for a DB instance running MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server. For more information, see Working with Read Replicas in the Amazon RDS User Guide.
Amazon Aurora doesn't support this action. Call the
CreateDBInstance
action to create a DB instance for an Aurora DB
cluster.
All read replica DB instances are created with backups disabled. All other DB instance attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance, except as specified.
Your source DB instance must have backup retention enabled.
4535 4536 4537 4538 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 4535 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.
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.
4651 4652 4653 4654 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 4651 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.
4768 4769 4770 4771 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 4768 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.
4848 4849 4850 4851 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 4848 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.
4936 4937 4938 4939 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 4936 def create_db_security_group(params = {}, = {}) req = build_request(:create_db_security_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.
5050 5051 5052 5053 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 5050 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 AWS Region.
5131 5132 5133 5134 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 5131 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 action 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 SourceIdentifier
= myDBInstance1
,
you are notified of all the db-instance
events for the specified
source. If you specify a SourceType
but do not specify a
SourceIdentifier
, you receive notice of the events for that source
type for all your RDS sources. If you don't specify either the
SourceType or the SourceIdentifier
, you are notified of events
generated from all RDS sources belonging to your customer account.
5300 5301 5302 5303 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 5300 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 AWS Regions. The global database contains a single primary cluster with read-write capability, and a read-only secondary cluster that receives data from the primary cluster through high-speed replication performed by the Aurora storage subsystem.
You can create a global database that is initially empty, and then add a primary cluster and a secondary cluster to it. Or you can specify an existing Aurora cluster during the create operation, and this cluster becomes the primary cluster of the global database.
5386 5387 5388 5389 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 5386 def create_global_cluster(params = {}, = {}) req = build_request(:create_global_cluster, params) req.send_request() end |
#create_option_group(params = {}) ⇒ Types::CreateOptionGroupResult
Creates a new option group. You can create up to 20 option groups.
5518 5519 5520 5521 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 5518 def create_option_group(params = {}, = {}) req = build_request(:create_option_group, params) req.send_request() end |
#delete_custom_availability_zone(params = {}) ⇒ Types::DeleteCustomAvailabilityZoneResult
Deletes a custom Availability Zone (AZ).
A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster.
For more information about RDS on VMware, see the RDS on VMware User Guide.
5564 5565 5566 5567 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 5564 def delete_custom_availability_zone(params = {}, = {}) req = build_request(:delete_custom_availability_zone, params) req.send_request() end |
#delete_db_cluster(params = {}) ⇒ Types::DeleteDBClusterResult
The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.
For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.
5751 5752 5753 5754 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 5751 def delete_db_cluster(params = {}, = {}) req = build_request(:delete_db_cluster, params) req.send_request() end |
#delete_db_cluster_endpoint(params = {}) ⇒ Types::DBClusterEndpoint
Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster.
5805 5806 5807 5808 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 5805 def delete_db_cluster_endpoint(params = {}, = {}) req = build_request(:delete_db_cluster_endpoint, params) req.send_request() end |
#delete_db_cluster_parameter_group(params = {}) ⇒ Struct
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.
5857 5858 5859 5860 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 5857 def delete_db_cluster_parameter_group(params = {}, = {}) req = build_request(:delete_db_cluster_parameter_group, params) req.send_request() end |
#delete_db_cluster_snapshot(params = {}) ⇒ Types::DeleteDBClusterSnapshotResult
Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.
available
state to be
deleted.
For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.
5944 5945 5946 5947 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 5944 def delete_db_cluster_snapshot(params = {}, = {}) req = build_request(:delete_db_cluster_snapshot, params) req.send_request() end |
#delete_db_instance(params = {}) ⇒ Types::DeleteDBInstanceResult
The DeleteDBInstance action deletes a previously provisioned DB
instance. When you delete a DB instance, all automated backups for
that instance are deleted and can't be recovered. Manual DB snapshots
of the DB instance to be deleted by DeleteDBInstance
are not
deleted.
If you request a final DB snapshot the status of the Amazon RDS DB
instance is deleting
until the DB snapshot is created. The API
action DescribeDBInstance
is used to monitor the status of this
operation. The action can't be canceled or reverted once submitted.
When a DB instance is in a failure state and has a status of failed
,
incompatible-restore
, or incompatible-network
, you can only delete
it when you skip creation of the final snapshot with the
SkipFinalSnapshot
parameter.
If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following conditions are true:
The DB cluster is a read replica of another Amazon Aurora DB cluster.
The DB instance is the only instance in the DB cluster.
To delete a DB instance in this case, first call the
PromoteReadReplicaDBCluster
API action to promote the DB cluster so
it's no longer a read replica. After the promotion completes, then
call the DeleteDBInstance
API action to delete the final instance in
the DB cluster.
6193 6194 6195 6196 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 6193 def delete_db_instance(params = {}, = {}) req = build_request(:delete_db_instance, params) req.send_request() end |
#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.
6257 6258 6259 6260 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 6257 def delete_db_instance_automated_backup(params = {}, = {}) req = build_request(:delete_db_instance_automated_backup, params) req.send_request() end |
#delete_db_parameter_group(params = {}) ⇒ Struct
Deletes a specified DB parameter group. The DB parameter group to be deleted can't be associated with any DB instances.
6297 6298 6299 6300 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 6297 def delete_db_parameter_group(params = {}, = {}) req = build_request(:delete_db_parameter_group, params) req.send_request() end |
#delete_db_proxy(params = {}) ⇒ Types::DeleteDBProxyResponse
Deletes an existing DB proxy.
6346 6347 6348 6349 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 6346 def delete_db_proxy(params = {}, = {}) req = build_request(:delete_db_proxy, params) req.send_request() end |
#delete_db_proxy_endpoint(params = {}) ⇒ Types::DeleteDBProxyEndpointResponse
Deletes a DBProxyEndpoint
. Doing so removes the ability to access
the DB proxy using the endpoint that you defined. The endpoint that
you delete might have provided capabilities such as read/write or
read-only operations, or using a different VPC than the DB proxy's
default VPC.
6390 6391 6392 6393 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 6390 def delete_db_proxy_endpoint(params = {}, = {}) req = build_request(:delete_db_proxy_endpoint, params) req.send_request() end |
#delete_db_security_group(params = {}) ⇒ Struct
Deletes a DB security group.
6440 6441 6442 6443 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 6440 def delete_db_security_group(params = {}, = {}) req = build_request(:delete_db_security_group, params) req.send_request() end |
#delete_db_snapshot(params = {}) ⇒ Types::DeleteDBSnapshotResult
Deletes a DB snapshot. If the snapshot is being copied, the copy operation is terminated.
available
state to be deleted.
6523 6524 6525 6526 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 6523 def delete_db_snapshot(params = {}, = {}) req = build_request(:delete_db_snapshot, params) req.send_request() end |
#delete_db_subnet_group(params = {}) ⇒ Struct
Deletes a DB subnet group.
6570 6571 6572 6573 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 6570 def delete_db_subnet_group(params = {}, = {}) req = build_request(:delete_db_subnet_group, params) req.send_request() end |
#delete_event_subscription(params = {}) ⇒ Types::DeleteEventSubscriptionResult
Deletes an RDS event notification subscription.
6625 6626 6627 6628 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 6625 def delete_event_subscription(params = {}, = {}) req = build_request(:delete_event_subscription, params) req.send_request() end |
#delete_global_cluster(params = {}) ⇒ Types::DeleteGlobalClusterResult
Deletes a global database cluster. The primary and secondary clusters must already be detached or destroyed first.
6675 6676 6677 6678 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 6675 def delete_global_cluster(params = {}, = {}) req = build_request(:delete_global_cluster, params) req.send_request() end |
#delete_installation_media(params = {}) ⇒ Types::InstallationMedia
Deletes the installation medium for a DB engine that requires an on-premises customer provided license, such as Microsoft SQL Server.
6718 6719 6720 6721 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 6718 def delete_installation_media(params = {}, = {}) req = build_request(:delete_installation_media, params) req.send_request() end |
#delete_option_group(params = {}) ⇒ Struct
Deletes an existing option group.
6753 6754 6755 6756 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 6753 def delete_option_group(params = {}, = {}) req = build_request(:delete_option_group, params) req.send_request() end |
#deregister_db_proxy_targets(params = {}) ⇒ Struct
Remove the association between one or more DBProxyTarget
data
structures and a DBProxyTargetGroup
.
6789 6790 6791 6792 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 6789 def deregister_db_proxy_targets(params = {}, = {}) req = build_request(:deregister_db_proxy_targets, params) req.send_request() end |
#describe_account_attributes(params = {}) ⇒ Types::AccountAttributesMessage
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.
6828 6829 6830 6831 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 6828 def describe_account_attributes(params = {}, = {}) req = build_request(:describe_account_attributes, params) req.send_request() end |
#describe_certificates(params = {}) ⇒ Types::CertificateMessage
Lists the set of CA certificates provided by Amazon RDS for this AWS account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6918 6919 6920 6921 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 6918 def describe_certificates(params = {}, = {}) req = build_request(:describe_certificates, params) req.send_request() end |
#describe_custom_availability_zones(params = {}) ⇒ Types::CustomAvailabilityZoneMessage
Returns information about custom Availability Zones (AZs).
A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster.
For more information about RDS on VMware, see the RDS on VMware User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6997 6998 6999 7000 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/client.rb', line 6997 def |