Class Fog::AWS::RDS::Real
In: lib/fog/aws/requests/rds/describe_engine_default_parameters.rb
lib/fog/aws/requests/rds/describe_db_snapshots.rb
lib/fog/aws/requests/rds/describe_db_reserved_instances.rb
lib/fog/aws/requests/rds/describe_db_parameters.rb
lib/fog/aws/requests/rds/modify_db_subnet_group.rb
lib/fog/aws/requests/rds/delete_db_snapshot.rb
lib/fog/aws/requests/rds/delete_db_subnet_group.rb
lib/fog/aws/requests/rds/modify_db_parameter_group.rb
lib/fog/aws/requests/rds/describe_db_engine_versions.rb
lib/fog/aws/requests/rds/describe_db_security_groups.rb
lib/fog/aws/requests/rds/modify_db_snapshot_attribute.rb
lib/fog/aws/requests/rds/modify_db_instance.rb
lib/fog/aws/requests/rds/describe_db_clusters.rb
lib/fog/aws/requests/rds/delete_db_cluster_snapshot.rb
lib/fog/aws/requests/rds/delete_db_instance.rb
lib/fog/aws/requests/rds/create_db_instance.rb
lib/fog/aws/requests/rds/describe_db_cluster_snapshots.rb
lib/fog/aws/requests/rds/delete_event_subscription.rb
lib/fog/aws/requests/rds/describe_events.rb
lib/fog/aws/requests/rds/create_db_snapshot.rb
lib/fog/aws/requests/rds/create_db_security_group.rb
lib/fog/aws/requests/rds/restore_db_instance_from_db_snapshot.rb
lib/fog/aws/requests/rds/remove_tags_from_resource.rb
lib/fog/aws/requests/rds/delete_db_cluster.rb
lib/fog/aws/requests/rds/revoke_db_security_group_ingress.rb
lib/fog/aws/requests/rds/reboot_db_instance.rb
lib/fog/aws/requests/rds/delete_db_security_group.rb
lib/fog/aws/requests/rds/describe_db_subnet_groups.rb
lib/fog/aws/requests/rds/create_db_subnet_group.rb
lib/fog/aws/requests/rds/delete_db_parameter_group.rb
lib/fog/aws/requests/rds/describe_orderable_db_instance_options.rb
lib/fog/aws/requests/rds/describe_db_log_files.rb
lib/fog/aws/requests/rds/add_tags_to_resource.rb
lib/fog/aws/requests/rds/describe_db_parameter_groups.rb
lib/fog/aws/requests/rds/authorize_db_security_group_ingress.rb
lib/fog/aws/requests/rds/describe_event_subscriptions.rb
lib/fog/aws/requests/rds/create_db_cluster_snapshot.rb
lib/fog/aws/requests/rds/describe_db_instances.rb
lib/fog/aws/requests/rds/promote_read_replica.rb
lib/fog/aws/requests/rds/create_db_instance_read_replica.rb
lib/fog/aws/requests/rds/list_tags_for_resource.rb
lib/fog/aws/requests/rds/create_event_subscription.rb
lib/fog/aws/requests/rds/restore_db_instance_to_point_in_time.rb
lib/fog/aws/requests/rds/create_db_cluster.rb
lib/fog/aws/requests/rds/copy_db_snapshot.rb
lib/fog/aws/requests/rds/download_db_logfile_portion.rb
lib/fog/aws/requests/rds/create_db_parameter_group.rb
lib/fog/aws/rds.rb
Parent: Object

Methods

Included Modules

Fog::AWS::CredentialFetcher::ConnectionMethods

Attributes

region  [R] 

Public Class methods

Initialize connection to ELB

Notes

options parameter must include values for :aws_access_key_id and :aws_secret_access_key in order to create a connection

Examples

  elb = ELB.new(
   :aws_access_key_id => your_aws_access_key_id,
   :aws_secret_access_key => your_aws_secret_access_key
  )

Parameters

  • options<~Hash> - config arguments for connection. Defaults to {}.
    • region<~String> - optional region to use. For instance, ‘eu-west-1’, ‘us-east-1’ and etc.

