Class: Aws::RDS::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::RDS::Client
- Includes:
- ClientStubs
- Defined in:
- lib/aws-sdk-rds/client.rb
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
API Operations collapse
-
#add_role_to_db_cluster(params = {}) ⇒ Struct
Associates an Identity and Access Management (IAM) role from an Aurora DB cluster.
-
#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.
-
#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_db_cluster(params = {}) ⇒ Types::CreateDBClusterResult
Creates a new 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_security_group(params = {}) ⇒ Types::CreateDBSecurityGroupResult
Creates a new DB security group.
-
#create_db_snapshot(params = {}) ⇒ Types::CreateDBSnapshotResult
Creates a DBSnapshot.
-
#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_option_group(params = {}) ⇒ Types::CreateOptionGroupResult
Creates a new option group.
-
#delete_db_cluster(params = {}) ⇒ Types::DeleteDBClusterResult
The DeleteDBCluster action deletes a previously provisioned 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_parameter_group(params = {}) ⇒ Struct
Deletes a specified DBParameterGroup.
-
#delete_db_security_group(params = {}) ⇒ Struct
Deletes a DB security group.
-
#delete_db_snapshot(params = {}) ⇒ Types::DeleteDBSnapshotResult
Deletes a DBSnapshot.
-
#delete_db_subnet_group(params = {}) ⇒ Struct
Deletes a DB subnet group.
-
#delete_event_subscription(params = {}) ⇒ Types::DeleteEventSubscriptionResult
Deletes an RDS event notification subscription.
-
#delete_option_group(params = {}) ⇒ Struct
Deletes an existing option group.
-
#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_db_cluster_backtracks(params = {}) ⇒ Types::DBClusterBacktrackMessage
Returns information about backtracks for a 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_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_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 security groups, DB snapshots, and DB parameter groups for the past 14 days.
-
#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 or copy a DB snapshot 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.
-
#list_tags_for_resource(params = {}) ⇒ Types::TagListMessage
Lists all tags on an Amazon RDS resource.
-
#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_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_snapshot(params = {}) ⇒ Types::ModifyDBSnapshotResult
Updates a manual DB snapshot, which can be encrypted or not encrypted, 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_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.
-
#remove_role_from_db_cluster(params = {}) ⇒ Struct
Disassociates an Identity and Access Management (IAM) role from an Aurora DB cluster.
-
#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 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_db_instance(params = {}) ⇒ Types::StartDBInstanceResult
Starts a DB instance that was stopped using the AWS console, the stop-db-instance AWS CLI command, or the StopDBInstance action.
-
#stop_db_instance(params = {}) ⇒ Types::StopDBInstanceResult
Stops a DB instance.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(*args) ⇒ 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.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(*args) ⇒ Client
Returns a new instance of Client.
155 156 157 |
# File 'lib/aws-sdk-rds/client.rb', line 155 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
14351 14352 14353 |
# File 'lib/aws-sdk-rds/client.rb', line 14351 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
14354 14355 14356 |
# File 'lib/aws-sdk-rds/client.rb', line 14354 def errors_module Errors end |
Instance Method Details
#add_role_to_db_cluster(params = {}) ⇒ Struct
Associates an Identity and Access Management (IAM) role from an Aurora DB cluster. For more information, see [Authorizing Amazon Aurora to Access Other AWS Services On Your Behalf].
[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Aurora.Authorizing.AWSServices.html
190 191 192 193 |
# File 'lib/aws-sdk-rds/client.rb', line 190 def add_role_to_db_cluster(params = {}, = {}) req = build_request(:add_role_to_db_cluster, params) req.send_request() end |
#add_source_identifier_to_subscription(params = {}) ⇒ Types::AddSourceIdentifierToSubscriptionResult
Adds a source identifier to an existing RDS event notification subscription.
265 266 267 268 |
# File 'lib/aws-sdk-rds/client.rb', line 265 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].
[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.Tagging.html
327 328 329 330 |
# File 'lib/aws-sdk-rds/client.rb', line 327 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).
407 408 409 410 |
# File 'lib/aws-sdk-rds/client.rb', line 407 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).
<note markdown=“1”> You can’t authorize ingress from an EC2 security group in one AWS Region to an Amazon RDS DB instance in another. You can’t authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.
</note>
For an overview of CIDR ranges, go to the [Wikipedia Tutorial].
509 510 511 512 |
# File 'lib/aws-sdk-rds/client.rb', line 509 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 RDS User Guide.*
[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AuroraMySQL.Managing.Backtrack.html
602 603 604 605 |
# File 'lib/aws-sdk-rds/client.rb', line 602 def backtrack_db_cluster(params = {}, = {}) req = build_request(:backtrack_db_cluster, params) req.send_request() end |
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
14210 14211 14212 14213 14214 14215 14216 14217 14218 14219 14220 14221 |
# File 'lib/aws-sdk-rds/client.rb', line 14210 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-rds' context[:gem_version] = '1.25.0' Seahorse::Client::Request.new(handlers, context) end |
#copy_db_cluster_parameter_group(params = {}) ⇒ Types::CopyDBClusterParameterGroupResult
Copies the specified DB cluster parameter group.
703 704 705 706 |
# File 'lib/aws-sdk-rds/client.rb', line 703 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 the `CopyDBClusterSnapshot` 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 the `CopyDBClusterSnapshot` 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 KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. This is the same identifier for both the `CopyDBClusterSnapshot` 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 will 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 your `SourceDBClusterSnapshotIdentifier` 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].
-
-
‘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 the `SourceDBClusterSnapshotIdentifier` 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 DB Cluster Snapshot in the Same Account, Either in the Same Region or Across Regions] in the *Amazon RDS User Guide.*
For more information on Amazon Aurora, see [Aurora on Amazon RDS] in the *Amazon RDS User Guide.*
[1]: docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html [2]: docs.aws.amazon.com/general/latest/gr/signature-version-4.html [3]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CopySnapshot.html#USER_CopyDBClusterSnapshot.CrossRegion [4]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html
969 970 971 972 |
# File 'lib/aws-sdk-rds/client.rb', line 969 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.
1064 1065 1066 1067 |
# File 'lib/aws-sdk-rds/client.rb', line 1064 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.*
[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CopyDBSnapshot.html
1303 1304 1305 1306 |
# File 'lib/aws-sdk-rds/client.rb', line 1303 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.
1429 1430 1431 1432 |
# File 'lib/aws-sdk-rds/client.rb', line 1429 def copy_option_group(params = {}, = {}) req = build_request(:copy_option_group, 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 [Aurora on Amazon RDS] in the *Amazon RDS User Guide.*
[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html
1872 1873 1874 1875 |
# File 'lib/aws-sdk-rds/client.rb', line 1872 def create_db_cluster(params = {}, = {}) req = build_request(:create_db_cluster, 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 command to verify that your DB cluster parameter group has been created or modified.
For more information on Amazon Aurora, see [Aurora on Amazon RDS] in the *Amazon RDS User Guide.*
[1]: console.aws.amazon.com/rds/ [2]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html
1998 1999 2000 2001 |
# File 'lib/aws-sdk-rds/client.rb', line 1998 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 [Aurora on Amazon RDS] in the *Amazon RDS User Guide.*
[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html
2100 2101 2102 2103 |
# File 'lib/aws-sdk-rds/client.rb', line 2100 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.
3087 3088 3089 3090 |
# File 'lib/aws-sdk-rds/client.rb', line 3087 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, or PostgreSQL. For more information, see [Working with PostgreSQL, MySQL, and MariaDB Read Replicas].
Amazon Aurora doesn’t support this action. You must call the ‘CreateDBInstance` action to create a DB instance for an Aurora DB cluster.
All Read Replica DB instances are created with backups disabled. All other DB instance attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance, except as specified following.
Your source DB instance must have backup retention enabled.
[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReadRepl.html
3590 3591 3592 3593 |
# File 'lib/aws-sdk-rds/client.rb', line 3590 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.
3711 3712 3713 3714 |
# File 'lib/aws-sdk-rds/client.rb', line 3711 def create_db_parameter_group(params = {}, = {}) req = build_request(:create_db_parameter_group, 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.
<note markdown=“1”> A DB security group controls access to EC2-Classic DB instances that are not in a VPC.
</note>
3804 3805 3806 3807 |
# File 'lib/aws-sdk-rds/client.rb', line 3804 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 DBSnapshot. The source DBInstance must be in “available” state.
3914 3915 3916 3917 |
# File 'lib/aws-sdk-rds/client.rb', line 3914 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.
3999 4000 4001 4002 |
# File 'lib/aws-sdk-rds/client.rb', line 3999 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 ARN (Amazon Resource Name) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.
You can specify the type of source (SourceType) you want to be notified of, provide a list of RDS sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.
If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your RDS sources. If you do not specify either the SourceType nor the SourceIdentifier, you are notified of events generated from all RDS sources belonging to your customer account.
4154 4155 4156 4157 |
# File 'lib/aws-sdk-rds/client.rb', line 4154 def create_event_subscription(params = {}, = {}) req = build_request(:create_event_subscription, params) req.send_request() end |
#create_option_group(params = {}) ⇒ Types::CreateOptionGroupResult
Creates a new option group. You can create up to 20 option groups.
4267 4268 4269 4270 |
# File 'lib/aws-sdk-rds/client.rb', line 4267 def create_option_group(params = {}, = {}) req = build_request(:create_option_group, 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 [Aurora on Amazon RDS] in the *Amazon RDS User Guide.*
[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html
4420 4421 4422 4423 |
# File 'lib/aws-sdk-rds/client.rb', line 4420 def delete_db_cluster(params = {}, = {}) req = build_request(:delete_db_cluster, 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 [Aurora on Amazon RDS] in the *Amazon RDS User Guide.*
[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html
4468 4469 4470 4471 |
# File 'lib/aws-sdk-rds/client.rb', line 4468 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.
<note markdown=“1”> The DB cluster snapshot must be in the ‘available` state to be deleted.
</note>
For more information on Amazon Aurora, see [Aurora on Amazon RDS] in the *Amazon RDS User Guide.*
[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html
4547 4548 4549 4550 |
# File 'lib/aws-sdk-rds/client.rb', line 4547 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.
Note that when a DB instance is in a failure state and has a status of ‘failed`, `incompatible-restore`, or `incompatible-network`, you can only delete it when the `SkipFinalSnapshot` parameter is set to `true`.
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.
4771 4772 4773 4774 |
# File 'lib/aws-sdk-rds/client.rb', line 4771 def delete_db_instance(params = {}, = {}) req = build_request(:delete_db_instance, params) req.send_request() end |
#delete_db_parameter_group(params = {}) ⇒ Struct
Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted can’t be associated with any DB instances.
4811 4812 4813 4814 |
# File 'lib/aws-sdk-rds/client.rb', line 4811 def delete_db_parameter_group(params = {}, = {}) req = build_request(:delete_db_parameter_group, params) req.send_request() end |
#delete_db_security_group(params = {}) ⇒ Struct
Deletes a DB security group.
<note markdown=“1”> The specified DB security group must not be associated with any DB instances.
</note>
4861 4862 4863 4864 |
# File 'lib/aws-sdk-rds/client.rb', line 4861 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 DBSnapshot. If the snapshot is being copied, the copy operation is terminated.
<note markdown=“1”> The DBSnapshot must be in the ‘available` state to be deleted.
</note>
4940 4941 4942 4943 |
# File 'lib/aws-sdk-rds/client.rb', line 4940 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.
<note markdown=“1”> The specified database subnet group must not be associated with any DB instances.
</note>
4987 4988 4989 4990 |
# File 'lib/aws-sdk-rds/client.rb', line 4987 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.
5042 5043 5044 5045 |
# File 'lib/aws-sdk-rds/client.rb', line 5042 def delete_event_subscription(params = {}, = {}) req = build_request(:delete_event_subscription, params) req.send_request() end |
#delete_option_group(params = {}) ⇒ Struct
Deletes an existing option group.
5077 5078 5079 5080 |
# File 'lib/aws-sdk-rds/client.rb', line 5077 def delete_option_group(params = {}, = {}) req = build_request(:delete_option_group, 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.
5116 5117 5118 5119 |
# File 'lib/aws-sdk-rds/client.rb', line 5116 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.
5202 5203 5204 5205 |
# File 'lib/aws-sdk-rds/client.rb', line 5202 def describe_certificates(params = {}, = {}) req = build_request(:describe_certificates, params) req.send_request() end |
#describe_db_cluster_backtracks(params = {}) ⇒ Types::DBClusterBacktrackMessage
Returns information about backtracks for a DB cluster.
For more information on Amazon Aurora, see [Aurora on Amazon RDS] in the *Amazon RDS User Guide.*
[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html
5322 5323 5324 5325 |
# File 'lib/aws-sdk-rds/client.rb', line 5322 def describe_db_cluster_backtracks(params = {}, = {}) req = build_request(:describe_db_cluster_backtracks, params) req.send_request() end |
#describe_db_cluster_parameter_groups(params = {}) ⇒ Types::DBClusterParameterGroupsMessage
Returns a list of ‘DBClusterParameterGroup` descriptions. If a `DBClusterParameterGroupName` parameter is specified, the list will contain only the description of the specified DB cluster parameter group.
For more information on Amazon Aurora, see [Aurora on Amazon RDS] in the *Amazon RDS User Guide.*
[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html
5414 5415 5416 5417 |
# File 'lib/aws-sdk-rds/client.rb', line 5414 def describe_db_cluster_parameter_groups(params = {}, = {}) req = build_request(:describe_db_cluster_parameter_groups, params) req.send_request() end |
#describe_db_cluster_parameters(params = {}) ⇒ Types::DBClusterParameterGroupDetails
Returns the detailed parameter list for a particular DB cluster parameter group.
For more information on Amazon Aurora, see [Aurora on Amazon RDS] in the *Amazon RDS User Guide.*
[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html
5518 5519 5520 5521 |
# File 'lib/aws-sdk-rds/client.rb', line 5518 def describe_db_cluster_parameters(params = {}, = {}) req = build_request(:describe_db_cluster_parameters, params) req.send_request() end |
#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.
When sharing snapshots with other AWS accounts, ‘DescribeDBClusterSnapshotAttributes` returns the `restore` attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the manual DB cluster snapshot. If `all` is included in the list of values for the `restore` attribute, then the manual DB cluster snapshot is public and can be copied or restored by all AWS accounts.
To add or remove access for an AWS account to copy or restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.
5578 5579 5580 5581 |
# File 'lib/aws-sdk-rds/client.rb', line 5578 def describe_db_cluster_snapshot_attributes(params = {}, = {}) req = build_request(:describe_db_cluster_snapshot_attributes, params) req.send_request() end |
#describe_db_cluster_snapshots(params = {}) ⇒ Types::DBClusterSnapshotMessage
Returns information about DB cluster snapshots. This API action supports pagination.
For more information on Amazon Aurora, see [Aurora on Amazon RDS] in the *Amazon RDS User Guide.*
[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html
5749 5750 5751 5752 |
# File 'lib/aws-sdk-rds/client.rb', line 5749 def describe_db_cluster_snapshots(params = {}, = {}) req = build_request(:describe_db_cluster_snapshots, params) req.send_request() end |
#describe_db_clusters(params = {}) ⇒ Types::DBClusterMessage
Returns information about provisioned Aurora DB clusters. This API supports pagination.
For more information on Amazon Aurora, see [Aurora on Amazon RDS] in the *Amazon RDS User Guide.*
[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html
5901 5902 5903 5904 |
# File 'lib/aws-sdk-rds/client.rb', line 5901 def describe_db_clusters(params = {}, = {}) req = build_request(:describe_db_clusters, params) req.send_request() end |
#describe_db_engine_versions(params = {}) ⇒ Types::DBEngineVersionMessage
Returns a list of the available DB engines.
6032 6033 6034 6035 |
# File 'lib/aws-sdk-rds/client.rb', line 6032 def describe_db_engine_versions(params = {}, = {}) req = build_request(:describe_db_engine_versions, params) req.send_request() end |
#describe_db_instances(params = {}) ⇒ Types::DBInstanceMessage
Returns information about provisioned RDS instances. This API supports pagination.
6226 6227 6228 6229 |
# File 'lib/aws-sdk-rds/client.rb', line 6226 def describe_db_instances(params = {}, = {}) req = build_request(:describe_db_instances, params) req.send_request() end |
#describe_db_log_files(params = {}) ⇒ Types::DescribeDBLogFilesResponse
Returns a list of DB log files for the DB instance.
6320 6321 6322 6323 |
# File 'lib/aws-sdk-rds/client.rb', line 6320 def describe_db_log_files(params = {}, = {}) req = build_request(:describe_db_log_files, params) req.send_request() end |
#describe_db_parameter_groups(params = {}) ⇒ Types::DBParameterGroupsMessage
Returns a list of ‘DBParameterGroup` descriptions. If a `DBParameterGroupName` is specified, the list will contain only the description of the specified DB parameter group.
6403 6404 6405 6406 |
# File 'lib/aws-sdk-rds/client.rb', line 6403 def describe_db_parameter_groups(params = {}, = {}) req = build_request(:describe_db_parameter_groups, params) req.send_request() end |
#describe_db_parameters(params = {}) ⇒ Types::DBParameterGroupDetails
Returns the detailed parameter list for a particular DB parameter group.
6502 6503 6504 6505 |
# File 'lib/aws-sdk-rds/client.rb', line 6502 def describe_db_parameters(params = {}, = {}) req = build_request(:describe_db_parameters, params) req.send_request() end |
#describe_db_security_groups(params = {}) ⇒ Types::DBSecurityGroupMessage
Returns a list of ‘DBSecurityGroup` descriptions. If a `DBSecurityGroupName` is specified, the list will contain only the descriptions of the specified DB security group.
6587 6588 6589 6590 |
# File 'lib/aws-sdk-rds/client.rb', line 6587 def describe_db_security_groups(params = {}, = {}) req = build_request(:describe_db_security_groups, params) req.send_request() end |
#describe_db_snapshot_attributes(params = {}) ⇒ Types::DescribeDBSnapshotAttributesResult
Returns a list of DB snapshot attribute names and values for a manual DB snapshot.
When sharing snapshots with other AWS accounts, ‘DescribeDBSnapshotAttributes` returns the `restore` attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the manual DB snapshot. If `all` is included in the list of values for the `restore` attribute, then the manual DB snapshot is public and can be copied or restored by all AWS accounts.
To add or remove access for an AWS account to copy or restore a manual DB snapshot, or to make the manual DB snapshot public or private, use the ModifyDBSnapshotAttribute API action.
6646 6647 6648 6649 |
# File 'lib/aws-sdk-rds/client.rb', line 6646 def describe_db_snapshot_attributes(params = {}, = {}) req = build_request(:describe_db_snapshot_attributes, params) req.send_request() end |
#describe_db_snapshots(params = {}) ⇒ Types::DBSnapshotMessage
Returns information about DB snapshots. This API action supports pagination.
6818 6819 6820 6821 |
# File 'lib/aws-sdk-rds/client.rb', line 6818 def describe_db_snapshots(params = {}, = {}) req = build_request(:describe_db_snapshots, params) req.send_request() end |
#describe_db_subnet_groups(params = {}) ⇒ Types::DBSubnetGroupMessage
Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.
For an overview of CIDR ranges, go to the [Wikipedia Tutorial].
6905 6906 6907 6908 |
# File 'lib/aws-sdk-rds/client.rb', line 6905 def describe_db_subnet_groups(params = {}, = {}) req = build_request(:describe_db_subnet_groups, params) req.send_request() end |
#describe_engine_default_cluster_parameters(params = {}) ⇒ Types::DescribeEngineDefaultClusterParametersResult
Returns the default engine and system parameter information for the cluster database engine.
For more information on Amazon Aurora, see [Aurora on Amazon RDS] in the *Amazon RDS User Guide.*
[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html
6998 6999 7000 7001 |
# File 'lib/aws-sdk-rds/client.rb', line 6998 def describe_engine_default_cluster_parameters(params = {}, = {}) req = build_request(:describe_engine_default_cluster_parameters, params) req.send_request() end |
#describe_engine_default_parameters(params = {}) ⇒ Types::DescribeEngineDefaultParametersResult
Returns the default engine and system parameter information for the specified database engine.
7083 7084 7085 7086 |
# File 'lib/aws-sdk-rds/client.rb', line 7083 def describe_engine_default_parameters(params = {}, = {}) req = build_request(:describe_engine_default_parameters, params) req.send_request() end |
#describe_event_categories(params = {}) ⇒ Types::EventCategoriesMessage
Displays a list of categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in the [ Events] topic in the *Amazon RDS User Guide.*
[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html
7146 7147 7148 7149 |
# File 'lib/aws-sdk-rds/client.rb', line 7146 def describe_event_categories(params = {}, = {}) req = build_request(:describe_event_categories, params) req.send_request() end |
#describe_event_subscriptions(params = {}) ⇒ Types::EventSubscriptionsMessage
Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.
If you specify a SubscriptionName, lists the description for that subscription.
7234 7235 7236 7237 |
# File 'lib/aws-sdk-rds/client.rb', line 7234 def describe_event_subscriptions(params = {}, = {}) req = build_request(:describe_event_subscriptions, params) req.send_request() end |
#describe_events(params = {}) ⇒ Types::EventsMessage
Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
7379 7380 7381 7382 |
# File 'lib/aws-sdk-rds/client.rb', line 7379 def describe_events(params = {}, = {}) req = build_request(:describe_events, params) req.send_request() end |
#describe_option_group_options(params = {}) ⇒ Types::OptionGroupOptionsMessage
Describes all available options.
7481 7482 7483 7484 |
# File 'lib/aws-sdk-rds/client.rb', line 7481 def (params = {}, = {}) req = build_request(:describe_option_group_options, params) req.send_request() end |
#describe_option_groups(params = {}) ⇒ Types::OptionGroups
Describes the available option groups.
7594 7595 7596 7597 |
# File 'lib/aws-sdk-rds/client.rb', line 7594 def describe_option_groups(params = {}, = {}) req = build_request(:describe_option_groups, params) req.send_request() end |
#describe_orderable_db_instance_options(params = {}) ⇒ Types::OrderableDBInstanceOptionsMessage
Returns a list of orderable DB instance options for the specified engine.
7717 7718 7719 7720 |
# File 'lib/aws-sdk-rds/client.rb', line 7717 def (params = {}, = {}) req = build_request(:describe_orderable_db_instance_options, params) req.send_request() end |
#describe_pending_maintenance_actions(params = {}) ⇒ Types::PendingMaintenanceActionsMessage
Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
7808 7809 7810 7811 |
# File 'lib/aws-sdk-rds/client.rb', line 7808 def describe_pending_maintenance_actions(params = {}, = {}) req = build_request(:describe_pending_maintenance_actions, params) req.send_request() end |
#describe_reserved_db_instances(params = {}) ⇒ Types::ReservedDBInstanceMessage
Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
7937 7938 7939 7940 |
# File 'lib/aws-sdk-rds/client.rb', line 7937 def describe_reserved_db_instances(params = {}, = {}) req = build_request(:describe_reserved_db_instances, params) req.send_request() end |
#describe_reserved_db_instances_offerings(params = {}) ⇒ Types::ReservedDBInstancesOfferingMessage
Lists available reserved DB instance offerings.
8061 8062 8063 8064 |
# File 'lib/aws-sdk-rds/client.rb', line 8061 def describe_reserved_db_instances_offerings(params = {}, = {}) req = build_request(:describe_reserved_db_instances_offerings, params) req.send_request() end |
#describe_source_regions(params = {}) ⇒ Types::SourceRegionMessage
Returns a list of the source AWS Regions where the current AWS Region can create a Read Replica or copy a DB snapshot from. This API action supports pagination.
8193 8194 8195 8196 |
# File 'lib/aws-sdk-rds/client.rb', line 8193 def describe_source_regions(params = {}, = {}) req = build_request(:describe_source_regions, params) req.send_request() end |
#describe_valid_db_instance_modifications(params = {}) ⇒ Types::DescribeValidDBInstanceModificationsResult
You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance.
8239 8240 8241 8242 |
# File 'lib/aws-sdk-rds/client.rb', line 8239 def describe_valid_db_instance_modifications(params = {}, = {}) req = build_request(:describe_valid_db_instance_modifications, params) req.send_request() end |
#download_db_log_file_portion(params = {}) ⇒ Types::DownloadDBLogFilePortionDetails
Downloads all or a portion of the specified log file, up to 1 MB in size.
8330 8331 8332 8333 |
# File 'lib/aws-sdk-rds/client.rb', line 8330 def download_db_log_file_portion(params = {}, = {}) req = build_request(:download_db_log_file_portion, params) req.send_request() end |
#failover_db_cluster(params = {}) ⇒ Types::FailoverDBClusterResult
Forces a failover for a DB cluster.
A failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary instance (the cluster writer).
Amazon Aurora will automatically fail over to an Aurora Replica, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a primary instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.
For more information on Amazon Aurora, see [Aurora on Amazon RDS] in the *Amazon RDS User Guide.*
[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html
8464 8465 8466 8467 |
# File 'lib/aws-sdk-rds/client.rb', line 8464 def failover_db_cluster(params = {}, = {}) req = build_request(:failover_db_cluster, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::TagListMessage
Lists all tags on an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see [Tagging Amazon RDS Resources].
[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.Tagging.html
8529 8530 8531 8532 |
# File 'lib/aws-sdk-rds/client.rb', line 8529 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#modify_current_db_cluster_capacity(params = {}) ⇒ Types::DBClusterCapacityInfo
Set the capacity of an Aurora Serverless DB cluster to a specific value.
Aurora Serverless scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might not scale fast enough to meet a sudden change in workload, such as a large number of new transactions. Call ‘ModifyCurrentDBClusterCapacity` to set the capacity explicitly.
After this call sets the DB cluster capacity, Aurora Serverless can automatically scale the DB cluster based on the cooldown period for scaling up and the cooldown period for scaling down.
For more information about Aurora Serverless, see [Using Amazon Aurora Serverless] in the *Amazon RDS User Guide*.
If you call ‘ModifyCurrentDBClusterCapacity` with the default `TimeoutAction`, connections that prevent Aurora Serverless from finding a scaling point might be dropped. For more information about scaling points, see [ Autoscaling for Aurora Serverless] in the *Amazon RDS User Guide*.
[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/aurora-serverless.html [2]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/aurora-serverless.how-it-works.html#aurora-serverless.how-it-works.auto-scaling
8628 8629 8630 8631 |
# File 'lib/aws-sdk-rds/client.rb', line 8628 def modify_current_db_cluster_capacity(params = {}, = {}) req = build_request(:modify_current_db_cluster_capacity, params) req.send_request() end |
#modify_db_cluster(params = {}) ⇒ Types::ModifyDBClusterResult
Modify a setting for an Amazon Aurora DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see [Aurora on Amazon RDS] in the *Amazon RDS User Guide.*
[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html
8927 8928 8929 8930 |
# File 'lib/aws-sdk-rds/client.rb', line 8927 def modify_db_cluster(params = {}, = {}) req = build_request(:modify_db_cluster, params) req.send_request() end |
#modify_db_cluster_parameter_group(params = {}) ⇒ Types::DBClusterParameterGroupNameMessage
Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ‘ParameterName`, `ParameterValue`, and `ApplyMethod`. A maximum of 20 parameters can be modified in a single request.
For more information on Amazon Aurora, see [Aurora on Amazon RDS] in the *Amazon RDS User Guide.*
<note markdown=“1”> Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB cluster associated with the parameter group before the change can take effect.
</note>
After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the ‘character_set_database` parameter. You can use the *Parameter Groups* option of the [Amazon RDS console] or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.
[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html [2]: console.aws.amazon.com/rds/
9022 9023 9024 9025 |
# File 'lib/aws-sdk-rds/client.rb', line 9022 def modify_db_cluster_parameter_group(params = {}, = {}) req = build_request(:modify_db_cluster_parameter_group, params) req.send_request() end |
#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.
To share a manual DB cluster snapshot with other AWS accounts, specify ‘restore` as the `AttributeName` and use the `ValuesToAdd` parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual DB cluster snapshot. Use the value `all` to make the manual DB cluster snapshot public, which means that it can be copied or restored by all AWS accounts. Do not add the `all` value for any manual DB cluster snapshots that contain private information that you don’t want available to all AWS accounts. If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized AWS account IDs for the ‘ValuesToAdd` parameter. You can’t use ‘all` as a value for that parameter in this case.
To view which AWS accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot public or private, use the DescribeDBClusterSnapshotAttributes API action.
9128 9129 9130 9131 |
# File 'lib/aws-sdk-rds/client.rb', line 9128 def modify_db_cluster_snapshot_attribute(params = {}, = {}) req = build_request(:modify_db_cluster_snapshot_attribute, params) req.send_request() end |
#modify_db_instance(params = {}) ⇒ Types::ModifyDBInstanceResult
Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. To learn what modifications you can make to your DB instance, call DescribeValidDBInstanceModifications before you call ModifyDBInstance.
9880 9881 9882 9883 |
# File 'lib/aws-sdk-rds/client.rb', line 9880 def modify_db_instance(params = {}, = {}) req = build_request(:modify_db_instance, params) req.send_request() end |
#modify_db_parameter_group(params = {}) ⇒ Types::DBParameterGroupNameMessage
Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: ‘ParameterName`, `ParameterValue`, and `ApplyMethod`. A maximum of 20 parameters can be modified in a single request.
<note markdown=“1”> Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance associated with the parameter group before the change can take effect.
</note>
After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the modify action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the ‘character_set_database` parameter. You can use the *Parameter Groups* option of the [Amazon RDS console] or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.
9990 9991 9992 9993 |
# File 'lib/aws-sdk-rds/client.rb', line 9990 def modify_db_parameter_group(params = {}, = {}) req = build_request(:modify_db_parameter_group, params) req.send_request() end |
#modify_db_snapshot(params = {}) ⇒ Types::ModifyDBSnapshotResult
Updates a manual DB snapshot, which can be encrypted or not encrypted, with a new engine version.
Amazon RDS supports upgrading DB snapshots for MySQL and Oracle.
10083 10084 10085 10086 |
# File 'lib/aws-sdk-rds/client.rb', line 10083 def modify_db_snapshot(params = {}, = {}) req = build_request(:modify_db_snapshot, params) req.send_request() end |
#modify_db_snapshot_attribute(params = {}) ⇒ Types::ModifyDBSnapshotAttributeResult
Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.
To share a manual DB snapshot with other AWS accounts, specify ‘restore` as the `AttributeName` and use the `ValuesToAdd` parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual DB snapshot. Uses the value `all` to make the manual DB snapshot public, which means it can be copied or restored by all AWS accounts. Do not add the `all` value for any manual DB snapshots that contain private information that you don’t want available to all AWS accounts. If the manual DB snapshot is encrypted, it can be shared, but only by specifying a list of authorized AWS account IDs for the ‘ValuesToAdd` parameter. You can’t use ‘all` as a value for that parameter in this case.
To view which AWS accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API action.
10181 10182 10183 10184 |
# File 'lib/aws-sdk-rds/client.rb', line 10181 def modify_db_snapshot_attribute(params = {}, = {}) req = build_request(:modify_db_snapshot_attribute, params) req.send_request() end |
#modify_db_subnet_group(params = {}) ⇒ Types::ModifyDBSubnetGroupResult
Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region.
10251 10252 10253 10254 |
# File 'lib/aws-sdk-rds/client.rb', line 10251 def modify_db_subnet_group(params = {}, = {}) req = build_request(:modify_db_subnet_group, params) req.send_request() end |
#modify_event_subscription(params = {}) ⇒ Types::ModifyEventSubscriptionResult
Modifies an existing RDS event notification subscription. Note that you can’t modify the source identifiers using this call; to change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.
You can see a list of the event categories for a given SourceType in the [Events] topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.
[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html
10354 10355 10356 10357 |
# File 'lib/aws-sdk-rds/client.rb', line 10354 def modify_event_subscription(params = {}, = {}) req = build_request(:modify_event_subscription, params) req.send_request() end |
#modify_option_group(params = {}) ⇒ Types::ModifyOptionGroupResult
Modifies an existing option group.
10477 10478 10479 10480 |
# File 'lib/aws-sdk-rds/client.rb', line 10477 def modify_option_group(params = {}, = {}) req = build_request(:modify_option_group, params) req.send_request() end |
#promote_read_replica(params = {}) ⇒ Types::PromoteReadReplicaResult
Promotes a Read Replica DB instance to a standalone DB instance.
<note markdown=“1”> * Backup duration is a function of the amount of changes to the
database since the previous backup. If you plan to promote a Read
Replica to a standalone instance, we recommend that you enable
backups and complete at least one backup prior to promotion. In
addition, a Read Replica cannot be promoted to a standalone instance
when it is in the `backing-up` status. If you have enabled backups
on your Read Replica, configure the automated backup window so that
daily backups do not interfere with Read Replica promotion.
-
This command doesn’t apply to Aurora MySQL and Aurora PostgreSQL.
</note>
10686 10687 10688 10689 |
# File 'lib/aws-sdk-rds/client.rb', line 10686 def promote_read_replica(params = {}, = {}) req = build_request(:promote_read_replica, params) req.send_request() end |
#promote_read_replica_db_cluster(params = {}) ⇒ Types::PromoteReadReplicaDBClusterResult
Promotes a Read Replica DB cluster to a standalone DB cluster.
10781 10782 10783 10784 |
# File 'lib/aws-sdk-rds/client.rb', line 10781 def promote_read_replica_db_cluster(params = {}, = {}) req = build_request(:promote_read_replica_db_cluster, params) req.send_request() end |
#purchase_reserved_db_instances_offering(params = {}) ⇒ Types::PurchaseReservedDBInstancesOfferingResult
Purchases a reserved DB instance offering.
10869 10870 10871 10872 |
# File 'lib/aws-sdk-rds/client.rb', line 10869 def purchase_reserved_db_instances_offering(params = {}, = {}) req = build_request(:purchase_reserved_db_instances_offering, params) req.send_request() end |
#reboot_db_instance(params = {}) ⇒ Types::RebootDBInstanceResult
You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect.
Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.
For more information about rebooting, see [Rebooting a DB Instance].
[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_RebootInstance.html
11044 11045 11046 11047 |
# File 'lib/aws-sdk-rds/client.rb', line 11044 def reboot_db_instance(params = {}, = {}) req = build_request(:reboot_db_instance, params) req.send_request() end |
#remove_role_from_db_cluster(params = {}) ⇒ Struct
Disassociates an Identity and Access Management (IAM) role from an Aurora DB cluster. For more information, see [Authorizing Amazon Aurora to Access Other AWS Services On Your Behalf].
[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Aurora.Authorizing.AWSServices.html
11078 11079 11080 11081 |
# File 'lib/aws-sdk-rds/client.rb', line 11078 def remove_role_from_db_cluster(params = {}, = {}) req = build_request(:remove_role_from_db_cluster, params) req.send_request() end |
#remove_source_identifier_from_subscription(params = {}) ⇒ Types::RemoveSourceIdentifierFromSubscriptionResult
Removes a source identifier from an existing RDS event notification subscription.
11141 11142 11143 11144 |
# File 'lib/aws-sdk-rds/client.rb', line 11141 def remove_source_identifier_from_subscription(params = {}, = {}) req = build_request(:remove_source_identifier_from_subscription, params) req.send_request() end |
#remove_tags_from_resource(params = {}) ⇒ Struct
Removes metadata tags from an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see [Tagging Amazon RDS Resources].
[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.Tagging.html
11192 11193 11194 11195 |
# File 'lib/aws-sdk-rds/client.rb', line 11192 def (params = {}, = {}) req = build_request(:remove_tags_from_resource, params) req.send_request() end |
#reset_db_cluster_parameter_group(params = {}) ⇒ Types::DBClusterParameterGroupNameMessage
Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: ‘ParameterName` and `ApplyMethod`. To reset the entire DB cluster parameter group, specify the `DBClusterParameterGroupName` and `ResetAllParameters` parameters.
When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to ‘pending-reboot` to take effect on the next DB instance restart or RebootDBInstance request. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to.
For more information on Amazon Aurora, see [Aurora on Amazon RDS] in the *Amazon RDS User Guide.*
[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html
11278 11279 11280 11281 |
# File 'lib/aws-sdk-rds/client.rb', line 11278 def reset_db_cluster_parameter_group(params = {}, = {}) req = build_request(:reset_db_cluster_parameter_group, params) req.send_request() end |
#reset_db_parameter_group(params = {}) ⇒ Types::DBParameterGroupNameMessage
Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters, provide a list of the following: ‘ParameterName` and `ApplyMethod`. To reset the entire DB parameter group, specify the `DBParameterGroup` name and `ResetAllParameters` parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to `pending-reboot` to take effect on the next DB instance restart or `RebootDBInstance` request.
11382 11383 11384 11385 |
# File 'lib/aws-sdk-rds/client.rb', line 11382 def reset_db_parameter_group(params = {}, = {}) req = build_request(:reset_db_parameter_group, params) req.send_request() end |
#restore_db_cluster_from_s3(params = {}) ⇒ Types::RestoreDBClusterFromS3Result
Creates an Amazon Aurora DB cluster from data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in [Migrating Data from MySQL by Using an Amazon S3 Bucket].
[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Aurora.Migrate.MySQL.html#Aurora.Migrate.MySQL.S3
11740 11741 11742 11743 |
# File 'lib/aws-sdk-rds/client.rb', line 11740 def restore_db_cluster_from_s3(params = {}, = {}) req = build_request(:restore_db_cluster_from_s3, params) req.send_request() end |
#restore_db_cluster_from_snapshot(params = {}) ⇒ Types::RestoreDBClusterFromSnapshotResult
Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
For more information on Amazon Aurora, see [Aurora on Amazon RDS] in the *Amazon RDS User Guide.*
[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html
12009 12010 12011 12012 |
# File 'lib/aws-sdk-rds/client.rb', line 12009 def restore_db_cluster_from_snapshot(params = {}, = {}) req = build_request(:restore_db_cluster_from_snapshot, params) req.send_request() end |
#restore_db_cluster_to_point_in_time(params = {}) ⇒ Types::RestoreDBClusterToPointInTimeResult
Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before ‘LatestRestorableTime` for up to `BackupRetentionPeriod` days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group.
<note markdown=“1”> This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in ‘DBClusterIdentifier`. You can create DB instances only after the `RestoreDBClusterToPointInTime` action has completed and the DB cluster is available.
</note>
For more information on Amazon Aurora, see [Aurora on Amazon RDS] in the *Amazon RDS User Guide.*
[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html
12299 12300 12301 12302 |
# File 'lib/aws-sdk-rds/client.rb', line 12299 def restore_db_cluster_to_point_in_time(params = {}, = {}) req = build_request(:restore_db_cluster_to_point_in_time, params) req.send_request() end |
#restore_db_instance_from_db_snapshot(params = {}) ⇒ Types::RestoreDBInstanceFromDBSnapshotResult
Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with the most of original configuration with the default security group and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored AZ deployment and not a single-AZ deployment.
If your intent is to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot action. RDS doesn’t allow two DB instances with the same name. Once you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you will replace the original DB instance with the DB instance created from the snapshot.
If you are restoring from a shared manual DB snapshot, the ‘DBSnapshotIdentifier` must be the ARN of the shared DB snapshot.
<note markdown=“1”> This command doesn’t apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterFromSnapshot.
</note>
12805 12806 12807 12808 |
# File 'lib/aws-sdk-rds/client.rb', line 12805 def restore_db_instance_from_db_snapshot(params = {}, = {}) req = build_request(:restore_db_instance_from_db_snapshot, params) req.send_request() end |
#restore_db_instance_from_s3(params = {}) ⇒ Types::RestoreDBInstanceFromS3Result
Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files. You can create a backup of your on-premises database, store it on Amazon Simple Storage Service (Amazon S3), and then restore the backup file onto a new Amazon RDS DB instance running MySQL. For more information, see [Importing Data into an Amazon RDS MySQL DB Instance].
[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/MySQL.Procedural.Importing.html
13320 13321 13322 13323 |
# File 'lib/aws-sdk-rds/client.rb', line 13320 def restore_db_instance_from_s3(params = {}, = {}) req = build_request(:restore_db_instance_from_s3, params) req.send_request() end |
#restore_db_instance_to_point_in_time(params = {}) ⇒ Types::RestoreDBInstanceToPointInTimeResult
Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property.
The target database is created with most of the original configuration, but in a system-selected Availability Zone, with the default security group, the default subnet group, and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored deployment and not a single-AZ deployment.
<note markdown=“1”> This command doesn’t apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterToPointInTime.
</note>
13829 13830 13831 13832 |
# File 'lib/aws-sdk-rds/client.rb', line 13829 def restore_db_instance_to_point_in_time(params = {}, = {}) req = build_request(:restore_db_instance_to_point_in_time, params) req.send_request() end |
#revoke_db_security_group_ingress(params = {}) ⇒ Types::RevokeDBSecurityGroupIngressResult
Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC Security Groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId).
13918 13919 13920 13921 |
# File 'lib/aws-sdk-rds/client.rb', line 13918 def revoke_db_security_group_ingress(params = {}, = {}) req = build_request(:revoke_db_security_group_ingress, params) req.send_request() end |
#start_db_instance(params = {}) ⇒ Types::StartDBInstanceResult
Starts a DB instance that was stopped using the AWS console, the stop-db-instance AWS CLI command, or the StopDBInstance action. For more information, see Stopping and Starting a DB instance in the AWS RDS user guide.
<note markdown=“1”> This command doesn’t apply to Aurora MySQL and Aurora PostgreSQL.
</note>
14056 14057 14058 14059 |
# File 'lib/aws-sdk-rds/client.rb', line 14056 def start_db_instance(params = {}, = {}) req = build_request(:start_db_instance, params) req.send_request() end |
#stop_db_instance(params = {}) ⇒ Types::StopDBInstanceResult
Stops a DB instance. When you stop a DB instance, Amazon RDS retains the DB instance’s metadata, including its endpoint, DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if necessary. For more information, see Stopping and Starting a DB instance in the AWS RDS user guide.
<note markdown=“1”> This command doesn’t apply to Aurora MySQL and Aurora PostgreSQL.
</note>
14201 14202 14203 14204 |
# File 'lib/aws-sdk-rds/client.rb', line 14201 def stop_db_instance(params = {}, = {}) req = build_request(:stop_db_instance, params) req.send_request() end |
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
## Basic Usage
A waiter will call an API operation until:
-
It is successful
-
It enters a terminal state
-
It makes the maximum number of attempts
In between attempts, the waiter will sleep.
# polls in a loop, sleeping between attempts
client.waiter_until(waiter_name, params)
## Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.
# poll for ~25 seconds
client.wait_until(waiter_name, params, {
max_attempts: 5,
delay: 5,
})
## Callbacks
You can be notified before each polling attempt and before each delay. If you throw ‘:success` or `:failure` from these callbacks, it will terminate the waiter.
started_at = Time.now
client.wait_until(waiter_name, params, {
# disable max attempts
max_attempts: nil,
# poll for 1 hour, instead of a number of attempts
before_wait: -> (attempts, response) do
throw :failure if Time.now - started_at > 3600
end
})
## Handling Errors
When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.
begin
client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
## Valid Waiters
The following table lists the valid waiter names, the operations they call, and the default ‘:delay` and `:max_attempts` values.
| waiter_name | params | :delay | :max_attempts | | ——————— | ———————— | ——– | ————- | | db_instance_available | #describe_db_instances | 30 | 60 | | db_instance_deleted | #describe_db_instances | 30 | 60 | | db_snapshot_available | #describe_db_snapshots | 30 | 60 | | db_snapshot_deleted | #describe_db_snapshots | 30 | 60 |
14314 14315 14316 14317 14318 |
# File 'lib/aws-sdk-rds/client.rb', line 14314 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
14322 14323 14324 |
# File 'lib/aws-sdk-rds/client.rb', line 14322 def waiter_names waiters.keys end |