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 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.
-
#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_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_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_global_cluster(params = {}) ⇒ Types::CreateGlobalClusterResult
Creates an Aurora global database spread across multiple regions.
-
#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_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 based on the source instance’s ‘DbiResourceId` value or the restorable instance’s resource ID.
-
#delete_db_parameter_group(params = {}) ⇒ Struct
Deletes a specified DB parameter group.
-
#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_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_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_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_global_clusters(params = {}) ⇒ Types::GlobalClustersMessage
Returns information about Aurora global database clusters.
-
#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_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_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_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.
-
#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 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_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.
-
#stop_db_cluster(params = {}) ⇒ Types::StopDBClusterResult
Stops an Amazon Aurora DB cluster.
-
#stop_db_instance(params = {}) ⇒ Types::StopDBInstanceResult
Stops an Amazon RDS DB instance.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#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.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
204 205 206 |
# File 'lib/aws-sdk-rds/client.rb', line 204 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.
16052 16053 16054 |
# File 'lib/aws-sdk-rds/client.rb', line 16052 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.
16055 16056 16057 |
# File 'lib/aws-sdk-rds/client.rb', line 16055 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 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*.
<note markdown=“1”> This action only applies to Aurora DB clusters.
</note>
[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Integrating.Authorizing.html
244 245 246 247 |
# File 'lib/aws-sdk-rds/client.rb', line 244 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.
278 279 280 281 |
# File 'lib/aws-sdk-rds/client.rb', line 278 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.
353 354 355 356 |
# File 'lib/aws-sdk-rds/client.rb', line 353 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
415 416 417 418 |
# File 'lib/aws-sdk-rds/client.rb', line 415 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).
495 496 497 498 |
# File 'lib/aws-sdk-rds/client.rb', line 495 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].
597 598 599 600 |
# File 'lib/aws-sdk-rds/client.rb', line 597 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.*
<note markdown=“1”> This action only applies to Aurora DB clusters.
</note>
[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Managing.Backtrack.html
694 695 696 697 |
# File 'lib/aws-sdk-rds/client.rb', line 694 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.
15911 15912 15913 15914 15915 15916 15917 15918 15919 15920 15921 15922 |
# File 'lib/aws-sdk-rds/client.rb', line 15911 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.44.0' Seahorse::Client::Request.new(handlers, context) end |
#copy_db_cluster_parameter_group(params = {}) ⇒ Types::CopyDBClusterParameterGroupResult
Copies the specified DB cluster parameter group.
<note markdown=“1”> This action only applies to Aurora DB clusters.
</note>
800 801 802 803 |
# File 'lib/aws-sdk-rds/client.rb', line 800 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 Snapshot] in the *Amazon Aurora User Guide.*
For more information on Amazon Aurora, see [ What Is Amazon Aurora?] in the *Amazon Aurora User Guide.*
<note markdown=“1”> This action only applies to Aurora DB clusters.
</note>
[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/AuroraUserGuide/USER_CopySnapshot.html [4]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
1070 1071 1072 1073 |
# File 'lib/aws-sdk-rds/client.rb', line 1070 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.
1165 1166 1167 1168 |
# File 'lib/aws-sdk-rds/client.rb', line 1165 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
1405 1406 1407 1408 |
# File 'lib/aws-sdk-rds/client.rb', line 1405 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.
1531 1532 1533 1534 |
# File 'lib/aws-sdk-rds/client.rb', line 1531 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 [ What Is Amazon Aurora?] in the *Amazon Aurora User Guide.*
<note markdown=“1”> This action only applies to Aurora DB clusters.
</note>
[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
1999 2000 2001 2002 |
# File 'lib/aws-sdk-rds/client.rb', line 1999 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.
<note markdown=“1”> This action only applies to Aurora DB clusters.
</note>
2073 2074 2075 2076 |
# File 'lib/aws-sdk-rds/client.rb', line 2073 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 command 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.*
<note markdown=“1”> This action only applies to Aurora DB clusters.
</note>
[1]: console.aws.amazon.com/rds/ [2]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
2203 2204 2205 2206 |
# File 'lib/aws-sdk-rds/client.rb', line 2203 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.*
<note markdown=“1”> This action only applies to Aurora DB clusters.
</note>
[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
2310 2311 2312 2313 |
# File 'lib/aws-sdk-rds/client.rb', line 2310 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.
3323 3324 3325 3326 |
# File 'lib/aws-sdk-rds/client.rb', line 3323 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][1
-
in the
*Amazon RDS User Guide*.
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
3854 3855 3856 3857 |
# File 'lib/aws-sdk-rds/client.rb', line 3854 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.
3975 3976 3977 3978 |
# File 'lib/aws-sdk-rds/client.rb', line 3975 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>
4068 4069 4070 4071 |
# File 'lib/aws-sdk-rds/client.rb', line 4068 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.
4179 4180 4181 4182 |
# File 'lib/aws-sdk-rds/client.rb', line 4179 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.
4264 4265 4266 4267 |
# File 'lib/aws-sdk-rds/client.rb', line 4264 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.
4419 4420 4421 4422 |
# File 'lib/aws-sdk-rds/client.rb', line 4419 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 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.
<note markdown=“1”> This action only applies to Aurora DB clusters.
</note>
4502 4503 4504 4505 |
# File 'lib/aws-sdk-rds/client.rb', line 4502 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.
4615 4616 4617 4618 |
# File 'lib/aws-sdk-rds/client.rb', line 4615 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 [ What Is Amazon Aurora?] in the *Amazon Aurora User Guide.*
<note markdown=“1”> This action only applies to Aurora DB clusters.
</note>
[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
4777 4778 4779 4780 |
# File 'lib/aws-sdk-rds/client.rb', line 4777 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.
<note markdown=“1”> This action only applies to Aurora DB clusters.
</note>
4831 4832 4833 4834 |
# File 'lib/aws-sdk-rds/client.rb', line 4831 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.*
<note markdown=“1”> This action only applies to Aurora DB clusters.
</note>
[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
4883 4884 4885 4886 |
# File 'lib/aws-sdk-rds/client.rb', line 4883 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 [ What Is Amazon Aurora?] in the *Amazon Aurora User Guide.*
<note markdown=“1”> This action only applies to Aurora DB clusters.
</note>
[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
4966 4967 4968 4969 |
# File 'lib/aws-sdk-rds/client.rb', line 4966 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.
5203 5204 5205 5206 |
# File 'lib/aws-sdk-rds/client.rb', line 5203 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 based on the source instance’s ‘DbiResourceId` value or the restorable instance’s resource ID.
5256 5257 5258 5259 |
# File 'lib/aws-sdk-rds/client.rb', line 5256 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.
5296 5297 5298 5299 |
# File 'lib/aws-sdk-rds/client.rb', line 5296 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>
5346 5347 5348 5349 |
# File 'lib/aws-sdk-rds/client.rb', line 5346 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.
<note markdown=“1”> The DB snapshot must be in the ‘available` state to be deleted.
</note>
5426 5427 5428 5429 |
# File 'lib/aws-sdk-rds/client.rb', line 5426 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>
5473 5474 5475 5476 |
# File 'lib/aws-sdk-rds/client.rb', line 5473 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.
5528 5529 5530 5531 |
# File 'lib/aws-sdk-rds/client.rb', line 5528 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.
<note markdown=“1”> This action only applies to Aurora DB clusters.
</note>
5574 5575 5576 5577 |
# File 'lib/aws-sdk-rds/client.rb', line 5574 def delete_global_cluster(params = {}, = {}) req = build_request(:delete_global_cluster, params) req.send_request() end |
#delete_option_group(params = {}) ⇒ Struct
Deletes an existing option group.
5609 5610 5611 5612 |
# File 'lib/aws-sdk-rds/client.rb', line 5609 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.
5648 5649 5650 5651 |
# File 'lib/aws-sdk-rds/client.rb', line 5648 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.
5734 5735 5736 5737 |
# File 'lib/aws-sdk-rds/client.rb', line 5734 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 [ What Is Amazon Aurora?] in the *Amazon Aurora User Guide.*
<note markdown=“1”> This action only applies to Aurora DB clusters.
</note>
[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
5858 5859 5860 5861 |
# File 'lib/aws-sdk-rds/client.rb', line 5858 def describe_db_cluster_backtracks(params = {}, = {}) req = build_request(:describe_db_cluster_backtracks, params) req.send_request() end |
#describe_db_cluster_endpoints(params = {}) ⇒ Types::DBClusterEndpointMessage
Returns information about endpoints for an Amazon Aurora DB cluster.
<note markdown=“1”> This action only applies to Aurora DB clusters.
</note>
5947 5948 5949 5950 |
# File 'lib/aws-sdk-rds/client.rb', line 5947 def describe_db_cluster_endpoints(params = {}, = {}) req = build_request(:describe_db_cluster_endpoints, 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 [ What Is Amazon Aurora?] in the *Amazon Aurora User Guide.*
<note markdown=“1”> This action only applies to Aurora DB clusters.
</note>
[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
6043 6044 6045 6046 |
# File 'lib/aws-sdk-rds/client.rb', line 6043 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 [ What Is Amazon Aurora?] in the *Amazon Aurora User Guide.*
<note markdown=“1”> This action only applies to Aurora DB clusters.
</note>
[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
6151 6152 6153 6154 |
# File 'lib/aws-sdk-rds/client.rb', line 6151 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.
<note markdown=“1”> This action only applies to Aurora DB clusters.
</note>
6215 6216 6217 6218 |
# File 'lib/aws-sdk-rds/client.rb', line 6215 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 [ What Is Amazon Aurora?] in the *Amazon Aurora User Guide.*
<note markdown=“1”> This action only applies to Aurora DB clusters.
</note>
[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
6390 6391 6392 6393 |
# File 'lib/aws-sdk-rds/client.rb', line 6390 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 [ What Is Amazon Aurora?] in the *Amazon Aurora User Guide.*
<note markdown=“1”> This action only applies to Aurora DB clusters.
</note>
[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
6551 6552 6553 6554 |
# File 'lib/aws-sdk-rds/client.rb', line 6551 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.
6684 6685 6686 6687 |
# File 'lib/aws-sdk-rds/client.rb', line 6684 def describe_db_engine_versions(params = {}, = {}) req = build_request(:describe_db_engine_versions, params) req.send_request() end |
#describe_db_instance_automated_backups(params = {}) ⇒ Types::DBInstanceAutomatedBackupMessage
Displays backups for both current and deleted instances. For example, use this operation to find details about automated backups for previously deleted instances. Current instances with retention periods greater than zero (0) are returned for both the ‘DescribeDBInstanceAutomatedBackups` and `DescribeDBInstances` operations.
All parameters are optional.
6799 6800 6801 6802 |
# File 'lib/aws-sdk-rds/client.rb', line 6799 def describe_db_instance_automated_backups(params = {}, = {}) req = build_request(:describe_db_instance_automated_backups, params) req.send_request() end |
#describe_db_instances(params = {}) ⇒ Types::DBInstanceMessage
Returns information about provisioned RDS instances. This API supports pagination.
7001 7002 7003 7004 |
# File 'lib/aws-sdk-rds/client.rb', line 7001 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.
7095 7096 7097 7098 |
# File 'lib/aws-sdk-rds/client.rb', line 7095 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.
7178 7179 7180 7181 |
# File 'lib/aws-sdk-rds/client.rb', line 7178 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.
7277 7278 7279 7280 |
# File 'lib/aws-sdk-rds/client.rb', line 7277 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.
7362 7363 7364 7365 |
# File 'lib/aws-sdk-rds/client.rb', line 7362 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.
7421 7422 7423 7424 |
# File 'lib/aws-sdk-rds/client.rb', line 7421 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.
7610 7611 7612 7613 |
# File 'lib/aws-sdk-rds/client.rb', line 7610 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].
7697 7698 7699 7700 |
# File 'lib/aws-sdk-rds/client.rb', line 7697 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 [ What Is Amazon Aurora?] in the *Amazon Aurora User Guide.*
[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
7790 7791 7792 7793 |
# File 'lib/aws-sdk-rds/client.rb', line 7790 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.
7875 7876 7877 7878 |
# File 'lib/aws-sdk-rds/client.rb', line 7875 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
7938 7939 7940 7941 |
# File 'lib/aws-sdk-rds/client.rb', line 7938 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.
8026 8027 8028 8029 |
# File 'lib/aws-sdk-rds/client.rb', line 8026 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.
8171 8172 8173 8174 |
# File 'lib/aws-sdk-rds/client.rb', line 8171 def describe_events(params = {}, = {}) req = build_request(:describe_events, params) req.send_request() end |
#describe_global_clusters(params = {}) ⇒ Types::GlobalClustersMessage
Returns information about Aurora global database clusters. This API supports pagination.
For more information on Amazon Aurora, see [ What Is Amazon Aurora?] in the *Amazon Aurora User Guide.*
<note markdown=“1”> This action only applies to Aurora DB clusters.
</note>
[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
8270 8271 8272 8273 |
# File 'lib/aws-sdk-rds/client.rb', line 8270 def describe_global_clusters(params = {}, = {}) req = build_request(:describe_global_clusters, params) req.send_request() end |
#describe_option_group_options(params = {}) ⇒ Types::OptionGroupOptionsMessage
Describes all available options.
8376 8377 8378 8379 |
# File 'lib/aws-sdk-rds/client.rb', line 8376 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.
8489 8490 8491 8492 |
# File 'lib/aws-sdk-rds/client.rb', line 8489 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.
8612 8613 8614 8615 |
# File 'lib/aws-sdk-rds/client.rb', line 8612 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.
8703 8704 8705 8706 |
# File 'lib/aws-sdk-rds/client.rb', line 8703 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.
8832 8833 8834 8835 |
# File 'lib/aws-sdk-rds/client.rb', line 8832 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.
8956 8957 8958 8959 |
# File 'lib/aws-sdk-rds/client.rb', line 8956 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.
9088 9089 9090 9091 |
# File 'lib/aws-sdk-rds/client.rb', line 9088 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.
9134 9135 9136 9137 |
# File 'lib/aws-sdk-rds/client.rb', line 9134 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.
9225 9226 9227 9228 |
# File 'lib/aws-sdk-rds/client.rb', line 9225 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 [ What Is Amazon Aurora?] in the *Amazon Aurora User Guide.*
<note markdown=“1”> This action only applies to Aurora DB clusters.
</note>
[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
9368 9369 9370 9371 |
# File 'lib/aws-sdk-rds/client.rb', line 9368 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] in the *Amazon RDS User Guide*.
[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.Tagging.html
9434 9435 9436 9437 |
# File 'lib/aws-sdk-rds/client.rb', line 9434 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 Aurora 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 Aurora User Guide*.
<note markdown=“1”> This action only applies to Aurora DB clusters.
</note>
[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html [2]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.how-it-works.html#aurora-serverless.how-it-works.auto-scaling
9537 9538 9539 9540 |
# File 'lib/aws-sdk-rds/client.rb', line 9537 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 [ What Is Amazon Aurora?] in the *Amazon Aurora User Guide.*
<note markdown=“1”> This action only applies to Aurora DB clusters.
</note>
[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
9879 9880 9881 9882 |
# File 'lib/aws-sdk-rds/client.rb', line 9879 def modify_db_cluster(params = {}, = {}) req = build_request(:modify_db_cluster, params) req.send_request() end |
#modify_db_cluster_endpoint(params = {}) ⇒ Types::DBClusterEndpoint
Modifies the properties of an endpoint in an Amazon Aurora DB cluster.
<note markdown=“1”> This action only applies to Aurora DB clusters.
</note>
9947 9948 9949 9950 |
# File 'lib/aws-sdk-rds/client.rb', line 9947 def modify_db_cluster_endpoint(params = {}, = {}) req = build_request(:modify_db_cluster_endpoint, 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 [ What Is Amazon Aurora?] in the *Amazon Aurora 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.
<note markdown=“1”> This action only applies to Aurora DB clusters.
</note>
[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html [2]: console.aws.amazon.com/rds/
10046 10047 10048 10049 |
# File 'lib/aws-sdk-rds/client.rb', line 10046 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.
<note markdown=“1”> This action only applies to Aurora DB clusters.
</note>
10156 10157 10158 10159 |
# File 'lib/aws-sdk-rds/client.rb', line 10156 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.
10936 10937 10938 10939 |
# File 'lib/aws-sdk-rds/client.rb', line 10936 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.
11046 11047 11048 11049 |
# File 'lib/aws-sdk-rds/client.rb', line 11046 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.
11140 11141 11142 11143 |
# File 'lib/aws-sdk-rds/client.rb', line 11140 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.
11238 11239 11240 11241 |
# File 'lib/aws-sdk-rds/client.rb', line 11238 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.
11308 11309 11310 11311 |
# File 'lib/aws-sdk-rds/client.rb', line 11308 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
11411 11412 11413 11414 |
# File 'lib/aws-sdk-rds/client.rb', line 11411 def modify_event_subscription(params = {}, = {}) req = build_request(:modify_event_subscription, params) req.send_request() end |
#modify_global_cluster(params = {}) ⇒ Types::ModifyGlobalClusterResult
Modify a setting for an Amazon Aurora global cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see [ What Is Amazon Aurora?] in the *Amazon Aurora User Guide.*
<note markdown=“1”> This action only applies to Aurora DB clusters.
</note>
[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
11493 11494 11495 11496 |
# File 'lib/aws-sdk-rds/client.rb', line 11493 def modify_global_cluster(params = {}, = {}) req = build_request(:modify_global_cluster, params) req.send_request() end |
#modify_option_group(params = {}) ⇒ Types::ModifyOptionGroupResult
Modifies an existing option group.
11616 11617 11618 11619 |
# File 'lib/aws-sdk-rds/client.rb', line 11616 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>
11833 11834 11835 11836 |
# File 'lib/aws-sdk-rds/client.rb', line 11833 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.
<note markdown=“1”> This action only applies to Aurora DB clusters.
</note>
11937 11938 11939 11940 |
# File 'lib/aws-sdk-rds/client.rb', line 11937 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.
12025 12026 12027 12028 |
# File 'lib/aws-sdk-rds/client.rb', line 12025 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] in the *Amazon RDS User Guide.*
[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_RebootInstance.html
12208 12209 12210 12211 |
# File 'lib/aws-sdk-rds/client.rb', line 12208 def reboot_db_instance(params = {}, = {}) req = build_request(:reboot_db_instance, params) req.send_request() end |
#remove_from_global_cluster(params = {}) ⇒ Types::RemoveFromGlobalClusterResult
Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary cluster in a different region.
<note markdown=“1”> This action only applies to Aurora DB clusters.
</note>
12262 12263 12264 12265 |
# File 'lib/aws-sdk-rds/client.rb', line 12262 def remove_from_global_cluster(params = {}, = {}) req = build_request(:remove_from_global_cluster, params) req.send_request() end |
#remove_role_from_db_cluster(params = {}) ⇒ Struct
Disassociates an AWS 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 ][1] in the *Amazon Aurora User Guide*.
<note markdown=“1”> This action only applies to Aurora DB clusters.
</note>
[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Integrating.Authorizing.html
12301 12302 12303 12304 |
# File 'lib/aws-sdk-rds/client.rb', line 12301 def remove_role_from_db_cluster(params = {}, = {}) req = build_request(:remove_role_from_db_cluster, params) req.send_request() end |
#remove_role_from_db_instance(params = {}) ⇒ Struct
Disassociates an AWS Identity and Access Management (IAM) role from a DB instance.
12336 12337 12338 12339 |
# File 'lib/aws-sdk-rds/client.rb', line 12336 def remove_role_from_db_instance(params = {}, = {}) req = build_request(:remove_role_from_db_instance, params) req.send_request() end |
#remove_source_identifier_from_subscription(params = {}) ⇒ Types::RemoveSourceIdentifierFromSubscriptionResult
Removes a source identifier from an existing RDS event notification subscription.
12399 12400 12401 12402 |
# File 'lib/aws-sdk-rds/client.rb', line 12399 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] in the *Amazon RDS User Guide.*
[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.Tagging.html
12451 12452 12453 12454 |
# File 'lib/aws-sdk-rds/client.rb', line 12451 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 [ What Is Amazon Aurora?] in the *Amazon Aurora User Guide.*
<note markdown=“1”> This action only applies to Aurora DB clusters.
</note>
[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
12541 12542 12543 12544 |
# File 'lib/aws-sdk-rds/client.rb', line 12541 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.
12645 12646 12647 12648 |
# File 'lib/aws-sdk-rds/client.rb', line 12645 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 to an Amazon Aurora MySQL DB Cluster] in the *Amazon Aurora User Guide*.
<note markdown=“1”> This action only applies to Aurora DB clusters.
</note>
[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Migrating.html
13022 13023 13024 13025 |
# File 'lib/aws-sdk-rds/client.rb', line 13022 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 [ What Is Amazon Aurora?] in the *Amazon Aurora User Guide.*
<note markdown=“1”> This action only applies to Aurora DB clusters.
</note>
[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
13327 13328 13329 13330 |
# File 'lib/aws-sdk-rds/client.rb', line 13327 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 [ What Is Amazon Aurora?] in the *Amazon Aurora User Guide.*
<note markdown=“1”> This action only applies to Aurora DB clusters.
</note>
[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html
13653 13654 13655 13656 |
# File 'lib/aws-sdk-rds/client.rb', line 13653 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>
14201 14202 14203 14204 |
# File 'lib/aws-sdk-rds/client.rb', line 14201 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] in the *Amazon RDS User Guide.*
[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/MySQL.Procedural.Importing.html
14735 14736 14737 14738 |
# File 'lib/aws-sdk-rds/client.rb', line 14735 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>
15289 15290 15291 15292 |
# File 'lib/aws-sdk-rds/client.rb', line 15289 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).
15378 15379 15380 15381 |
# File 'lib/aws-sdk-rds/client.rb', line 15378 def revoke_db_security_group_ingress(params = {}, = {}) req = build_request(:revoke_db_security_group_ingress, params) req.send_request() end |
#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.
For more information, see [ Stopping and Starting an Aurora Cluster] in the *Amazon Aurora User Guide.*
<note markdown=“1”> This action only applies to Aurora DB clusters.
</note>
[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-cluster-stop-start.html
15483 15484 15485 15486 |
# File 'lib/aws-sdk-rds/client.rb', line 15483 def start_db_cluster(params = {}, = {}) req = build_request(:start_db_cluster, params) req.send_request() end |
#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.
For more information, see [ Starting an Amazon RDS DB instance That Was Previously Stopped] in the *Amazon RDS User Guide.*
<note markdown=“1”> This command doesn’t apply to Aurora MySQL and Aurora PostgreSQL. For Aurora DB clusters, use StartDBCluster instead.
</note>
[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_StartInstance.html
15636 15637 15638 15639 |
# File 'lib/aws-sdk-rds/client.rb', line 15636 def start_db_instance(params = {}, = {}) req = build_request(:start_db_instance, params) req.send_request() end |
#stop_db_cluster(params = {}) ⇒ Types::StopDBClusterResult
Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster’s metadata, including its endpoints and DB parameter groups. Aurora also retains the transaction logs so you can do a point-in-time restore if necessary.
For more information, see [ Stopping and Starting an Aurora Cluster] in the *Amazon Aurora User Guide.*
<note markdown=“1”> This action only applies to Aurora DB clusters.
</note>
[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-cluster-stop-start.html
15742 15743 15744 15745 |
# File 'lib/aws-sdk-rds/client.rb', line 15742 def stop_db_cluster(params = {}, = {}) req = build_request(:stop_db_cluster, params) req.send_request() end |
#stop_db_instance(params = {}) ⇒ Types::StopDBInstanceResult
Stops an Amazon RDS 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 an Amazon RDS DB Instance Temporarily] in the *Amazon RDS User Guide.*
<note markdown=“1”> This command doesn’t apply to Aurora MySQL and Aurora PostgreSQL. For Aurora clusters, use StopDBCluster instead.
</note>
[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_StopInstance.html
15902 15903 15904 15905 |
# File 'lib/aws-sdk-rds/client.rb', line 15902 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 |
16015 16016 16017 16018 16019 |
# File 'lib/aws-sdk-rds/client.rb', line 16015 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.
16023 16024 16025 |
# File 'lib/aws-sdk-rds/client.rb', line 16023 def waiter_names waiters.keys end |