Returns

  • ELB object with connection to AWS.

Public Instance methods

adds tags to a database instance docs.amazonwebservices.com/AmazonRDS/latest/APIReference/API_AddTagsToResource.html

Parameters

  • rds_id <~String> - name of the RDS instance whose tags are to be retrieved
  • tags <~Hash> A Hash of (String) key-value pairs

Returns

  • response<~Excon::Response>:
    • body<~Hash>:

authorizes a db security group ingress docs.amazonwebservices.com/AmazonRDS/latest/APIReference/index.html?API_AuthorizeDBSecurityGroupIngress.html

Parameters

  • CIDRIP <~String> - The IP range to authorize
  • DBSecurityGroupName <~String> - The name for the DB Security Group.
  • EC2SecurityGroupName <~String> - Name of the EC2 Security Group to authorize.
  • EC2SecurityGroupOwnerId <~String> - AWS Account Number of the owner of the security group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value.

Returns

  • response<~Excon::Response>:
    • body<~Hash>:

Copy a db snapshot

Parameters

  • source_db_snapshot_identifier<~String> - Id of db snapshot
  • target_db_snapshot_identifier<~String> - Desired Id of the db snapshot copy
  • ‘copy_tags’<~Boolean> - true to copy all tags from the source DB snapshot to the target DB snapshot; otherwise false.

Returns

  • response<~Excon::Response>:
    • body<~Hash>:

Amazon API Reference

Create a db cluster

@see docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html

Parameters ====

  • AvailabilityZones<~Array> - A list of EC2 Availability Zones that instances in the DB cluster can be created in
  • BackupRetentionPeriod<~String> - The number of days for which automated backups are retained
  • CharacterSetName<~String> - A value that indicates that the DB cluster should be associated with the specified CharacterSet
  • DatabaseName<~String> - The name for your database of up to 8 alpha-numeric characters. If you do not provide a name, Amazon RDS will not create a database in the DB cluster you are creating
  • DBClusterIdentifier<~String> - The DB cluster identifier. This parameter is stored as a lowercase string
  • DBClusterParameterGroupName<~String> - The name of the DB cluster parameter group to associate with this DB cluster
  • DBSubnetGroupName<~String> - A DB subnet group to associate with this DB cluster
  • Engine<~String> - The name of the database engine to be used for this DB cluster
  • EngineVersion<~String> - The version number of the database engine to use
  • KmsKeyId<~String> - The KMS key identifier for an encrypted DB cluster
  • MasterUsername<~String> - The name of the master user for the client DB cluster
  • MasterUserPassword<~String> - The password for the master database user
  • OptionGroupName<~String> - A value that indicates that the DB cluster should be associated with the specified option group
  • Port<~Integer> - The port number on which the instances in the DB cluster accept connections
  • PreferredBackupWindow<~String> - The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter
  • PreferredMaintenanceWindow<~String> - The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC)
  • StorageEncrypted<~Boolean> - Specifies whether the DB cluster is encrypted
  • Tags<~Array> - A list of tags
  • VpcSecurityGroups<~Array> - A list of EC2 VPC security groups to associate with this DB cluster

Returns ====

  • response<~Excon::Response>:
    • body<~Hash>:

create a snapshot of a db cluster docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBClusterSnapshot.html

Parameters ====

  • DBClusterIdentifier<~String> - The identifier of the DB cluster to create a snapshot for
  • DBClusterSnapshotIdentifier<~String> - The identifier of the DB cluster snapshot
  • Tags<~Array> - The tags to be assigned to the DB cluster snapshot

Returns ====

  • response<~Excon::Response>:
    • body<~Hash>:

Create a db instance

@param DBInstanceIdentifier [String] name of the db instance to modify @param AllocatedStorage [Integer] Storage space, in GB @param AutoMinorVersionUpgrade [Boolean] Indicates that minor version upgrades will be applied automatically to the DB Instance during the maintenance window @param AvailabilityZone [String] The availability zone to create the instance in @param BackupRetentionPeriod [Integer] 0-8 The number of days to retain automated backups. @param DBInstanceClass [String] The new compute and memory capacity of the DB Instance @param DBName [String] The name of the database to create when the DB Instance is created @param DBParameterGroupName [String] The name of the DB Parameter Group to apply to this DB Instance @param DBSecurityGroups [Array] A list of DB Security Groups to authorize on this DB Instance @param Engine [String] The name of the database engine to be used for this instance. @param EngineVersion [String] The version number of the database engine to use. @param Iops [Integer] IOPS rate @param MasterUsername [String] The db master user @param MasterUserPassword [String] The new password for the DB Instance master user @param MultiAZ [Boolean] Specifies if the DB Instance is a Multi-AZ deployment @param Port [Integer] The port number on which the database accepts connections. @param PreferredBackupWindow [String] The daily time range during which automated backups are created if automated backups are enabled @param PreferredMaintenanceWindow [String] The weekly time range (in UTC) during which system maintenance can occur, which may result in an outage @param DBSubnetGroupName [String] The name, if any, of the VPC subnet for this RDS instance @param PubliclyAccessible [Boolean] Whether an RDS instance inside of the VPC subnet should have a public-facing endpoint @param VpcSecurityGroups [Array] A list of VPC Security Groups to authorize on this DB instance @param StorageType [string] Specifies storage type to be associated with the DB Instance. Valid values: standard | gp2 | io1

@return [Excon::Response]:

  * body [Hash]:

@see docs.amazonwebservices.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html

create a read replica db instance docs.amazonwebservices.com/AmazonRDS/latest/APIReference/API_CreateDBInstanceReadReplica.html

Parameters

  • DBInstanceIdentifier <~String> - name of the db instance to create
  • SourceDBInstanceIdentifier <~String> - name of the db instance that will be the source. Must have backup retention on
  • AutoMinorVersionUpgrade <~Boolean> Indicates that minor version upgrades will be applied automatically to the DB Instance during the maintenance window
  • AvailabilityZone <~String> The availability zone to create the instance in
  • DBInstanceClass <~String> The new compute and memory capacity of the DB Instance
  • Port <~Integer> The port number on which the database accepts connections.

Returns

  • response<~Excon::Response>:
    • body<~Hash>:

create a database parameter group docs.amazonwebservices.com/AmazonRDS/latest/APIReference/API_CreateDBParameterGroup.html

Parameters

  • DBParameterGroupName <~String> - name of the parameter group
  • DBParameterGroupFamily <~String> - The DB parameter group family name. Current valid values: MySQL5.1 | MySQL5.5
  • Description <~String> - The description for the DB Parameter Grou

Returns

  • response<~Excon::Response>:
    • body<~Hash>:

creates a db security group docs.amazonwebservices.com/AmazonRDS/latest/APIReference/index.html?API_CreateDBSecurityGroup.html

Parameters

  • DBSecurityGroupDescription <~String> - The description for the DB Security Group
  • DBSecurityGroupName <~String> - The name for the DB Security Group. This value is stored as a lowercase string. Must contain no more than 255 alphanumeric characters or hyphens. Must not be "Default".

Returns

  • response<~Excon::Response>:
    • body<~Hash>:

creates a db snapshot docs.amazonwebservices.com/AmazonRDS/latest/APIReference/API_CreateDBSnapshot.html

Parameters

  • DBInstanceIdentifier <~String> - ID of instance to create snapshot for
  • DBSnapshotIdentifier <~String> - The identifier for the DB Snapshot. 1-255 alphanumeric or hyphen characters. Must start with a letter

Returns

  • response<~Excon::Response>:
    • body<~Hash>:

Creates a db subnet group docs.amazonwebservices.com/AmazonRDS/2012-01-15/APIReference/API_CreateDBSubnetGroup.html

Parameters

  • DBSubnetGroupName <~String> - The name for the DB Subnet Group. This value is stored as a lowercase string. Must contain no more than 255 alphanumeric characters or hyphens. Must not be "Default".
  • SubnetIds <~Array> - The EC2 Subnet IDs for the DB Subnet Group.
  • DBSubnetGroupDescription <~String> - The description for the DB Subnet Group

Returns

  • response<~Excon::Response>:
    • body<~Hash>:

Subscribes a db instance to an SNS queue

@see docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateEventSubscription.html

Parameters

  • Enabled <~Boolean> - set to true to activate the subscription, set to false to create the subscription but not active it
  • EventCategories <~Array> - A list of event categories for a SourceType that you want to subscribe to
  • SnsTopicArn <~String> - The Amazon Resource Name of the SNS topic created for event notification
  • SourceIds <~Array> - The list of identifiers of the event sources for which events will be returned
  • SourceType <~String> - The type of source that will be generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned
  • SubscriptionName <~String> - The name of the subscription
  • Tags <~Array> - A list of tags

delete a database cluster

@see docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DeleteDBCluster.html

Parameters ====

  • DBClusterIdentifier <~String> - The DB cluster identifier for the DB cluster to be deleted
  • FinalDBSnapshotIdentifier <~String> - The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is set to false
  • SkipFinalSnapshot <~Boolean> - Determines whether a final DB cluster snapshot is created before the DB cluster is deleted

Returns ====

  • response<~Excon::Response>
    • body<~Hash>

delete a db cluster snapshot docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DeleteDBClusterSnapshot.html

Parameters ====

  • DBClusterSnapshotIdentifier<~String> - The identifier of the DB cluster snapshot to delete

Returns ====

  • response<~Excon::Response>:
    • body<~Hash>:

delete a database instance docs.amazonwebservices.com/AmazonRDS/latest/APIReference/API_DeleteDBInstance.html

Parameters

  • DBInstanceIdentifier <~String> - The DB Instance identifier for the DB Instance to be deleted.
  • FinalDBSnapshotIdentifier <~String> - The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to false
  • SkipFinalSnapshot <~Boolean> - Determines whether a final DB Snapshot is created before the DB Instance is deleted

Returns

  • response<~Excon::Response>:
    • body<~Hash>:

delete a database parameter group docs.amazonwebservices.com/AmazonRDS/latest/APIReference/API_DeleteDBParameterGroup.html

Parameters

  • DBParameterGroupName <~String> - name of the parameter group. Must not be associated with any instances

Returns

  • response<~Excon::Response>:
    • body<~Hash>:

deletes a db security group docs.amazonwebservices.com/AmazonRDS/latest/APIReference/index.html?API_DeleteDBSecurityGroup.html

Parameters

  • DBSecurityGroupName <~String> - The name for the DB Security Group to delete

Returns

  • response<~Excon::Response>:
    • body<~Hash>:

delete a database snapshot docs.amazonwebservices.com/AmazonRDS/latest/APIReference/API_DeleteDBSnapshot.html

Parameters

  • DBSnapshotIdentifier <~String> - name of the snapshot

Returns

  • response<~Excon::Response>:
    • body<~Hash>:

Deletes a db subnet group docs.aws.amazon.com/AmazonRDS/2013-09-09/APIReference/API_DeleteDBSubnetGroup.html

Parameters

  • DBSubnetGroupName <~String> - The name for the DB Subnet Group. This value is stored as a lowercase string. Must contain no more than 255 alphanumeric characters or hyphens. Must not be "Default".

Returns

  • response<~Excon::Response>:
    • body<~Hash>:

deletes an event subscription docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DeleteEventSubscription.html

Parameters

  • SubscriptionName <~String> - The name of the subscription to delete

Returns

  • response<~Excon::Response>:
    • body<~Hash>

Describe all or specified db cluster snapshots docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBClusterSnapshots.html

Parameters ====

  • DBClusterIdentifier<~String> - A DB cluster identifier to retrieve the list of DB cluster snapshots for
  • DBClusterSnapshotIdentifier<~String> - A specific DB cluster snapshot identifier to describe
  • SnapshotType<~String> - The type of DB cluster snapshots that will be returned. Values can be automated or manual

Returns ====

  • response<~Excon::Response>:
    • body<~Hash>:

Describe all or specified db clusters docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBClusters.html

Parameters ====

  • DBClusterIdentifier<~String> - The user-supplied DB cluster identifier

Returns ====

  • response<~Excon::Response>:
    • body<~Hash>:

