Class: AWS.RDS (2013-02-12)
- Inherits:
-
AWS.Service
- Object
- AWS.Service
- AWS.RDS_20130212
- Identifier:
- rds
- API Version:
- 2013-02-12
- Defined in:
- (unknown)
Overview
Constructs a service interface object. Each API operation is exposed as a function on service.
Sending a Request Using RDS
var rds = new AWS.RDS();
rds.addSourceIdentifierToSubscription(params, function (err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Locking the API Version
In order to ensure that the RDS object uses this specific API, you can
construct the object by passing the apiVersion
option to the constructor:
var rds = new AWS.RDS({apiVersion: '2013-02-12'});
You can also set the API version globally in AWS.config.apiVersions
using
the rds service identifier:
AWS.config.apiVersions = {
rds: '2013-02-12',
// other service API versions
};
var rds = new AWS.RDS();
Version:
-
2013-02-12
Constructor Summary collapse
-
new AWS.RDS(options = {}) ⇒ Object
constructor
Constructs a service object.
Property Summary collapse
-
endpoint ⇒ AWS.Endpoint
readwrite
An Endpoint object representing the endpoint URL for service requests.
Properties inherited from AWS.Service
Method Summary collapse
-
addSourceIdentifierToSubscription(params = {}, callback) ⇒ AWS.Request
Calls the AddSourceIdentifierToSubscription API operation.
-
addTagsToResource(params = {}, callback) ⇒ AWS.Request
Calls the AddTagsToResource API operation.
-
authorizeDBSecurityGroupIngress(params = {}, callback) ⇒ AWS.Request
Calls the AuthorizeDBSecurityGroupIngress API operation.
-
copyDBSnapshot(params = {}, callback) ⇒ AWS.Request
Calls the CopyDBSnapshot API operation.
-
createDBInstance(params = {}, callback) ⇒ AWS.Request
Calls the CreateDBInstance API operation.
-
createDBInstanceReadReplica(params = {}, callback) ⇒ AWS.Request
Calls the CreateDBInstanceReadReplica API operation.
-
createDBParameterGroup(params = {}, callback) ⇒ AWS.Request
Calls the CreateDBParameterGroup API operation.
-
createDBSecurityGroup(params = {}, callback) ⇒ AWS.Request
Calls the CreateDBSecurityGroup API operation.
-
createDBSnapshot(params = {}, callback) ⇒ AWS.Request
Calls the CreateDBSnapshot API operation.
-
createDBSubnetGroup(params = {}, callback) ⇒ AWS.Request
Calls the CreateDBSubnetGroup API operation.
-
createEventSubscription(params = {}, callback) ⇒ AWS.Request
Calls the CreateEventSubscription API operation.
-
createOptionGroup(params = {}, callback) ⇒ AWS.Request
Calls the CreateOptionGroup API operation.
-
deleteDBInstance(params = {}, callback) ⇒ AWS.Request
Calls the DeleteDBInstance API operation.
-
deleteDBParameterGroup(params = {}, callback) ⇒ AWS.Request
Calls the DeleteDBParameterGroup API operation.
-
deleteDBSecurityGroup(params = {}, callback) ⇒ AWS.Request
Calls the DeleteDBSecurityGroup API operation.
-
deleteDBSnapshot(params = {}, callback) ⇒ AWS.Request
Calls the DeleteDBSnapshot API operation.
-
deleteDBSubnetGroup(params = {}, callback) ⇒ AWS.Request
Calls the DeleteDBSubnetGroup API operation.
-
deleteEventSubscription(params = {}, callback) ⇒ AWS.Request
Calls the DeleteEventSubscription API operation.
-
deleteOptionGroup(params = {}, callback) ⇒ AWS.Request
Calls the DeleteOptionGroup API operation.
-
describeDBEngineVersions(params = {}, callback) ⇒ AWS.Request
Calls the DescribeDBEngineVersions API operation.
-
describeDBInstances(params = {}, callback) ⇒ AWS.Request
Calls the DescribeDBInstances API operation.
-
describeDBLogFiles(params = {}, callback) ⇒ AWS.Request
Calls the DescribeDBLogFiles API operation.
-
describeDBParameterGroups(params = {}, callback) ⇒ AWS.Request
Calls the DescribeDBParameterGroups API operation.
-
describeDBParameters(params = {}, callback) ⇒ AWS.Request
Calls the DescribeDBParameters API operation.
-
describeDBSecurityGroups(params = {}, callback) ⇒ AWS.Request
Calls the DescribeDBSecurityGroups API operation.
-
describeDBSnapshots(params = {}, callback) ⇒ AWS.Request
Calls the DescribeDBSnapshots API operation.
-
describeDBSubnetGroups(params = {}, callback) ⇒ AWS.Request
Calls the DescribeDBSubnetGroups API operation.
-
describeEngineDefaultParameters(params = {}, callback) ⇒ AWS.Request
Calls the DescribeEngineDefaultParameters API operation.
-
describeEventCategories(params = {}, callback) ⇒ AWS.Request
Calls the DescribeEventCategories API operation.
-
describeEvents(params = {}, callback) ⇒ AWS.Request
Calls the DescribeEvents API operation.
-
describeEventSubscriptions(params = {}, callback) ⇒ AWS.Request
Calls the DescribeEventSubscriptions API operation.
-
describeOptionGroupOptions(params = {}, callback) ⇒ AWS.Request
Calls the DescribeOptionGroupOptions API operation.
-
describeOptionGroups(params = {}, callback) ⇒ AWS.Request
Calls the DescribeOptionGroups API operation.
-
describeOrderableDBInstanceOptions(params = {}, callback) ⇒ AWS.Request
Calls the DescribeOrderableDBInstanceOptions API operation.
-
describeReservedDBInstances(params = {}, callback) ⇒ AWS.Request
Calls the DescribeReservedDBInstances API operation.
-
describeReservedDBInstancesOfferings(params = {}, callback) ⇒ AWS.Request
Calls the DescribeReservedDBInstancesOfferings API operation.
-
downloadDBLogFilePortion(params = {}, callback) ⇒ AWS.Request
Calls the DownloadDBLogFilePortion API operation.
-
listTagsForResource(params = {}, callback) ⇒ AWS.Request
Calls the ListTagsForResource API operation.
-
modifyDBInstance(params = {}, callback) ⇒ AWS.Request
Calls the ModifyDBInstance API operation.
-
modifyDBParameterGroup(params = {}, callback) ⇒ AWS.Request
Calls the ModifyDBParameterGroup API operation.
-
modifyDBSubnetGroup(params = {}, callback) ⇒ AWS.Request
Calls the ModifyDBSubnetGroup API operation.
-
modifyEventSubscription(params = {}, callback) ⇒ AWS.Request
Calls the ModifyEventSubscription API operation.
-
modifyOptionGroup(params = {}, callback) ⇒ AWS.Request
Calls the ModifyOptionGroup API operation.
-
promoteReadReplica(params = {}, callback) ⇒ AWS.Request
Calls the PromoteReadReplica API operation.
-
purchaseReservedDBInstancesOffering(params = {}, callback) ⇒ AWS.Request
Calls the PurchaseReservedDBInstancesOffering API operation.
-
rebootDBInstance(params = {}, callback) ⇒ AWS.Request
Calls the RebootDBInstance API operation.
-
removeSourceIdentifierFromSubscription(params = {}, callback) ⇒ AWS.Request
Calls the RemoveSourceIdentifierFromSubscription API operation.
-
removeTagsFromResource(params = {}, callback) ⇒ AWS.Request
Calls the RemoveTagsFromResource API operation.
-
resetDBParameterGroup(params = {}, callback) ⇒ AWS.Request
Calls the ResetDBParameterGroup API operation.
-
restoreDBInstanceFromDBSnapshot(params = {}, callback) ⇒ AWS.Request
Calls the RestoreDBInstanceFromDBSnapshot API operation.
-
restoreDBInstanceToPointInTime(params = {}, callback) ⇒ AWS.Request
Calls the RestoreDBInstanceToPointInTime API operation.
-
revokeDBSecurityGroupIngress(params = {}, callback) ⇒ AWS.Request
Calls the RevokeDBSecurityGroupIngress API operation.
Methods inherited from AWS.Service
makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService
Constructor Details
new AWS.RDS(options = {}) ⇒ Object
Constructs a service object. This object has one method for each API operation.
Examples:
Constructing a RDS object
var rds = new AWS.RDS({apiVersion: '2013-02-12'});
Options Hash (options):
-
params
(map)
—
An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.
-
endpoint
(String|AWS.Endpoint)
—
The endpoint URI to send requests to. The default endpoint is built from the configured
region
. The endpoint should be a string like'https://{service}.{region}.amazonaws.com'
or an Endpoint object. -
accessKeyId
(String)
—
your AWS access key ID.
-
secretAccessKey
(String)
—
your AWS secret access key.
-
sessionToken
(AWS.Credentials)
—
the optional AWS session token to sign requests with.
-
credentials
(AWS.Credentials)
—
the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.
-
credentialProvider
(AWS.CredentialProviderChain)
—
the provider chain used to resolve credentials if no static
credentials
property is set. -
region
(String)
—
the region to send service requests to. See AWS.RDS_20130212.region for more information.
-
maxRetries
(Integer)
—
the maximum amount of retries to attempt with a request. See AWS.RDS_20130212.maxRetries for more information.
-
maxRedirects
(Integer)
—
the maximum amount of redirects to follow with a request. See AWS.RDS_20130212.maxRedirects for more information.
-
sslEnabled
(Boolean)
—
whether to enable SSL for requests.
-
paramValidation
(Boolean|map)
—
whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:
- min [Boolean] — Validates that a value meets the min
constraint. This is enabled by default when paramValidation is set
to
true
. - max [Boolean] — Validates that a value meets the max constraint.
- pattern [Boolean] — Validates that a string value matches a regular expression.
- enum [Boolean] — Validates that a string value matches one of the allowable enum values.
- min [Boolean] — Validates that a value meets the min
constraint. This is enabled by default when paramValidation is set
to
-
computeChecksums
(Boolean)
—
whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)
-
convertResponseTypes
(Boolean)
—
whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to
true
. -
correctClockSkew
(Boolean)
—
whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to
false
. -
s3ForcePathStyle
(Boolean)
—
whether to force path style URLs for S3 objects.
-
s3BucketEndpoint
(Boolean)
—
whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an
endpoint
to be provided explicitly to the service constructor. -
s3DisableBodySigning
(Boolean)
—
whether S3 body signing should be disabled when using signature version
v4
. Body signing can only be disabled when using https. Defaults totrue
. -
s3UsEast1RegionalEndpoint
('legacy'|'regional')
—
when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to
legacy
-
s3UseArnRegion
(Boolean)
—
whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to
true
-
retryDelayOptions
(map)
—
A set of options to configure the retry delay on retryable errors. Currently supported options are:
- base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
- customBackoff [function] — A custom function that accepts a
retry count and error and returns the amount of time to delay in
milliseconds. If the result is a non-zero negative value, no further
retry attempts will be made. The
base
option will be ignored if this option is supplied. The function is only called for retryable errors.
-
httpOptions
(map)
—
A set of options to pass to the low-level HTTP request. Currently supported options are:
- proxy [String] — the URL to proxy requests through
- agent [http.Agent, https.Agent] — the Agent object to perform
HTTP requests with. Used for connection pooling. Defaults to the global
agent (
http.globalAgent
) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment. - connectTimeout [Integer] — Sets the socket to timeout after
failing to establish a connection with the server after
connectTimeout
milliseconds. This timeout has no effect once a socket connection has been established. - timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
- xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
- xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
-
apiVersion
(String, Date)
—
a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by
apiVersions
). Specify 'latest' to use the latest possible version. -
apiVersions
(map<String, String|Date>)
—
a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.
-
logger
(#write, #log)
—
an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests
-
systemClockOffset
(Number)
—
an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global
AWS.config
object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds. -
signatureVersion
(String)
—
the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.
-
signatureCache
(Boolean)
—
whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to
true
. -
dynamoDbCrc32
(Boolean)
—
whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default:
true
. -
useAccelerateEndpoint
(Boolean)
—
Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default:
false
. -
clientSideMonitoring
(Boolean)
—
whether to collect and publish this client's performance metrics of all its API requests.
-
endpointDiscoveryEnabled
(Boolean|undefined)
—
whether to call operations with endpoints given by service dynamically. Setting this
-
endpointCacheSize
(Number)
—
the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000
-
hostPrefixEnabled
(Boolean)
—
whether to marshal request parameters to the prefix of hostname. Defaults to
true
. -
stsRegionalEndpoints
('legacy'|'regional')
—
whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.
-
useFipsEndpoint
(Boolean)
—
Enables FIPS compatible endpoints. Defaults to
false
. -
useDualstackEndpoint
(Boolean)
—
Enables IPv6 dualstack endpoint. Defaults to
false
.
Property Details
Method Details
addSourceIdentifierToSubscription(params = {}, callback) ⇒ AWS.Request
Calls the AddSourceIdentifierToSubscription API operation.
Service Reference:
Examples:
Calling the addSourceIdentifierToSubscription operation
var params = {
SourceIdentifier: 'STRING_VALUE', /* required */
SubscriptionName: 'STRING_VALUE' /* required */
};
rds.addSourceIdentifierToSubscription(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
SubscriptionName
— (String
)SourceIdentifier
— (String
)
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:EventSubscription
— (map
)CustomerAwsId
— (String
)CustSubscriptionId
— (String
)SnsTopicArn
— (String
)Status
— (String
)SubscriptionCreationTime
— (String
)SourceType
— (String
)SourceIdsList
— (Array<String>
)EventCategoriesList
— (Array<String>
)Enabled
— (Boolean
)
-
(AWS.Response)
—
Returns:
addTagsToResource(params = {}, callback) ⇒ AWS.Request
Calls the AddTagsToResource API operation.
Service Reference:
Examples:
Calling the addTagsToResource operation
var params = {
ResourceName: 'STRING_VALUE', /* required */
Tags: [ /* required */
{
Key: 'STRING_VALUE',
Value: 'STRING_VALUE'
},
/* more items */
]
};
rds.addTagsToResource(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
ResourceName
— (String
)Tags
— (Array<map>
)Key
— (String
)Value
— (String
)
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
authorizeDBSecurityGroupIngress(params = {}, callback) ⇒ AWS.Request
Calls the AuthorizeDBSecurityGroupIngress API operation.
Service Reference:
Examples:
Calling the authorizeDBSecurityGroupIngress operation
var params = {
DBSecurityGroupName: 'STRING_VALUE', /* required */
CIDRIP: 'STRING_VALUE',
EC2SecurityGroupId: 'STRING_VALUE',
EC2SecurityGroupName: 'STRING_VALUE',
EC2SecurityGroupOwnerId: 'STRING_VALUE'
};
rds.authorizeDBSecurityGroupIngress(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
DBSecurityGroupName
— (String
)CIDRIP
— (String
)EC2SecurityGroupName
— (String
)EC2SecurityGroupId
— (String
)EC2SecurityGroupOwnerId
— (String
)
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:DBSecurityGroup
— (map
)OwnerId
— (String
)DBSecurityGroupName
— (String
)DBSecurityGroupDescription
— (String
)VpcId
— (String
)EC2SecurityGroups
— (Array<map>
)Status
— (String
)EC2SecurityGroupName
— (String
)EC2SecurityGroupId
— (String
)EC2SecurityGroupOwnerId
— (String
)
IPRanges
— (Array<map>
)Status
— (String
)CIDRIP
— (String
)
-
(AWS.Response)
—
Returns:
copyDBSnapshot(params = {}, callback) ⇒ AWS.Request
Calls the CopyDBSnapshot API operation.
Service Reference:
Examples:
Calling the copyDBSnapshot operation
var params = {
SourceDBSnapshotIdentifier: 'STRING_VALUE', /* required */
TargetDBSnapshotIdentifier: 'STRING_VALUE' /* required */
};
rds.copyDBSnapshot(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
SourceDBSnapshotIdentifier
— (String
)TargetDBSnapshotIdentifier
— (String
)
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:DBSnapshot
— (map
)DBSnapshotIdentifier
— (String
)DBInstanceIdentifier
— (String
)SnapshotCreateTime
— (Date
)Engine
— (String
)AllocatedStorage
— (Integer
)Status
— (String
)Port
— (Integer
)AvailabilityZone
— (String
)VpcId
— (String
)InstanceCreateTime
— (Date
)MasterUsername
— (String
)EngineVersion
— (String
)LicenseModel
— (String
)SnapshotType
— (String
)Iops
— (Integer
)OptionGroupName
— (String
)
-
(AWS.Response)
—
Returns:
createDBInstance(params = {}, callback) ⇒ AWS.Request
Calls the CreateDBInstance API operation.
Service Reference:
Examples:
Calling the createDBInstance operation
var params = {
AllocatedStorage: 'NUMBER_VALUE', /* required */
DBInstanceClass: 'STRING_VALUE', /* required */
DBInstanceIdentifier: 'STRING_VALUE', /* required */
Engine: 'STRING_VALUE', /* required */
MasterUserPassword: 'STRING_VALUE', /* required */
MasterUsername: 'STRING_VALUE', /* required */
AutoMinorVersionUpgrade: true || false,
AvailabilityZone: 'STRING_VALUE',
BackupRetentionPeriod: 'NUMBER_VALUE',
CharacterSetName: 'STRING_VALUE',
DBName: 'STRING_VALUE',
DBParameterGroupName: 'STRING_VALUE',
DBSecurityGroups: [
'STRING_VALUE',
/* more items */
],
DBSubnetGroupName: 'STRING_VALUE',
EngineVersion: 'STRING_VALUE',
Iops: 'NUMBER_VALUE',
LicenseModel: 'STRING_VALUE',
MultiAZ: true || false,
OptionGroupName: 'STRING_VALUE',
Port: 'NUMBER_VALUE',
PreferredBackupWindow: 'STRING_VALUE',
PreferredMaintenanceWindow: 'STRING_VALUE',
PubliclyAccessible: true || false,
VpcSecurityGroupIds: [
'STRING_VALUE',
/* more items */
]
};
rds.createDBInstance(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
DBName
— (String
)DBInstanceIdentifier
— (String
)AllocatedStorage
— (Integer
)DBInstanceClass
— (String
)Engine
— (String
)MasterUsername
— (String
)MasterUserPassword
— (String
)DBSecurityGroups
— (Array<String>
)VpcSecurityGroupIds
— (Array<String>
)AvailabilityZone
— (String
)DBSubnetGroupName
— (String
)PreferredMaintenanceWindow
— (String
)DBParameterGroupName
— (String
)BackupRetentionPeriod
— (Integer
)PreferredBackupWindow
— (String
)Port
— (Integer
)MultiAZ
— (Boolean
)EngineVersion
— (String
)AutoMinorVersionUpgrade
— (Boolean
)LicenseModel
— (String
)Iops
— (Integer
)OptionGroupName
— (String
)CharacterSetName
— (String
)PubliclyAccessible
— (Boolean
)
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:DBInstance
— (map
)DBInstanceIdentifier
— (String
)DBInstanceClass
— (String
)Engine
— (String
)DBInstanceStatus
— (String
)MasterUsername
— (String
)DBName
— (String
)Endpoint
— (map
)Address
— (String
)Port
— (Integer
)
AllocatedStorage
— (Integer
)InstanceCreateTime
— (Date
)PreferredBackupWindow
— (String
)BackupRetentionPeriod
— (Integer
)DBSecurityGroups
— (Array<map>
)DBSecurityGroupName
— (String
)Status
— (String
)
VpcSecurityGroups
— (Array<map>
)VpcSecurityGroupId
— (String
)Status
— (String
)
DBParameterGroups
— (Array<map>
)DBParameterGroupName
— (String
)ParameterApplyStatus
— (String
)
AvailabilityZone
— (String
)DBSubnetGroup
— (map
)DBSubnetGroupName
— (String
)DBSubnetGroupDescription
— (String
)VpcId
— (String
)SubnetGroupStatus
— (String
)Subnets
— (Array<map>
)SubnetIdentifier
— (String
)SubnetAvailabilityZone
— (map
)Name
— (String
)ProvisionedIopsCapable
— (Boolean
)
SubnetStatus
— (String
)
PreferredMaintenanceWindow
— (String
)PendingModifiedValues
— (map
)DBInstanceClass
— (String
)AllocatedStorage
— (Integer
)MasterUserPassword
— (String
)Port
— (Integer
)BackupRetentionPeriod
— (Integer
)MultiAZ
— (Boolean
)EngineVersion
— (String
)Iops
— (Integer
)DBInstanceIdentifier
— (String
)
LatestRestorableTime
— (Date
)MultiAZ
— (Boolean
)EngineVersion
— (String
)AutoMinorVersionUpgrade
— (Boolean
)ReadReplicaSourceDBInstanceIdentifier
— (String
)ReadReplicaDBInstanceIdentifiers
— (Array<String>
)LicenseModel
— (String
)Iops
— (Integer
)OptionGroupMemberships
— (Array<map>
)OptionGroupName
— (String
)Status
— (String
)
CharacterSetName
— (String
)SecondaryAvailabilityZone
— (String
)PubliclyAccessible
— (Boolean
)
-
(AWS.Response)
—
Returns:
createDBInstanceReadReplica(params = {}, callback) ⇒ AWS.Request
Calls the CreateDBInstanceReadReplica API operation.
Service Reference:
Examples:
Calling the createDBInstanceReadReplica operation
var params = {
DBInstanceIdentifier: 'STRING_VALUE', /* required */
SourceDBInstanceIdentifier: 'STRING_VALUE', /* required */
AutoMinorVersionUpgrade: true || false,
AvailabilityZone: 'STRING_VALUE',
DBInstanceClass: 'STRING_VALUE',
Iops: 'NUMBER_VALUE',
OptionGroupName: 'STRING_VALUE',
Port: 'NUMBER_VALUE',
PubliclyAccessible: true || false
};
rds.createDBInstanceReadReplica(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
DBInstanceIdentifier
— (String
)SourceDBInstanceIdentifier
— (String
)DBInstanceClass
— (String
)AvailabilityZone
— (String
)Port
— (Integer
)AutoMinorVersionUpgrade
— (Boolean
)Iops
— (Integer
)OptionGroupName
— (String
)PubliclyAccessible
— (Boolean
)
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:DBInstance
— (map
)DBInstanceIdentifier
— (String
)DBInstanceClass
— (String
)Engine
— (String
)DBInstanceStatus
— (String
)MasterUsername
— (String
)DBName
— (String
)Endpoint
— (map
)Address
— (String
)Port
— (Integer
)
AllocatedStorage
— (Integer
)InstanceCreateTime
— (Date
)PreferredBackupWindow
— (String
)BackupRetentionPeriod
— (Integer
)DBSecurityGroups
— (Array<map>
)DBSecurityGroupName
— (String
)Status
— (String
)
VpcSecurityGroups
— (Array<map>
)VpcSecurityGroupId
— (String
)Status
— (String
)
DBParameterGroups
— (Array<map>
)DBParameterGroupName
— (String
)ParameterApplyStatus
— (String
)
AvailabilityZone
— (String
)DBSubnetGroup
— (map
)DBSubnetGroupName
— (String
)DBSubnetGroupDescription
— (String
)VpcId
— (String
)SubnetGroupStatus
— (String
)Subnets
— (Array<map>
)SubnetIdentifier
— (String
)SubnetAvailabilityZone
— (map
)Name
— (String
)ProvisionedIopsCapable
— (Boolean
)
SubnetStatus
— (String
)
PreferredMaintenanceWindow
— (String
)PendingModifiedValues
— (map
)DBInstanceClass
— (String
)AllocatedStorage
— (Integer
)MasterUserPassword
— (String
)Port
— (Integer
)BackupRetentionPeriod
— (Integer
)MultiAZ
— (Boolean
)EngineVersion
— (String
)Iops
— (Integer
)DBInstanceIdentifier
— (String
)
LatestRestorableTime
— (Date
)MultiAZ
— (Boolean
)EngineVersion
— (String
)AutoMinorVersionUpgrade
— (Boolean
)ReadReplicaSourceDBInstanceIdentifier
— (String
)ReadReplicaDBInstanceIdentifiers
— (Array<String>
)LicenseModel
— (String
)Iops
— (Integer
)OptionGroupMemberships
— (Array<map>
)OptionGroupName
— (String
)Status
— (String
)
CharacterSetName
— (String
)SecondaryAvailabilityZone
— (String
)PubliclyAccessible
— (Boolean
)
-
(AWS.Response)
—
Returns:
createDBParameterGroup(params = {}, callback) ⇒ AWS.Request
Calls the CreateDBParameterGroup API operation.
Service Reference:
Examples:
Calling the createDBParameterGroup operation
var params = {
DBParameterGroupFamily: 'STRING_VALUE', /* required */
DBParameterGroupName: 'STRING_VALUE', /* required */
Description: 'STRING_VALUE' /* required */
};
rds.createDBParameterGroup(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
DBParameterGroupName
— (String
)DBParameterGroupFamily
— (String
)Description
— (String
)
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:DBParameterGroup
— (map
)DBParameterGroupName
— (String
)DBParameterGroupFamily
— (String
)Description
— (String
)
-
(AWS.Response)
—
Returns:
createDBSecurityGroup(params = {}, callback) ⇒ AWS.Request
Calls the CreateDBSecurityGroup API operation.
Service Reference:
Examples:
Calling the createDBSecurityGroup operation
var params = {
DBSecurityGroupDescription: 'STRING_VALUE', /* required */
DBSecurityGroupName: 'STRING_VALUE' /* required */
};
rds.createDBSecurityGroup(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
DBSecurityGroupName
— (String
)DBSecurityGroupDescription
— (String
)
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:DBSecurityGroup
— (map
)OwnerId
— (String
)DBSecurityGroupName
— (String
)DBSecurityGroupDescription
— (String
)VpcId
— (String
)EC2SecurityGroups
— (Array<map>
)Status
— (String
)EC2SecurityGroupName
— (String
)EC2SecurityGroupId
— (String
)EC2SecurityGroupOwnerId
— (String
)
IPRanges
— (Array<map>
)Status
— (String
)CIDRIP
— (String
)
-
(AWS.Response)
—
Returns:
createDBSnapshot(params = {}, callback) ⇒ AWS.Request
Calls the CreateDBSnapshot API operation.
Service Reference:
Examples:
Calling the createDBSnapshot operation
var params = {
DBInstanceIdentifier: 'STRING_VALUE', /* required */
DBSnapshotIdentifier: 'STRING_VALUE' /* required */
};
rds.createDBSnapshot(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
DBSnapshotIdentifier
— (String
)DBInstanceIdentifier
— (String
)
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:DBSnapshot
— (map
)DBSnapshotIdentifier
— (String
)DBInstanceIdentifier
— (String
)SnapshotCreateTime
— (Date
)Engine
— (String
)AllocatedStorage
— (Integer
)Status
— (String
)Port
— (Integer
)AvailabilityZone
— (String
)VpcId
— (String
)InstanceCreateTime
— (Date
)MasterUsername
— (String
)EngineVersion
— (String
)LicenseModel
— (String
)SnapshotType
— (String
)Iops
— (Integer
)OptionGroupName
— (String
)
-
(AWS.Response)
—
Returns:
createDBSubnetGroup(params = {}, callback) ⇒ AWS.Request
Calls the CreateDBSubnetGroup API operation.
Service Reference:
Examples:
Calling the createDBSubnetGroup operation
var params = {
DBSubnetGroupDescription: 'STRING_VALUE', /* required */
DBSubnetGroupName: 'STRING_VALUE', /* required */
SubnetIds: [ /* required */
'STRING_VALUE',
/* more items */
]
};
rds.createDBSubnetGroup(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
DBSubnetGroupName
— (String
)DBSubnetGroupDescription
— (String
)SubnetIds
— (Array<String>
)
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:DBSubnetGroup
— (map
)DBSubnetGroupName
— (String
)DBSubnetGroupDescription
— (String
)VpcId
— (String
)SubnetGroupStatus
— (String
)Subnets
— (Array<map>
)SubnetIdentifier
— (String
)SubnetAvailabilityZone
— (map
)Name
— (String
)ProvisionedIopsCapable
— (Boolean
)
SubnetStatus
— (String
)
-
(AWS.Response)
—
Returns:
createEventSubscription(params = {}, callback) ⇒ AWS.Request
Calls the CreateEventSubscription API operation.
Service Reference:
Examples:
Calling the createEventSubscription operation
var params = {
SnsTopicArn: 'STRING_VALUE', /* required */
SubscriptionName: 'STRING_VALUE', /* required */
Enabled: true || false,
EventCategories: [
'STRING_VALUE',
/* more items */
],
SourceIds: [
'STRING_VALUE',
/* more items */
],
SourceType: 'STRING_VALUE'
};
rds.createEventSubscription(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
SubscriptionName
— (String
)SnsTopicArn
— (String
)SourceType
— (String
)EventCategories
— (Array<String>
)SourceIds
— (Array<String>
)Enabled
— (Boolean
)
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:EventSubscription
— (map
)CustomerAwsId
— (String
)CustSubscriptionId
— (String
)SnsTopicArn
— (String
)Status
— (String
)SubscriptionCreationTime
— (String
)SourceType
— (String
)SourceIdsList
— (Array<String>
)EventCategoriesList
— (Array<String>
)Enabled
— (Boolean
)
-
(AWS.Response)
—
Returns:
createOptionGroup(params = {}, callback) ⇒ AWS.Request
Calls the CreateOptionGroup API operation.
Service Reference:
Examples:
Calling the createOptionGroup operation
var params = {
EngineName: 'STRING_VALUE', /* required */
MajorEngineVersion: 'STRING_VALUE', /* required */
OptionGroupDescription: 'STRING_VALUE', /* required */
OptionGroupName: 'STRING_VALUE' /* required */
};
rds.createOptionGroup(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
OptionGroupName
— (String
)EngineName
— (String
)MajorEngineVersion
— (String
)OptionGroupDescription
— (String
)
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:OptionGroup
— (map
)OptionGroupName
— (String
)OptionGroupDescription
— (String
)EngineName
— (String
)MajorEngineVersion
— (String
)Options
— (Array<map>
)OptionName
— (String
)OptionDescription
— (String
)Persistent
— (Boolean
)Port
— (Integer
)OptionSettings
— (Array<map>
)Name
— (String
)Value
— (String
)DefaultValue
— (String
)Description
— (String
)ApplyType
— (String
)DataType
— (String
)AllowedValues
— (String
)IsModifiable
— (Boolean
)IsCollection
— (Boolean
)
DBSecurityGroupMemberships
— (Array<map>
)DBSecurityGroupName
— (String
)Status
— (String
)
VpcSecurityGroupMemberships
— (Array<map>
)VpcSecurityGroupId
— (String
)Status
— (String
)
AllowsVpcAndNonVpcInstanceMemberships
— (Boolean
)VpcId
— (String
)
-
(AWS.Response)
—
Returns:
deleteDBInstance(params = {}, callback) ⇒ AWS.Request
Calls the DeleteDBInstance API operation.
Service Reference:
Examples:
Calling the deleteDBInstance operation
var params = {
DBInstanceIdentifier: 'STRING_VALUE', /* required */
FinalDBSnapshotIdentifier: 'STRING_VALUE',
SkipFinalSnapshot: true || false
};
rds.deleteDBInstance(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
DBInstanceIdentifier
— (String
)SkipFinalSnapshot
— (Boolean
)FinalDBSnapshotIdentifier
— (String
)
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:DBInstance
— (map
)DBInstanceIdentifier
— (String
)DBInstanceClass
— (String
)Engine
— (String
)DBInstanceStatus
— (String
)MasterUsername
— (String
)DBName
— (String
)Endpoint
— (map
)Address
— (String
)Port
— (Integer
)
AllocatedStorage
— (Integer
)InstanceCreateTime
— (Date
)PreferredBackupWindow
— (String
)BackupRetentionPeriod
— (Integer
)DBSecurityGroups
— (Array<map>
)DBSecurityGroupName
— (String
)Status
— (String
)
VpcSecurityGroups
— (Array<map>
)VpcSecurityGroupId
— (String
)Status
— (String
)
DBParameterGroups
— (Array<map>
)DBParameterGroupName
— (String
)ParameterApplyStatus
— (String
)
AvailabilityZone
— (String
)DBSubnetGroup
— (map
)DBSubnetGroupName
— (String
)DBSubnetGroupDescription
— (String
)VpcId
— (String
)SubnetGroupStatus
— (String
)Subnets
— (Array<map>
)SubnetIdentifier
— (String
)SubnetAvailabilityZone
— (map
)Name
— (String
)ProvisionedIopsCapable
— (Boolean
)
SubnetStatus
— (String
)
PreferredMaintenanceWindow
— (String
)PendingModifiedValues
— (map
)DBInstanceClass
— (String
)AllocatedStorage
— (Integer
)MasterUserPassword
— (String
)Port
— (Integer
)BackupRetentionPeriod
— (Integer
)MultiAZ
— (Boolean
)EngineVersion
— (String
)Iops
— (Integer
)DBInstanceIdentifier
— (String
)
LatestRestorableTime
— (Date
)MultiAZ
— (Boolean
)EngineVersion
— (String
)AutoMinorVersionUpgrade
— (Boolean
)ReadReplicaSourceDBInstanceIdentifier
— (String
)ReadReplicaDBInstanceIdentifiers
— (Array<String>
)LicenseModel
— (String
)Iops
— (Integer
)OptionGroupMemberships
— (Array<map>
)OptionGroupName
— (String
)Status
— (String
)
CharacterSetName
— (String
)SecondaryAvailabilityZone
— (String
)PubliclyAccessible
— (Boolean
)
-
(AWS.Response)
—
Returns:
deleteDBParameterGroup(params = {}, callback) ⇒ AWS.Request
Calls the DeleteDBParameterGroup API operation.
Service Reference:
Examples:
Calling the deleteDBParameterGroup operation
var params = {
DBParameterGroupName: 'STRING_VALUE' /* required */
};
rds.deleteDBParameterGroup(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
DBParameterGroupName
— (String
)
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
deleteDBSecurityGroup(params = {}, callback) ⇒ AWS.Request
Calls the DeleteDBSecurityGroup API operation.
Service Reference:
Examples:
Calling the deleteDBSecurityGroup operation
var params = {
DBSecurityGroupName: 'STRING_VALUE' /* required */
};
rds.deleteDBSecurityGroup(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
DBSecurityGroupName
— (String
)
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
deleteDBSnapshot(params = {}, callback) ⇒ AWS.Request
Calls the DeleteDBSnapshot API operation.
Service Reference:
Examples:
Calling the deleteDBSnapshot operation
var params = {
DBSnapshotIdentifier: 'STRING_VALUE' /* required */
};
rds.deleteDBSnapshot(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
DBSnapshotIdentifier
— (String
)
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:DBSnapshot
— (map
)DBSnapshotIdentifier
— (String
)DBInstanceIdentifier
— (String
)SnapshotCreateTime
— (Date
)Engine
— (String
)AllocatedStorage
— (Integer
)Status
— (String
)Port
— (Integer
)AvailabilityZone
— (String
)VpcId
— (String
)InstanceCreateTime
— (Date
)MasterUsername
— (String
)EngineVersion
— (String
)LicenseModel
— (String
)SnapshotType
— (String
)Iops
— (Integer
)OptionGroupName
— (String
)
-
(AWS.Response)
—
Returns:
deleteDBSubnetGroup(params = {}, callback) ⇒ AWS.Request
Calls the DeleteDBSubnetGroup API operation.
Service Reference:
Examples:
Calling the deleteDBSubnetGroup operation
var params = {
DBSubnetGroupName: 'STRING_VALUE' /* required */
};
rds.deleteDBSubnetGroup(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
DBSubnetGroupName
— (String
)
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
deleteEventSubscription(params = {}, callback) ⇒ AWS.Request
Calls the DeleteEventSubscription API operation.
Service Reference:
Examples:
Calling the deleteEventSubscription operation
var params = {
SubscriptionName: 'STRING_VALUE' /* required */
};
rds.deleteEventSubscription(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
SubscriptionName
— (String
)
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:EventSubscription
— (map
)CustomerAwsId
— (String
)CustSubscriptionId
— (String
)SnsTopicArn
— (String
)Status
— (String
)SubscriptionCreationTime
— (String
)SourceType
— (String
)SourceIdsList
— (Array<String>
)EventCategoriesList
— (Array<String>
)Enabled
— (Boolean
)
-
(AWS.Response)
—
Returns:
deleteOptionGroup(params = {}, callback) ⇒ AWS.Request
Calls the DeleteOptionGroup API operation.
Service Reference:
Examples:
Calling the deleteOptionGroup operation
var params = {
OptionGroupName: 'STRING_VALUE' /* required */
};
rds.deleteOptionGroup(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
OptionGroupName
— (String
)
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
describeDBEngineVersions(params = {}, callback) ⇒ AWS.Request
Calls the DescribeDBEngineVersions API operation.
Service Reference:
Examples:
Calling the describeDBEngineVersions operation
var params = {
DBParameterGroupFamily: 'STRING_VALUE',
DefaultOnly: true || false,
Engine: 'STRING_VALUE',
EngineVersion: 'STRING_VALUE',
ListSupportedCharacterSets: true || false,
Marker: 'STRING_VALUE',
MaxRecords: 'NUMBER_VALUE'
};
rds.describeDBEngineVersions(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
Engine
— (String
)EngineVersion
— (String
)DBParameterGroupFamily
— (String
)MaxRecords
— (Integer
)Marker
— (String
)DefaultOnly
— (Boolean
)ListSupportedCharacterSets
— (Boolean
)
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:Marker
— (String
)DBEngineVersions
— (Array<map>
)Engine
— (String
)EngineVersion
— (String
)DBParameterGroupFamily
— (String
)DBEngineDescription
— (String
)DBEngineVersionDescription
— (String
)DefaultCharacterSet
— (map
)CharacterSetName
— (String
)CharacterSetDescription
— (String
)
SupportedCharacterSets
— (Array<map>
)CharacterSetName
— (String
)CharacterSetDescription
— (String
)
-
(AWS.Response)
—
Returns:
describeDBInstances(params = {}, callback) ⇒ AWS.Request
Calls the DescribeDBInstances API operation.
Service Reference:
Examples:
Calling the describeDBInstances operation
var params = {
DBInstanceIdentifier: 'STRING_VALUE',
Marker: 'STRING_VALUE',
MaxRecords: 'NUMBER_VALUE'
};
rds.describeDBInstances(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
DBInstanceIdentifier
— (String
)MaxRecords
— (Integer
)Marker
— (String
)
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:Marker
— (String
)DBInstances
— (Array<map>
)DBInstanceIdentifier
— (String
)DBInstanceClass
— (String
)Engine
— (String
)DBInstanceStatus
— (String
)MasterUsername
— (String
)DBName
— (String
)Endpoint
— (map
)Address
— (String
)Port
— (Integer
)
AllocatedStorage
— (Integer
)InstanceCreateTime
— (Date
)PreferredBackupWindow
— (String
)BackupRetentionPeriod
— (Integer
)DBSecurityGroups
— (Array<map>
)DBSecurityGroupName
— (String
)Status
— (String
)
VpcSecurityGroups
— (Array<map>
)VpcSecurityGroupId
— (String
)Status
— (String
)
DBParameterGroups
— (Array<map>
)DBParameterGroupName
— (String
)ParameterApplyStatus
— (String
)
AvailabilityZone
— (String
)DBSubnetGroup
— (map
)DBSubnetGroupName
— (String
)DBSubnetGroupDescription
— (String
)VpcId
— (String
)SubnetGroupStatus
— (String
)Subnets
— (Array<map>
)SubnetIdentifier
— (String
)SubnetAvailabilityZone
— (map
)Name
— (String
)ProvisionedIopsCapable
— (Boolean
)
SubnetStatus
— (String
)
PreferredMaintenanceWindow
— (String
)PendingModifiedValues
— (map
)DBInstanceClass
— (String
)AllocatedStorage
— (Integer
)MasterUserPassword
— (String
)Port
— (Integer
)BackupRetentionPeriod
— (Integer
)MultiAZ
— (Boolean
)EngineVersion
— (String
)Iops
— (Integer
)DBInstanceIdentifier
— (String
)
LatestRestorableTime
— (Date
)MultiAZ
— (Boolean
)EngineVersion
— (String
)AutoMinorVersionUpgrade
— (Boolean
)ReadReplicaSourceDBInstanceIdentifier
— (String
)ReadReplicaDBInstanceIdentifiers
— (Array<String>
)LicenseModel
— (String
)Iops
— (Integer
)OptionGroupMemberships
— (Array<map>
)OptionGroupName
— (String
)Status
— (String
)
CharacterSetName
— (String
)SecondaryAvailabilityZone
— (String
)PubliclyAccessible
— (Boolean
)
-
(AWS.Response)
—
Returns:
describeDBLogFiles(params = {}, callback) ⇒ AWS.Request
Calls the DescribeDBLogFiles API operation.
Service Reference:
Examples:
Calling the describeDBLogFiles operation
var params = {
DBInstanceIdentifier: 'STRING_VALUE', /* required */
FileLastWritten: 'NUMBER_VALUE',
FileSize: 'NUMBER_VALUE',
FilenameContains: 'STRING_VALUE',
Marker: 'STRING_VALUE',
MaxRecords: 'NUMBER_VALUE'
};
rds.describeDBLogFiles(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
DBInstanceIdentifier
— (String
)FilenameContains
— (String
)FileLastWritten
— (Integer
)FileSize
— (Integer
)MaxRecords
— (Integer
)Marker
— (String
)
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:DescribeDBLogFiles
— (Array<map>
)LogFileName
— (String
)LastWritten
— (Integer
)Size
— (Integer
)
Marker
— (String
)
-
(AWS.Response)
—
Returns:
describeDBParameterGroups(params = {}, callback) ⇒ AWS.Request
Calls the DescribeDBParameterGroups API operation.
Service Reference:
Examples:
Calling the describeDBParameterGroups operation
var params = {
DBParameterGroupName: 'STRING_VALUE',
Marker: 'STRING_VALUE',
MaxRecords: 'NUMBER_VALUE'
};
rds.describeDBParameterGroups(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
DBParameterGroupName
— (String
)MaxRecords
— (Integer
)Marker
— (String
)
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:Marker
— (String
)DBParameterGroups
— (Array<map>
)DBParameterGroupName
— (String
)DBParameterGroupFamily
— (String
)Description
— (String
)
-
(AWS.Response)
—
Returns:
describeDBParameters(params = {}, callback) ⇒ AWS.Request
Calls the DescribeDBParameters API operation.
Service Reference:
Examples:
Calling the describeDBParameters operation
var params = {
DBParameterGroupName: 'STRING_VALUE', /* required */
Marker: 'STRING_VALUE',
MaxRecords: 'NUMBER_VALUE',
Source: 'STRING_VALUE'
};
rds.describeDBParameters(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
DBParameterGroupName
— (String
)Source
— (String
)MaxRecords
— (Integer
)Marker
— (String
)
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:Parameters
— (Array<map>
)ParameterName
— (String
)ParameterValue
— (String
)Description
— (String
)Source
— (String
)ApplyType
— (String
)DataType
— (String
)AllowedValues
— (String
)IsModifiable
— (Boolean
)MinimumEngineVersion
— (String
)ApplyMethod
— (String
) Possible values include:"immediate"
"pending-reboot"
Marker
— (String
)
-
(AWS.Response)
—
Returns:
describeDBSecurityGroups(params = {}, callback) ⇒ AWS.Request
Calls the DescribeDBSecurityGroups API operation.
Service Reference:
Examples:
Calling the describeDBSecurityGroups operation
var params = {
DBSecurityGroupName: 'STRING_VALUE',
Marker: 'STRING_VALUE',
MaxRecords: 'NUMBER_VALUE'
};
rds.describeDBSecurityGroups(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
DBSecurityGroupName
— (String
)MaxRecords
— (Integer
)Marker
— (String
)
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:Marker
— (String
)DBSecurityGroups
— (Array<map>
)OwnerId
— (String
)DBSecurityGroupName
— (String
)DBSecurityGroupDescription
— (String
)VpcId
— (String
)EC2SecurityGroups
— (Array<map>
)Status
— (String
)EC2SecurityGroupName
— (String
)EC2SecurityGroupId
— (String
)EC2SecurityGroupOwnerId
— (String
)
IPRanges
— (Array<map>
)Status
— (String
)CIDRIP
— (String
)
-
(AWS.Response)
—
Returns:
describeDBSnapshots(params = {}, callback) ⇒ AWS.Request
Calls the DescribeDBSnapshots API operation.
Service Reference:
Examples:
Calling the describeDBSnapshots operation
var params = {
DBInstanceIdentifier: 'STRING_VALUE',
DBSnapshotIdentifier: 'STRING_VALUE',
Marker: 'STRING_VALUE',
MaxRecords: 'NUMBER_VALUE',
SnapshotType: 'STRING_VALUE'
};
rds.describeDBSnapshots(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
DBInstanceIdentifier
— (String
)DBSnapshotIdentifier
— (String
)SnapshotType
— (String
)MaxRecords
— (Integer
)Marker
— (String
)
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:Marker
— (String
)DBSnapshots
— (Array<map>
)DBSnapshotIdentifier
— (String
)DBInstanceIdentifier
— (String
)SnapshotCreateTime
— (Date
)Engine
— (String
)AllocatedStorage
— (Integer
)Status
— (String
)Port
— (Integer
)AvailabilityZone
— (String
)VpcId
— (String
)InstanceCreateTime
— (Date
)MasterUsername
— (String
)EngineVersion
— (String
)LicenseModel
— (String
)SnapshotType
— (String
)Iops
— (Integer
)OptionGroupName
— (String
)
-
(AWS.Response)
—
Returns:
describeDBSubnetGroups(params = {}, callback) ⇒ AWS.Request
Calls the DescribeDBSubnetGroups API operation.
Service Reference:
Examples:
Calling the describeDBSubnetGroups operation
var params = {
DBSubnetGroupName: 'STRING_VALUE',
Marker: 'STRING_VALUE',
MaxRecords: 'NUMBER_VALUE'
};
rds.describeDBSubnetGroups(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
DBSubnetGroupName
— (String
)MaxRecords
— (Integer
)Marker
— (String
)
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:Marker
— (String
)DBSubnetGroups
— (Array<map>
)DBSubnetGroupName
— (String
)DBSubnetGroupDescription
— (String
)VpcId
— (String
)SubnetGroupStatus
— (String
)Subnets
— (Array<map>
)SubnetIdentifier
— (String
)SubnetAvailabilityZone
— (map
)Name
— (String
)ProvisionedIopsCapable
— (Boolean
)
SubnetStatus
— (String
)
-
(AWS.Response)
—
Returns:
describeEngineDefaultParameters(params = {}, callback) ⇒ AWS.Request
Calls the DescribeEngineDefaultParameters API operation.
Service Reference:
Examples:
Calling the describeEngineDefaultParameters operation
var params = {
DBParameterGroupFamily: 'STRING_VALUE', /* required */
Marker: 'STRING_VALUE',
MaxRecords: 'NUMBER_VALUE'
};
rds.describeEngineDefaultParameters(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
DBParameterGroupFamily
— (String
)MaxRecords
— (Integer
)Marker
— (String
)
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:EngineDefaults
— (map
)DBParameterGroupFamily
— (String
)Marker
— (String
)Parameters
— (Array<map>
)ParameterName
— (String
)ParameterValue
— (String
)Description
— (String
)Source
— (String
)ApplyType
— (String
)DataType
— (String
)AllowedValues
— (String
)IsModifiable
— (Boolean
)MinimumEngineVersion
— (String
)ApplyMethod
— (String
) Possible values include:"immediate"
"pending-reboot"
-
(AWS.Response)
—
Returns:
describeEventCategories(params = {}, callback) ⇒ AWS.Request
Calls the DescribeEventCategories API operation.
Service Reference:
Examples:
Calling the describeEventCategories operation
var params = {
SourceType: 'STRING_VALUE'
};
rds.describeEventCategories(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
SourceType
— (String
)
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:EventCategoriesMapList
— (Array<map>
)SourceType
— (String
)EventCategories
— (Array<String>
)
-
(AWS.Response)
—
Returns:
describeEvents(params = {}, callback) ⇒ AWS.Request
Calls the DescribeEvents API operation.
Service Reference:
Examples:
Calling the describeEvents operation
var params = {
Duration: 'NUMBER_VALUE',
EndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
EventCategories: [
'STRING_VALUE',
/* more items */
],
Marker: 'STRING_VALUE',
MaxRecords: 'NUMBER_VALUE',
SourceIdentifier: 'STRING_VALUE',
SourceType: db-instance | db-parameter-group | db-security-group | db-snapshot,
StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
};
rds.describeEvents(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
SourceIdentifier
— (String
)SourceType
— (String
) Possible values include:"db-instance"
"db-parameter-group"
"db-security-group"
"db-snapshot"
StartTime
— (Date
)EndTime
— (Date
)Duration
— (Integer
)EventCategories
— (Array<String>
)MaxRecords
— (Integer
)Marker
— (String
)
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:Marker
— (String
)Events
— (Array<map>
)SourceIdentifier
— (String
)SourceType
— (String
) Possible values include:"db-instance"
"db-parameter-group"
"db-security-group"
"db-snapshot"
Message
— (String
)EventCategories
— (Array<String>
)Date
— (Date
)
-
(AWS.Response)
—
Returns:
describeEventSubscriptions(params = {}, callback) ⇒ AWS.Request
Calls the DescribeEventSubscriptions API operation.
Service Reference:
Examples:
Calling the describeEventSubscriptions operation
var params = {
Marker: 'STRING_VALUE',
MaxRecords: 'NUMBER_VALUE',
SubscriptionName: 'STRING_VALUE'
};
rds.describeEventSubscriptions(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
SubscriptionName
— (String
)MaxRecords
— (Integer
)Marker
— (String
)
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:Marker
— (String
)EventSubscriptionsList
— (Array<map>
)CustomerAwsId
— (String
)CustSubscriptionId
— (String
)SnsTopicArn
— (String
)Status
— (String
)SubscriptionCreationTime
— (String
)SourceType
— (String
)SourceIdsList
— (Array<String>
)EventCategoriesList
— (Array<String>
)Enabled
— (Boolean
)
-
(AWS.Response)
—
Returns:
describeOptionGroupOptions(params = {}, callback) ⇒ AWS.Request
Calls the DescribeOptionGroupOptions API operation.
Service Reference:
Examples:
Calling the describeOptionGroupOptions operation
var params = {
EngineName: 'STRING_VALUE', /* required */
MajorEngineVersion: 'STRING_VALUE',
Marker: 'STRING_VALUE',
MaxRecords: 'NUMBER_VALUE'
};
rds.describeOptionGroupOptions(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
EngineName
— (String
)MajorEngineVersion
— (String
)MaxRecords
— (Integer
)Marker
— (String
)
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:OptionGroupOptions
— (Array<map>
)Name
— (String
)Description
— (String
)EngineName
— (String
)MajorEngineVersion
— (String
)MinimumRequiredMinorEngineVersion
— (String
)PortRequired
— (Boolean
)DefaultPort
— (Integer
)OptionsDependedOn
— (Array<String>
)Persistent
— (Boolean
)OptionGroupOptionSettings
— (Array<map>
)SettingName
— (String
)SettingDescription
— (String
)DefaultValue
— (String
)ApplyType
— (String
)AllowedValues
— (String
)IsModifiable
— (Boolean
)
Marker
— (String
)
-
(AWS.Response)
—
Returns:
describeOptionGroups(params = {}, callback) ⇒ AWS.Request
Calls the DescribeOptionGroups API operation.
Service Reference:
Examples:
Calling the describeOptionGroups operation
var params = {
EngineName: 'STRING_VALUE',
MajorEngineVersion: 'STRING_VALUE',
Marker: 'STRING_VALUE',
MaxRecords: 'NUMBER_VALUE',
OptionGroupName: 'STRING_VALUE'
};
rds.describeOptionGroups(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
OptionGroupName
— (String
)Marker
— (String
)MaxRecords
— (Integer
)EngineName
— (String
)MajorEngineVersion
— (String
)
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:OptionGroupsList
— (Array<map>
)OptionGroupName
— (String
)OptionGroupDescription
— (String
)EngineName
— (String
)MajorEngineVersion
— (String
)Options
— (Array<map>
)OptionName
— (String
)OptionDescription
— (String
)Persistent
— (Boolean
)Port
— (Integer
)OptionSettings
— (Array<map>
)Name
— (String
)Value
— (String
)DefaultValue
— (String
)Description
— (String
)ApplyType
— (String
)DataType
— (String
)AllowedValues
— (String
)IsModifiable
— (Boolean
)IsCollection
— (Boolean
)
DBSecurityGroupMemberships
— (Array<map>
)DBSecurityGroupName
— (String
)Status
— (String
)
VpcSecurityGroupMemberships
— (Array<map>
)VpcSecurityGroupId
— (String
)Status
— (String
)
AllowsVpcAndNonVpcInstanceMemberships
— (Boolean
)VpcId
— (String
)
Marker
— (String
)
-
(AWS.Response)
—
Returns:
describeOrderableDBInstanceOptions(params = {}, callback) ⇒ AWS.Request
Calls the DescribeOrderableDBInstanceOptions API operation.
Service Reference:
Examples:
Calling the describeOrderableDBInstanceOptions operation
var params = {
Engine: 'STRING_VALUE', /* required */
DBInstanceClass: 'STRING_VALUE',
EngineVersion: 'STRING_VALUE',
LicenseModel: 'STRING_VALUE',
Marker: 'STRING_VALUE',
MaxRecords: 'NUMBER_VALUE',
Vpc: true || false
};
rds.describeOrderableDBInstanceOptions(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
Engine
— (String
)EngineVersion
— (String
)DBInstanceClass
— (String
)LicenseModel
— (String
)Vpc
— (Boolean
)MaxRecords
— (Integer
)Marker
— (String
)
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:OrderableDBInstanceOptions
— (Array<map>
)Engine
— (String
)EngineVersion
— (String
)DBInstanceClass
— (String
)LicenseModel
— (String
)AvailabilityZones
— (Array<map>
)Name
— (String
)ProvisionedIopsCapable
— (Boolean
)
MultiAZCapable
— (Boolean
)ReadReplicaCapable
— (Boolean
)Vpc
— (Boolean
)
Marker
— (String
)
-
(AWS.Response)
—
Returns:
describeReservedDBInstances(params = {}, callback) ⇒ AWS.Request
Calls the DescribeReservedDBInstances API operation.
Service Reference:
Examples:
Calling the describeReservedDBInstances operation
var params = {
DBInstanceClass: 'STRING_VALUE',
Duration: 'STRING_VALUE',
Marker: 'STRING_VALUE',
MaxRecords: 'NUMBER_VALUE',
MultiAZ: true || false,
OfferingType: 'STRING_VALUE',
ProductDescription: 'STRING_VALUE',
ReservedDBInstanceId: 'STRING_VALUE',
ReservedDBInstancesOfferingId: 'STRING_VALUE'
};
rds.describeReservedDBInstances(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
ReservedDBInstanceId
— (String
)ReservedDBInstancesOfferingId
— (String
)DBInstanceClass
— (String
)Duration
— (String
)ProductDescription
— (String
)OfferingType
— (String
)MultiAZ
— (Boolean
)MaxRecords
— (Integer
)Marker
— (String
)
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:Marker
— (String
)ReservedDBInstances
— (Array<map>
)ReservedDBInstanceId
— (String
)ReservedDBInstancesOfferingId
— (String
)DBInstanceClass
— (String
)StartTime
— (Date
)Duration
— (Integer
)FixedPrice
— (Float
)UsagePrice
— (Float
)CurrencyCode
— (String
)DBInstanceCount
— (Integer
)ProductDescription
— (String
)OfferingType
— (String
)MultiAZ
— (Boolean
)State
— (String
)RecurringCharges
— (Array<map>
)RecurringChargeAmount
— (Float
)RecurringChargeFrequency
— (String
)
-
(AWS.Response)
—
Returns:
describeReservedDBInstancesOfferings(params = {}, callback) ⇒ AWS.Request
Calls the DescribeReservedDBInstancesOfferings API operation.
Service Reference:
Examples:
Calling the describeReservedDBInstancesOfferings operation
var params = {
DBInstanceClass: 'STRING_VALUE',
Duration: 'STRING_VALUE',
Marker: 'STRING_VALUE',
MaxRecords: 'NUMBER_VALUE',
MultiAZ: true || false,
OfferingType: 'STRING_VALUE',
ProductDescription: 'STRING_VALUE',
ReservedDBInstancesOfferingId: 'STRING_VALUE'
};
rds.describeReservedDBInstancesOfferings(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
ReservedDBInstancesOfferingId
— (String
)DBInstanceClass
— (String
)Duration
— (String
)ProductDescription
— (String
)OfferingType
— (String
)MultiAZ
— (Boolean
)MaxRecords
— (Integer
)Marker
— (String
)
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:Marker
— (String
)ReservedDBInstancesOfferings
— (Array<map>
)ReservedDBInstancesOfferingId
— (String
)DBInstanceClass
— (String
)Duration
— (Integer
)FixedPrice
— (Float
)UsagePrice
— (Float
)CurrencyCode
— (String
)ProductDescription
— (String
)OfferingType
— (String
)MultiAZ
— (Boolean
)RecurringCharges
— (Array<map>
)RecurringChargeAmount
— (Float
)RecurringChargeFrequency
— (String
)
-
(AWS.Response)
—
Returns:
downloadDBLogFilePortion(params = {}, callback) ⇒ AWS.Request
Calls the DownloadDBLogFilePortion API operation.
Service Reference:
Examples:
Calling the downloadDBLogFilePortion operation
var params = {
DBInstanceIdentifier: 'STRING_VALUE', /* required */
LogFileName: 'STRING_VALUE', /* required */
Marker: 'STRING_VALUE',
NumberOfLines: 'NUMBER_VALUE'
};
rds.downloadDBLogFilePortion(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
DBInstanceIdentifier
— (String
)LogFileName
— (String
)Marker
— (String
)NumberOfLines
— (Integer
)
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:LogFileData
— (String
)Marker
— (String
)AdditionalDataPending
— (Boolean
)
-
(AWS.Response)
—
Returns:
listTagsForResource(params = {}, callback) ⇒ AWS.Request
Calls the ListTagsForResource API operation.
Service Reference:
Examples:
Calling the listTagsForResource operation
var params = {
ResourceName: 'STRING_VALUE' /* required */
};
rds.listTagsForResource(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
ResourceName
— (String
)
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:TagList
— (Array<map>
)Key
— (String
)Value
— (String
)
-
(AWS.Response)
—
Returns:
modifyDBInstance(params = {}, callback) ⇒ AWS.Request
Calls the ModifyDBInstance API operation.
Service Reference:
Examples:
Calling the modifyDBInstance operation
var params = {
DBInstanceIdentifier: 'STRING_VALUE', /* required */
AllocatedStorage: 'NUMBER_VALUE',
AllowMajorVersionUpgrade: true || false,
ApplyImmediately: true || false,
AutoMinorVersionUpgrade: true || false,
BackupRetentionPeriod: 'NUMBER_VALUE',
DBInstanceClass: 'STRING_VALUE',
DBParameterGroupName: 'STRING_VALUE',
DBSecurityGroups: [
'STRING_VALUE',
/* more items */
],
EngineVersion: 'STRING_VALUE',
Iops: 'NUMBER_VALUE',
MasterUserPassword: 'STRING_VALUE',
MultiAZ: true || false,
NewDBInstanceIdentifier: 'STRING_VALUE',
OptionGroupName: 'STRING_VALUE',
PreferredBackupWindow: 'STRING_VALUE',
PreferredMaintenanceWindow: 'STRING_VALUE',
VpcSecurityGroupIds: [
'STRING_VALUE',
/* more items */
]
};
rds.modifyDBInstance(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
DBInstanceIdentifier
— (String
)AllocatedStorage
— (Integer
)DBInstanceClass
— (String
)DBSecurityGroups
— (Array<String>
)VpcSecurityGroupIds
— (Array<String>
)ApplyImmediately
— (Boolean
)MasterUserPassword
— (String
)DBParameterGroupName
— (String
)BackupRetentionPeriod
— (Integer
)PreferredBackupWindow
— (String
)PreferredMaintenanceWindow
— (String
)MultiAZ
— (Boolean
)EngineVersion
— (String
)AllowMajorVersionUpgrade
— (Boolean
)AutoMinorVersionUpgrade
— (Boolean
)Iops
— (Integer
)OptionGroupName
— (String
)NewDBInstanceIdentifier
— (String
)
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:DBInstance
— (map
)DBInstanceIdentifier
— (String
)DBInstanceClass
— (String
)Engine
— (String
)DBInstanceStatus
— (String
)MasterUsername
— (String
)DBName
— (String
)Endpoint
— (map
)Address
— (String
)Port
— (Integer
)
AllocatedStorage
— (Integer
)InstanceCreateTime
— (Date
)PreferredBackupWindow
— (String
)BackupRetentionPeriod
— (Integer
)DBSecurityGroups
— (Array<map>
)DBSecurityGroupName
— (String
)Status
— (String
)
VpcSecurityGroups
— (Array<map>
)VpcSecurityGroupId
— (String
)Status
— (String
)
DBParameterGroups
— (Array<map>
)DBParameterGroupName
— (String
)ParameterApplyStatus
— (String
)
AvailabilityZone
— (String
)DBSubnetGroup
— (map
)DBSubnetGroupName
— (String
)DBSubnetGroupDescription
— (String
)VpcId
— (String
)SubnetGroupStatus
— (String
)Subnets
— (Array<map>
)SubnetIdentifier
— (String
)SubnetAvailabilityZone
— (map
)Name
— (String
)ProvisionedIopsCapable
— (Boolean
)
SubnetStatus
— (String
)
PreferredMaintenanceWindow
— (String
)PendingModifiedValues
— (map
)DBInstanceClass
— (String
)AllocatedStorage
— (Integer
)MasterUserPassword
— (String
)Port
— (Integer
)BackupRetentionPeriod
— (Integer
)MultiAZ
— (Boolean
)EngineVersion
— (String
)Iops
— (Integer
)DBInstanceIdentifier
— (String
)
LatestRestorableTime
— (Date
)MultiAZ
— (Boolean
)EngineVersion
— (String
)AutoMinorVersionUpgrade
— (Boolean
)ReadReplicaSourceDBInstanceIdentifier
— (String
)ReadReplicaDBInstanceIdentifiers
— (Array<String>
)LicenseModel
— (String
)Iops
— (Integer
)OptionGroupMemberships
— (Array<map>
)OptionGroupName
— (String
)Status
— (String
)
CharacterSetName
— (String
)SecondaryAvailabilityZone
— (String
)PubliclyAccessible
— (Boolean
)
-
(AWS.Response)
—
Returns:
modifyDBParameterGroup(params = {}, callback) ⇒ AWS.Request
Calls the ModifyDBParameterGroup API operation.
Service Reference:
Examples:
Calling the modifyDBParameterGroup operation
var params = {
DBParameterGroupName: 'STRING_VALUE', /* required */
Parameters: [ /* required */
{
AllowedValues: 'STRING_VALUE',
ApplyMethod: immediate | pending-reboot,
ApplyType: 'STRING_VALUE',
DataType: 'STRING_VALUE',
Description: 'STRING_VALUE',
IsModifiable: true || false,
MinimumEngineVersion: 'STRING_VALUE',
ParameterName: 'STRING_VALUE',
ParameterValue: 'STRING_VALUE',
Source: 'STRING_VALUE'
},
/* more items */
]
};
rds.modifyDBParameterGroup(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
DBParameterGroupName
— (String
)Parameters
— (Array<map>
)ParameterName
— (String
)ParameterValue
— (String
)Description
— (String
)Source
— (String
)ApplyType
— (String
)DataType
— (String
)AllowedValues
— (String
)IsModifiable
— (Boolean
)MinimumEngineVersion
— (String
)ApplyMethod
— (String
) Possible values include:"immediate"
"pending-reboot"
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:DBParameterGroupName
— (String
)
-
(AWS.Response)
—
Returns:
modifyDBSubnetGroup(params = {}, callback) ⇒ AWS.Request
Calls the ModifyDBSubnetGroup API operation.
Service Reference:
Examples:
Calling the modifyDBSubnetGroup operation
var params = {
DBSubnetGroupName: 'STRING_VALUE', /* required */
SubnetIds: [ /* required */
'STRING_VALUE',
/* more items */
],
DBSubnetGroupDescription: 'STRING_VALUE'
};
rds.modifyDBSubnetGroup(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
DBSubnetGroupName
— (String
)DBSubnetGroupDescription
— (String
)SubnetIds
— (Array<String>
)
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:DBSubnetGroup
— (map
)DBSubnetGroupName
— (String
)DBSubnetGroupDescription
— (String
)VpcId
— (String
)SubnetGroupStatus
— (String
)Subnets
— (Array<map>
)SubnetIdentifier
— (String
)SubnetAvailabilityZone
— (map
)Name
— (String
)ProvisionedIopsCapable
— (Boolean
)
SubnetStatus
— (String
)
-
(AWS.Response)
—
Returns:
modifyEventSubscription(params = {}, callback) ⇒ AWS.Request
Calls the ModifyEventSubscription API operation.
Service Reference:
Examples:
Calling the modifyEventSubscription operation
var params = {
SubscriptionName: 'STRING_VALUE', /* required */
Enabled: true || false,
EventCategories: [
'STRING_VALUE',
/* more items */
],
SnsTopicArn: 'STRING_VALUE',
SourceType: 'STRING_VALUE'
};
rds.modifyEventSubscription(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
SubscriptionName
— (String
)SnsTopicArn
— (String
)SourceType
— (String
)EventCategories
— (Array<String>
)Enabled
— (Boolean
)
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:EventSubscription
— (map
)CustomerAwsId
— (String
)CustSubscriptionId
— (String
)SnsTopicArn
— (String
)Status
— (String
)SubscriptionCreationTime
— (String
)SourceType
— (String
)SourceIdsList
— (Array<String>
)EventCategoriesList
— (Array<String>
)Enabled
— (Boolean
)
-
(AWS.Response)
—
Returns:
modifyOptionGroup(params = {}, callback) ⇒ AWS.Request
Calls the ModifyOptionGroup API operation.
Service Reference:
Examples:
Calling the modifyOptionGroup operation
var params = {
OptionGroupName: 'STRING_VALUE', /* required */
ApplyImmediately: true || false,
OptionsToInclude: [
{
OptionName: 'STRING_VALUE', /* required */
DBSecurityGroupMemberships: [
'STRING_VALUE',
/* more items */
],
OptionSettings: [
{
AllowedValues: 'STRING_VALUE',
ApplyType: 'STRING_VALUE',
DataType: 'STRING_VALUE',
DefaultValue: 'STRING_VALUE',
Description: 'STRING_VALUE',
IsCollection: true || false,
IsModifiable: true || false,
Name: 'STRING_VALUE',
Value: 'STRING_VALUE'
},
/* more items */
],
Port: 'NUMBER_VALUE',
VpcSecurityGroupMemberships: [
'STRING_VALUE',
/* more items */
]
},
/* more items */
],
OptionsToRemove: [
'STRING_VALUE',
/* more items */
]
};
rds.modifyOptionGroup(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
OptionGroupName
— (String
)OptionsToInclude
— (Array<map>
)OptionName
— required — (String
)Port
— (Integer
)DBSecurityGroupMemberships
— (Array<String>
)VpcSecurityGroupMemberships
— (Array<String>
)OptionSettings
— (Array<map>
)Name
— (String
)Value
— (String
)DefaultValue
— (String
)Description
— (String
)ApplyType
— (String
)DataType
— (String
)AllowedValues
— (String
)IsModifiable
— (Boolean
)IsCollection
— (Boolean
)
OptionsToRemove
— (Array<String>
)ApplyImmediately
— (Boolean
)
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:OptionGroup
— (map
)OptionGroupName
— (String
)OptionGroupDescription
— (String
)EngineName
— (String
)MajorEngineVersion
— (String
)Options
— (Array<map>
)OptionName
— (String
)OptionDescription
— (String
)Persistent
— (Boolean
)Port
— (Integer
)OptionSettings
— (Array<map>
)Name
— (String
)Value
— (String
)DefaultValue
— (String
)Description
— (String
)ApplyType
— (String
)DataType
— (String
)AllowedValues
— (String
)IsModifiable
— (Boolean
)IsCollection
— (Boolean
)
DBSecurityGroupMemberships
— (Array<map>
)DBSecurityGroupName
— (String
)Status
— (String
)
VpcSecurityGroupMemberships
— (Array<map>
)VpcSecurityGroupId
— (String
)Status
— (String
)
AllowsVpcAndNonVpcInstanceMemberships
— (Boolean
)VpcId
— (String
)
-
(AWS.Response)
—
Returns:
promoteReadReplica(params = {}, callback) ⇒ AWS.Request
Calls the PromoteReadReplica API operation.
Service Reference:
Examples:
Calling the promoteReadReplica operation
var params = {
DBInstanceIdentifier: 'STRING_VALUE', /* required */
BackupRetentionPeriod: 'NUMBER_VALUE',
PreferredBackupWindow: 'STRING_VALUE'
};
rds.promoteReadReplica(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
DBInstanceIdentifier
— (String
)BackupRetentionPeriod
— (Integer
)PreferredBackupWindow
— (String
)
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:DBInstance
— (map
)DBInstanceIdentifier
— (String
)DBInstanceClass
— (String
)Engine
— (String
)DBInstanceStatus
— (String
)MasterUsername
— (String
)DBName
— (String
)Endpoint
— (map
)Address
— (String
)Port
— (Integer
)
AllocatedStorage
— (Integer
)InstanceCreateTime
— (Date
)PreferredBackupWindow
— (String
)BackupRetentionPeriod
— (Integer
)DBSecurityGroups
— (Array<map>
)DBSecurityGroupName
— (String
)Status
— (String
)
VpcSecurityGroups
— (Array<map>
)VpcSecurityGroupId
— (String
)Status
— (String
)
DBParameterGroups
— (Array<map>
)DBParameterGroupName
— (String
)ParameterApplyStatus
— (String
)
AvailabilityZone
— (String
)DBSubnetGroup
— (map
)DBSubnetGroupName
— (String
)DBSubnetGroupDescription
— (String
)VpcId
— (String
)SubnetGroupStatus
— (String
)Subnets
— (Array<map>
)SubnetIdentifier
— (String
)SubnetAvailabilityZone
— (map
)Name
— (String
)ProvisionedIopsCapable
— (Boolean
)
SubnetStatus
— (String
)
PreferredMaintenanceWindow
— (String
)PendingModifiedValues
— (map
)DBInstanceClass
— (String
)AllocatedStorage
— (Integer
)MasterUserPassword
— (String
)Port
— (Integer
)BackupRetentionPeriod
— (Integer
)MultiAZ
— (Boolean
)EngineVersion
— (String
)Iops
— (Integer
)DBInstanceIdentifier
— (String
)
LatestRestorableTime
— (Date
)MultiAZ
— (Boolean
)EngineVersion
— (String
)AutoMinorVersionUpgrade
— (Boolean
)ReadReplicaSourceDBInstanceIdentifier
— (String
)ReadReplicaDBInstanceIdentifiers
— (Array<String>
)LicenseModel
— (String
)Iops
— (Integer
)OptionGroupMemberships
— (Array<map>
)OptionGroupName
— (String
)Status
— (String
)
CharacterSetName
— (String
)SecondaryAvailabilityZone
— (String
)PubliclyAccessible
— (Boolean
)
-
(AWS.Response)
—
Returns:
purchaseReservedDBInstancesOffering(params = {}, callback) ⇒ AWS.Request
Calls the PurchaseReservedDBInstancesOffering API operation.
Service Reference:
Examples:
Calling the purchaseReservedDBInstancesOffering operation
var params = {
ReservedDBInstancesOfferingId: 'STRING_VALUE', /* required */
DBInstanceCount: 'NUMBER_VALUE',
ReservedDBInstanceId: 'STRING_VALUE'
};
rds.purchaseReservedDBInstancesOffering(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
ReservedDBInstancesOfferingId
— (String
)ReservedDBInstanceId
— (String
)DBInstanceCount
— (Integer
)
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:ReservedDBInstance
— (map
)ReservedDBInstanceId
— (String
)ReservedDBInstancesOfferingId
— (String
)DBInstanceClass
— (String
)StartTime
— (Date
)Duration
— (Integer
)FixedPrice
— (Float
)UsagePrice
— (Float
)CurrencyCode
— (String
)DBInstanceCount
— (Integer
)ProductDescription
— (String
)OfferingType
— (String
)MultiAZ
— (Boolean
)State
— (String
)RecurringCharges
— (Array<map>
)RecurringChargeAmount
— (Float
)RecurringChargeFrequency
— (String
)
-
(AWS.Response)
—
Returns:
rebootDBInstance(params = {}, callback) ⇒ AWS.Request
Calls the RebootDBInstance API operation.
Service Reference:
Examples:
Calling the rebootDBInstance operation
var params = {
DBInstanceIdentifier: 'STRING_VALUE', /* required */
ForceFailover: true || false
};
rds.rebootDBInstance(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
DBInstanceIdentifier
— (String
)ForceFailover
— (Boolean
)
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:DBInstance
— (map
)DBInstanceIdentifier
— (String
)DBInstanceClass
— (String
)Engine
— (String
)DBInstanceStatus
— (String
)MasterUsername
— (String
)DBName
— (String
)Endpoint
— (map
)Address
— (String
)Port
— (Integer
)
AllocatedStorage
— (Integer
)InstanceCreateTime
— (Date
)PreferredBackupWindow
— (String
)BackupRetentionPeriod
— (Integer
)DBSecurityGroups
— (Array<map>
)DBSecurityGroupName
— (String
)Status
— (String
)
VpcSecurityGroups
— (Array<map>
)VpcSecurityGroupId
— (String
)Status
— (String
)
DBParameterGroups
— (Array<map>
)DBParameterGroupName
— (String
)ParameterApplyStatus
— (String
)
AvailabilityZone
— (String
)DBSubnetGroup
— (map
)DBSubnetGroupName
— (String
)DBSubnetGroupDescription
— (String
)VpcId
— (String
)SubnetGroupStatus
— (String
)Subnets
— (Array<map>
)SubnetIdentifier
— (String
)SubnetAvailabilityZone
— (map
)Name
— (String
)ProvisionedIopsCapable
— (Boolean
)
SubnetStatus
— (String
)
PreferredMaintenanceWindow
— (String
)PendingModifiedValues
— (map
)DBInstanceClass
— (String
)AllocatedStorage
— (Integer
)MasterUserPassword
— (String
)Port
— (Integer
)BackupRetentionPeriod
— (Integer
)MultiAZ
— (Boolean
)EngineVersion
— (String
)Iops
— (Integer
)DBInstanceIdentifier
— (String
)
LatestRestorableTime
— (Date
)MultiAZ
— (Boolean
)EngineVersion
— (String
)AutoMinorVersionUpgrade
— (Boolean
)ReadReplicaSourceDBInstanceIdentifier
— (String
)ReadReplicaDBInstanceIdentifiers
— (Array<String>
)LicenseModel
— (String
)Iops
— (Integer
)OptionGroupMemberships
— (Array<map>
)OptionGroupName
— (String
)Status
— (String
)
CharacterSetName
— (String
)SecondaryAvailabilityZone
— (String
)PubliclyAccessible
— (Boolean
)
-
(AWS.Response)
—
Returns:
removeSourceIdentifierFromSubscription(params = {}, callback) ⇒ AWS.Request
Calls the RemoveSourceIdentifierFromSubscription API operation.
Service Reference:
Examples:
Calling the removeSourceIdentifierFromSubscription operation
var params = {
SourceIdentifier: 'STRING_VALUE', /* required */
SubscriptionName: 'STRING_VALUE' /* required */
};
rds.removeSourceIdentifierFromSubscription(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
SubscriptionName
— (String
)SourceIdentifier
— (String
)
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:EventSubscription
— (map
)CustomerAwsId
— (String
)CustSubscriptionId
— (String
)SnsTopicArn
— (String
)Status
— (String
)SubscriptionCreationTime
— (String
)SourceType
— (String
)SourceIdsList
— (Array<String>
)EventCategoriesList
— (Array<String>
)Enabled
— (Boolean
)
-
(AWS.Response)
—
Returns:
removeTagsFromResource(params = {}, callback) ⇒ AWS.Request
Calls the RemoveTagsFromResource API operation.
Service Reference:
Examples:
Calling the removeTagsFromResource operation
var params = {
ResourceName: 'STRING_VALUE', /* required */
TagKeys: [ /* required */
'STRING_VALUE',
/* more items */
]
};
rds.removeTagsFromResource(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
ResourceName
— (String
)TagKeys
— (Array<String>
)
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
resetDBParameterGroup(params = {}, callback) ⇒ AWS.Request
Calls the ResetDBParameterGroup API operation.
Service Reference:
Examples:
Calling the resetDBParameterGroup operation
var params = {
DBParameterGroupName: 'STRING_VALUE', /* required */
Parameters: [
{
AllowedValues: 'STRING_VALUE',
ApplyMethod: immediate | pending-reboot,
ApplyType: 'STRING_VALUE',
DataType: 'STRING_VALUE',
Description: 'STRING_VALUE',
IsModifiable: true || false,
MinimumEngineVersion: 'STRING_VALUE',
ParameterName: 'STRING_VALUE',
ParameterValue: 'STRING_VALUE',
Source: 'STRING_VALUE'
},
/* more items */
],
ResetAllParameters: true || false
};
rds.resetDBParameterGroup(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
DBParameterGroupName
— (String
)ResetAllParameters
— (Boolean
)Parameters
— (Array<map>
)ParameterName
— (String
)ParameterValue
— (String
)Description
— (String
)Source
— (String
)ApplyType
— (String
)DataType
— (String
)AllowedValues
— (String
)IsModifiable
— (Boolean
)MinimumEngineVersion
— (String
)ApplyMethod
— (String
) Possible values include:"immediate"
"pending-reboot"
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:DBParameterGroupName
— (String
)
-
(AWS.Response)
—
Returns:
restoreDBInstanceFromDBSnapshot(params = {}, callback) ⇒ AWS.Request
Calls the RestoreDBInstanceFromDBSnapshot API operation.
Service Reference:
Examples:
Calling the restoreDBInstanceFromDBSnapshot operation
var params = {
DBInstanceIdentifier: 'STRING_VALUE', /* required */
DBSnapshotIdentifier: 'STRING_VALUE', /* required */
AutoMinorVersionUpgrade: true || false,
AvailabilityZone: 'STRING_VALUE',
DBInstanceClass: 'STRING_VALUE',
DBName: 'STRING_VALUE',
DBSubnetGroupName: 'STRING_VALUE',
Engine: 'STRING_VALUE',
Iops: 'NUMBER_VALUE',
LicenseModel: 'STRING_VALUE',
MultiAZ: true || false,
OptionGroupName: 'STRING_VALUE',
Port: 'NUMBER_VALUE',
PubliclyAccessible: true || false
};
rds.restoreDBInstanceFromDBSnapshot(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
DBInstanceIdentifier
— (String
)DBSnapshotIdentifier
— (String
)DBInstanceClass
— (String
)Port
— (Integer
)AvailabilityZone
— (String
)DBSubnetGroupName
— (String
)MultiAZ
— (Boolean
)PubliclyAccessible
— (Boolean
)AutoMinorVersionUpgrade
— (Boolean
)LicenseModel
— (String
)DBName
— (String
)Engine
— (String
)Iops
— (Integer
)OptionGroupName
— (String
)
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:DBInstance
— (map
)DBInstanceIdentifier
— (String
)DBInstanceClass
— (String
)Engine
— (String
)DBInstanceStatus
— (String
)MasterUsername
— (String
)DBName
— (String
)Endpoint
— (map
)Address
— (String
)Port
— (Integer
)
AllocatedStorage
— (Integer
)InstanceCreateTime
— (Date
)PreferredBackupWindow
— (String
)BackupRetentionPeriod
— (Integer
)DBSecurityGroups
— (Array<map>
)DBSecurityGroupName
— (String
)Status
— (String
)
VpcSecurityGroups
— (Array<map>
)VpcSecurityGroupId
— (String
)Status
— (String
)
DBParameterGroups
— (Array<map>
)DBParameterGroupName
— (String
)ParameterApplyStatus
— (String
)
AvailabilityZone
— (String
)DBSubnetGroup
— (map
)DBSubnetGroupName
— (String
)DBSubnetGroupDescription
— (String
)VpcId
— (String
)SubnetGroupStatus
— (String
)Subnets
— (Array<map>
)SubnetIdentifier
— (String
)SubnetAvailabilityZone
— (map
)Name
— (String
)ProvisionedIopsCapable
— (Boolean
)
SubnetStatus
— (String
)
PreferredMaintenanceWindow
— (String
)PendingModifiedValues
— (map
)DBInstanceClass
— (String
)AllocatedStorage
— (Integer
)MasterUserPassword
— (String
)Port
— (Integer
)BackupRetentionPeriod
— (Integer
)MultiAZ
— (Boolean
)EngineVersion
— (String
)Iops
— (Integer
)DBInstanceIdentifier
— (String
)
LatestRestorableTime
— (Date
)MultiAZ
— (Boolean
)EngineVersion
— (String
)AutoMinorVersionUpgrade
— (Boolean
)ReadReplicaSourceDBInstanceIdentifier
— (String
)ReadReplicaDBInstanceIdentifiers
— (Array<String>
)LicenseModel
— (String
)Iops
— (Integer
)OptionGroupMemberships
— (Array<map>
)OptionGroupName
— (String
)Status
— (String
)
CharacterSetName
— (String
)SecondaryAvailabilityZone
— (String
)PubliclyAccessible
— (Boolean
)
-
(AWS.Response)
—
Returns:
restoreDBInstanceToPointInTime(params = {}, callback) ⇒ AWS.Request
Calls the RestoreDBInstanceToPointInTime API operation.
Service Reference:
Examples:
Calling the restoreDBInstanceToPointInTime operation
var params = {
SourceDBInstanceIdentifier: 'STRING_VALUE', /* required */
TargetDBInstanceIdentifier: 'STRING_VALUE', /* required */
AutoMinorVersionUpgrade: true || false,
AvailabilityZone: 'STRING_VALUE',
DBInstanceClass: 'STRING_VALUE',
DBName: 'STRING_VALUE',
DBSubnetGroupName: 'STRING_VALUE',
Engine: 'STRING_VALUE',
Iops: 'NUMBER_VALUE',
LicenseModel: 'STRING_VALUE',
MultiAZ: true || false,
OptionGroupName: 'STRING_VALUE',
Port: 'NUMBER_VALUE',
PubliclyAccessible: true || false,
RestoreTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
UseLatestRestorableTime: true || false
};
rds.restoreDBInstanceToPointInTime(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
SourceDBInstanceIdentifier
— (String
)TargetDBInstanceIdentifier
— (String
)RestoreTime
— (Date
)UseLatestRestorableTime
— (Boolean
)DBInstanceClass
— (String
)Port
— (Integer
)AvailabilityZone
— (String
)DBSubnetGroupName
— (String
)MultiAZ
— (Boolean
)PubliclyAccessible
— (Boolean
)AutoMinorVersionUpgrade
— (Boolean
)LicenseModel
— (String
)DBName
— (String
)Engine
— (String
)Iops
— (Integer
)OptionGroupName
— (String
)
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:DBInstance
— (map
)DBInstanceIdentifier
— (String
)DBInstanceClass
— (String
)Engine
— (String
)DBInstanceStatus
— (String
)MasterUsername
— (String
)DBName
— (String
)Endpoint
— (map
)Address
— (String
)Port
— (Integer
)
AllocatedStorage
— (Integer
)InstanceCreateTime
— (Date
)PreferredBackupWindow
— (String
)BackupRetentionPeriod
— (Integer
)DBSecurityGroups
— (Array<map>
)DBSecurityGroupName
— (String
)Status
— (String
)
VpcSecurityGroups
— (Array<map>
)VpcSecurityGroupId
— (String
)Status
— (String
)
DBParameterGroups
— (Array<map>
)DBParameterGroupName
— (String
)ParameterApplyStatus
— (String
)
AvailabilityZone
— (String
)DBSubnetGroup
— (map
)DBSubnetGroupName
— (String
)DBSubnetGroupDescription
— (String
)VpcId
— (String
)SubnetGroupStatus
— (String
)Subnets
— (Array<map>
)SubnetIdentifier
— (String
)SubnetAvailabilityZone
— (map
)Name
— (String
)ProvisionedIopsCapable
— (Boolean
)
SubnetStatus
— (String
)
PreferredMaintenanceWindow
— (String
)PendingModifiedValues
— (map
)DBInstanceClass
— (String
)AllocatedStorage
— (Integer
)MasterUserPassword
— (String
)Port
— (Integer
)BackupRetentionPeriod
— (Integer
)MultiAZ
— (Boolean
)EngineVersion
— (String
)Iops
— (Integer
)DBInstanceIdentifier
— (String
)
LatestRestorableTime
— (Date
)MultiAZ
— (Boolean
)EngineVersion
— (String
)AutoMinorVersionUpgrade
— (Boolean
)ReadReplicaSourceDBInstanceIdentifier
— (String
)ReadReplicaDBInstanceIdentifiers
— (Array<String>
)LicenseModel
— (String
)Iops
— (Integer
)OptionGroupMemberships
— (Array<map>
)OptionGroupName
— (String
)Status
— (String
)
CharacterSetName
— (String
)SecondaryAvailabilityZone
— (String
)PubliclyAccessible
— (Boolean
)
-
(AWS.Response)
—
Returns:
revokeDBSecurityGroupIngress(params = {}, callback) ⇒ AWS.Request
Calls the RevokeDBSecurityGroupIngress API operation.
Service Reference:
Examples:
Calling the revokeDBSecurityGroupIngress operation
var params = {
DBSecurityGroupName: 'STRING_VALUE', /* required */
CIDRIP: 'STRING_VALUE',
EC2SecurityGroupId: 'STRING_VALUE',
EC2SecurityGroupName: 'STRING_VALUE',
EC2SecurityGroupOwnerId: 'STRING_VALUE'
};
rds.revokeDBSecurityGroupIngress(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
DBSecurityGroupName
— (String
)CIDRIP
— (String
)EC2SecurityGroupName
— (String
)EC2SecurityGroupId
— (String
)EC2SecurityGroupOwnerId
— (String
)
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:DBSecurityGroup
— (map
)OwnerId
— (String
)DBSecurityGroupName
— (String
)DBSecurityGroupDescription
— (String
)VpcId
— (String
)EC2SecurityGroups
— (Array<map>
)Status
— (String
)EC2SecurityGroupName
— (String
)EC2SecurityGroupId
— (String
)EC2SecurityGroupOwnerId
— (String
)
IPRanges
— (Array<map>
)Status
— (String
)CIDRIP
— (String
)
-
(AWS.Response)
—
Returns: