You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::RDS::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::RDS::Client
- Defined in:
- (unknown)
Overview
An API client for Amazon Relational Database Service. To construct a client, you need to configure a :region
and :credentials
.
rds = Aws::RDS::Client.new(
region: region_name,
credentials: credentials,
# ...
)
See #initialize for a full list of supported configuration options.
Region
You can configure a default region in the following locations:
ENV['AWS_REGION']
Aws.config[:region]
Go here for a list of supported regions.
Credentials
Default credentials are loaded automatically from the following locations:
ENV['AWS_ACCESS_KEY_ID']
andENV['AWS_SECRET_ACCESS_KEY']
Aws.config[:credentials]
- The shared credentials ini file at
~/.aws/credentials
(more information) - From an instance profile when running on EC2
You can also construct a credentials object from one of the following classes:
Alternatively, you configure credentials with :access_key_id
and
:secret_access_key
:
# load credentials from disk
creds = YAML.load(File.read('/path/to/secrets'))
Aws::RDS::Client.new(
access_key_id: creds['access_key_id'],
secret_access_key: creds['secret_access_key']
)
Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
Constructor collapse
-
#initialize(options = {}) ⇒ Aws::RDS::Client
constructor
Constructs an API client.
API Operations collapse
-
#add_role_to_db_cluster(options = {}) ⇒ Struct
Associates an Identity and Access Management (IAM) role from an Amazon Aurora DB cluster.
-
#add_role_to_db_instance(options = {}) ⇒ Struct
Associates an AWS Identity and Access Management (IAM) role with a DB instance.
To add a role to a DB instance, the status of the DB instance must be
available
. -
#add_source_identifier_to_subscription(options = {}) ⇒ Types::AddSourceIdentifierToSubscriptionResult
Adds a source identifier to an existing RDS event notification subscription.
.
-
#add_tags_to_resource(options = {}) ⇒ Struct
Adds metadata tags to an Amazon RDS resource.
-
#apply_pending_maintenance_action(options = {}) ⇒ Types::ApplyPendingMaintenanceActionResult
Applies a pending maintenance action to a resource (for example, to a DB instance).
.
-
#authorize_db_security_group_ingress(options = {}) ⇒ Types::AuthorizeDBSecurityGroupIngressResult
Enables ingress to a DBSecurityGroup using one of two forms of authorization.
-
#backtrack_db_cluster(options = {}) ⇒ 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.
This action only applies to Aurora DB clusters.
-
#copy_db_cluster_parameter_group(options = {}) ⇒ Types::CopyDBClusterParameterGroupResult
Copies the specified DB cluster parameter group.
This action only applies to Aurora DB clusters.
-
#copy_db_cluster_snapshot(options = {}) ⇒ 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.
-
#copy_db_parameter_group(options = {}) ⇒ Types::CopyDBParameterGroupResult
Copies the specified DB parameter group.
.
-
#copy_db_snapshot(options = {}) ⇒ Types::CopyDBSnapshotResult
Copies the specified DB snapshot.
-
#copy_option_group(options = {}) ⇒ Types::CopyOptionGroupResult
Copies the specified option group.
.
-
#create_custom_availability_zone(options = {}) ⇒ Types::CreateCustomAvailabilityZoneResult
Creates a custom Availability Zone (AZ).
A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster.
For more information about RDS on VMware, see the RDS on VMware User Guide.
. -
#create_db_cluster(options = {}) ⇒ 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. -
#create_db_cluster_endpoint(options = {}) ⇒ Types::DBClusterEndpoint
Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.
This action only applies to Aurora DB clusters.
-
#create_db_cluster_parameter_group(options = {}) ⇒ 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.
-
#create_db_cluster_snapshot(options = {}) ⇒ Types::CreateDBClusterSnapshotResult
Creates a snapshot of a DB cluster.
-
#create_db_instance(options = {}) ⇒ Types::CreateDBInstanceResult
Creates a new DB instance.
.
-
#create_db_instance_read_replica(options = {}) ⇒ Types::CreateDBInstanceReadReplicaResult
Creates a new DB instance that acts as a Read Replica for an existing source DB instance.
-
#create_db_parameter_group(options = {}) ⇒ 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.
-
#create_db_proxy(options = {}) ⇒ Types::CreateDBProxyResponse
This is prerelease documentation for the RDS Database Proxy feature in preview release.
-
#create_db_security_group(options = {}) ⇒ Types::CreateDBSecurityGroupResult
Creates a new DB security group.
-
#create_db_snapshot(options = {}) ⇒ Types::CreateDBSnapshotResult
Creates a DBSnapshot.
-
#create_db_subnet_group(options = {}) ⇒ Types::CreateDBSubnetGroupResult
Creates a new DB subnet group.
-
#create_event_subscription(options = {}) ⇒ Types::CreateEventSubscriptionResult
Creates an RDS event notification subscription.
-
#create_global_cluster(options = {}) ⇒ Types::CreateGlobalClusterResult
Creates an Aurora global database spread across multiple regions.
-
#create_option_group(options = {}) ⇒ Types::CreateOptionGroupResult
Creates a new option group.
-
#delete_custom_availability_zone(options = {}) ⇒ Types::DeleteCustomAvailabilityZoneResult
Deletes a custom Availability Zone (AZ).
A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster.
For more information about RDS on VMware, see the RDS on VMware User Guide.
. -
#delete_db_cluster(options = {}) ⇒ Types::DeleteDBClusterResult
The DeleteDBCluster action deletes a previously provisioned DB cluster.
-
#delete_db_cluster_endpoint(options = {}) ⇒ Types::DBClusterEndpoint
Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster.
This action only applies to Aurora DB clusters.
-
#delete_db_cluster_parameter_group(options = {}) ⇒ Struct
Deletes a specified DB cluster parameter group.
-
#delete_db_cluster_snapshot(options = {}) ⇒ Types::DeleteDBClusterSnapshotResult
Deletes a DB cluster snapshot.
-
#delete_db_instance(options = {}) ⇒ Types::DeleteDBInstanceResult
The DeleteDBInstance action deletes a previously provisioned DB instance.
-
#delete_db_instance_automated_backup(options = {}) ⇒ Types::DeleteDBInstanceAutomatedBackupResult
Deletes automated backups based on the source instance's
DbiResourceId
value or the restorable instance's resource ID..
-
#delete_db_parameter_group(options = {}) ⇒ Struct
Deletes a specified DB parameter group.
-
#delete_db_proxy(options = {}) ⇒ Types::DeleteDBProxyResponse
This is prerelease documentation for the RDS Database Proxy feature in preview release.
-
#delete_db_security_group(options = {}) ⇒ Struct
Deletes a DB security group.
The specified DB security group must not be associated with any DB instances.
-
#delete_db_snapshot(options = {}) ⇒ Types::DeleteDBSnapshotResult
Deletes a DB snapshot.
-
#delete_db_subnet_group(options = {}) ⇒ Struct
Deletes a DB subnet group.
The specified database subnet group must not be associated with any DB instances.
-
#delete_event_subscription(options = {}) ⇒ Types::DeleteEventSubscriptionResult
Deletes an RDS event notification subscription.
.
-
#delete_global_cluster(options = {}) ⇒ Types::DeleteGlobalClusterResult
Deletes a global database cluster.
-
#delete_installation_media(options = {}) ⇒ Types::InstallationMedia
Deletes the installation medium for a DB engine that requires an on-premises customer provided license, such as Microsoft SQL Server.
.
-
#delete_option_group(options = {}) ⇒ Struct
Deletes an existing option group.
.
-
#deregister_db_proxy_targets(options = {}) ⇒ Struct
This is prerelease documentation for the RDS Database Proxy feature in preview release.
-
#describe_account_attributes(options = {}) ⇒ Types::AccountAttributesMessage
Lists all of the attributes for a customer account.
-
#describe_certificates(options = {}) ⇒ Types::CertificateMessage
Lists the set of CA certificates provided by Amazon RDS for this AWS account.
.
-
#describe_custom_availability_zones(options = {}) ⇒ Types::CustomAvailabilityZoneMessage
Returns information about custom Availability Zones (AZs).
A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster.
For more information about RDS on VMware, see the RDS on VMware User Guide.
. -
#describe_db_cluster_backtracks(options = {}) ⇒ 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.
This action only applies to Aurora DB clusters.
-
#describe_db_cluster_endpoints(options = {}) ⇒ Types::DBClusterEndpointMessage
Returns information about endpoints for an Amazon Aurora DB cluster.
This action only applies to Aurora DB clusters.
-
#describe_db_cluster_parameter_groups(options = {}) ⇒ Types::DBClusterParameterGroupsMessage
Returns a list of
DBClusterParameterGroup
descriptions. -
#describe_db_cluster_parameters(options = {}) ⇒ 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.
This action only applies to Aurora DB clusters.
-
#describe_db_cluster_snapshot_attributes(options = {}) ⇒ 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 therestore
attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the manual DB cluster snapshot. -
#describe_db_cluster_snapshots(options = {}) ⇒ Types::DBClusterSnapshotMessage
Returns information about DB cluster snapshots.
-
#describe_db_clusters(options = {}) ⇒ Types::DBClusterMessage
Returns information about provisioned Aurora DB clusters.
-
#describe_db_engine_versions(options = {}) ⇒ Types::DBEngineVersionMessage
Returns a list of the available DB engines.
.
-
#describe_db_instance_automated_backups(options = {}) ⇒ Types::DBInstanceAutomatedBackupMessage
Displays backups for both current and deleted instances.
-
#describe_db_instances(options = {}) ⇒ Types::DBInstanceMessage
Returns information about provisioned RDS instances.
-
#describe_db_log_files(options = {}) ⇒ Types::DescribeDBLogFilesResponse
Returns a list of DB log files for the DB instance.
.
-
#describe_db_parameter_groups(options = {}) ⇒ Types::DBParameterGroupsMessage
Returns a list of
DBParameterGroup
descriptions. -
#describe_db_parameters(options = {}) ⇒ Types::DBParameterGroupDetails
Returns the detailed parameter list for a particular DB parameter group.
.
-
#describe_db_proxies(options = {}) ⇒ Types::DescribeDBProxiesResponse
This is prerelease documentation for the RDS Database Proxy feature in preview release.
-
#describe_db_proxy_target_groups(options = {}) ⇒ Types::DescribeDBProxyTargetGroupsResponse
This is prerelease documentation for the RDS Database Proxy feature in preview release.
-
#describe_db_proxy_targets(options = {}) ⇒ Types::DescribeDBProxyTargetsResponse
This is prerelease documentation for the RDS Database Proxy feature in preview release.
-
#describe_db_security_groups(options = {}) ⇒ Types::DBSecurityGroupMessage
Returns a list of
DBSecurityGroup
descriptions. -
#describe_db_snapshot_attributes(options = {}) ⇒ 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 therestore
attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the manual DB snapshot. -
#describe_db_snapshots(options = {}) ⇒ Types::DBSnapshotMessage
Returns information about DB snapshots.
-
#describe_db_subnet_groups(options = {}) ⇒ Types::DBSubnetGroupMessage
Returns a list of DBSubnetGroup descriptions.
-
#describe_engine_default_cluster_parameters(options = {}) ⇒ 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.
. -
#describe_engine_default_parameters(options = {}) ⇒ Types::DescribeEngineDefaultParametersResult
Returns the default engine and system parameter information for the specified database engine.
.
-
#describe_event_categories(options = {}) ⇒ Types::EventCategoriesMessage
Displays a list of categories for all event source types, or, if specified, for a specified source type.
-
#describe_event_subscriptions(options = {}) ⇒ Types::EventSubscriptionsMessage
Lists all the subscription descriptions for a customer account.
-
#describe_events(options = {}) ⇒ 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(options = {}) ⇒ Types::GlobalClustersMessage
Returns information about Aurora global database clusters.
-
#describe_installation_media(options = {}) ⇒ Types::InstallationMediaMessage
Describes the available installation media for a DB engine that requires an on-premises customer provided license, such as Microsoft SQL Server.
.
-
#describe_option_group_options(options = {}) ⇒ Types::OptionGroupOptionsMessage
Describes all available options.
.
-
#describe_option_groups(options = {}) ⇒ Types::OptionGroups
Describes the available option groups.
.
-
#describe_orderable_db_instance_options(options = {}) ⇒ Types::OrderableDBInstanceOptionsMessage
Returns a list of orderable DB instance options for the specified engine.
.
-
#describe_pending_maintenance_actions(options = {}) ⇒ Types::PendingMaintenanceActionsMessage
Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
.
-
#describe_reserved_db_instances(options = {}) ⇒ Types::ReservedDBInstanceMessage
Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
.
-
#describe_reserved_db_instances_offerings(options = {}) ⇒ Types::ReservedDBInstancesOfferingMessage
Lists available reserved DB instance offerings.
.
-
#describe_source_regions(options = {}) ⇒ 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(options = {}) ⇒ Types::DescribeValidDBInstanceModificationsResult
You can call
DescribeValidDBInstanceModifications
to learn what modifications you can make to your DB instance. -
#download_db_log_file_portion(options = {}) ⇒ Types::DownloadDBLogFilePortionDetails
Downloads all or a portion of the specified log file, up to 1 MB in size.
.
-
#failover_db_cluster(options = {}) ⇒ 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.
-
#import_installation_media(options = {}) ⇒ Types::InstallationMedia
Imports the installation media for a DB engine that requires an on-premises customer provided license, such as SQL Server.
.
-
#list_tags_for_resource(options = {}) ⇒ 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.
. -
#modify_current_db_cluster_capacity(options = {}) ⇒ 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.
-
#modify_db_cluster(options = {}) ⇒ Types::ModifyDBClusterResult
Modify a setting for an Amazon Aurora DB cluster.
-
#modify_db_cluster_endpoint(options = {}) ⇒ Types::DBClusterEndpoint
Modifies the properties of an endpoint in an Amazon Aurora DB cluster.
This action only applies to Aurora DB clusters.
-
#modify_db_cluster_parameter_group(options = {}) ⇒ Types::DBClusterParameterGroupNameMessage
Modifies the parameters of a DB cluster parameter group.
-
#modify_db_cluster_snapshot_attribute(options = {}) ⇒ 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 theAttributeName
and use theValuesToAdd
parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual DB cluster snapshot. -
#modify_db_instance(options = {}) ⇒ Types::ModifyDBInstanceResult
Modifies settings for a DB instance.
-
#modify_db_parameter_group(options = {}) ⇒ Types::DBParameterGroupNameMessage
Modifies the parameters of a DB parameter group.
-
#modify_db_proxy(options = {}) ⇒ Types::ModifyDBProxyResponse
This is prerelease documentation for the RDS Database Proxy feature in preview release.
-
#modify_db_proxy_target_group(options = {}) ⇒ Types::ModifyDBProxyTargetGroupResponse
This is prerelease documentation for the RDS Database Proxy feature in preview release.
-
#modify_db_snapshot(options = {}) ⇒ Types::ModifyDBSnapshotResult
Updates a manual DB snapshot, which can be encrypted or not encrypted, with a new engine version.
-
#modify_db_snapshot_attribute(options = {}) ⇒ 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 theAttributeName
and use theValuesToAdd
parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual DB snapshot. -
#modify_db_subnet_group(options = {}) ⇒ Types::ModifyDBSubnetGroupResult
Modifies an existing DB subnet group.
-
#modify_event_subscription(options = {}) ⇒ Types::ModifyEventSubscriptionResult
Modifies an existing RDS event notification subscription.
-
#modify_global_cluster(options = {}) ⇒ Types::ModifyGlobalClusterResult
Modify a setting for an Amazon Aurora global cluster.
-
#modify_option_group(options = {}) ⇒ Types::ModifyOptionGroupResult
Modifies an existing option group.
.
-
#promote_read_replica(options = {}) ⇒ Types::PromoteReadReplicaResult
Promotes a Read Replica DB instance to a standalone DB instance.
-
Backup duration is a function of the amount of changes to the database since the previous backup.
-
-
#promote_read_replica_db_cluster(options = {}) ⇒ Types::PromoteReadReplicaDBClusterResult
Promotes a Read Replica DB cluster to a standalone DB cluster.
This action only applies to Aurora DB clusters.
-
#purchase_reserved_db_instances_offering(options = {}) ⇒ Types::PurchaseReservedDBInstancesOfferingResult
Purchases a reserved DB instance offering.
.
-
#reboot_db_instance(options = {}) ⇒ Types::RebootDBInstanceResult
You might need to reboot your DB instance, usually for maintenance reasons.
-
#register_db_proxy_targets(options = {}) ⇒ Types::RegisterDBProxyTargetsResponse
This is prerelease documentation for the RDS Database Proxy feature in preview release.
-
#remove_from_global_cluster(options = {}) ⇒ Types::RemoveFromGlobalClusterResult
Detaches an Aurora secondary cluster from an Aurora global database cluster.
-
#remove_role_from_db_cluster(options = {}) ⇒ Struct
Disassociates an AWS Identity and Access Management (IAM) role from an Amazon Aurora DB cluster.
-
#remove_role_from_db_instance(options = {}) ⇒ Struct
Disassociates an AWS Identity and Access Management (IAM) role from a DB instance.
.
-
#remove_source_identifier_from_subscription(options = {}) ⇒ Types::RemoveSourceIdentifierFromSubscriptionResult
Removes a source identifier from an existing RDS event notification subscription.
.
-
#remove_tags_from_resource(options = {}) ⇒ 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.
. -
#reset_db_cluster_parameter_group(options = {}) ⇒ Types::DBClusterParameterGroupNameMessage
Modifies the parameters of a DB cluster parameter group to the default value.
-
#reset_db_parameter_group(options = {}) ⇒ Types::DBParameterGroupNameMessage
Modifies the parameters of a DB parameter group to the engine/system default value.
-
#restore_db_cluster_from_s3(options = {}) ⇒ Types::RestoreDBClusterFromS3Result
Creates an Amazon Aurora DB cluster from data stored in an Amazon S3 bucket.
-
#restore_db_cluster_from_snapshot(options = {}) ⇒ 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.
-
#restore_db_cluster_to_point_in_time(options = {}) ⇒ Types::RestoreDBClusterToPointInTimeResult
Restores a DB cluster to an arbitrary point in time.
-
#restore_db_instance_from_db_snapshot(options = {}) ⇒ Types::RestoreDBInstanceFromDBSnapshotResult
Creates a new DB instance from a DB snapshot.
-
#restore_db_instance_from_s3(options = {}) ⇒ Types::RestoreDBInstanceFromS3Result
Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files.
-
#restore_db_instance_to_point_in_time(options = {}) ⇒ Types::RestoreDBInstanceToPointInTimeResult
Restores a DB instance to an arbitrary point in time.
-
#revoke_db_security_group_ingress(options = {}) ⇒ Types::RevokeDBSecurityGroupIngressResult
Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC Security Groups.
-
#start_activity_stream(options = {}) ⇒ Types::StartActivityStreamResponse
Starts a database activity stream to monitor activity on the database.
-
#start_db_cluster(options = {}) ⇒ 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.
This action only applies to Aurora DB clusters.
-
#start_db_instance(options = {}) ⇒ 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_activity_stream(options = {}) ⇒ Types::StopActivityStreamResponse
Stops a database activity stream that was started using the AWS console, the
start-activity-stream
AWS CLI command, or theStartActivityStream
action.For more information, see Database Activity Streams in the Amazon Aurora User Guide.
. -
#stop_db_cluster(options = {}) ⇒ Types::StopDBClusterResult
Stops an Amazon Aurora DB cluster.
-
#stop_db_instance(options = {}) ⇒ Types::StopDBInstanceResult
Stops an Amazon RDS DB instance.
Instance Method Summary collapse
-
#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean
Waiters polls an API operation until a resource enters a desired state.
-
#waiter_names ⇒ Array<Symbol>
Returns the list of supported waiters.
Methods inherited from Seahorse::Client::Base
add_plugin, api, #build_request, clear_plugins, define, new, #operation, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options = {}) ⇒ Aws::RDS::Client
Constructs an API client.
Instance Method Details
#add_role_to_db_cluster(options = {}) ⇒ 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.
This action only applies to Aurora DB clusters.
#add_role_to_db_instance(options = {}) ⇒ Struct
Associates an AWS Identity and Access Management (IAM) role with a DB instance.
To add a role to a DB instance, the status of the DB instance must be available
.
#add_source_identifier_to_subscription(options = {}) ⇒ Types::AddSourceIdentifierToSubscriptionResult
Adds a source identifier to an existing RDS event notification subscription.
#add_tags_to_resource(options = {}) ⇒ 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.
#apply_pending_maintenance_action(options = {}) ⇒ Types::ApplyPendingMaintenanceActionResult
Applies a pending maintenance action to a resource (for example, to a DB instance).
#authorize_db_security_group_ingress(options = {}) ⇒ Types::AuthorizeDBSecurityGroupIngressResult
Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the Internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).
You can't authorize ingress from an EC2 security group in one 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.
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
#backtrack_db_cluster(options = {}) ⇒ 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.
This action only applies to Aurora DB clusters.
#copy_db_cluster_parameter_group(options = {}) ⇒ Types::CopyDBClusterParameterGroupResult
Copies the specified DB cluster parameter group.
This action only applies to Aurora DB clusters.
#copy_db_cluster_snapshot(options = {}) ⇒ Types::CopyDBClusterSnapshotResult
Copies a snapshot of a DB cluster.
To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier
must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.
You can copy an encrypted DB cluster snapshot from another AWS Region. In that case, the AWS Region where you call the CopyDBClusterSnapshot
action is the destination AWS Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another AWS Region, you must provide the following values:
-
KmsKeyId
- The AWS Key Management System (AWS KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. -
PreSignedUrl
- A URL that contains a Signature Version 4 signed request for theCopyDBClusterSnapshot
action to be called in the source AWS Region where the DB cluster snapshot is copied from. The pre-signed URL must be a valid request for theCopyDBClusterSnapshot
API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied.The pre-signed URL request must contain the following parameter values:
-
KmsKeyId
- The 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 theCopyDBClusterSnapshot
action that is called in the destination AWS Region, and the action contained in the pre-signed URL. -
DestinationRegion
- The name of the AWS Region that the DB cluster snapshot 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 yourSourceDBClusterSnapshotIdentifier
looks like the following example:arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115
.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.
If you are using an AWS SDK tool or the AWS CLI, you can specify
SourceRegion
(or--source-region
for the AWS CLI) instead of specifyingPreSignedUrl
manually. SpecifyingSourceRegion
autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source AWS Region. -
-
TargetDBClusterSnapshotIdentifier
- The identifier for the new copy of the DB cluster snapshot in the destination AWS Region. -
SourceDBClusterSnapshotIdentifier
- The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the ARN format for the source AWS Region and is the same value as theSourceDBClusterSnapshotIdentifier
in the pre-signed URL.
To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified by TargetDBClusterSnapshotIdentifier
while that DB cluster snapshot is in "copying" status.
For more information on copying encrypted DB cluster snapshots from one AWS Region to another, see Copying a Snapshot in the Amazon Aurora User Guide.
For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.
This action only applies to Aurora DB clusters.
#copy_db_parameter_group(options = {}) ⇒ Types::CopyDBParameterGroupResult
Copies the specified DB parameter group.
#copy_db_snapshot(options = {}) ⇒ 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.
#copy_option_group(options = {}) ⇒ Types::CopyOptionGroupResult
Copies the specified option group.
#create_custom_availability_zone(options = {}) ⇒ Types::CreateCustomAvailabilityZoneResult
Creates a custom Availability Zone (AZ).
A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster.
For more information about RDS on VMware, see the RDS on VMware User Guide.
#create_db_cluster(options = {}) ⇒ 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.
This action only applies to Aurora DB clusters.
#create_db_cluster_endpoint(options = {}) ⇒ Types::DBClusterEndpoint
Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.
This action only applies to Aurora DB clusters.
#create_db_cluster_parameter_group(options = {}) ⇒ Types::CreateDBClusterParameterGroupResult
Creates a new DB cluster parameter group.
Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.
A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup
. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster
. When you associate a new DB cluster parameter group with a running DB cluster, you need to reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.
After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database
parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters
action to verify that your DB cluster parameter group has been created or modified.
For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.
This action only applies to Aurora DB clusters.
#create_db_cluster_snapshot(options = {}) ⇒ 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.
This action only applies to Aurora DB clusters.
#create_db_instance(options = {}) ⇒ Types::CreateDBInstanceResult
Creates a new DB instance.
#create_db_instance_read_replica(options = {}) ⇒ Types::CreateDBInstanceReadReplicaResult
Creates a new DB instance that acts as a Read Replica for an existing source DB instance. You can create a Read Replica for a DB instance running MySQL, MariaDB, Oracle, or PostgreSQL. For more information, see Working with Read Replicas 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.
#create_db_parameter_group(options = {}) ⇒ 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.
#create_db_proxy(options = {}) ⇒ Types::CreateDBProxyResponse
This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.
Creates a new DB proxy.
#create_db_security_group(options = {}) ⇒ Types::CreateDBSecurityGroupResult
Creates a new DB security group. DB security groups control access to a DB instance.
A DB security group controls access to EC2-Classic DB instances that are not in a VPC.
#create_db_snapshot(options = {}) ⇒ Types::CreateDBSnapshotResult
Creates a DBSnapshot. The source DBInstance must be in "available" state.
#create_db_subnet_group(options = {}) ⇒ 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.
#create_event_subscription(options = {}) ⇒ 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.
RDS event notification is only available for unencrypted SNS topics. If you specify an encrypted SNS topic, event notifications aren't sent for the topic.
#create_global_cluster(options = {}) ⇒ 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.
This action only applies to Aurora DB clusters.
#create_option_group(options = {}) ⇒ Types::CreateOptionGroupResult
Creates a new option group. You can create up to 20 option groups.
#delete_custom_availability_zone(options = {}) ⇒ Types::DeleteCustomAvailabilityZoneResult
Deletes a custom Availability Zone (AZ).
A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster.
For more information about RDS on VMware, see the RDS on VMware User Guide.
#delete_db_cluster(options = {}) ⇒ 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.
This action only applies to Aurora DB clusters.
#delete_db_cluster_endpoint(options = {}) ⇒ Types::DBClusterEndpoint
Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster.
This action only applies to Aurora DB clusters.
#delete_db_cluster_parameter_group(options = {}) ⇒ 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.
This action only applies to Aurora DB clusters.
#delete_db_cluster_snapshot(options = {}) ⇒ Types::DeleteDBClusterSnapshotResult
Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.
The DB cluster snapshot must be in the available
state to be deleted.
For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.
This action only applies to Aurora DB clusters.
#delete_db_instance(options = {}) ⇒ 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 you skip creation of the final snapshot with the SkipFinalSnapshot
parameter.
If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following conditions are true:
-
The DB cluster is a Read Replica of another Amazon Aurora DB cluster.
-
The DB instance is the only instance in the DB cluster.
To delete a DB instance in this case, first call the PromoteReadReplicaDBCluster
API action to promote the DB cluster so it's no longer a Read Replica. After the promotion completes, then call the DeleteDBInstance
API action to delete the final instance in the DB cluster.
#delete_db_instance_automated_backup(options = {}) ⇒ Types::DeleteDBInstanceAutomatedBackupResult
Deletes automated backups based on the source instance's DbiResourceId
value or the restorable instance's resource ID.
#delete_db_parameter_group(options = {}) ⇒ Struct
Deletes a specified DB parameter group. The DB parameter group to be deleted can't be associated with any DB instances.
#delete_db_proxy(options = {}) ⇒ Types::DeleteDBProxyResponse
This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.
Deletes an existing proxy.
#delete_db_security_group(options = {}) ⇒ Struct
Deletes a DB security group.
The specified DB security group must not be associated with any DB instances.
#delete_db_snapshot(options = {}) ⇒ Types::DeleteDBSnapshotResult
Deletes a DB snapshot. If the snapshot is being copied, the copy operation is terminated.
The DB snapshot must be in the available
state to be deleted.
#delete_db_subnet_group(options = {}) ⇒ Struct
Deletes a DB subnet group.
The specified database subnet group must not be associated with any DB instances.
#delete_event_subscription(options = {}) ⇒ Types::DeleteEventSubscriptionResult
Deletes an RDS event notification subscription.
#delete_global_cluster(options = {}) ⇒ Types::DeleteGlobalClusterResult
Deletes a global database cluster. The primary and secondary clusters must already be detached or destroyed first.
This action only applies to Aurora DB clusters.
#delete_installation_media(options = {}) ⇒ Types::InstallationMedia
Deletes the installation medium for a DB engine that requires an on-premises customer provided license, such as Microsoft SQL Server.
#delete_option_group(options = {}) ⇒ Struct
Deletes an existing option group.
#deregister_db_proxy_targets(options = {}) ⇒ Struct
This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.
Remove the association between one or more DBProxyTarget
data structures and a DBProxyTargetGroup
.
#describe_account_attributes(options = {}) ⇒ 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.
#describe_certificates(options = {}) ⇒ Types::CertificateMessage
Lists the set of CA certificates provided by Amazon RDS for this AWS account.
#describe_custom_availability_zones(options = {}) ⇒ Types::CustomAvailabilityZoneMessage
Returns information about custom Availability Zones (AZs).
A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster.
For more information about RDS on VMware, see the RDS on VMware User Guide.
#describe_db_cluster_backtracks(options = {}) ⇒ 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.
This action only applies to Aurora DB clusters.
#describe_db_cluster_endpoints(options = {}) ⇒ Types::DBClusterEndpointMessage
Returns information about endpoints for an Amazon Aurora DB cluster.
This action only applies to Aurora DB clusters.
#describe_db_cluster_parameter_groups(options = {}) ⇒ 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.
This action only applies to Aurora DB clusters.
#describe_db_cluster_parameters(options = {}) ⇒ 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.
This action only applies to Aurora DB clusters.
#describe_db_cluster_snapshot_attributes(options = {}) ⇒ 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.
This action only applies to Aurora DB clusters.
#describe_db_cluster_snapshots(options = {}) ⇒ 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.
This action only applies to Aurora DB clusters.
#describe_db_clusters(options = {}) ⇒ 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.
This action only applies to Aurora DB clusters.
#describe_db_engine_versions(options = {}) ⇒ Types::DBEngineVersionMessage
Returns a list of the available DB engines.
#describe_db_instance_automated_backups(options = {}) ⇒ 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.
#describe_db_instances(options = {}) ⇒ Types::DBInstanceMessage
Returns information about provisioned RDS instances. This API supports pagination.