Describe all or specified load db instances docs.amazonwebservices.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html

Parameters

  • DBInstanceIdentifier <~String> - ID of instance to retrieve information for. if absent information for all instances is returned

Returns

  • response<~Excon::Response>:
    • body<~Hash>:

Describe log files for a DB instance docs.amazonwebservices.com/AmazonRDS/latest/APIReference/API_DescribeDBLogFiles.html

Parameters

  • DBInstanceIdentifier <~String> - ID of instance to retrieve information for. Required.
  • Options <~Hash> - Hash of options. Optional. The following keys are used:
    • :file_last_written <~Long> - Filter available log files for those written after this time. Optional.
    • :file_size <~Long> - Filters the available log files for files larger than the specified size. Optional.
    • :filename_contains <~String> - Filters the available log files for log file names that contain the specified string. Optional.
    • :marker <~String> - The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords. Optional.
    • :max_records <~Integer> - The maximum number of records to include in the response. If more records exist, a pagination token is included in the response. Optional.

Returns

  • response<~Excon::Response>:
    • body<~Hash>:

This API returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the descriptions of the specified DBParameterGroup docs.amazonwebservices.com/AmazonRDS/latest/APIReference/API_DescribeDBParameterGroups.html

Parameters

  • DBParameterGroupName <~String> - The name of a specific database parameter group to return details for.
  • Source <~String> - The parameter types to return. user | system | engine-default

Returns

  • response<~Excon::Response>:
    • body<~Hash>:

Describe parameters from a parameter group docs.amazonwebservices.com/AmazonRDS/latest/APIReference/API_DescribeDBParameters.html

Parameters

  • DBParameterGroupName <~String> - name of parameter group to retrieve parameters for
  • Source <~String> - The parameter types to return. user | system | engine-default

Returns

  • response<~Excon::Response>:
    • body<~Hash>:

Describe all or specified load db instances docs.amazonwebservices.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html

Parameters

  • DBInstanceIdentifier <~String> - ID of instance to retrieve information for. if absent information for all instances is returned

Returns

  • response<~Excon::Response>:
    • body<~Hash>:

Describe all or specified db security groups docs.amazonwebservices.com/AmazonRDS/latest/APIReference/index.html?API_DescribeDBSecurityGroups.html

Parameters

  • DBSecurityGroupName <~String> - The name of the DB Security Group to return details for.
  • Marker <~String> - An optional marker provided in the previous DescribeDBInstances request
  • MaxRecords <~Integer> - Max number of records to return (between 20 and 100)

Only one of DBInstanceIdentifier or DBSnapshotIdentifier can be specified

Returns

  • response<~Excon::Response>:
    • body<~Hash>:

Describe all or specified db snapshots docs.amazonwebservices.com/AmazonRDS/latest/APIReference/API_DescribeDBSnapshots.html

Parameters

  • DBInstanceIdentifier <~String> - ID of instance to retrieve information for. if absent information for all instances is returned
  • DBSnapshotIdentifier <~String> - ID of snapshot to retrieve information for. if absent information for all snapshots is returned
  • SnapshotType <~String> - type of snapshot to retrive (automated|manual)
  • Marker <~String> - An optional marker provided in the previous DescribeDBInstances request
  • MaxRecords <~Integer> - Max number of records to return (between 20 and 100)

Only one of DBInstanceIdentifier or DBSnapshotIdentifier can be specified

Returns

  • response<~Excon::Response>:
    • body<~Hash>:

This API returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup docs.amazonwebservices.com/AmazonRDS/2012-01-15/APIReference/API_DescribeDBSubnetGroups.html

Parameters

  • DBSubnetGroupName <~String> - The name of a specific database subnet group to return details for.

Returns

  • response<~Excon::Response>:
    • body<~Hash>:

Returns the default engine and system parameter information for the specified database engine docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeEngineDefaultParameters.html

Parameters ====

  • DBParameterGroupFamily<~String> - The name of the DB parameter group family

Returns ====

  • response<~Excon::Response>:
    • body<~Hash>:

Describe all or specified event notifications docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeEventSubscriptions.html

