Class: AWS.RDS (2013-01-10)

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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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. The data 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)

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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. The data 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)

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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. The data 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)
      • OptionGroupMembership — (map)
        • OptionGroupName — (String)
        • Status — (String)
      • CharacterSetName — (String)
      • SecondaryAvailabilityZone — (String)
      • PubliclyAccessible — (Boolean)

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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. The data 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)
      • OptionGroupMembership — (map)
        • OptionGroupName — (String)
        • Status — (String)
      • CharacterSetName — (String)
      • SecondaryAvailabilityZone — (String)
      • PubliclyAccessible — (Boolean)

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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. The data object has the following properties:

    • DBParameterGroup — (map)
      • DBParameterGroupName — (String)
      • DBParameterGroupFamily — (String)
      • Description — (String)

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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. The data 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)

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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. The data 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)

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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. The data 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)

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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. The data object has the following properties:

    • EventSubscription — (map)
      • Id — (String)
      • CustomerAwsId — (String)
      • CustSubscriptionId — (String)
      • SnsTopicArn — (String)
      • Status — (String)
      • SubscriptionCreationTime — (String)
      • SourceType — (String)
      • SourceIdsList — (Array<String>)
      • EventCategoriesList — (Array<String>)
      • Enabled — (Boolean)

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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. The data object has the following properties:

    • OptionGroup — (map)
      • OptionGroupName — (String)
      • OptionGroupDescription — (String)
      • EngineName — (String)
      • MajorEngineVersion — (String)
      • Options — (Array<map>)
        • OptionName — (String)
        • OptionDescription — (String)
        • Port — (Integer)
        • DBSecurityGroupMemberships — (Array<map>)
          • DBSecurityGroupName — (String)
          • Status — (String)
        • VpcSecurityGroupMemberships — (Array<map>)
          • VpcSecurityGroupId — (String)
          • Status — (String)
      • AllowsVpcAndNonVpcInstanceMemberships — (Boolean)
      • VpcId — (String)

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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. The data 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)
      • OptionGroupMembership — (map)
        • OptionGroupName — (String)
        • Status — (String)
      • CharacterSetName — (String)
      • SecondaryAvailabilityZone — (String)
      • PubliclyAccessible — (Boolean)

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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. The data 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)

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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. The data object has the following properties:

    • EventSubscription — (map)
      • Id — (String)
      • CustomerAwsId — (String)
      • CustSubscriptionId — (String)
      • SnsTopicArn — (String)
      • Status — (String)
      • SubscriptionCreationTime — (String)
      • SourceType — (String)
      • SourceIdsList — (Array<String>)
      • EventCategoriesList — (Array<String>)
      • Enabled — (Boolean)

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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. The data 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)

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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. The data 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)
      • OptionGroupMembership — (map)
        • OptionGroupName — (String)
        • Status — (String)
      • CharacterSetName — (String)
      • SecondaryAvailabilityZone — (String)
      • PubliclyAccessible — (Boolean)

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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. The data object has the following properties:

    • Marker — (String)
    • DBParameterGroups — (Array<map>)
      • DBParameterGroupName — (String)
      • DBParameterGroupFamily — (String)
      • Description — (String)

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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. The data 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)

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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. The data 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)

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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. The data 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)

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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. The data 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)

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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. The data 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"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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. The data object has the following properties:

    • EventCategoriesMapList — (Array<map>)
      • SourceType — (String)
      • EventCategories — (Array<String>)

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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. The data 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)

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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. The data object has the following properties:

    • Marker — (String)
    • EventSubscriptionsList — (Array<map>)
      • Id — (String)
      • CustomerAwsId — (String)
      • CustSubscriptionId — (String)
      • SnsTopicArn — (String)
      • Status — (String)
      • SubscriptionCreationTime — (String)
      • SourceType — (String)
      • SourceIdsList — (Array<String>)
      • EventCategoriesList — (Array<String>)
      • Enabled — (Boolean)

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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. The data 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>)
    • Marker — (String)

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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. The data object has the following properties:

    • OptionGroupsList — (Array<map>)
      • OptionGroupName — (String)
      • OptionGroupDescription — (String)
      • EngineName — (String)
      • MajorEngineVersion — (String)
      • Options — (Array<map>)
        • OptionName — (String)
        • OptionDescription — (String)
        • Port — (Integer)
        • DBSecurityGroupMemberships — (Array<map>)
          • DBSecurityGroupName — (String)
          • Status — (String)
        • VpcSecurityGroupMemberships — (Array<map>)
          • VpcSecurityGroupId — (String)
          • Status — (String)
      • AllowsVpcAndNonVpcInstanceMemberships — (Boolean)
      • VpcId — (String)
    • Marker — (String)

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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. The data 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)

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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. The data 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)

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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. The data 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)

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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. The data object has the following properties:

    • TagList — (Array<map>)
      • Key — (String)
      • Value — (String)

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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. The data 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)
      • OptionGroupMembership — (map)
        • OptionGroupName — (String)
        • Status — (String)
      • CharacterSetName — (String)
      • SecondaryAvailabilityZone — (String)
      • PubliclyAccessible — (Boolean)

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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. The data object has the following properties:

    • DBParameterGroupName — (String)

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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. The data 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)

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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. The data object has the following properties:

    • EventSubscription — (map)
      • Id — (String)
      • CustomerAwsId — (String)
      • CustSubscriptionId — (String)
      • SnsTopicArn — (String)
      • Status — (String)
      • SubscriptionCreationTime — (String)
      • SourceType — (String)
      • SourceIdsList — (Array<String>)
      • EventCategoriesList — (Array<String>)
      • Enabled — (Boolean)

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  OptionGroupName: 'STRING_VALUE', /* required */
  ApplyImmediately: true || false,
  OptionsToInclude: [
    {
      OptionName: 'STRING_VALUE', /* required */
      DBSecurityGroupMemberships: [
        '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>)
  • 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. The data object has the following properties:

    • OptionGroup — (map)
      • OptionGroupName — (String)
      • OptionGroupDescription — (String)
      • EngineName — (String)
      • MajorEngineVersion — (String)
      • Options — (Array<map>)
        • OptionName — (String)
        • OptionDescription — (String)
        • Port — (Integer)
        • DBSecurityGroupMemberships — (Array<map>)
          • DBSecurityGroupName — (String)
          • Status — (String)
        • VpcSecurityGroupMemberships — (Array<map>)
          • VpcSecurityGroupId — (String)
          • Status — (String)
      • AllowsVpcAndNonVpcInstanceMemberships — (Boolean)
      • VpcId — (String)

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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. The data 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)
      • OptionGroupMembership — (map)
        • OptionGroupName — (String)
        • Status — (String)
      • CharacterSetName — (String)
      • SecondaryAvailabilityZone — (String)
      • PubliclyAccessible — (Boolean)

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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. The data 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)

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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. The data 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)
      • OptionGroupMembership — (map)
        • OptionGroupName — (String)
        • Status — (String)
      • CharacterSetName — (String)
      • SecondaryAvailabilityZone — (String)
      • PubliclyAccessible — (Boolean)

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

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. The data object has the following properties:

    • EventSubscription — (map)
      • Id — (String)
      • CustomerAwsId — (String)
      • CustSubscriptionId — (String)
      • SnsTopicArn — (String)
      • Status — (String)
      • SubscriptionCreationTime — (String)
      • SourceType — (String)
      • SourceIdsList — (Array<String>)
      • EventCategoriesList — (Array<String>)
      • Enabled — (Boolean)