Parameters

  • Marker <~String> - An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request
  • MaxRecords <~String> - The maximum number of records to include in the response (20-100)
  • SubscriptionName <~String> - The name of the RDS event notification subscription you want to describe

Returns

  • response<~Excon::Response>:
    • body<~Hash>

Returns a list of service events

For more information see: docs.amazonwebservices.com/AmazonRDS/latest/APIReference/API_DescribeEvents.html

Parameters (optional)

  • options <~Hash> (optional):
  • :start_time <~DateTime> - starting time for event records
  • :end_time <~DateTime> - ending time for event records
  • :duration <~Integer> - The number of minutes to retrieve events for
                     Default = 60 Mins
    
  • :marker <~String> - marker provided in the previous request
  • :max_records <~Integer> - the maximum number of records to include
                     Default = 100
                     Constraints: min = 20, maximum 100
    
  • :source_identifier <~String> - identifier of the event source
  • :source_type <~DateTime> - event type, one of:
      (db-instance | db-parameter-group | db-security-group | db-snapshot)
    

Returns

  • response <~Excon::Response>:
    • body <~Hash>

Describe all or specified load db instances docs.amazonwebservices.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html

Parameters

  • Engine <~String> - The name of the engine to retrieve DB Instance options for. Required.
  • Options <~Hash> - Hash of options. Optional. The following keys are used:
    • :db_instance_class <~String> - Filter available offerings matching the specified DB Instance class. Optional.
    • :engine_version <~String> - Filters available offerings matching the specified engine version. Optional.
    • :license_model <~String> - Filters available offerings matching the specified license model. Optional.
    • :marker <~String> - The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords. Optional.
    • :max_records <~Integer> - The maximum number of records to include in the response. If more records exist, a pagination token is included in the response. Optional.
    • :vpc <~Boolean> - Filter to show only the available VPC or non-VPC offerings. Optional.

Returns

  • response<~Excon::Response>:
    • body<~Hash>:

Retrieve a portion of a log file of a db instance docs.amazonwebservices.com/AmazonRDS/latest/APIReference/API_DownloadDBLogFilePortion.html

Parameters

  • DBInstanceIdentifier <~String> - ID of instance to retrieve information for. Required.
  • LogFileName <~String> - The name of the log file to be downloaded. Required.
  • Options <~Hash> - Hash of options. Optional. The following keys are used:
    • :marker <~String> - The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords. Optional.
    • :max_records <~Integer> - The maximum number of records to include in the response. If more records exist, a pagination token is included in the response. Optional.
    • :number_of_lines <~Integer> - The number of lines to download. Optional.

Returns

  • response<~Excon::Response>:
    • body<~Hash>:

returns a Hash of tags for a database instance docs.amazonwebservices.com/AmazonRDS/latest/APIReference/API_ListTagsForResource.html

Parameters

  • rds_id <~String> - name of the RDS instance whose tags are to be retrieved

Returns

  • response<~Excon::Response>:
    • body<~Hash>:

modifies a database instance docs.amazonwebservices.com/AmazonRDS/latest/APIReference/API_ModifyDBInstance.html

Parameters

  • DBInstanceIdentifier <~String> - name of the db instance to modify
  • ApplyImmediately <~Boolean> - whether to apply the changes immediately or wait for the next maintenance window
  • AllocatedStorage <~Integer> Storage space, in GB
  • AllowMajorVersionUpgrade <~Boolean> Must be set to true if EngineVersion specifies a different major version
  • AutoMinorVersionUpgrade <~Boolean> Indicates that minor version upgrades will be applied automatically to the DB Instance during the maintenance window
  • BackupRetentionPeriod <~Integer> 0-8 The number of days to retain automated backups.
  • DBInstanceClass <~String> The new compute and memory capacity of the DB Instanc
  • DBParameterGroupName <~String> The name of the DB Parameter Group to apply to this DB Instance
  • DBSecurityGroups <~Array> A list of DB Security Groups to authorize on this DB Instance
  • EngineVersion <~String> The version number of the database engine to upgrade to.
  • Iops <~Integer> IOPS rate
  • MasterUserPassword <~String> The new password for the DB Instance master user
  • MultiAZ <~Boolean> Specifies if the DB Instance is a Multi-AZ deployment
  • PreferredBackupWindow <~String> The daily time range during which automated backups are created if automated backups are enabled
  • PreferredMaintenanceWindow <~String> The weekly time range (in UTC) during which system maintenance can occur, which may result in an outage
  • VpcSecurityGroups <~Array> A list of VPC Security Group IDs to authorize on this DB instance

Returns

  • response<~Excon::Response>:
    • body<~Hash>:

modifies a database parameter group docs.amazonwebservices.com/AmazonRDS/latest/APIReference/API_ModifyDBParameterGroup.html

Parameters

  • DBParameterGroupName <~String> - name of the parameter group
  • Parameters<~Array> - Array of up to 20 Hashes describing parameters to set
    • ‘ParameterName’<~String> - parameter name.
    • ‘ParameterValue’<~String> - new paremeter value
    • ‘ApplyMethod’<~String> - immediate | pending-reboot whether to set the parameter immediately or not (may require an instance restart)

Returns

  • response<~Excon::Response>:
    • body<~Hash>:

Modify db snapshot attributes

Parameters

  • db_snapshot_identifier<~String> - Id of snapshot to modify
  • attributes<~Hash>:
    • ‘Add.MemberId’<~Array> - One or more account ids to grant rds create permission to
    • ‘Remove.MemberId’<~Array> - One or more account ids to revoke rds create permission from

Amazon API Reference

Creates a db subnet group docs.aws.amazon.com/AmazonRDS/2012-01-15/APIReference/API_ModifyDBSubnetGroup.html

Parameters

  • DBSubnetGroupName <~String> - The name for the DB Subnet Group. This value is stored as a lowercase string. Must contain no more than 255 alphanumeric characters or hyphens. Must not be "Default".
  • SubnetIds <~Array> - The EC2 Subnet IDs for the DB Subnet Group.
  • DBSubnetGroupDescription <~String> - The description for the DB Subnet Group

Returns

  • response<~Excon::Response>:
    • body<~Hash>:

promote a read replica to a writable RDS instance docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_PromoteReadReplica.html

Parameters

  • DBInstanceIdentifier <~String> - The DB Instance identifier for the DB Instance to be deleted.
  • BackupRetentionPeriod <~Integer> - The number of days to retain automated backups. Range: 0-8.
                          Setting this parameter to a positive number enables backups.
                          Setting this parameter to 0 disables automated backups.
    
  • PreferredBackupWindow <~String> - The daily time range during which automated backups are created if
                          automated backups are enabled, using the BackupRetentionPeriod parameter.
                          Default: A 30-minute window selected at random from an 8-hour block of time per region.
    

See the Amazon RDS User Guide for the time blocks for each region from which the default backup windows are assigned.

Returns

  • response<~Excon::Response>:
    • body<~Hash>:

reboots a database instance docs.amazonwebservices.com/AmazonRDS/latest/APIReference/API_RebootDBInstance.html

Parameters

  • DBInstanceIdentifier <~String> - name of the db instance to reboot

Returns

  • response<~Excon::Response>:
    • body<~Hash>:

removes tags from a database instance docs.amazonwebservices.com/AmazonRDS/latest/APIReference/API_RemoveTagsFromResource.html

Parameters

  • rds_id <~String> - name of the RDS instance whose tags are to be retrieved
  • keys <~Array> A list of String keys for the tags to remove

Returns

  • response<~Excon::Response>:
    • body<~Hash>:

revokes a db security group ingress docs.amazonwebservices.com/AmazonRDS/latest/APIReference/index.html?API_RevokeDBSecurityGroupIngress.html

Parameters

  • CIDRIP <~String> - The IP range to revoke
  • DBSecurityGroupName <~String> - The name for the DB Security Group.
  • EC2SecurityGroupName <~String> - Name of the EC2 Security Group to revoke.
  • EC2SecurityGroupOwnerId <~String> - AWS Account Number of the owner of the security group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value.

Returns

  • response<~Excon::Response>:
    • body<~Hash>:

[Validate]