Class: AWS.Neptune

Inherits:
AWS.Service show all
Identifier:
neptune
API Version:
2014-10-31
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Amazon Neptune is a fast, reliable, fully-managed graph database service that makes it easy to build and run applications that work with highly connected datasets. The core of Amazon Neptune is a purpose-built, high-performance graph database engine optimized for storing billions of relationships and querying the graph with milliseconds latency. Amazon Neptune supports popular graph models Property Graph and W3C's RDF, and their respective query languages Apache TinkerPop Gremlin and SPARQL, allowing you to easily build queries that efficiently navigate highly connected datasets. Neptune powers graph use cases such as recommendation engines, fraud detection, knowledge graphs, drug discovery, and network security.

This interface reference for Amazon Neptune contains documentation for a programming or command line interface you can use to manage Amazon Neptune. Note that Amazon Neptune is asynchronous, which means that some interfaces might require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. The reference structure is as follows, and we list following some related topics from the user guide.

Sending a Request Using Neptune

var neptune = new AWS.Neptune();
neptune.addRoleToDBCluster(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 Neptune object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var neptune = new AWS.Neptune({apiVersion: '2014-10-31'});

You can also set the API version globally in AWS.config.apiVersions using the neptune service identifier:

AWS.config.apiVersions = {
  neptune: '2014-10-31',
  // other service API versions
};

var neptune = new AWS.Neptune();

Version:

  • 2014-10-31

Waiter Resource States

This service supports a list of resource states that can be polled using the waitFor() method. The resource states are:

dBInstanceAvailable, dBInstanceDeleted

Constructor Summary

Property Summary

Properties inherited from AWS.Service

apiVersions

Method Summary

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, setupRequestListeners, defineService

Constructor Details

new AWS.Neptune(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a Neptune object

var neptune = new AWS.Neptune({apiVersion: '2014-10-31'});

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) —

    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'.

  • 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.Neptune.region for more information.

  • maxRetries (Integer) —

    the maximum amount of retries to attempt with a request. See AWS.Neptune.maxRetries for more information.

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.Neptune.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.
  • 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 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 returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • 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) —

    whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

  • 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.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

addRoleToDBCluster(params = {}, callback) ⇒ AWS.Request

Associates an Identity and Access Management (IAM) role from an Neptune DB cluster.

Service Reference:

Examples:

Calling the addRoleToDBCluster operation

var params = {
  DBClusterIdentifier: 'STRING_VALUE', /* required */
  RoleArn: 'STRING_VALUE' /* required */
};
neptune.addRoleToDBCluster(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: {}) —
    • DBClusterIdentifier — (String)

      The name of the DB cluster to associate the IAM role with.

    • RoleArn — (String)

      The Amazon Resource Name (ARN) of the IAM role to associate with the Neptune DB cluster, for example arn:aws:iam::123456789012:role/NeptuneAccessRole.

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.

addSourceIdentifierToSubscription(params = {}, callback) ⇒ AWS.Request

Adds a source identifier to an existing event notification subscription.

Service Reference:

Examples:

Calling the addSourceIdentifierToSubscription operation

var params = {
  SourceIdentifier: 'STRING_VALUE', /* required */
  SubscriptionName: 'STRING_VALUE' /* required */
};
neptune.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)

      The name of the event notification subscription you want to add a source identifier to.

    • SourceIdentifier — (String)

      The identifier of the event source to be added.

      Constraints:

      • If the source type is a DB instance, then a DBInstanceIdentifier must be supplied.

      • If the source type is a DB security group, a DBSecurityGroupName must be supplied.

      • If the source type is a DB parameter group, a DBParameterGroupName must be supplied.

      • If the source type is a DB snapshot, a DBSnapshotIdentifier must be supplied.

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)

        Contains the results of a successful invocation of the DescribeEventSubscriptions action.

        • CustomerAwsId — (String)

          The AWS customer account associated with the event notification subscription.

        • CustSubscriptionId — (String)

          The event notification subscription Id.

        • SnsTopicArn — (String)

          The topic ARN of the event notification subscription.

        • Status — (String)

          The status of the event notification subscription.

          Constraints:

          Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist

          The status "no-permission" indicates that Neptune no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.

        • SubscriptionCreationTime — (String)

          The time the event notification subscription was created.

        • SourceType — (String)

          The source type for the event notification subscription.

        • SourceIdsList — (Array<String>)

          A list of source IDs for the event notification subscription.

        • EventCategoriesList — (Array<String>)

          A list of event categories for the event notification subscription.

        • Enabled — (Boolean)

          A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

        • EventSubscriptionArn — (String)

          The Amazon Resource Name (ARN) for the event subscription.

Returns:

  • (AWS.Request) —

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

addTagsToResource(params = {}, callback) ⇒ AWS.Request

Adds metadata tags to an Amazon Neptune resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon Neptune resources, or used in a Condition statement in an IAM policy for Amazon Neptune.

Service Reference:

Examples:

Calling the addTagsToResource operation

var params = {
  ResourceName: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
neptune.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)

      The Amazon Neptune resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an Amazon Resource Name (ARN).

    • Tags — (Array<map>)

      The tags to be assigned to the Amazon Neptune resource.

      • Key — (String)

        A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

      • Value — (String)

        A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

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.

applyPendingMaintenanceAction(params = {}, callback) ⇒ AWS.Request

Applies a pending maintenance action to a resource (for example, to a DB instance).

Service Reference:

Examples:

Calling the applyPendingMaintenanceAction operation

var params = {
  ApplyAction: 'STRING_VALUE', /* required */
  OptInType: 'STRING_VALUE', /* required */
  ResourceIdentifier: 'STRING_VALUE' /* required */
};
neptune.applyPendingMaintenanceAction(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: {}) —
    • ResourceIdentifier — (String)

      The Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to. For information about creating an ARN, see Constructing an Amazon Resource Name (ARN).

    • ApplyAction — (String)

      The pending maintenance action to apply to this resource.

      Valid values: system-update, db-upgrade

    • OptInType — (String)

      A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in request of type immediate can't be undone.

      Valid values:

      • immediate - Apply the maintenance action immediately.

      • next-maintenance - Apply the maintenance action during the next maintenance window for the resource.

      • undo-opt-in - Cancel any existing next-maintenance opt-in requests.

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:

      • ResourcePendingMaintenanceActions — (map)

        Describes the pending maintenance actions for a resource.

        • ResourceIdentifier — (String)

          The ARN of the resource that has pending maintenance actions.

        • PendingMaintenanceActionDetails — (Array<map>)

          A list that provides details about the pending maintenance actions for the resource.

          • Action — (String)

            The type of pending maintenance action that is available for the resource.

          • AutoAppliedAfterDate — (Date)

            The date of the maintenance window when the action is applied. The maintenance action is applied to the resource during its first maintenance window after this date. If this date is specified, any next-maintenance opt-in requests are ignored.

          • ForcedApplyDate — (Date)

            The date when the maintenance action is automatically applied. The maintenance action is applied to the resource on this date regardless of the maintenance window for the resource. If this date is specified, any immediate opt-in requests are ignored.

          • OptInStatus — (String)

            Indicates the type of opt-in request that has been received for the resource.

          • CurrentApplyDate — (Date)

            The effective date when the pending maintenance action is applied to the resource. This date takes into account opt-in requests received from the ApplyPendingMaintenanceAction API, the AutoAppliedAfterDate, and the ForcedApplyDate. This value is blank if an opt-in request has not been received and nothing has been specified as AutoAppliedAfterDate or ForcedApplyDate.

          • Description — (String)

            A description providing more detail about the maintenance action.

Returns:

  • (AWS.Request) —

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

copyDBClusterParameterGroup(params = {}, callback) ⇒ AWS.Request

Copies the specified DB cluster parameter group.

Service Reference:

Examples:

Calling the copyDBClusterParameterGroup operation

var params = {
  SourceDBClusterParameterGroupIdentifier: 'STRING_VALUE', /* required */
  TargetDBClusterParameterGroupDescription: 'STRING_VALUE', /* required */
  TargetDBClusterParameterGroupIdentifier: 'STRING_VALUE', /* required */
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
neptune.copyDBClusterParameterGroup(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: {}) —
    • SourceDBClusterParameterGroupIdentifier — (String)

      The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group. For information about creating an ARN, see Constructing an Amazon Resource Name (ARN).

      Constraints:

      • Must specify a valid DB cluster parameter group.

      • If the source DB cluster parameter group is in the same AWS Region as the copy, specify a valid DB parameter group identifier, for example my-db-cluster-param-group, or a valid ARN.

      • If the source DB parameter group is in a different AWS Region than the copy, specify a valid DB cluster parameter group ARN, for example arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1.

    • TargetDBClusterParameterGroupIdentifier — (String)

      The identifier for the copied DB cluster parameter group.

      Constraints:

      • Cannot be null, empty, or blank

      • Must contain from 1 to 255 letters, numbers, or hyphens

      • First character must be a letter

      • Cannot end with a hyphen or contain two consecutive hyphens

      Example: my-cluster-param-group1

    • TargetDBClusterParameterGroupDescription — (String)

      A description for the copied DB cluster parameter group.

    • Tags — (Array<map>)

      The tags to be assigned to the copied DB cluster parameter group.

      • Key — (String)

        A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

      • Value — (String)

        A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

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:

      • DBClusterParameterGroup — (map)

        Contains the details of an Amazon Neptune DB cluster parameter group.

        This data type is used as a response element in the DescribeDBClusterParameterGroups action.

        • DBClusterParameterGroupName — (String)

          Provides the name of the DB cluster parameter group.

        • DBParameterGroupFamily — (String)

          Provides the name of the DB parameter group family that this DB cluster parameter group is compatible with.

        • Description — (String)

          Provides the customer-specified description for this DB cluster parameter group.

        • DBClusterParameterGroupArn — (String)

          The Amazon Resource Name (ARN) for the DB cluster parameter group.

Returns:

  • (AWS.Request) —

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

copyDBClusterSnapshot(params = {}, callback) ⇒ AWS.Request

Copies a snapshot of a DB cluster.

To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.

You can't copy from one AWS Region to another.

Service Reference:

Examples:

Calling the copyDBClusterSnapshot operation

var params = {
  SourceDBClusterSnapshotIdentifier: 'STRING_VALUE', /* required */
  TargetDBClusterSnapshotIdentifier: 'STRING_VALUE', /* required */
  CopyTags: true || false,
  KmsKeyId: 'STRING_VALUE',
  PreSignedUrl: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
neptune.copyDBClusterSnapshot(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: {}) —
    • SourceDBClusterSnapshotIdentifier — (String)

      The identifier of the DB cluster snapshot to copy. This parameter is not case-sensitive.

      You can't copy from one AWS Region to another.

      Constraints:

      • Must specify a valid system snapshot in the "available" state.

      • Specify a valid DB snapshot identifier.

      Example: my-cluster-snapshot1

    • TargetDBClusterSnapshotIdentifier — (String)

      The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter is not case-sensitive.

      Constraints:

      • Must contain from 1 to 63 letters, numbers, or hyphens.

      • First character must be a letter.

      • Cannot end with a hyphen or contain two consecutive hyphens.

      Example: my-cluster-snapshot2

    • KmsKeyId — (String)

      The AWS AWS KMS key ID for an encrypted DB cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

      If you copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, Amazon Neptune encrypts the target DB cluster snapshot using the specified KMS encryption key.

      If you copy an encrypted DB cluster snapshot from your AWS account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value for KmsKeyId, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot.

      If you copy an encrypted DB cluster snapshot that is shared from another AWS account, then you must specify a value for KmsKeyId.

      KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region.

    • PreSignedUrl — (String)

      Not currently supported.

    • CopyTags — (Boolean)

      True to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot, and otherwise false. The default is false.

    • Tags — (Array<map>)

      The tags to assign to the new DB cluster snapshot copy.

      • Key — (String)

        A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

      • Value — (String)

        A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

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:

      • DBClusterSnapshot — (map)

        Contains the details for an Amazon Neptune DB cluster snapshot

        This data type is used as a response element in the DescribeDBClusterSnapshots action.

        • AvailabilityZones — (Array<String>)

          Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.

        • DBClusterSnapshotIdentifier — (String)

          Specifies the identifier for the DB cluster snapshot.

        • DBClusterIdentifier — (String)

          Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.

        • SnapshotCreateTime — (Date)

          Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).

        • Engine — (String)

          Specifies the name of the database engine.

        • AllocatedStorage — (Integer)

          Specifies the allocated storage size in gibibytes (GiB).

        • Status — (String)

          Specifies the status of this DB cluster snapshot.

        • Port — (Integer)

          Specifies the port that the DB cluster was listening on at the time of the snapshot.

        • VpcId — (String)

          Provides the VPC ID associated with the DB cluster snapshot.

        • ClusterCreateTime — (Date)

          Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

        • MasterUsername — (String)

          Provides the master username for the DB cluster snapshot.

        • EngineVersion — (String)

          Provides the version of the database engine for this DB cluster snapshot.

        • LicenseModel — (String)

          Provides the license model information for this DB cluster snapshot.

        • SnapshotType — (String)

          Provides the type of the DB cluster snapshot.

        • PercentProgress — (Integer)

          Specifies the percentage of the estimated data that has been transferred.

        • StorageEncrypted — (Boolean)

          Specifies whether the DB cluster snapshot is encrypted.

        • KmsKeyId — (String)

          If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.

        • DBClusterSnapshotArn — (String)

          The Amazon Resource Name (ARN) for the DB cluster snapshot.

        • SourceDBClusterSnapshotArn — (String)

          If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.

        • IAMDatabaseAuthenticationEnabled — (Boolean)

          True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

Returns:

  • (AWS.Request) —

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

copyDBParameterGroup(params = {}, callback) ⇒ AWS.Request

Copies the specified DB parameter group.

Service Reference:

Examples:

Calling the copyDBParameterGroup operation

var params = {
  SourceDBParameterGroupIdentifier: 'STRING_VALUE', /* required */
  TargetDBParameterGroupDescription: 'STRING_VALUE', /* required */
  TargetDBParameterGroupIdentifier: 'STRING_VALUE', /* required */
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
neptune.copyDBParameterGroup(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: {}) —
    • SourceDBParameterGroupIdentifier — (String)

      The identifier or ARN for the source DB parameter group. For information about creating an ARN, see Constructing an Amazon Resource Name (ARN).

      Constraints:

      • Must specify a valid DB parameter group.

      • Must specify a valid DB parameter group identifier, for example my-db-param-group, or a valid ARN.

    • TargetDBParameterGroupIdentifier — (String)

      The identifier for the copied DB parameter group.

      Constraints:

      • Cannot be null, empty, or blank.

      • Must contain from 1 to 255 letters, numbers, or hyphens.

      • First character must be a letter.

      • Cannot end with a hyphen or contain two consecutive hyphens.

      Example: my-db-parameter-group

    • TargetDBParameterGroupDescription — (String)

      A description for the copied DB parameter group.

    • Tags — (Array<map>)

      The tags to be assigned to the copied DB parameter group.

      • Key — (String)

        A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

      • Value — (String)

        A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

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)

        Contains the details of an Amazon Neptune DB parameter group.

        This data type is used as a response element in the DescribeDBParameterGroups action.

        • DBParameterGroupName — (String)

          Provides the name of the DB parameter group.

        • DBParameterGroupFamily — (String)

          Provides the name of the DB parameter group family that this DB parameter group is compatible with.

        • Description — (String)

          Provides the customer-specified description for this DB parameter group.

        • DBParameterGroupArn — (String)

          The Amazon Resource Name (ARN) for the DB parameter group.

Returns:

  • (AWS.Request) —

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

createDBCluster(params = {}, callback) ⇒ AWS.Request

Creates a new Amazon Neptune DB cluster.

You can use the ReplicationSourceIdentifier parameter to create the DB cluster as a Read Replica of another DB cluster or Amazon Neptune DB instance.

Service Reference:

Examples:

Calling the createDBCluster operation

var params = {
  DBClusterIdentifier: 'STRING_VALUE', /* required */
  Engine: 'STRING_VALUE', /* required */
  AvailabilityZones: [
    'STRING_VALUE',
    /* more items */
  ],
  BackupRetentionPeriod: 'NUMBER_VALUE',
  CharacterSetName: 'STRING_VALUE',
  DBClusterParameterGroupName: 'STRING_VALUE',
  DBSubnetGroupName: 'STRING_VALUE',
  DatabaseName: 'STRING_VALUE',
  EnableIAMDatabaseAuthentication: true || false,
  EngineVersion: 'STRING_VALUE',
  KmsKeyId: 'STRING_VALUE',
  MasterUserPassword: 'STRING_VALUE',
  MasterUsername: 'STRING_VALUE',
  OptionGroupName: 'STRING_VALUE',
  Port: 'NUMBER_VALUE',
  PreSignedUrl: 'STRING_VALUE',
  PreferredBackupWindow: 'STRING_VALUE',
  PreferredMaintenanceWindow: 'STRING_VALUE',
  ReplicationSourceIdentifier: 'STRING_VALUE',
  StorageEncrypted: true || false,
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  VpcSecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
neptune.createDBCluster(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: {}) —
    • AvailabilityZones — (Array<String>)

      A list of EC2 Availability Zones that instances in the DB cluster can be created in.

    • BackupRetentionPeriod — (Integer)

      The number of days for which automated backups are retained. You must specify a minimum value of 1.

      Default: 1

      Constraints:

      • Must be a value from 1 to 35

    • CharacterSetName — (String)

      A value that indicates that the DB cluster should be associated with the specified CharacterSet.

    • DatabaseName — (String)

      The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon Neptune will not create a database in the DB cluster you are creating.

    • DBClusterIdentifier — (String)

      The DB cluster identifier. This parameter is stored as a lowercase string.

      Constraints:

      • Must contain from 1 to 63 letters, numbers, or hyphens.

      • First character must be a letter.

      • Cannot end with a hyphen or contain two consecutive hyphens.

      Example: my-cluster1

    • DBClusterParameterGroupName — (String)

      The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default is used.

      Constraints:

      • If supplied, must match the name of an existing DBClusterParameterGroup.

    • VpcSecurityGroupIds — (Array<String>)

      A list of EC2 VPC security groups to associate with this DB cluster.

    • DBSubnetGroupName — (String)

      A DB subnet group to associate with this DB cluster.

      Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

      Example: mySubnetgroup

    • Engine — (String)

      The name of the database engine to be used for this DB cluster.

      Valid Values: neptune

    • EngineVersion — (String)

      The version number of the database engine to use.

      Example: 1.0.1

    • Port — (Integer)

      The port number on which the instances in the DB cluster accept connections.

      Default: 8182

    • MasterUsername — (String)

      The name of the master user for the DB cluster.

      Constraints:

      • Must be 1 to 16 letters or numbers.

      • First character must be a letter.

      • Cannot be a reserved word for the chosen database engine.

    • MasterUserPassword — (String)

      The password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".

      Constraints: Must contain from 8 to 41 characters.

    • OptionGroupName — (String)

      A value that indicates that the DB cluster should be associated with the specified option group.

      Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.

    • PreferredBackupWindow — (String)

      The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

      The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Neptune User Guide.

      Constraints:

      • Must be in the format hh24:mi-hh24:mi.

      • Must be in Universal Coordinated Time (UTC).

      • Must not conflict with the preferred maintenance window.

      • Must be at least 30 minutes.

    • PreferredMaintenanceWindow — (String)

      The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

      Format: ddd:hh24:mi-ddd:hh24:mi

      The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Neptune User Guide.

      Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

      Constraints: Minimum 30-minute window.

    • ReplicationSourceIdentifier — (String)

      The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.

    • Tags — (Array<map>)

      The tags to assign to the new DB cluster.

      • Key — (String)

        A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

      • Value — (String)

        A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

    • StorageEncrypted — (Boolean)

      Specifies whether the DB cluster is encrypted.

    • KmsKeyId — (String)

      The AWS KMS key identifier for an encrypted DB cluster.

      The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

      If an encryption key is not specified in KmsKeyId:

      • If ReplicationSourceIdentifier identifies an encrypted source, then Amazon Neptune will use the encryption key used to encrypt the source. Otherwise, Amazon Neptune will use your default encryption key.

      • If the StorageEncrypted parameter is true and ReplicationSourceIdentifier is not specified, then Amazon Neptune will use your default encryption key.

      AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

      If you create a Read Replica of an encrypted DB cluster in another AWS Region, you must set KmsKeyId to a KMS key ID that is valid in the destination AWS Region. This key is used to encrypt the Read Replica in that AWS Region.

    • PreSignedUrl — (String)

      This parameter is not currently supported.

    • EnableIAMDatabaseAuthentication — (Boolean)

      True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

      Default: false

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:

      • DBCluster — (map)

        Contains the details of an Amazon Neptune DB cluster.

        This data type is used as a response element in the DescribeDBClusters action.

        • AllocatedStorage — (Integer)

          AllocatedStorage always returns 1, because Neptune DB cluster storage size is not fixed, but instead automatically adjusts as needed.

        • AvailabilityZones — (Array<String>)

          Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.

        • BackupRetentionPeriod — (Integer)

          Specifies the number of days for which automatic DB snapshots are retained.

        • CharacterSetName — (String)

          If present, specifies the name of the character set that this cluster is associated with.

        • DatabaseName — (String)

          Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

        • DBClusterIdentifier — (String)

          Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

        • DBClusterParameterGroup — (String)

          Specifies the name of the DB cluster parameter group for the DB cluster.

        • DBSubnetGroup — (String)

          Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

        • Status — (String)

          Specifies the current state of this DB cluster.

        • PercentProgress — (String)

          Specifies the progress of the operation as a percentage.

        • EarliestRestorableTime — (Date)

          Specifies the earliest time to which a database can be restored with point-in-time restore.

        • Endpoint — (String)

          Specifies the connection endpoint for the primary instance of the DB cluster.

        • ReaderEndpoint — (String)

          The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Read Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Neptune distributes the connection requests among the Read Replicas in the DB cluster. This functionality can help balance your read workload across multiple Read Replicas in your DB cluster.

          If a failover occurs, and the Read Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Read Replicas in the cluster, you can then reconnect to the reader endpoint.

        • MultiAZ — (Boolean)

          Specifies whether the DB cluster has instances in multiple Availability Zones.

        • Engine — (String)

          Provides the name of the database engine to be used for this DB cluster.

        • EngineVersion — (String)

          Indicates the database engine version.

        • LatestRestorableTime — (Date)

          Specifies the latest time to which a database can be restored with point-in-time restore.

        • Port — (Integer)

          Specifies the port that the database engine is listening on.

        • MasterUsername — (String)

          Contains the master username for the DB cluster.

        • DBClusterOptionGroupMemberships — (Array<map>)

          Provides the list of option group memberships for this DB cluster.

          • DBClusterOptionGroupName — (String)

            Specifies the name of the DB cluster option group.

          • Status — (String)

            Specifies the status of the DB cluster option group.

        • PreferredBackupWindow — (String)

          Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

        • PreferredMaintenanceWindow — (String)

          Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

        • ReplicationSourceIdentifier — (String)

          Not supported by Neptune.

        • ReadReplicaIdentifiers — (Array<String>)

          Contains one or more identifiers of the Read Replicas associated with this DB cluster.

        • DBClusterMembers — (Array<map>)

          Provides the list of instances that make up the DB cluster.

          • DBInstanceIdentifier — (String)

            Specifies the instance identifier for this member of the DB cluster.

          • IsClusterWriter — (Boolean)

            Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

          • DBClusterParameterGroupStatus — (String)

            Specifies the status of the DB cluster parameter group for this member of the DB cluster.

          • PromotionTier — (Integer)

            A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance.

        • VpcSecurityGroups — (Array<map>)

          Provides a list of VPC security groups that the DB cluster belongs to.

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • HostedZoneId — (String)

          Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

        • StorageEncrypted — (Boolean)

          Specifies whether the DB cluster is encrypted.

        • KmsKeyId — (String)

          If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster.

        • DbClusterResourceId — (String)

          The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.

        • DBClusterArn — (String)

          The Amazon Resource Name (ARN) for the DB cluster.

        • AssociatedRoles — (Array<map>)

          Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.

          • RoleArn — (String)

            The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.

          • Status — (String)

            Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:

            • ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other AWS services on your behalf.

            • PENDING - the IAM role ARN is being associated with the DB cluster.

            • INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other AWS services on your behalf.

        • IAMDatabaseAuthenticationEnabled — (Boolean)

          True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

        • CloneGroupId — (String)

          Identifies the clone group to which the DB cluster is associated.

        • ClusterCreateTime — (Date)

          Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

Returns:

  • (AWS.Request) —

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

createDBClusterParameterGroup(params = {}, callback) ⇒ AWS.Request

Creates a new DB cluster parameter group.

Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.

A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster. When you associate a new DB cluster parameter group with a running DB cluster, you need to reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.

After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon Neptune to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon Neptune console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.

Service Reference:

Examples:

Calling the createDBClusterParameterGroup operation

var params = {
  DBClusterParameterGroupName: 'STRING_VALUE', /* required */
  DBParameterGroupFamily: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE', /* required */
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
neptune.createDBClusterParameterGroup(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: {}) —
    • DBClusterParameterGroupName — (String)

      The name of the DB cluster parameter group.

      Constraints:

      • Must match the name of an existing DBClusterParameterGroup.

      Note: This value is stored as a lowercase string.
    • DBParameterGroupFamily — (String)

      The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.

    • Description — (String)

      The description for the DB cluster parameter group.

    • Tags — (Array<map>)

      The tags to be assigned to the new DB cluster parameter group.

      • Key — (String)

        A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

      • Value — (String)

        A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

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:

      • DBClusterParameterGroup — (map)

        Contains the details of an Amazon Neptune DB cluster parameter group.

        This data type is used as a response element in the DescribeDBClusterParameterGroups action.

        • DBClusterParameterGroupName — (String)

          Provides the name of the DB cluster parameter group.

        • DBParameterGroupFamily — (String)

          Provides the name of the DB parameter group family that this DB cluster parameter group is compatible with.

        • Description — (String)

          Provides the customer-specified description for this DB cluster parameter group.

        • DBClusterParameterGroupArn — (String)

          The Amazon Resource Name (ARN) for the DB cluster parameter group.

Returns:

  • (AWS.Request) —

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

createDBClusterSnapshot(params = {}, callback) ⇒ AWS.Request

Creates a snapshot of a DB cluster.

Service Reference:

Examples:

Calling the createDBClusterSnapshot operation

var params = {
  DBClusterIdentifier: 'STRING_VALUE', /* required */
  DBClusterSnapshotIdentifier: 'STRING_VALUE', /* required */
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
neptune.createDBClusterSnapshot(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: {}) —
    • DBClusterSnapshotIdentifier — (String)

      The identifier of the DB cluster snapshot. This parameter is stored as a lowercase string.

      Constraints:

      • Must contain from 1 to 63 letters, numbers, or hyphens.

      • First character must be a letter.

      • Cannot end with a hyphen or contain two consecutive hyphens.

      Example: my-cluster1-snapshot1

    • DBClusterIdentifier — (String)

      The identifier of the DB cluster to create a snapshot for. This parameter is not case-sensitive.

      Constraints:

      • Must match the identifier of an existing DBCluster.

      Example: my-cluster1

    • Tags — (Array<map>)

      The tags to be assigned to the DB cluster snapshot.

      • Key — (String)

        A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

      • Value — (String)

        A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

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:

      • DBClusterSnapshot — (map)

        Contains the details for an Amazon Neptune DB cluster snapshot

        This data type is used as a response element in the DescribeDBClusterSnapshots action.

        • AvailabilityZones — (Array<String>)

          Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.

        • DBClusterSnapshotIdentifier — (String)

          Specifies the identifier for the DB cluster snapshot.

        • DBClusterIdentifier — (String)

          Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.

        • SnapshotCreateTime — (Date)

          Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).

        • Engine — (String)

          Specifies the name of the database engine.

        • AllocatedStorage — (Integer)

          Specifies the allocated storage size in gibibytes (GiB).

        • Status — (String)

          Specifies the status of this DB cluster snapshot.

        • Port — (Integer)

          Specifies the port that the DB cluster was listening on at the time of the snapshot.

        • VpcId — (String)

          Provides the VPC ID associated with the DB cluster snapshot.

        • ClusterCreateTime — (Date)

          Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

        • MasterUsername — (String)

          Provides the master username for the DB cluster snapshot.

        • EngineVersion — (String)

          Provides the version of the database engine for this DB cluster snapshot.

        • LicenseModel — (String)

          Provides the license model information for this DB cluster snapshot.

        • SnapshotType — (String)

          Provides the type of the DB cluster snapshot.

        • PercentProgress — (Integer)

          Specifies the percentage of the estimated data that has been transferred.

        • StorageEncrypted — (Boolean)

          Specifies whether the DB cluster snapshot is encrypted.

        • KmsKeyId — (String)

          If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.

        • DBClusterSnapshotArn — (String)

          The Amazon Resource Name (ARN) for the DB cluster snapshot.

        • SourceDBClusterSnapshotArn — (String)

          If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.

        • IAMDatabaseAuthenticationEnabled — (Boolean)

          True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

Returns:

  • (AWS.Request) —

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

createDBInstance(params = {}, callback) ⇒ AWS.Request

Creates a new DB instance.

Service Reference:

Examples:

Calling the createDBInstance operation

var params = {
  DBInstanceClass: 'STRING_VALUE', /* required */
  DBInstanceIdentifier: 'STRING_VALUE', /* required */
  Engine: 'STRING_VALUE', /* required */
  AllocatedStorage: 'NUMBER_VALUE',
  AutoMinorVersionUpgrade: true || false,
  AvailabilityZone: 'STRING_VALUE',
  BackupRetentionPeriod: 'NUMBER_VALUE',
  CharacterSetName: 'STRING_VALUE',
  CopyTagsToSnapshot: true || false,
  DBClusterIdentifier: 'STRING_VALUE',
  DBName: 'STRING_VALUE',
  DBParameterGroupName: 'STRING_VALUE',
  DBSecurityGroups: [
    'STRING_VALUE',
    /* more items */
  ],
  DBSubnetGroupName: 'STRING_VALUE',
  Domain: 'STRING_VALUE',
  DomainIAMRoleName: 'STRING_VALUE',
  EnableCloudwatchLogsExports: [
    'STRING_VALUE',
    /* more items */
  ],
  EnableIAMDatabaseAuthentication: true || false,
  EnablePerformanceInsights: true || false,
  EngineVersion: 'STRING_VALUE',
  Iops: 'NUMBER_VALUE',
  KmsKeyId: 'STRING_VALUE',
  LicenseModel: 'STRING_VALUE',
  MasterUserPassword: 'STRING_VALUE',
  MasterUsername: 'STRING_VALUE',
  MonitoringInterval: 'NUMBER_VALUE',
  MonitoringRoleArn: 'STRING_VALUE',
  MultiAZ: true || false,
  OptionGroupName: 'STRING_VALUE',
  PerformanceInsightsKMSKeyId: 'STRING_VALUE',
  Port: 'NUMBER_VALUE',
  PreferredBackupWindow: 'STRING_VALUE',
  PreferredMaintenanceWindow: 'STRING_VALUE',
  PromotionTier: 'NUMBER_VALUE',
  PubliclyAccessible: true || false,
  StorageEncrypted: true || false,
  StorageType: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  TdeCredentialArn: 'STRING_VALUE',
  TdeCredentialPassword: 'STRING_VALUE',
  Timezone: 'STRING_VALUE',
  VpcSecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
neptune.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)

      Not supported.

    • DBInstanceIdentifier — (String)

      The DB instance identifier. This parameter is stored as a lowercase string.

      Constraints:

      • Must contain from 1 to 63 letters, numbers, or hyphens.

      • First character must be a letter.

      • Cannot end with a hyphen or contain two consecutive hyphens.

      Example: mydbinstance

    • AllocatedStorage — (Integer)

      The amount of storage (in gibibytes) to allocate for the DB instance.

      Type: Integer

      Not applicable. Neptune cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in a Neptune cluster volume.

    • DBInstanceClass — (String)

      The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions.

    • Engine — (String)

      The name of the database engine to be used for this instance.

      Valid Values: neptune

    • MasterUsername — (String)

      The name for the master user. Not used.

    • MasterUserPassword — (String)

      The password for the master user. The password can include any printable ASCII character except "/", """, or "@".

      Not used.

    • DBSecurityGroups — (Array<String>)

      A list of DB security groups to associate with this DB instance.

      Default: The default DB security group for the database engine.

    • VpcSecurityGroupIds — (Array<String>)

      A list of EC2 VPC security groups to associate with this DB instance.

      Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see CreateDBCluster.

      Default: The default EC2 VPC security group for the DB subnet group's VPC.

    • AvailabilityZone — (String)

      The EC2 Availability Zone that the DB instance is created in

      Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.

      Example: us-east-1d

      Constraint: The AvailabilityZone parameter can't be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same AWS Region as the current endpoint.

    • DBSubnetGroupName — (String)

      A DB subnet group to associate with this DB instance.

      If there is no DB subnet group, then it is a non-VPC DB instance.

    • PreferredMaintenanceWindow — (String)

      The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).

      Format: ddd:hh24:mi-ddd:hh24:mi

      The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.

      Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

      Constraints: Minimum 30-minute window.

    • DBParameterGroupName — (String)

      The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine is used.

      Constraints:

      • Must be 1 to 255 letters, numbers, or hyphens.

      • First character must be a letter

      • Cannot end with a hyphen or contain two consecutive hyphens

    • BackupRetentionPeriod — (Integer)

      The number of days for which automated backups are retained.

      Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see CreateDBCluster.

      Default: 1

      Constraints:

      • Must be a value from 0 to 35

      • Cannot be set to 0 if the DB instance is a source to Read Replicas

    • PreferredBackupWindow — (String)

      The daily time range during which automated backups are created.

      Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see CreateDBCluster.

    • Port — (Integer)

      The port number on which the database accepts connections.

      Not applicable. The port is managed by the DB cluster. For more information, see CreateDBCluster.

      Default: 8182

      Type: Integer

    • MultiAZ — (Boolean)

      Specifies if the DB instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the MultiAZ parameter is set to true.

    • EngineVersion — (String)

      The version number of the database engine to use.

    • AutoMinorVersionUpgrade — (Boolean)

      Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.

      Default: true

    • LicenseModel — (String)

      License model information for this DB instance.

      Valid values: license-included | bring-your-own-license | general-public-license

    • Iops — (Integer)

      The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

    • OptionGroupName — (String)

      Indicates that the DB instance should be associated with the specified option group.

      Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance

    • CharacterSetName — (String)

      Indicates that the DB instance should be associated with the specified CharacterSet.

      Not applicable. The character set is managed by the DB cluster. For more information, see CreateDBCluster.

    • PubliclyAccessible — (Boolean)

      This flag should no longer be used.

    • Tags — (Array<map>)

      The tags to assign to the new instance.

      • Key — (String)

        A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

      • Value — (String)

        A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

    • DBClusterIdentifier — (String)

      The identifier of the DB cluster that the instance will belong to.

      For information on creating a DB cluster, see CreateDBCluster.

      Type: String

    • StorageType — (String)

      Specifies the storage type to be associated with the DB instance.

      Not applicable. Storage is managed by the DB Cluster.

    • TdeCredentialArn — (String)

      The ARN from the key store with which to associate the instance for TDE encryption.

    • TdeCredentialPassword — (String)

      The password for the given ARN from the key store in order to access the device.

    • StorageEncrypted — (Boolean)

      Specifies whether the DB instance is encrypted.

      Not applicable. The encryption for DB instances is managed by the DB cluster. For more information, see CreateDBCluster.

      Default: false

    • KmsKeyId — (String)

      The AWS KMS key identifier for an encrypted DB instance.

      The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.

      Not applicable. The KMS key identifier is managed by the DB cluster. For more information, see CreateDBCluster.

      If the StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, then Amazon Neptune will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

    • Domain — (String)

      Specify the Active Directory Domain to create the instance in.

    • CopyTagsToSnapshot — (Boolean)

      True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false.

    • MonitoringInterval — (Integer)

      The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.

      If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.

      Valid Values: 0, 1, 5, 10, 15, 30, 60

    • MonitoringRoleArn — (String)

      The ARN for the IAM role that permits Neptune to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess.

      If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

    • DomainIAMRoleName — (String)

      Specify the name of the IAM role to be used when making API calls to the Directory Service.

    • PromotionTier — (Integer)

      A value that specifies the order in which an Read Replica is promoted to the primary instance after a failure of the existing primary instance.

      Default: 1

      Valid Values: 0 - 15

    • Timezone — (String)

      The time zone of the DB instance.

    • EnableIAMDatabaseAuthentication — (Boolean)

      True to enable AWS Identity and Access Management (IAM) authentication for Neptune.

      Default: false

    • EnablePerformanceInsights — (Boolean)

      True to enable Performance Insights for the DB instance, and otherwise false.

    • PerformanceInsightsKMSKeyId — (String)

      The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

    • EnableCloudwatchLogsExports — (Array<String>)

      The list of log types that need to be enabled for exporting to CloudWatch Logs.

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)

        Contains the details of an Amazon Neptune DB instance.

        This data type is used as a response element in the DescribeDBInstances action.

        • DBInstanceIdentifier — (String)

          Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

        • DBInstanceClass — (String)

          Contains the name of the compute and memory capacity class of the DB instance.

        • Engine — (String)

          Provides the name of the database engine to be used for this DB instance.

        • DBInstanceStatus — (String)

          Specifies the current state of this database.

        • MasterUsername — (String)

          Contains the master username for the DB instance.

        • DBName — (String)

          The database name.

        • Endpoint — (map)

          Specifies the connection endpoint.

          • Address — (String)

            Specifies the DNS address of the DB instance.

          • Port — (Integer)

            Specifies the port that the database engine is listening on.

          • HostedZoneId — (String)

            Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

        • AllocatedStorage — (Integer)

          Specifies the allocated storage size specified in gibibytes.

        • InstanceCreateTime — (Date)

          Provides the date and time the DB instance was created.

        • PreferredBackupWindow — (String)

          Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

        • BackupRetentionPeriod — (Integer)

          Specifies the number of days for which automatic DB snapshots are retained.

        • DBSecurityGroups — (Array<map>)

          Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

          • DBSecurityGroupName — (String)

            The name of the DB security group.

          • Status — (String)

            The status of the DB security group.

        • VpcSecurityGroups — (Array<map>)

          Provides a list of VPC security group elements that the DB instance belongs to.

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • DBParameterGroups — (Array<map>)

          Provides the list of DB parameter groups applied to this DB instance.

          • DBParameterGroupName — (String)

            The name of the DP parameter group.

          • ParameterApplyStatus — (String)

            The status of parameter updates.

        • AvailabilityZone — (String)

          Specifies the name of the Availability Zone the DB instance is located in.

        • DBSubnetGroup — (map)

          Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

          • DBSubnetGroupName — (String)

            The name of the DB subnet group.

          • DBSubnetGroupDescription — (String)

            Provides the description of the DB subnet group.

          • VpcId — (String)

            Provides the VpcId of the DB subnet group.

          • SubnetGroupStatus — (String)

            Provides the status of the DB subnet group.

          • Subnets — (Array<map>)

            Contains a list of Subnet elements.

            • SubnetIdentifier — (String)

              Specifies the identifier of the subnet.

            • SubnetAvailabilityZone — (map)

              Specifies the EC2 Availability Zone that the subnet is in.

              • Name — (String)

                The name of the availability zone.

            • SubnetStatus — (String)

              Specifies the status of the subnet.

          • DBSubnetGroupArn — (String)

            The Amazon Resource Name (ARN) for the DB subnet group.

        • PreferredMaintenanceWindow — (String)

          Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

        • PendingModifiedValues — (map)

          Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

          • DBInstanceClass — (String)

            Contains the new DBInstanceClass for the DB instance that will be applied or is currently being applied.

          • AllocatedStorage — (Integer)

            Contains the new AllocatedStorage size for the DB instance that will be applied or is currently being applied.

          • MasterUserPassword — (String)

            Contains the pending or currently-in-progress change of the master credentials for the DB instance.

          • Port — (Integer)

            Specifies the pending port for the DB instance.

          • BackupRetentionPeriod — (Integer)

            Specifies the pending number of days for which automated backups are retained.

          • MultiAZ — (Boolean)

            Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.

          • EngineVersion — (String)

            Indicates the database engine version.

          • LicenseModel — (String)

            The license model for the DB instance.

            Valid values: license-included | bring-your-own-license | general-public-license

          • Iops — (Integer)

            Specifies the new Provisioned IOPS value for the DB instance that will be applied or is currently being applied.

          • DBInstanceIdentifier — (String)

            Contains the new DBInstanceIdentifier for the DB instance that will be applied or is currently being applied.

          • StorageType — (String)

            Specifies the storage type to be associated with the DB instance.

          • CACertificateIdentifier — (String)

            Specifies the identifier of the CA certificate for the DB instance.

          • DBSubnetGroupName — (String)

            The new DB subnet group for the DB instance.

          • PendingCloudwatchLogsExports — (map)

            Specifies the CloudWatch logs to be exported.

            • LogTypesToEnable — (Array<String>)

              Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.

            • LogTypesToDisable — (Array<String>)

              Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.

        • LatestRestorableTime — (Date)

          Specifies the latest time to which a database can be restored with point-in-time restore.

        • MultiAZ — (Boolean)

          Specifies if the DB instance is a Multi-AZ deployment.

        • EngineVersion — (String)

          Indicates the database engine version.

        • AutoMinorVersionUpgrade — (Boolean)

          Indicates that minor version patches are applied automatically.

        • ReadReplicaSourceDBInstanceIdentifier — (String)

          Contains the identifier of the source DB instance if this DB instance is a Read Replica.

        • ReadReplicaDBInstanceIdentifiers — (Array<String>)

          Contains one or more identifiers of the Read Replicas associated with this DB instance.

        • ReadReplicaDBClusterIdentifiers — (Array<String>)

          Contains one or more identifiers of DB clusters that are Read Replicas of this DB instance.

        • LicenseModel — (String)

          License model information for this DB instance.

        • Iops — (Integer)

          Specifies the Provisioned IOPS (I/O operations per second) value.

        • OptionGroupMemberships — (Array<map>)

          Provides the list of option group memberships for this DB instance.

          • OptionGroupName — (String)

            The name of the option group that the instance belongs to.

          • Status — (String)

            The status of the DB instance's option group membership. Valid values are: in-sync, pending-apply, pending-removal, pending-maintenance-apply, pending-maintenance-removal, applying, removing, and failed.

        • CharacterSetName — (String)

          If present, specifies the name of the character set that this instance is associated with.

        • SecondaryAvailabilityZone — (String)

          If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

        • PubliclyAccessible — (Boolean)

          This flag should no longer be used.

        • StatusInfos — (Array<map>)

          The status of a Read Replica. If the instance is not a Read Replica, this is blank.

          • StatusType — (String)

            This value is currently "read replication."

          • Normal — (Boolean)

            Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

          • Status — (String)

            Status of the DB instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.

          • Message — (String)

            Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.

        • StorageType — (String)

          Specifies the storage type associated with DB instance.

        • TdeCredentialArn — (String)

          The ARN from the key store with which the instance is associated for TDE encryption.

        • DbInstancePort — (Integer)

          Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

        • DBClusterIdentifier — (String)

          If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

        • StorageEncrypted — (Boolean)

          Not supported: The encryption for DB instances is managed by the DB cluster.

        • KmsKeyId — (String)

          Not supported: The encryption for DB instances is managed by the DB cluster.

        • DbiResourceId — (String)

          The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.

        • CACertificateIdentifier — (String)

          The identifier of the CA certificate for this DB instance.

        • DomainMemberships — (Array<map>)

          Not supported

          • Domain — (String)

            The identifier of the Active Directory Domain.

          • Status — (String)

            The status of the DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).

          • FQDN — (String)

            The fully qualified domain name of the Active Directory Domain.

          • IAMRoleName — (String)

            The name of the IAM role to be used when making API calls to the Directory Service.

        • CopyTagsToSnapshot — (Boolean)

          Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

        • MonitoringInterval — (Integer)

          The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

        • EnhancedMonitoringResourceArn — (String)

          The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

        • MonitoringRoleArn — (String)

          The ARN for the IAM role that permits Neptune to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

        • PromotionTier — (Integer)

          A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance.

        • DBInstanceArn — (String)

          The Amazon Resource Name (ARN) for the DB instance.

        • Timezone — (String)

          Not supported.

        • IAMDatabaseAuthenticationEnabled — (Boolean)

          True if AWS Identity and Access Management (IAM) authentication is enabled, and otherwise false.

        • PerformanceInsightsEnabled — (Boolean)

          True if Performance Insights is enabled for the DB instance, and otherwise false.

        • PerformanceInsightsKMSKeyId — (String)

          The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

        • EnabledCloudwatchLogsExports — (Array<String>)

          A list of log types that this DB instance is configured to export to CloudWatch Logs.

Returns:

  • (AWS.Request) —

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

createDBParameterGroup(params = {}, callback) ⇒ AWS.Request

Creates a new DB parameter group.

A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.

After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon Neptune to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon Neptune console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.

Service Reference:

Examples:

Calling the createDBParameterGroup operation

var params = {
  DBParameterGroupFamily: 'STRING_VALUE', /* required */
  DBParameterGroupName: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE', /* required */
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
neptune.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)

      The name of the DB parameter group.

      Constraints:

      • Must be 1 to 255 letters, numbers, or hyphens.

      • First character must be a letter

      • Cannot end with a hyphen or contain two consecutive hyphens

      Note: This value is stored as a lowercase string.
    • DBParameterGroupFamily — (String)

      The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.

    • Description — (String)

      The description for the DB parameter group.

    • Tags — (Array<map>)

      The tags to be assigned to the new DB parameter group.

      • Key — (String)

        A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

      • Value — (String)

        A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

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)

        Contains the details of an Amazon Neptune DB parameter group.

        This data type is used as a response element in the DescribeDBParameterGroups action.

        • DBParameterGroupName — (String)

          Provides the name of the DB parameter group.

        • DBParameterGroupFamily — (String)

          Provides the name of the DB parameter group family that this DB parameter group is compatible with.

        • Description — (String)

          Provides the customer-specified description for this DB parameter group.

        • DBParameterGroupArn — (String)

          The Amazon Resource Name (ARN) for the DB parameter group.

Returns:

  • (AWS.Request) —

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

createDBSubnetGroup(params = {}, callback) ⇒ AWS.Request

Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region.

Service Reference:

Examples:

Calling the createDBSubnetGroup operation

var params = {
  DBSubnetGroupDescription: 'STRING_VALUE', /* required */
  DBSubnetGroupName: 'STRING_VALUE', /* required */
  SubnetIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
neptune.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)

      The name for the DB subnet group. This value is stored as a lowercase string.

      Constraints: Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. Must not be default.

      Example: mySubnetgroup

    • DBSubnetGroupDescription — (String)

      The description for the DB subnet group.

    • SubnetIds — (Array<String>)

      The EC2 Subnet IDs for the DB subnet group.

    • Tags — (Array<map>)

      The tags to be assigned to the new DB subnet group.

      • Key — (String)

        A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

      • Value — (String)

        A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

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)

        Contains the details of an Amazon Neptune DB subnet group.

        This data type is used as a response element in the DescribeDBSubnetGroups action.

        • DBSubnetGroupName — (String)

          The name of the DB subnet group.

        • DBSubnetGroupDescription — (String)

          Provides the description of the DB subnet group.

        • VpcId — (String)

          Provides the VpcId of the DB subnet group.

        • SubnetGroupStatus — (String)

          Provides the status of the DB subnet group.

        • Subnets — (Array<map>)

          Contains a list of Subnet elements.

          • SubnetIdentifier — (String)

            Specifies the identifier of the subnet.

          • SubnetAvailabilityZone — (map)

            Specifies the EC2 Availability Zone that the subnet is in.

            • Name — (String)

              The name of the availability zone.

          • SubnetStatus — (String)

            Specifies the status of the subnet.

        • DBSubnetGroupArn — (String)

          The Amazon Resource Name (ARN) for the DB subnet group.

Returns:

  • (AWS.Request) —

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

createEventSubscription(params = {}, callback) ⇒ AWS.Request

Creates an event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the Neptune console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.

You can specify the type of source (SourceType) you want to be notified of, provide a list of Neptune sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.

If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your Neptune sources. If you do not specify either the SourceType nor the SourceIdentifier, you are notified of events generated from all Neptune sources belonging to your customer account.

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',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
neptune.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)

      The name of the subscription.

      Constraints: The name must be less than 255 characters.

    • SnsTopicArn — (String)

      The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

    • SourceType — (String)

      The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.

      Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot

    • EventCategories — (Array<String>)

      A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType by using the DescribeEventCategories action.

    • SourceIds — (Array<String>)

      The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

      Constraints:

      • If SourceIds are supplied, SourceType must also be provided.

      • If the source type is a DB instance, then a DBInstanceIdentifier must be supplied.

      • If the source type is a DB security group, a DBSecurityGroupName must be supplied.

      • If the source type is a DB parameter group, a DBParameterGroupName must be supplied.

      • If the source type is a DB snapshot, a DBSnapshotIdentifier must be supplied.

    • Enabled — (Boolean)

      A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.

    • Tags — (Array<map>)

      The tags to be applied to the new event subscription.

      • Key — (String)

        A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

      • Value — (String)

        A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

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)

        Contains the results of a successful invocation of the DescribeEventSubscriptions action.

        • CustomerAwsId — (String)

          The AWS customer account associated with the event notification subscription.

        • CustSubscriptionId — (String)

          The event notification subscription Id.

        • SnsTopicArn — (String)

          The topic ARN of the event notification subscription.

        • Status — (String)

          The status of the event notification subscription.

          Constraints:

          Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist

          The status "no-permission" indicates that Neptune no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.

        • SubscriptionCreationTime — (String)

          The time the event notification subscription was created.

        • SourceType — (String)

          The source type for the event notification subscription.

        • SourceIdsList — (Array<String>)

          A list of source IDs for the event notification subscription.

        • EventCategoriesList — (Array<String>)

          A list of event categories for the event notification subscription.

        • Enabled — (Boolean)

          A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

        • EventSubscriptionArn — (String)

          The Amazon Resource Name (ARN) for the event subscription.

Returns:

  • (AWS.Request) —

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

deleteDBCluster(params = {}, callback) ⇒ AWS.Request

The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.

Service Reference:

Examples:

Calling the deleteDBCluster operation

var params = {
  DBClusterIdentifier: 'STRING_VALUE', /* required */
  FinalDBSnapshotIdentifier: 'STRING_VALUE',
  SkipFinalSnapshot: true || false
};
neptune.deleteDBCluster(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: {}) —
    • DBClusterIdentifier — (String)

      The DB cluster identifier for the DB cluster to be deleted. This parameter isn't case-sensitive.

      Constraints:

      • Must match an existing DBClusterIdentifier.

    • SkipFinalSnapshot — (Boolean)

      Determines whether a final DB cluster snapshot is created before the DB cluster is deleted. If true is specified, no DB cluster snapshot is created. If false is specified, a DB cluster snapshot is created before the DB cluster is deleted.

      Note: You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is false.

      Default: false

    • FinalDBSnapshotIdentifier — (String)

      The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is set to false.

      Note: Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.

      Constraints:

      • Must be 1 to 255 letters, numbers, or hyphens.

      • First character must be a letter

      • Cannot end with a hyphen or contain two consecutive hyphens

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:

      • DBCluster — (map)

        Contains the details of an Amazon Neptune DB cluster.

        This data type is used as a response element in the DescribeDBClusters action.

        • AllocatedStorage — (Integer)

          AllocatedStorage always returns 1, because Neptune DB cluster storage size is not fixed, but instead automatically adjusts as needed.

        • AvailabilityZones — (Array<String>)

          Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.

        • BackupRetentionPeriod — (Integer)

          Specifies the number of days for which automatic DB snapshots are retained.

        • CharacterSetName — (String)

          If present, specifies the name of the character set that this cluster is associated with.

        • DatabaseName — (String)

          Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

        • DBClusterIdentifier — (String)

          Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

        • DBClusterParameterGroup — (String)

          Specifies the name of the DB cluster parameter group for the DB cluster.

        • DBSubnetGroup — (String)

          Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

        • Status — (String)

          Specifies the current state of this DB cluster.

        • PercentProgress — (String)

          Specifies the progress of the operation as a percentage.

        • EarliestRestorableTime — (Date)

          Specifies the earliest time to which a database can be restored with point-in-time restore.

        • Endpoint — (String)

          Specifies the connection endpoint for the primary instance of the DB cluster.

        • ReaderEndpoint — (String)

          The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Read Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Neptune distributes the connection requests among the Read Replicas in the DB cluster. This functionality can help balance your read workload across multiple Read Replicas in your DB cluster.

          If a failover occurs, and the Read Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Read Replicas in the cluster, you can then reconnect to the reader endpoint.

        • MultiAZ — (Boolean)

          Specifies whether the DB cluster has instances in multiple Availability Zones.

        • Engine — (String)

          Provides the name of the database engine to be used for this DB cluster.

        • EngineVersion — (String)

          Indicates the database engine version.

        • LatestRestorableTime — (Date)

          Specifies the latest time to which a database can be restored with point-in-time restore.

        • Port — (Integer)

          Specifies the port that the database engine is listening on.

        • MasterUsername — (String)

          Contains the master username for the DB cluster.

        • DBClusterOptionGroupMemberships — (Array<map>)

          Provides the list of option group memberships for this DB cluster.

          • DBClusterOptionGroupName — (String)

            Specifies the name of the DB cluster option group.

          • Status — (String)

            Specifies the status of the DB cluster option group.

        • PreferredBackupWindow — (String)

          Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

        • PreferredMaintenanceWindow — (String)

          Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

        • ReplicationSourceIdentifier — (String)

          Not supported by Neptune.

        • ReadReplicaIdentifiers — (Array<String>)

          Contains one or more identifiers of the Read Replicas associated with this DB cluster.

        • DBClusterMembers — (Array<map>)

          Provides the list of instances that make up the DB cluster.

          • DBInstanceIdentifier — (String)

            Specifies the instance identifier for this member of the DB cluster.

          • IsClusterWriter — (Boolean)

            Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

          • DBClusterParameterGroupStatus — (String)

            Specifies the status of the DB cluster parameter group for this member of the DB cluster.

          • PromotionTier — (Integer)

            A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance.

        • VpcSecurityGroups — (Array<map>)

          Provides a list of VPC security groups that the DB cluster belongs to.

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • HostedZoneId — (String)

          Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

        • StorageEncrypted — (Boolean)

          Specifies whether the DB cluster is encrypted.

        • KmsKeyId — (String)

          If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster.

        • DbClusterResourceId — (String)

          The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.

        • DBClusterArn — (String)

          The Amazon Resource Name (ARN) for the DB cluster.

        • AssociatedRoles — (Array<map>)

          Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.

          • RoleArn — (String)

            The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.

          • Status — (String)

            Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:

            • ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other AWS services on your behalf.

            • PENDING - the IAM role ARN is being associated with the DB cluster.

            • INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other AWS services on your behalf.

        • IAMDatabaseAuthenticationEnabled — (Boolean)

          True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

        • CloneGroupId — (String)

          Identifies the clone group to which the DB cluster is associated.

        • ClusterCreateTime — (Date)

          Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

Returns:

  • (AWS.Request) —

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

deleteDBClusterParameterGroup(params = {}, callback) ⇒ AWS.Request

Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.

Service Reference:

Examples:

Calling the deleteDBClusterParameterGroup operation

var params = {
  DBClusterParameterGroupName: 'STRING_VALUE' /* required */
};
neptune.deleteDBClusterParameterGroup(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: {}) —
    • DBClusterParameterGroupName — (String)

      The name of the DB cluster parameter group.

      Constraints:

      • Must be the name of an existing DB cluster parameter group.

      • You can't delete a default DB cluster parameter group.

      • Cannot be associated with any DB clusters.

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.

deleteDBClusterSnapshot(params = {}, callback) ⇒ AWS.Request

Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.

Note: The DB cluster snapshot must be in the available state to be deleted.

Service Reference:

Examples:

Calling the deleteDBClusterSnapshot operation

var params = {
  DBClusterSnapshotIdentifier: 'STRING_VALUE' /* required */
};
neptune.deleteDBClusterSnapshot(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: {}) —
    • DBClusterSnapshotIdentifier — (String)

      The identifier of the DB cluster snapshot to delete.

      Constraints: Must be the name of an existing DB cluster snapshot in the available state.

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:

      • DBClusterSnapshot — (map)

        Contains the details for an Amazon Neptune DB cluster snapshot

        This data type is used as a response element in the DescribeDBClusterSnapshots action.

        • AvailabilityZones — (Array<String>)

          Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.

        • DBClusterSnapshotIdentifier — (String)

          Specifies the identifier for the DB cluster snapshot.

        • DBClusterIdentifier — (String)

          Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.

        • SnapshotCreateTime — (Date)

          Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).

        • Engine — (String)

          Specifies the name of the database engine.

        • AllocatedStorage — (Integer)

          Specifies the allocated storage size in gibibytes (GiB).

        • Status — (String)

          Specifies the status of this DB cluster snapshot.

        • Port — (Integer)

          Specifies the port that the DB cluster was listening on at the time of the snapshot.

        • VpcId — (String)

          Provides the VPC ID associated with the DB cluster snapshot.

        • ClusterCreateTime — (Date)

          Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

        • MasterUsername — (String)

          Provides the master username for the DB cluster snapshot.

        • EngineVersion — (String)

          Provides the version of the database engine for this DB cluster snapshot.

        • LicenseModel — (String)

          Provides the license model information for this DB cluster snapshot.

        • SnapshotType — (String)

          Provides the type of the DB cluster snapshot.

        • PercentProgress — (Integer)

          Specifies the percentage of the estimated data that has been transferred.

        • StorageEncrypted — (Boolean)

          Specifies whether the DB cluster snapshot is encrypted.

        • KmsKeyId — (String)

          If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.

        • DBClusterSnapshotArn — (String)

          The Amazon Resource Name (ARN) for the DB cluster snapshot.

        • SourceDBClusterSnapshotArn — (String)

          If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.

        • IAMDatabaseAuthenticationEnabled — (Boolean)

          True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

Returns:

  • (AWS.Request) —

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

deleteDBInstance(params = {}, callback) ⇒ AWS.Request

The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted.

If you request a final DB snapshot the status of the Amazon Neptune DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this operation. The action can't be canceled or reverted once submitted.

Note that when a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, you can only delete it when the SkipFinalSnapshot parameter is set to true.

If the specified DB instance is part of a DB cluster, you can't delete the DB instance if both of the following conditions are true:

  • The DB instance is the only instance in the DB cluster.

Service Reference:

Examples:

Calling the deleteDBInstance operation

var params = {
  DBInstanceIdentifier: 'STRING_VALUE', /* required */
  FinalDBSnapshotIdentifier: 'STRING_VALUE',
  SkipFinalSnapshot: true || false
};
neptune.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)

      The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive.

      Constraints:

      • Must match the name of an existing DB instance.

    • SkipFinalSnapshot — (Boolean)

      Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted.

      Note that when a DB instance is in a failure state and has a status of 'failed', 'incompatible-restore', or 'incompatible-network', it can only be deleted when the SkipFinalSnapshot parameter is set to "true".

      Specify true when deleting a Read Replica.

      Note: The FinalDBSnapshotIdentifier parameter must be specified if SkipFinalSnapshot is false.

      Default: false

    • FinalDBSnapshotIdentifier — (String)

      The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to false.

      Note: Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.

      Constraints:

      • Must be 1 to 255 letters or numbers.

      • First character must be a letter

      • Cannot end with a hyphen or contain two consecutive hyphens

      • Cannot be specified when deleting a Read Replica.

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)

        Contains the details of an Amazon Neptune DB instance.

        This data type is used as a response element in the DescribeDBInstances action.

        • DBInstanceIdentifier — (String)

          Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

        • DBInstanceClass — (String)

          Contains the name of the compute and memory capacity class of the DB instance.

        • Engine — (String)

          Provides the name of the database engine to be used for this DB instance.

        • DBInstanceStatus — (String)

          Specifies the current state of this database.

        • MasterUsername — (String)

          Contains the master username for the DB instance.

        • DBName — (String)

          The database name.

        • Endpoint — (map)

          Specifies the connection endpoint.

          • Address — (String)

            Specifies the DNS address of the DB instance.

          • Port — (Integer)

            Specifies the port that the database engine is listening on.

          • HostedZoneId — (String)

            Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

        • AllocatedStorage — (Integer)

          Specifies the allocated storage size specified in gibibytes.

        • InstanceCreateTime — (Date)

          Provides the date and time the DB instance was created.

        • PreferredBackupWindow — (String)

          Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

        • BackupRetentionPeriod — (Integer)

          Specifies the number of days for which automatic DB snapshots are retained.

        • DBSecurityGroups — (Array<map>)

          Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

          • DBSecurityGroupName — (String)

            The name of the DB security group.

          • Status — (String)

            The status of the DB security group.

        • VpcSecurityGroups — (Array<map>)

          Provides a list of VPC security group elements that the DB instance belongs to.

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • DBParameterGroups — (Array<map>)

          Provides the list of DB parameter groups applied to this DB instance.

          • DBParameterGroupName — (String)

            The name of the DP parameter group.

          • ParameterApplyStatus — (String)

            The status of parameter updates.

        • AvailabilityZone — (String)

          Specifies the name of the Availability Zone the DB instance is located in.

        • DBSubnetGroup — (map)

          Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

          • DBSubnetGroupName — (String)

            The name of the DB subnet group.

          • DBSubnetGroupDescription — (String)

            Provides the description of the DB subnet group.

          • VpcId — (String)

            Provides the VpcId of the DB subnet group.

          • SubnetGroupStatus — (String)

            Provides the status of the DB subnet group.

          • Subnets — (Array<map>)

            Contains a list of Subnet elements.

            • SubnetIdentifier — (String)

              Specifies the identifier of the subnet.

            • SubnetAvailabilityZone — (map)

              Specifies the EC2 Availability Zone that the subnet is in.

              • Name — (String)

                The name of the availability zone.

            • SubnetStatus — (String)

              Specifies the status of the subnet.

          • DBSubnetGroupArn — (String)

            The Amazon Resource Name (ARN) for the DB subnet group.

        • PreferredMaintenanceWindow — (String)

          Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

        • PendingModifiedValues — (map)

          Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

          • DBInstanceClass — (String)

            Contains the new DBInstanceClass for the DB instance that will be applied or is currently being applied.

          • AllocatedStorage — (Integer)

            Contains the new AllocatedStorage size for the DB instance that will be applied or is currently being applied.

          • MasterUserPassword — (String)

            Contains the pending or currently-in-progress change of the master credentials for the DB instance.

          • Port — (Integer)

            Specifies the pending port for the DB instance.

          • BackupRetentionPeriod — (Integer)

            Specifies the pending number of days for which automated backups are retained.

          • MultiAZ — (Boolean)

            Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.

          • EngineVersion — (String)

            Indicates the database engine version.

          • LicenseModel — (String)

            The license model for the DB instance.

            Valid values: license-included | bring-your-own-license | general-public-license

          • Iops — (Integer)

            Specifies the new Provisioned IOPS value for the DB instance that will be applied or is currently being applied.

          • DBInstanceIdentifier — (String)

            Contains the new DBInstanceIdentifier for the DB instance that will be applied or is currently being applied.

          • StorageType — (String)

            Specifies the storage type to be associated with the DB instance.

          • CACertificateIdentifier — (String)

            Specifies the identifier of the CA certificate for the DB instance.

          • DBSubnetGroupName — (String)

            The new DB subnet group for the DB instance.

          • PendingCloudwatchLogsExports — (map)

            Specifies the CloudWatch logs to be exported.

            • LogTypesToEnable — (Array<String>)

              Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.

            • LogTypesToDisable — (Array<String>)

              Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.

        • LatestRestorableTime — (Date)

          Specifies the latest time to which a database can be restored with point-in-time restore.

        • MultiAZ — (Boolean)

          Specifies if the DB instance is a Multi-AZ deployment.

        • EngineVersion — (String)

          Indicates the database engine version.

        • AutoMinorVersionUpgrade — (Boolean)

          Indicates that minor version patches are applied automatically.

        • ReadReplicaSourceDBInstanceIdentifier — (String)

          Contains the identifier of the source DB instance if this DB instance is a Read Replica.

        • ReadReplicaDBInstanceIdentifiers — (Array<String>)

          Contains one or more identifiers of the Read Replicas associated with this DB instance.

        • ReadReplicaDBClusterIdentifiers — (Array<String>)

          Contains one or more identifiers of DB clusters that are Read Replicas of this DB instance.

        • LicenseModel — (String)

          License model information for this DB instance.

        • Iops — (Integer)

          Specifies the Provisioned IOPS (I/O operations per second) value.

        • OptionGroupMemberships — (Array<map>)

          Provides the list of option group memberships for this DB instance.

          • OptionGroupName — (String)

            The name of the option group that the instance belongs to.

          • Status — (String)

            The status of the DB instance's option group membership. Valid values are: in-sync, pending-apply, pending-removal, pending-maintenance-apply, pending-maintenance-removal, applying, removing, and failed.

        • CharacterSetName — (String)

          If present, specifies the name of the character set that this instance is associated with.

        • SecondaryAvailabilityZone — (String)

          If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

        • PubliclyAccessible — (Boolean)

          This flag should no longer be used.

        • StatusInfos — (Array<map>)

          The status of a Read Replica. If the instance is not a Read Replica, this is blank.

          • StatusType — (String)

            This value is currently "read replication."

          • Normal — (Boolean)

            Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

          • Status — (String)

            Status of the DB instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.

          • Message — (String)

            Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.

        • StorageType — (String)

          Specifies the storage type associated with DB instance.

        • TdeCredentialArn — (String)

          The ARN from the key store with which the instance is associated for TDE encryption.

        • DbInstancePort — (Integer)

          Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

        • DBClusterIdentifier — (String)

          If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

        • StorageEncrypted — (Boolean)

          Not supported: The encryption for DB instances is managed by the DB cluster.

        • KmsKeyId — (String)

          Not supported: The encryption for DB instances is managed by the DB cluster.

        • DbiResourceId — (String)

          The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.

        • CACertificateIdentifier — (String)

          The identifier of the CA certificate for this DB instance.

        • DomainMemberships — (Array<map>)

          Not supported

          • Domain — (String)

            The identifier of the Active Directory Domain.

          • Status — (String)

            The status of the DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).

          • FQDN — (String)

            The fully qualified domain name of the Active Directory Domain.

          • IAMRoleName — (String)

            The name of the IAM role to be used when making API calls to the Directory Service.

        • CopyTagsToSnapshot — (Boolean)

          Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

        • MonitoringInterval — (Integer)

          The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

        • EnhancedMonitoringResourceArn — (String)

          The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

        • MonitoringRoleArn — (String)

          The ARN for the IAM role that permits Neptune to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

        • PromotionTier — (Integer)

          A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance.

        • DBInstanceArn — (String)

          The Amazon Resource Name (ARN) for the DB instance.

        • Timezone — (String)

          Not supported.

        • IAMDatabaseAuthenticationEnabled — (Boolean)

          True if AWS Identity and Access Management (IAM) authentication is enabled, and otherwise false.

        • PerformanceInsightsEnabled — (Boolean)

          True if Performance Insights is enabled for the DB instance, and otherwise false.

        • PerformanceInsightsKMSKeyId — (String)

          The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

        • EnabledCloudwatchLogsExports — (Array<String>)

          A list of log types that this DB instance is configured to export to CloudWatch Logs.

Returns:

  • (AWS.Request) —

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

deleteDBParameterGroup(params = {}, callback) ⇒ AWS.Request

Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted can't be associated with any DB instances.

Service Reference:

Examples:

Calling the deleteDBParameterGroup operation

var params = {
  DBParameterGroupName: 'STRING_VALUE' /* required */
};
neptune.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)

      The name of the DB parameter group.

      Constraints:

      • Must be the name of an existing DB parameter group

      • You can't delete a default DB parameter group

      • Cannot be associated with any DB instances

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.

deleteDBSubnetGroup(params = {}, callback) ⇒ AWS.Request

Deletes a DB subnet group.

Note: The specified database subnet group must not be associated with any DB instances.

Service Reference:

Examples:

Calling the deleteDBSubnetGroup operation

var params = {
  DBSubnetGroupName: 'STRING_VALUE' /* required */
};
neptune.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)

      The name of the database subnet group to delete.

      Note: You can't delete the default subnet group.

      Constraints:

      Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

      Example: mySubnetgroup

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.

deleteEventSubscription(params = {}, callback) ⇒ AWS.Request

Deletes an event notification subscription.

Service Reference:

Examples:

Calling the deleteEventSubscription operation

var params = {
  SubscriptionName: 'STRING_VALUE' /* required */
};
neptune.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)

      The name of the event notification subscription you want to delete.

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)

        Contains the results of a successful invocation of the DescribeEventSubscriptions action.

        • CustomerAwsId — (String)

          The AWS customer account associated with the event notification subscription.

        • CustSubscriptionId — (String)

          The event notification subscription Id.

        • SnsTopicArn — (String)

          The topic ARN of the event notification subscription.

        • Status — (String)

          The status of the event notification subscription.

          Constraints:

          Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist

          The status "no-permission" indicates that Neptune no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.

        • SubscriptionCreationTime — (String)

          The time the event notification subscription was created.

        • SourceType — (String)

          The source type for the event notification subscription.

        • SourceIdsList — (Array<String>)

          A list of source IDs for the event notification subscription.

        • EventCategoriesList — (Array<String>)

          A list of event categories for the event notification subscription.

        • Enabled — (Boolean)

          A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

        • EventSubscriptionArn — (String)

          The Amazon Resource Name (ARN) for the event subscription.

Returns:

  • (AWS.Request) —

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

describeDBClusterParameterGroups(params = {}, callback) ⇒ AWS.Request

Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list will contain only the description of the specified DB cluster parameter group.

Service Reference:

Examples:

Calling the describeDBClusterParameterGroups operation

var params = {
  DBClusterParameterGroupName: 'STRING_VALUE',
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE'
};
neptune.describeDBClusterParameterGroups(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: {}) —
    • DBClusterParameterGroupName — (String)

      The name of a specific DB cluster parameter group to return details for.

      Constraints:

      • If supplied, must match the name of an existing DBClusterParameterGroup.

    • Filters — (Array<map>)

      This parameter is not currently supported.

      • Name — required — (String)

        This parameter is not currently supported.

      • Values — required — (Array<String>)

        This parameter is not currently supported.

    • MaxRecords — (Integer)

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

      An optional pagination token provided by a previous DescribeDBClusterParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

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)

        An optional pagination token provided by a previous DescribeDBClusterParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

      • DBClusterParameterGroups — (Array<map>)

        A list of DB cluster parameter groups.

        • DBClusterParameterGroupName — (String)

          Provides the name of the DB cluster parameter group.

        • DBParameterGroupFamily — (String)

          Provides the name of the DB parameter group family that this DB cluster parameter group is compatible with.

        • Description — (String)

          Provides the customer-specified description for this DB cluster parameter group.

        • DBClusterParameterGroupArn — (String)

          The Amazon Resource Name (ARN) for the DB cluster parameter group.

Returns:

  • (AWS.Request) —

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

describeDBClusterParameters(params = {}, callback) ⇒ AWS.Request

Returns the detailed parameter list for a particular DB cluster parameter group.

Service Reference:

Examples:

Calling the describeDBClusterParameters operation

var params = {
  DBClusterParameterGroupName: 'STRING_VALUE', /* required */
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  Source: 'STRING_VALUE'
};
neptune.describeDBClusterParameters(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: {}) —
    • DBClusterParameterGroupName — (String)

      The name of a specific DB cluster parameter group to return parameter details for.

      Constraints:

      • If supplied, must match the name of an existing DBClusterParameterGroup.

    • Source — (String)

      A value that indicates to return only parameters for a specific source. Parameter sources can be engine, service, or customer.

    • Filters — (Array<map>)

      This parameter is not currently supported.

      • Name — required — (String)

        This parameter is not currently supported.

      • Values — required — (Array<String>)

        This parameter is not currently supported.

    • MaxRecords — (Integer)

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

      An optional pagination token provided by a previous DescribeDBClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

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>)

        Provides a list of parameters for the DB cluster parameter group.

        • ParameterName — (String)

          Specifies the name of the parameter.

        • ParameterValue — (String)

          Specifies the value of the parameter.

        • Description — (String)

          Provides a description of the parameter.

        • Source — (String)

          Indicates the source of the parameter value.

        • ApplyType — (String)

          Specifies the engine specific parameters type.

        • DataType — (String)

          Specifies the valid data type for the parameter.

        • AllowedValues — (String)

          Specifies the valid range of values for the parameter.

        • IsModifiable — (Boolean)

          Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

        • MinimumEngineVersion — (String)

          The earliest engine version to which the parameter can apply.

        • ApplyMethod — (String)

          Indicates when to apply parameter updates.

          Possible values include:
          • "immediate"
          • "pending-reboot"
      • Marker — (String)

        An optional pagination token provided by a previous DescribeDBClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

Returns:

  • (AWS.Request) —

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

describeDBClusters(params = {}, callback) ⇒ AWS.Request

Returns information about provisioned DB clusters. This API supports pagination.

Service Reference:

Examples:

Calling the describeDBClusters operation

var params = {
  DBClusterIdentifier: 'STRING_VALUE',
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE'
};
neptune.describeDBClusters(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: {}) —
    • DBClusterIdentifier — (String)

      The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.

      Constraints:

      • If supplied, must match an existing DBClusterIdentifier.

    • Filters — (Array<map>)

      A filter that specifies one or more DB clusters to describe.

      Supported filters:

      • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB clusters identified by these ARNs.

      • Name — required — (String)

        This parameter is not currently supported.

      • Values — required — (Array<String>)

        This parameter is not currently supported.

    • MaxRecords — (Integer)

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

      An optional pagination token provided by a previous DescribeDBClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

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)

        A pagination token that can be used in a subsequent DescribeDBClusters request.

      • DBClusters — (Array<map>)

        Contains a list of DB clusters for the user.

        • AllocatedStorage — (Integer)

          AllocatedStorage always returns 1, because Neptune DB cluster storage size is not fixed, but instead automatically adjusts as needed.

        • AvailabilityZones — (Array<String>)

          Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.

        • BackupRetentionPeriod — (Integer)

          Specifies the number of days for which automatic DB snapshots are retained.

        • CharacterSetName — (String)

          If present, specifies the name of the character set that this cluster is associated with.

        • DatabaseName — (String)

          Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

        • DBClusterIdentifier — (String)

          Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

        • DBClusterParameterGroup — (String)

          Specifies the name of the DB cluster parameter group for the DB cluster.

        • DBSubnetGroup — (String)

          Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

        • Status — (String)

          Specifies the current state of this DB cluster.

        • PercentProgress — (String)

          Specifies the progress of the operation as a percentage.

        • EarliestRestorableTime — (Date)

          Specifies the earliest time to which a database can be restored with point-in-time restore.

        • Endpoint — (String)

          Specifies the connection endpoint for the primary instance of the DB cluster.

        • ReaderEndpoint — (String)

          The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Read Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Neptune distributes the connection requests among the Read Replicas in the DB cluster. This functionality can help balance your read workload across multiple Read Replicas in your DB cluster.

          If a failover occurs, and the Read Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Read Replicas in the cluster, you can then reconnect to the reader endpoint.

        • MultiAZ — (Boolean)

          Specifies whether the DB cluster has instances in multiple Availability Zones.

        • Engine — (String)

          Provides the name of the database engine to be used for this DB cluster.

        • EngineVersion — (String)

          Indicates the database engine version.

        • LatestRestorableTime — (Date)

          Specifies the latest time to which a database can be restored with point-in-time restore.

        • Port — (Integer)

          Specifies the port that the database engine is listening on.

        • MasterUsername — (String)

          Contains the master username for the DB cluster.

        • DBClusterOptionGroupMemberships — (Array<map>)

          Provides the list of option group memberships for this DB cluster.

          • DBClusterOptionGroupName — (String)

            Specifies the name of the DB cluster option group.

          • Status — (String)

            Specifies the status of the DB cluster option group.

        • PreferredBackupWindow — (String)

          Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

        • PreferredMaintenanceWindow — (String)

          Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

        • ReplicationSourceIdentifier — (String)

          Not supported by Neptune.

        • ReadReplicaIdentifiers — (Array<String>)

          Contains one or more identifiers of the Read Replicas associated with this DB cluster.

        • DBClusterMembers — (Array<map>)

          Provides the list of instances that make up the DB cluster.

          • DBInstanceIdentifier — (String)

            Specifies the instance identifier for this member of the DB cluster.

          • IsClusterWriter — (Boolean)

            Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

          • DBClusterParameterGroupStatus — (String)

            Specifies the status of the DB cluster parameter group for this member of the DB cluster.

          • PromotionTier — (Integer)

            A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance.

        • VpcSecurityGroups — (Array<map>)

          Provides a list of VPC security groups that the DB cluster belongs to.

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • HostedZoneId — (String)

          Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

        • StorageEncrypted — (Boolean)

          Specifies whether the DB cluster is encrypted.

        • KmsKeyId — (String)

          If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster.

        • DbClusterResourceId — (String)

          The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.

        • DBClusterArn — (String)

          The Amazon Resource Name (ARN) for the DB cluster.

        • AssociatedRoles — (Array<map>)

          Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.

          • RoleArn — (String)

            The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.

          • Status — (String)

            Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:

            • ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other AWS services on your behalf.

            • PENDING - the IAM role ARN is being associated with the DB cluster.

            • INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other AWS services on your behalf.

        • IAMDatabaseAuthenticationEnabled — (Boolean)

          True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

        • CloneGroupId — (String)

          Identifies the clone group to which the DB cluster is associated.

        • ClusterCreateTime — (Date)

          Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

Returns:

  • (AWS.Request) —

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

describeDBClusterSnapshotAttributes(params = {}, callback) ⇒ AWS.Request

Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.

When sharing snapshots with other AWS accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of values for the restore attribute, then the manual DB cluster snapshot is public and can be copied or restored by all AWS accounts.

To add or remove access for an AWS account to copy or restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.

Service Reference:

Examples:

Calling the describeDBClusterSnapshotAttributes operation

var params = {
  DBClusterSnapshotIdentifier: 'STRING_VALUE' /* required */
};
neptune.describeDBClusterSnapshotAttributes(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: {}) —
    • DBClusterSnapshotIdentifier — (String)

      The identifier for the DB cluster snapshot to describe the attributes for.

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:

      • DBClusterSnapshotAttributesResult — (map)

        Contains the results of a successful call to the DescribeDBClusterSnapshotAttributes API action.

        Manual DB cluster snapshot attributes are used to authorize other AWS accounts to copy or restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.

        • DBClusterSnapshotIdentifier — (String)

          The identifier of the manual DB cluster snapshot that the attributes apply to.

        • DBClusterSnapshotAttributes — (Array<map>)

          The list of attributes and values for the manual DB cluster snapshot.

          • AttributeName — (String)

            The name of the manual DB cluster snapshot attribute.

            The attribute named restore refers to the list of AWS accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.

          • AttributeValues — (Array<String>)

            The value(s) for the manual DB cluster snapshot attribute.

            If the AttributeName field is set to restore, then this element returns a list of IDs of the AWS accounts that are authorized to copy or restore the manual DB cluster snapshot. If a value of all is in the list, then the manual DB cluster snapshot is public and available for any AWS account to copy or restore.

Returns:

  • (AWS.Request) —

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

describeDBClusterSnapshots(params = {}, callback) ⇒ AWS.Request

Returns information about DB cluster snapshots. This API action supports pagination.

Service Reference:

Examples:

Calling the describeDBClusterSnapshots operation

var params = {
  DBClusterIdentifier: 'STRING_VALUE',
  DBClusterSnapshotIdentifier: 'STRING_VALUE',
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  IncludePublic: true || false,
  IncludeShared: true || false,
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  SnapshotType: 'STRING_VALUE'
};
neptune.describeDBClusterSnapshots(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: {}) —
    • DBClusterIdentifier — (String)

      The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter is not case-sensitive.

      Constraints:

      • If supplied, must match the identifier of an existing DBCluster.

    • DBClusterSnapshotIdentifier — (String)

      A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with the DBClusterIdentifier parameter. This value is stored as a lowercase string.

      Constraints:

      • If supplied, must match the identifier of an existing DBClusterSnapshot.

      • If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

    • SnapshotType — (String)

      The type of DB cluster snapshots to be returned. You can specify one of the following values:

      • automated - Return all DB cluster snapshots that have been automatically taken by Amazon Neptune for my AWS account.

      • manual - Return all DB cluster snapshots that have been taken by my AWS account.

      • shared - Return all manual DB cluster snapshots that have been shared to my AWS account.

      • public - Return all DB cluster snapshots that have been marked as public.

      If you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public DB cluster snapshots with these results by setting the IncludePublic parameter to true.

      The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.

    • Filters — (Array<map>)

      This parameter is not currently supported.

      • Name — required — (String)

        This parameter is not currently supported.

      • Values — required — (Array<String>)

        This parameter is not currently supported.

    • MaxRecords — (Integer)

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

      An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    • IncludeShared — (Boolean)

      True to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, and otherwise false. The default is false.

      You can give an AWS account permission to restore a manual DB cluster snapshot from another AWS account by the ModifyDBClusterSnapshotAttribute API action.

    • IncludePublic — (Boolean)

      True to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account, and otherwise false. The default is false. The default is false.

      You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.

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)

        An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

      • DBClusterSnapshots — (Array<map>)

        Provides a list of DB cluster snapshots for the user.

        • AvailabilityZones — (Array<String>)

          Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.

        • DBClusterSnapshotIdentifier — (String)

          Specifies the identifier for the DB cluster snapshot.

        • DBClusterIdentifier — (String)

          Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.

        • SnapshotCreateTime — (Date)

          Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).

        • Engine — (String)

          Specifies the name of the database engine.

        • AllocatedStorage — (Integer)

          Specifies the allocated storage size in gibibytes (GiB).

        • Status — (String)

          Specifies the status of this DB cluster snapshot.

        • Port — (Integer)

          Specifies the port that the DB cluster was listening on at the time of the snapshot.

        • VpcId — (String)

          Provides the VPC ID associated with the DB cluster snapshot.

        • ClusterCreateTime — (Date)

          Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

        • MasterUsername — (String)

          Provides the master username for the DB cluster snapshot.

        • EngineVersion — (String)

          Provides the version of the database engine for this DB cluster snapshot.

        • LicenseModel — (String)

          Provides the license model information for this DB cluster snapshot.

        • SnapshotType — (String)

          Provides the type of the DB cluster snapshot.

        • PercentProgress — (Integer)

          Specifies the percentage of the estimated data that has been transferred.

        • StorageEncrypted — (Boolean)

          Specifies whether the DB cluster snapshot is encrypted.

        • KmsKeyId — (String)

          If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.

        • DBClusterSnapshotArn — (String)

          The Amazon Resource Name (ARN) for the DB cluster snapshot.

        • SourceDBClusterSnapshotArn — (String)

          If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.

        • IAMDatabaseAuthenticationEnabled — (Boolean)

          True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

Returns:

  • (AWS.Request) —

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

describeDBEngineVersions(params = {}, callback) ⇒ AWS.Request

Returns a list of the available DB engines.

Service Reference:

Examples:

Calling the describeDBEngineVersions operation

var params = {
  DBParameterGroupFamily: 'STRING_VALUE',
  DefaultOnly: true || false,
  Engine: 'STRING_VALUE',
  EngineVersion: 'STRING_VALUE',
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  ListSupportedCharacterSets: true || false,
  ListSupportedTimezones: true || false,
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE'
};
neptune.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)

      The database engine to return.

    • EngineVersion — (String)

      The database engine version to return.

      Example: 5.1.49

    • DBParameterGroupFamily — (String)

      The name of a specific DB parameter group family to return details for.

      Constraints:

      • If supplied, must match an existing DBParameterGroupFamily.

    • Filters — (Array<map>)

      Not currently supported.

      • Name — required — (String)

        This parameter is not currently supported.

      • Values — required — (Array<String>)

        This parameter is not currently supported.

    • MaxRecords — (Integer)

      The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

      An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    • DefaultOnly — (Boolean)

      Indicates that only the default version of the specified engine or engine and major version combination is returned.

    • ListSupportedCharacterSets — (Boolean)

      If this parameter is specified and the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.

    • ListSupportedTimezones — (Boolean)

      If this parameter is specified and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version.

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)

        An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

      • DBEngineVersions — (Array<map>)

        A list of DBEngineVersion elements.

        • Engine — (String)

          The name of the database engine.

        • EngineVersion — (String)

          The version number of the database engine.

        • DBParameterGroupFamily — (String)

          The name of the DB parameter group family for the database engine.

        • DBEngineDescription — (String)

          The description of the database engine.

        • DBEngineVersionDescription — (String)

          The description of the database engine version.

        • DefaultCharacterSet — (map)

          The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API is not specified.

          • CharacterSetName — (String)

            The name of the character set.

          • CharacterSetDescription — (String)

            The description of the character set.

        • SupportedCharacterSets — (Array<map>)

          A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance action.

          • CharacterSetName — (String)

            The name of the character set.

          • CharacterSetDescription — (String)

            The description of the character set.

        • ValidUpgradeTarget — (Array<map>)

          A list of engine versions that this database engine version can be upgraded to.

          • Engine — (String)

            The name of the upgrade target database engine.

          • EngineVersion — (String)

            The version number of the upgrade target database engine.

          • Description — (String)

            The version of the database engine that a DB instance can be upgraded to.

          • AutoUpgrade — (Boolean)

            A value that indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.

          • IsMajorVersionUpgrade — (Boolean)

            A value that indicates whether a database engine is upgraded to a major version.

        • SupportedTimezones — (Array<map>)

          A list of the time zones supported by this engine for the Timezone parameter of the CreateDBInstance action.

          • TimezoneName — (String)

            The name of the time zone.

        • ExportableLogTypes — (Array<String>)

          The types of logs that the database engine has available for export to CloudWatch Logs.

        • SupportsLogExportsToCloudwatchLogs — (Boolean)

          A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.

        • SupportsReadReplica — (Boolean)

          Indicates whether the database engine version supports read replicas.

Returns:

  • (AWS.Request) —

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

describeDBInstances(params = {}, callback) ⇒ AWS.Request

Returns information about provisioned instances. This API supports pagination.

Service Reference:

Examples:

Calling the describeDBInstances operation

var params = {
  DBInstanceIdentifier: 'STRING_VALUE',
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE'
};
neptune.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)

      The user-supplied instance identifier. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case-sensitive.

      Constraints:

      • If supplied, must match the identifier of an existing DBInstance.

    • Filters — (Array<map>)

      A filter that specifies one or more DB instances to describe.

      Supported filters:

      • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB instances associated with the DB clusters identified by these ARNs.

      • db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list will only include information about the DB instances identified by these ARNs.

      • Name — required — (String)

        This parameter is not currently supported.

      • Values — required — (Array<String>)

        This parameter is not currently supported.

    • MaxRecords — (Integer)

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

      An optional pagination token provided by a previous DescribeDBInstances request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

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)

        An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

      • DBInstances — (Array<map>)

        A list of DBInstance instances.

        • DBInstanceIdentifier — (String)

          Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

        • DBInstanceClass — (String)

          Contains the name of the compute and memory capacity class of the DB instance.

        • Engine — (String)

          Provides the name of the database engine to be used for this DB instance.

        • DBInstanceStatus — (String)

          Specifies the current state of this database.

        • MasterUsername — (String)

          Contains the master username for the DB instance.

        • DBName — (String)

          The database name.

        • Endpoint — (map)

          Specifies the connection endpoint.

          • Address — (String)

            Specifies the DNS address of the DB instance.

          • Port — (Integer)

            Specifies the port that the database engine is listening on.

          • HostedZoneId — (String)

            Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

        • AllocatedStorage — (Integer)

          Specifies the allocated storage size specified in gibibytes.

        • InstanceCreateTime — (Date)

          Provides the date and time the DB instance was created.

        • PreferredBackupWindow — (String)

          Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

        • BackupRetentionPeriod — (Integer)

          Specifies the number of days for which automatic DB snapshots are retained.

        • DBSecurityGroups — (Array<map>)

          Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

          • DBSecurityGroupName — (String)

            The name of the DB security group.

          • Status — (String)

            The status of the DB security group.

        • VpcSecurityGroups — (Array<map>)

          Provides a list of VPC security group elements that the DB instance belongs to.

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • DBParameterGroups — (Array<map>)

          Provides the list of DB parameter groups applied to this DB instance.

          • DBParameterGroupName — (String)

            The name of the DP parameter group.

          • ParameterApplyStatus — (String)

            The status of parameter updates.

        • AvailabilityZone — (String)

          Specifies the name of the Availability Zone the DB instance is located in.

        • DBSubnetGroup — (map)

          Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

          • DBSubnetGroupName — (String)

            The name of the DB subnet group.

          • DBSubnetGroupDescription — (String)

            Provides the description of the DB subnet group.

          • VpcId — (String)

            Provides the VpcId of the DB subnet group.

          • SubnetGroupStatus — (String)

            Provides the status of the DB subnet group.

          • Subnets — (Array<map>)

            Contains a list of Subnet elements.

            • SubnetIdentifier — (String)

              Specifies the identifier of the subnet.

            • SubnetAvailabilityZone — (map)

              Specifies the EC2 Availability Zone that the subnet is in.

              • Name — (String)

                The name of the availability zone.

            • SubnetStatus — (String)

              Specifies the status of the subnet.

          • DBSubnetGroupArn — (String)

            The Amazon Resource Name (ARN) for the DB subnet group.

        • PreferredMaintenanceWindow — (String)

          Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

        • PendingModifiedValues — (map)

          Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

          • DBInstanceClass — (String)

            Contains the new DBInstanceClass for the DB instance that will be applied or is currently being applied.

          • AllocatedStorage — (Integer)

            Contains the new AllocatedStorage size for the DB instance that will be applied or is currently being applied.

          • MasterUserPassword — (String)

            Contains the pending or currently-in-progress change of the master credentials for the DB instance.

          • Port — (Integer)

            Specifies the pending port for the DB instance.

          • BackupRetentionPeriod — (Integer)

            Specifies the pending number of days for which automated backups are retained.

          • MultiAZ — (Boolean)

            Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.

          • EngineVersion — (String)

            Indicates the database engine version.

          • LicenseModel — (String)

            The license model for the DB instance.

            Valid values: license-included | bring-your-own-license | general-public-license

          • Iops — (Integer)

            Specifies the new Provisioned IOPS value for the DB instance that will be applied or is currently being applied.

          • DBInstanceIdentifier — (String)

            Contains the new DBInstanceIdentifier for the DB instance that will be applied or is currently being applied.

          • StorageType — (String)

            Specifies the storage type to be associated with the DB instance.

          • CACertificateIdentifier — (String)

            Specifies the identifier of the CA certificate for the DB instance.

          • DBSubnetGroupName — (String)

            The new DB subnet group for the DB instance.

          • PendingCloudwatchLogsExports — (map)

            Specifies the CloudWatch logs to be exported.

            • LogTypesToEnable — (Array<String>)

              Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.

            • LogTypesToDisable — (Array<String>)

              Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.

        • LatestRestorableTime — (Date)

          Specifies the latest time to which a database can be restored with point-in-time restore.

        • MultiAZ — (Boolean)

          Specifies if the DB instance is a Multi-AZ deployment.

        • EngineVersion — (String)

          Indicates the database engine version.

        • AutoMinorVersionUpgrade — (Boolean)

          Indicates that minor version patches are applied automatically.

        • ReadReplicaSourceDBInstanceIdentifier — (String)

          Contains the identifier of the source DB instance if this DB instance is a Read Replica.

        • ReadReplicaDBInstanceIdentifiers — (Array<String>)

          Contains one or more identifiers of the Read Replicas associated with this DB instance.

        • ReadReplicaDBClusterIdentifiers — (Array<String>)

          Contains one or more identifiers of DB clusters that are Read Replicas of this DB instance.

        • LicenseModel — (String)

          License model information for this DB instance.

        • Iops — (Integer)

          Specifies the Provisioned IOPS (I/O operations per second) value.

        • OptionGroupMemberships — (Array<map>)

          Provides the list of option group memberships for this DB instance.

          • OptionGroupName — (String)

            The name of the option group that the instance belongs to.

          • Status — (String)

            The status of the DB instance's option group membership. Valid values are: in-sync, pending-apply, pending-removal, pending-maintenance-apply, pending-maintenance-removal, applying, removing, and failed.

        • CharacterSetName — (String)

          If present, specifies the name of the character set that this instance is associated with.

        • SecondaryAvailabilityZone — (String)

          If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

        • PubliclyAccessible — (Boolean)

          This flag should no longer be used.

        • StatusInfos — (Array<map>)

          The status of a Read Replica. If the instance is not a Read Replica, this is blank.

          • StatusType — (String)

            This value is currently "read replication."

          • Normal — (Boolean)

            Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

          • Status — (String)

            Status of the DB instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.

          • Message — (String)

            Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.

        • StorageType — (String)

          Specifies the storage type associated with DB instance.

        • TdeCredentialArn — (String)

          The ARN from the key store with which the instance is associated for TDE encryption.

        • DbInstancePort — (Integer)

          Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

        • DBClusterIdentifier — (String)

          If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

        • StorageEncrypted — (Boolean)

          Not supported: The encryption for DB instances is managed by the DB cluster.

        • KmsKeyId — (String)

          Not supported: The encryption for DB instances is managed by the DB cluster.

        • DbiResourceId — (String)

          The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.

        • CACertificateIdentifier — (String)

          The identifier of the CA certificate for this DB instance.

        • DomainMemberships — (Array<map>)

          Not supported

          • Domain — (String)

            The identifier of the Active Directory Domain.

          • Status — (String)

            The status of the DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).

          • FQDN — (String)

            The fully qualified domain name of the Active Directory Domain.

          • IAMRoleName — (String)

            The name of the IAM role to be used when making API calls to the Directory Service.

        • CopyTagsToSnapshot — (Boolean)

          Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

        • MonitoringInterval — (Integer)

          The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

        • EnhancedMonitoringResourceArn — (String)

          The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

        • MonitoringRoleArn — (String)

          The ARN for the IAM role that permits Neptune to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

        • PromotionTier — (Integer)

          A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance.

        • DBInstanceArn — (String)

          The Amazon Resource Name (ARN) for the DB instance.

        • Timezone — (String)

          Not supported.

        • IAMDatabaseAuthenticationEnabled — (Boolean)

          True if AWS Identity and Access Management (IAM) authentication is enabled, and otherwise false.

        • PerformanceInsightsEnabled — (Boolean)

          True if Performance Insights is enabled for the DB instance, and otherwise false.

        • PerformanceInsightsKMSKeyId — (String)

          The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

        • EnabledCloudwatchLogsExports — (Array<String>)

          A list of log types that this DB instance is configured to export to CloudWatch Logs.

Returns:

  • (AWS.Request) —

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

Waiter Resource States:

describeDBParameterGroups(params = {}, callback) ⇒ AWS.Request

Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group.

Service Reference:

Examples:

Calling the describeDBParameterGroups operation

var params = {
  DBParameterGroupName: 'STRING_VALUE',
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE'
};
neptune.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)

      The name of a specific DB parameter group to return details for.

      Constraints:

      • If supplied, must match the name of an existing DBClusterParameterGroup.

    • Filters — (Array<map>)

      This parameter is not currently supported.

      • Name — required — (String)

        This parameter is not currently supported.

      • Values — required — (Array<String>)

        This parameter is not currently supported.

    • MaxRecords — (Integer)

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

      An optional pagination token provided by a previous DescribeDBParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

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)

        An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

      • DBParameterGroups — (Array<map>)

        A list of DBParameterGroup instances.

        • DBParameterGroupName — (String)

          Provides the name of the DB parameter group.

        • DBParameterGroupFamily — (String)

          Provides the name of the DB parameter group family that this DB parameter group is compatible with.

        • Description — (String)

          Provides the customer-specified description for this DB parameter group.

        • DBParameterGroupArn — (String)

          The Amazon Resource Name (ARN) for the DB parameter group.

Returns:

  • (AWS.Request) —

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

describeDBParameters(params = {}, callback) ⇒ AWS.Request

Returns the detailed parameter list for a particular DB parameter group.

Service Reference:

Examples:

Calling the describeDBParameters operation

var params = {
  DBParameterGroupName: 'STRING_VALUE', /* required */
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  Source: 'STRING_VALUE'
};
neptune.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)

      The name of a specific DB parameter group to return details for.

      Constraints:

      • If supplied, must match the name of an existing DBParameterGroup.

    • Source — (String)

      The parameter types to return.

      Default: All parameter types returned

      Valid Values: user | system | engine-default

    • Filters — (Array<map>)

      This parameter is not currently supported.

      • Name — required — (String)

        This parameter is not currently supported.

      • Values — required — (Array<String>)

        This parameter is not currently supported.

    • MaxRecords — (Integer)

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

      An optional pagination token provided by a previous DescribeDBParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

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>)

        A list of Parameter values.

        • ParameterName — (String)

          Specifies the name of the parameter.

        • ParameterValue — (String)

          Specifies the value of the parameter.

        • Description — (String)

          Provides a description of the parameter.

        • Source — (String)

          Indicates the source of the parameter value.

        • ApplyType — (String)

          Specifies the engine specific parameters type.

        • DataType — (String)

          Specifies the valid data type for the parameter.

        • AllowedValues — (String)

          Specifies the valid range of values for the parameter.

        • IsModifiable — (Boolean)

          Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

        • MinimumEngineVersion — (String)

          The earliest engine version to which the parameter can apply.

        • ApplyMethod — (String)

          Indicates when to apply parameter updates.

          Possible values include:
          • "immediate"
          • "pending-reboot"
      • Marker — (String)

        An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Returns:

  • (AWS.Request) —

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

describeDBSubnetGroups(params = {}, callback) ⇒ AWS.Request

Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.

For an overview of CIDR ranges, go to the Wikipedia Tutorial.

Service Reference:

Examples:

Calling the describeDBSubnetGroups operation

var params = {
  DBSubnetGroupName: 'STRING_VALUE',
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE'
};
neptune.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)

      The name of the DB subnet group to return details for.

    • Filters — (Array<map>)

      This parameter is not currently supported.

      • Name — required — (String)

        This parameter is not currently supported.

      • Values — required — (Array<String>)

        This parameter is not currently supported.

    • MaxRecords — (Integer)

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

      An optional pagination token provided by a previous DescribeDBSubnetGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

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)

        An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

      • DBSubnetGroups — (Array<map>)

        A list of DBSubnetGroup instances.

        • DBSubnetGroupName — (String)

          The name of the DB subnet group.

        • DBSubnetGroupDescription — (String)

          Provides the description of the DB subnet group.

        • VpcId — (String)

          Provides the VpcId of the DB subnet group.

        • SubnetGroupStatus — (String)

          Provides the status of the DB subnet group.

        • Subnets — (Array<map>)

          Contains a list of Subnet elements.

          • SubnetIdentifier — (String)

            Specifies the identifier of the subnet.

          • SubnetAvailabilityZone — (map)

            Specifies the EC2 Availability Zone that the subnet is in.

            • Name — (String)

              The name of the availability zone.

          • SubnetStatus — (String)

            Specifies the status of the subnet.

        • DBSubnetGroupArn — (String)

          The Amazon Resource Name (ARN) for the DB subnet group.

Returns:

  • (AWS.Request) —

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

describeEngineDefaultClusterParameters(params = {}, callback) ⇒ AWS.Request

Returns the default engine and system parameter information for the cluster database engine.

Service Reference:

Examples:

Calling the describeEngineDefaultClusterParameters operation

var params = {
  DBParameterGroupFamily: 'STRING_VALUE', /* required */
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE'
};
neptune.describeEngineDefaultClusterParameters(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)

      The name of the DB cluster parameter group family to return engine parameter information for.

    • Filters — (Array<map>)

      This parameter is not currently supported.

      • Name — required — (String)

        This parameter is not currently supported.

      • Values — required — (Array<String>)

        This parameter is not currently supported.

    • MaxRecords — (Integer)

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

      An optional pagination token provided by a previous DescribeEngineDefaultClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

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)

        Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.

        • DBParameterGroupFamily — (String)

          Specifies the name of the DB parameter group family that the engine default parameters apply to.

        • Marker — (String)

          An optional pagination token provided by a previous EngineDefaults request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

        • Parameters — (Array<map>)

          Contains a list of engine default parameters.

          • ParameterName — (String)

            Specifies the name of the parameter.

          • ParameterValue — (String)

            Specifies the value of the parameter.

          • Description — (String)

            Provides a description of the parameter.

          • Source — (String)

            Indicates the source of the parameter value.

          • ApplyType — (String)

            Specifies the engine specific parameters type.

          • DataType — (String)

            Specifies the valid data type for the parameter.

          • AllowedValues — (String)

            Specifies the valid range of values for the parameter.

          • IsModifiable — (Boolean)

            Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

          • MinimumEngineVersion — (String)

            The earliest engine version to which the parameter can apply.

          • ApplyMethod — (String)

            Indicates when to apply parameter updates.

            Possible values include:
            • "immediate"
            • "pending-reboot"

Returns:

  • (AWS.Request) —

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

describeEngineDefaultParameters(params = {}, callback) ⇒ AWS.Request

Returns the default engine and system parameter information for the specified database engine.

Service Reference:

Examples:

Calling the describeEngineDefaultParameters operation

var params = {
  DBParameterGroupFamily: 'STRING_VALUE', /* required */
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE'
};
neptune.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)

      The name of the DB parameter group family.

    • Filters — (Array<map>)

      Not currently supported.

      • Name — required — (String)

        This parameter is not currently supported.

      • Values — required — (Array<String>)

        This parameter is not currently supported.

    • MaxRecords — (Integer)

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

      An optional pagination token provided by a previous DescribeEngineDefaultParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

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)

        Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.

        • DBParameterGroupFamily — (String)

          Specifies the name of the DB parameter group family that the engine default parameters apply to.

        • Marker — (String)

          An optional pagination token provided by a previous EngineDefaults request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

        • Parameters — (Array<map>)

          Contains a list of engine default parameters.

          • ParameterName — (String)

            Specifies the name of the parameter.

          • ParameterValue — (String)

            Specifies the value of the parameter.

          • Description — (String)

            Provides a description of the parameter.

          • Source — (String)

            Indicates the source of the parameter value.

          • ApplyType — (String)

            Specifies the engine specific parameters type.

          • DataType — (String)

            Specifies the valid data type for the parameter.

          • AllowedValues — (String)

            Specifies the valid range of values for the parameter.

          • IsModifiable — (Boolean)

            Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

          • MinimumEngineVersion — (String)

            The earliest engine version to which the parameter can apply.

          • ApplyMethod — (String)

            Indicates when to apply parameter updates.

            Possible values include:
            • "immediate"
            • "pending-reboot"

Returns:

  • (AWS.Request) —

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

describeEventCategories(params = {}, callback) ⇒ AWS.Request

Displays a list of categories for all event source types, or, if specified, for a specified source type.

Service Reference:

Examples:

Calling the describeEventCategories operation

var params = {
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  SourceType: 'STRING_VALUE'
};
neptune.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)

      The type of source that is generating the events.

      Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot

    • Filters — (Array<map>)

      This parameter is not currently supported.

      • Name — required — (String)

        This parameter is not currently supported.

      • Values — required — (Array<String>)

        This parameter is not currently supported.

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>)

        A list of EventCategoriesMap data types.

        • SourceType — (String)

          The source type that the returned categories belong to

        • EventCategories — (Array<String>)

          The event categories for the specified source type

Returns:

  • (AWS.Request) —

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

describeEvents(params = {}, callback) ⇒ AWS.Request

Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.

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 */
  ],
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  SourceIdentifier: 'STRING_VALUE',
  SourceType: db-instance | db-parameter-group | db-security-group | db-snapshot | db-cluster | db-cluster-snapshot,
  StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
};
neptune.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)

      The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.

      Constraints:

      • If SourceIdentifier is supplied, SourceType must also be provided.

      • If the source type is DBInstance, then a DBInstanceIdentifier must be supplied.

      • If the source type is DBSecurityGroup, a DBSecurityGroupName must be supplied.

      • If the source type is DBParameterGroup, a DBParameterGroupName must be supplied.

      • If the source type is DBSnapshot, a DBSnapshotIdentifier must be supplied.

      • Cannot end with a hyphen or contain two consecutive hyphens.

    • SourceType — (String)

      The event source to retrieve events for. If no value is specified, all events are returned.

      Possible values include:
      • "db-instance"
      • "db-parameter-group"
      • "db-security-group"
      • "db-snapshot"
      • "db-cluster"
      • "db-cluster-snapshot"
    • StartTime — (Date)

      The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

      Example: 2009-07-08T18:00Z

    • EndTime — (Date)

      The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

      Example: 2009-07-08T18:00Z

    • Duration — (Integer)

      The number of minutes to retrieve events for.

      Default: 60

    • EventCategories — (Array<String>)

      A list of event categories that trigger notifications for a event notification subscription.

    • Filters — (Array<map>)

      This parameter is not currently supported.

      • Name — required — (String)

        This parameter is not currently supported.

      • Values — required — (Array<String>)

        This parameter is not currently supported.

    • MaxRecords — (Integer)

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

      An optional pagination token provided by a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

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)

        An optional pagination token provided by a previous Events request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

      • Events — (Array<map>)

        A list of Event instances.

        • SourceIdentifier — (String)

          Provides the identifier for the source of the event.

        • SourceType — (String)

          Specifies the source type for this event.

          Possible values include:
          • "db-instance"
          • "db-parameter-group"
          • "db-security-group"
          • "db-snapshot"
          • "db-cluster"
          • "db-cluster-snapshot"
        • Message — (String)

          Provides the text of this event.

        • EventCategories — (Array<String>)

          Specifies the category for the event.

        • Date — (Date)

          Specifies the date and time of the event.

        • SourceArn — (String)

          The Amazon Resource Name (ARN) for the event.

Returns:

  • (AWS.Request) —

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

describeEventSubscriptions(params = {}, callback) ⇒ AWS.Request

Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.

If you specify a SubscriptionName, lists the description for that subscription.

Service Reference:

Examples:

Calling the describeEventSubscriptions operation

var params = {
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  SubscriptionName: 'STRING_VALUE'
};
neptune.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)

      The name of the event notification subscription you want to describe.

    • Filters — (Array<map>)

      This parameter is not currently supported.

      • Name — required — (String)

        This parameter is not currently supported.

      • Values — required — (Array<String>)

        This parameter is not currently supported.

    • MaxRecords — (Integer)

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

      An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

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)

        An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

      • EventSubscriptionsList — (Array<map>)

        A list of EventSubscriptions data types.

        • CustomerAwsId — (String)

          The AWS customer account associated with the event notification subscription.

        • CustSubscriptionId — (String)

          The event notification subscription Id.

        • SnsTopicArn — (String)

          The topic ARN of the event notification subscription.

        • Status — (String)

          The status of the event notification subscription.

          Constraints:

          Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist

          The status "no-permission" indicates that Neptune no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.

        • SubscriptionCreationTime — (String)

          The time the event notification subscription was created.

        • SourceType — (String)

          The source type for the event notification subscription.

        • SourceIdsList — (Array<String>)

          A list of source IDs for the event notification subscription.

        • EventCategoriesList — (Array<String>)

          A list of event categories for the event notification subscription.

        • Enabled — (Boolean)

          A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

        • EventSubscriptionArn — (String)

          The Amazon Resource Name (ARN) for the event subscription.

Returns:

  • (AWS.Request) —

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

describeOrderableDBInstanceOptions(params = {}, callback) ⇒ AWS.Request

Returns a list of orderable DB instance options for the specified engine.

Service Reference:

Examples:

Calling the describeOrderableDBInstanceOptions operation

var params = {
  Engine: 'STRING_VALUE', /* required */
  DBInstanceClass: 'STRING_VALUE',
  EngineVersion: 'STRING_VALUE',
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  LicenseModel: 'STRING_VALUE',
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  Vpc: true || false
};
neptune.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)

      The name of the engine to retrieve DB instance options for.

    • EngineVersion — (String)

      The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.

    • DBInstanceClass — (String)

      The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.

    • LicenseModel — (String)

      The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.

    • Vpc — (Boolean)

      The VPC filter value. Specify this parameter to show only the available VPC or non-VPC offerings.

    • Filters — (Array<map>)

      This parameter is not currently supported.

      • Name — required — (String)

        This parameter is not currently supported.

      • Values — required — (Array<String>)

        This parameter is not currently supported.

    • MaxRecords — (Integer)

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

      An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

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>)

        An OrderableDBInstanceOption structure containing information about orderable options for the DB instance.

        • Engine — (String)

          The engine type of a DB instance.

        • EngineVersion — (String)

          The engine version of a DB instance.

        • DBInstanceClass — (String)

          The DB instance class for a DB instance.

        • LicenseModel — (String)

          The license model for a DB instance.

        • AvailabilityZones — (Array<map>)

          A list of Availability Zones for a DB instance.

          • Name — (String)

            The name of the availability zone.

        • MultiAZCapable — (Boolean)

          Indicates whether a DB instance is Multi-AZ capable.

        • ReadReplicaCapable — (Boolean)

          Indicates whether a DB instance can have a Read Replica.

        • Vpc — (Boolean)

          Indicates whether a DB instance is in a VPC.

        • SupportsStorageEncryption — (Boolean)

          Indicates whether a DB instance supports encrypted storage.

        • StorageType — (String)

          Indicates the storage type for a DB instance.

        • SupportsIops — (Boolean)

          Indicates whether a DB instance supports provisioned IOPS.

        • SupportsEnhancedMonitoring — (Boolean)

          Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.

        • SupportsIAMDatabaseAuthentication — (Boolean)

          Indicates whether a DB instance supports IAM database authentication.

        • SupportsPerformanceInsights — (Boolean)

          True if a DB instance supports Performance Insights, otherwise false.

        • MinStorageSize — (Integer)

          Minimum storage size for a DB instance.

        • MaxStorageSize — (Integer)

          Maximum storage size for a DB instance.

        • MinIopsPerDbInstance — (Integer)

          Minimum total provisioned IOPS for a DB instance.

        • MaxIopsPerDbInstance — (Integer)

          Maximum total provisioned IOPS for a DB instance.

        • MinIopsPerGib — (Float)

          Minimum provisioned IOPS per GiB for a DB instance.

        • MaxIopsPerGib — (Float)

          Maximum provisioned IOPS per GiB for a DB instance.

      • Marker — (String)

        An optional pagination token provided by a previous OrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

Returns:

  • (AWS.Request) —

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

describePendingMaintenanceActions(params = {}, callback) ⇒ AWS.Request

Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.

Service Reference:

Examples:

Calling the describePendingMaintenanceActions operation

var params = {
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  ResourceIdentifier: 'STRING_VALUE'
};
neptune.describePendingMaintenanceActions(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: {}) —
    • ResourceIdentifier — (String)

      The ARN of a resource to return pending maintenance actions for.

    • Filters — (Array<map>)

      A filter that specifies one or more resources to return pending maintenance actions for.

      Supported filters:

      • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include pending maintenance actions for the DB clusters identified by these ARNs.

      • db-instance-id - Accepts DB instance identifiers and DB instance ARNs. The results list will only include pending maintenance actions for the DB instances identified by these ARNs.

      • Name — required — (String)

        This parameter is not currently supported.

      • Values — required — (Array<String>)

        This parameter is not currently supported.

    • Marker — (String)

      An optional pagination token provided by a previous DescribePendingMaintenanceActions request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by MaxRecords.

    • MaxRecords — (Integer)

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

      Default: 100

      Constraints: Minimum 20, maximum 100.

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:

      • PendingMaintenanceActions — (Array<map>)

        A list of the pending maintenance actions for the resource.

        • ResourceIdentifier — (String)

          The ARN of the resource that has pending maintenance actions.

        • PendingMaintenanceActionDetails — (Array<map>)

          A list that provides details about the pending maintenance actions for the resource.

          • Action — (String)

            The type of pending maintenance action that is available for the resource.

          • AutoAppliedAfterDate — (Date)

            The date of the maintenance window when the action is applied. The maintenance action is applied to the resource during its first maintenance window after this date. If this date is specified, any next-maintenance opt-in requests are ignored.

          • ForcedApplyDate — (Date)

            The date when the maintenance action is automatically applied. The maintenance action is applied to the resource on this date regardless of the maintenance window for the resource. If this date is specified, any immediate opt-in requests are ignored.

          • OptInStatus — (String)

            Indicates the type of opt-in request that has been received for the resource.

          • CurrentApplyDate — (Date)

            The effective date when the pending maintenance action is applied to the resource. This date takes into account opt-in requests received from the ApplyPendingMaintenanceAction API, the AutoAppliedAfterDate, and the ForcedApplyDate. This value is blank if an opt-in request has not been received and nothing has been specified as AutoAppliedAfterDate or ForcedApplyDate.

          • Description — (String)

            A description providing more detail about the maintenance action.

      • Marker — (String)

        An optional pagination token provided by a previous DescribePendingMaintenanceActions request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by MaxRecords.

Returns:

  • (AWS.Request) —

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

describeValidDBInstanceModifications(params = {}, callback) ⇒ AWS.Request

You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance.

Service Reference:

Examples:

Calling the describeValidDBInstanceModifications operation

var params = {
  DBInstanceIdentifier: 'STRING_VALUE' /* required */
};
neptune.describeValidDBInstanceModifications(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)

      The customer identifier or the ARN of your DB instance.

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:

      • ValidDBInstanceModificationsMessage — (map)

        Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the DescribeValidDBInstanceModifications action. You can use this information when you call ModifyDBInstance.

        • Storage — (Array<map>)

          Valid storage options for your DB instance.

          • StorageType — (String)

            The valid storage types for your DB instance. For example, gp2, io1.

          • StorageSize — (Array<map>)

            The valid range of storage in gibibytes. For example, 100 to 16384.

            • From — (Integer)

              The minimum value in the range.

            • To — (Integer)

              The maximum value in the range.

            • Step — (Integer)

              The step value for the range. For example, if you have a range of 5,000 to 10,000, with a step value of 1,000, the valid values start at 5,000 and step up by 1,000. Even though 7,500 is within the range, it isn't a valid value for the range. The valid values are 5,000, 6,000, 7,000, 8,000...

          • ProvisionedIops — (Array<map>)

            The valid range of provisioned IOPS. For example, 1000-20000.

            • From — (Integer)

              The minimum value in the range.

            • To — (Integer)

              The maximum value in the range.

            • Step — (Integer)

              The step value for the range. For example, if you have a range of 5,000 to 10,000, with a step value of 1,000, the valid values start at 5,000 and step up by 1,000. Even though 7,500 is within the range, it isn't a valid value for the range. The valid values are 5,000, 6,000, 7,000, 8,000...

          • IopsToStorageRatio — (Array<map>)

            The valid range of Provisioned IOPS to gibibytes of storage multiplier. For example, 3-10, which means that provisioned IOPS can be between 3 and 10 times storage.

            • From — (Float)

              The minimum value in the range.

            • To — (Float)

              The maximum value in the range.

Returns:

  • (AWS.Request) —

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

failoverDBCluster(params = {}, callback) ⇒ AWS.Request

Forces a failover for a DB cluster.

A failover for a DB cluster promotes one of the Read Replicas (read-only instances) in the DB cluster to be the primary instance (the cluster writer).

Amazon Neptune will automatically fail over to a Read Replica, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a primary instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.

Service Reference:

Examples:

Calling the failoverDBCluster operation

var params = {
  DBClusterIdentifier: 'STRING_VALUE',
  TargetDBInstanceIdentifier: 'STRING_VALUE'
};
neptune.failoverDBCluster(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: {}) —
    • DBClusterIdentifier — (String)

      A DB cluster identifier to force a failover for. This parameter is not case-sensitive.

      Constraints:

      • Must match the identifier of an existing DBCluster.

    • TargetDBInstanceIdentifier — (String)

      The name of the instance to promote to the primary instance.

      You must specify the instance identifier for an Read Replica in the DB cluster. For example, mydbcluster-replica1.

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:

      • DBCluster — (map)

        Contains the details of an Amazon Neptune DB cluster.

        This data type is used as a response element in the DescribeDBClusters action.

        • AllocatedStorage — (Integer)

          AllocatedStorage always returns 1, because Neptune DB cluster storage size is not fixed, but instead automatically adjusts as needed.

        • AvailabilityZones — (Array<String>)

          Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.

        • BackupRetentionPeriod — (Integer)

          Specifies the number of days for which automatic DB snapshots are retained.

        • CharacterSetName — (String)

          If present, specifies the name of the character set that this cluster is associated with.

        • DatabaseName — (String)

          Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

        • DBClusterIdentifier — (String)

          Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

        • DBClusterParameterGroup — (String)

          Specifies the name of the DB cluster parameter group for the DB cluster.

        • DBSubnetGroup — (String)

          Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

        • Status — (String)

          Specifies the current state of this DB cluster.

        • PercentProgress — (String)

          Specifies the progress of the operation as a percentage.

        • EarliestRestorableTime — (Date)

          Specifies the earliest time to which a database can be restored with point-in-time restore.

        • Endpoint — (String)

          Specifies the connection endpoint for the primary instance of the DB cluster.

        • ReaderEndpoint — (String)

          The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Read Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Neptune distributes the connection requests among the Read Replicas in the DB cluster. This functionality can help balance your read workload across multiple Read Replicas in your DB cluster.

          If a failover occurs, and the Read Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Read Replicas in the cluster, you can then reconnect to the reader endpoint.

        • MultiAZ — (Boolean)

          Specifies whether the DB cluster has instances in multiple Availability Zones.

        • Engine — (String)

          Provides the name of the database engine to be used for this DB cluster.

        • EngineVersion — (String)

          Indicates the database engine version.

        • LatestRestorableTime — (Date)

          Specifies the latest time to which a database can be restored with point-in-time restore.

        • Port — (Integer)

          Specifies the port that the database engine is listening on.

        • MasterUsername — (String)

          Contains the master username for the DB cluster.

        • DBClusterOptionGroupMemberships — (Array<map>)

          Provides the list of option group memberships for this DB cluster.

          • DBClusterOptionGroupName — (String)

            Specifies the name of the DB cluster option group.

          • Status — (String)

            Specifies the status of the DB cluster option group.

        • PreferredBackupWindow — (String)

          Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

        • PreferredMaintenanceWindow — (String)

          Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

        • ReplicationSourceIdentifier — (String)

          Not supported by Neptune.

        • ReadReplicaIdentifiers — (Array<String>)

          Contains one or more identifiers of the Read Replicas associated with this DB cluster.

        • DBClusterMembers — (Array<map>)

          Provides the list of instances that make up the DB cluster.

          • DBInstanceIdentifier — (String)

            Specifies the instance identifier for this member of the DB cluster.

          • IsClusterWriter — (Boolean)

            Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

          • DBClusterParameterGroupStatus — (String)

            Specifies the status of the DB cluster parameter group for this member of the DB cluster.

          • PromotionTier — (Integer)

            A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance.

        • VpcSecurityGroups — (Array<map>)

          Provides a list of VPC security groups that the DB cluster belongs to.

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • HostedZoneId — (String)

          Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

        • StorageEncrypted — (Boolean)

          Specifies whether the DB cluster is encrypted.

        • KmsKeyId — (String)

          If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster.

        • DbClusterResourceId — (String)

          The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.

        • DBClusterArn — (String)

          The Amazon Resource Name (ARN) for the DB cluster.

        • AssociatedRoles — (Array<map>)

          Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.

          • RoleArn — (String)

            The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.

          • Status — (String)

            Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:

            • ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other AWS services on your behalf.

            • PENDING - the IAM role ARN is being associated with the DB cluster.

            • INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other AWS services on your behalf.

        • IAMDatabaseAuthenticationEnabled — (Boolean)

          True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

        • CloneGroupId — (String)

          Identifies the clone group to which the DB cluster is associated.

        • ClusterCreateTime — (Date)

          Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

Returns:

  • (AWS.Request) —

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

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Lists all tags on an Amazon Neptune resource.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceName: 'STRING_VALUE', /* required */
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ]
};
neptune.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)

      The Amazon Neptune resource with tags to be listed. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an Amazon Resource Name (ARN).

    • Filters — (Array<map>)

      This parameter is not currently supported.

      • Name — required — (String)

        This parameter is not currently supported.

      • Values — required — (Array<String>)

        This parameter is not currently supported.

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>)

        List of tags returned by the ListTagsForResource operation.

        • Key — (String)

          A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

        • Value — (String)

          A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

Returns:

  • (AWS.Request) —

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

modifyDBCluster(params = {}, callback) ⇒ AWS.Request

Modify a setting for a DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.

Service Reference:

Examples:

Calling the modifyDBCluster operation

var params = {
  DBClusterIdentifier: 'STRING_VALUE', /* required */
  ApplyImmediately: true || false,
  BackupRetentionPeriod: 'NUMBER_VALUE',
  DBClusterParameterGroupName: 'STRING_VALUE',
  EnableIAMDatabaseAuthentication: true || false,
  EngineVersion: 'STRING_VALUE',
  MasterUserPassword: 'STRING_VALUE',
  NewDBClusterIdentifier: 'STRING_VALUE',
  OptionGroupName: 'STRING_VALUE',
  Port: 'NUMBER_VALUE',
  PreferredBackupWindow: 'STRING_VALUE',
  PreferredMaintenanceWindow: 'STRING_VALUE',
  VpcSecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
neptune.modifyDBCluster(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: {}) —
    • DBClusterIdentifier — (String)

      The DB cluster identifier for the cluster being modified. This parameter is not case-sensitive.

      Constraints:

      • Must match the identifier of an existing DBCluster.

    • NewDBClusterIdentifier — (String)

      The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.

      Constraints:

      • Must contain from 1 to 63 letters, numbers, or hyphens

      • The first character must be a letter

      • Cannot end with a hyphen or contain two consecutive hyphens

      Example: my-cluster2

    • ApplyImmediately — (Boolean)

      A value that specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB cluster. If this parameter is set to false, changes to the DB cluster are applied during the next maintenance window.

      The ApplyImmediately parameter only affects the NewDBClusterIdentifier and MasterUserPassword values. If you set the ApplyImmediately parameter value to false, then changes to the NewDBClusterIdentifier and MasterUserPassword values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.

      Default: false

    • BackupRetentionPeriod — (Integer)

      The number of days for which automated backups are retained. You must specify a minimum value of 1.

      Default: 1

      Constraints:

      • Must be a value from 1 to 35

    • DBClusterParameterGroupName — (String)

      The name of the DB cluster parameter group to use for the DB cluster.

    • VpcSecurityGroupIds — (Array<String>)

      A list of VPC security groups that the DB cluster will belong to.

    • Port — (Integer)

      The port number on which the DB cluster accepts connections.

      Constraints: Value must be 1150-65535

      Default: The same port as the original DB cluster.

    • MasterUserPassword — (String)

      The new password for the master database user. This password can contain any printable ASCII character except "/", """, or "@".

      Constraints: Must contain from 8 to 41 characters.

    • OptionGroupName — (String)

      A value that indicates that the DB cluster should be associated with the specified option group. Changing this parameter doesn't result in an outage except in the following case, and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

      Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.

    • PreferredBackupWindow — (String)

      The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

      The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region.

      Constraints:

      • Must be in the format hh24:mi-hh24:mi.

      • Must be in Universal Coordinated Time (UTC).

      • Must not conflict with the preferred maintenance window.

      • Must be at least 30 minutes.

    • PreferredMaintenanceWindow — (String)

      The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

      Format: ddd:hh24:mi-ddd:hh24:mi

      The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.

      Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

      Constraints: Minimum 30-minute window.

    • EnableIAMDatabaseAuthentication — (Boolean)

      True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

      Default: false

    • EngineVersion — (String)

      The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true.

      For a list of valid engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.

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:

      • DBCluster — (map)

        Contains the details of an Amazon Neptune DB cluster.

        This data type is used as a response element in the DescribeDBClusters action.

        • AllocatedStorage — (Integer)

          AllocatedStorage always returns 1, because Neptune DB cluster storage size is not fixed, but instead automatically adjusts as needed.

        • AvailabilityZones — (Array<String>)

          Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.

        • BackupRetentionPeriod — (Integer)

          Specifies the number of days for which automatic DB snapshots are retained.

        • CharacterSetName — (String)

          If present, specifies the name of the character set that this cluster is associated with.

        • DatabaseName — (String)

          Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

        • DBClusterIdentifier — (String)

          Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

        • DBClusterParameterGroup — (String)

          Specifies the name of the DB cluster parameter group for the DB cluster.

        • DBSubnetGroup — (String)

          Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

        • Status — (String)

          Specifies the current state of this DB cluster.

        • PercentProgress — (String)

          Specifies the progress of the operation as a percentage.

        • EarliestRestorableTime — (Date)

          Specifies the earliest time to which a database can be restored with point-in-time restore.

        • Endpoint — (String)

          Specifies the connection endpoint for the primary instance of the DB cluster.

        • ReaderEndpoint — (String)

          The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Read Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Neptune distributes the connection requests among the Read Replicas in the DB cluster. This functionality can help balance your read workload across multiple Read Replicas in your DB cluster.

          If a failover occurs, and the Read Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Read Replicas in the cluster, you can then reconnect to the reader endpoint.

        • MultiAZ — (Boolean)

          Specifies whether the DB cluster has instances in multiple Availability Zones.

        • Engine — (String)

          Provides the name of the database engine to be used for this DB cluster.

        • EngineVersion — (String)

          Indicates the database engine version.

        • LatestRestorableTime — (Date)

          Specifies the latest time to which a database can be restored with point-in-time restore.

        • Port — (Integer)

          Specifies the port that the database engine is listening on.

        • MasterUsername — (String)

          Contains the master username for the DB cluster.

        • DBClusterOptionGroupMemberships — (Array<map>)

          Provides the list of option group memberships for this DB cluster.

          • DBClusterOptionGroupName — (String)

            Specifies the name of the DB cluster option group.

          • Status — (String)

            Specifies the status of the DB cluster option group.

        • PreferredBackupWindow — (String)

          Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

        • PreferredMaintenanceWindow — (String)

          Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

        • ReplicationSourceIdentifier — (String)

          Not supported by Neptune.

        • ReadReplicaIdentifiers — (Array<String>)

          Contains one or more identifiers of the Read Replicas associated with this DB cluster.

        • DBClusterMembers — (Array<map>)

          Provides the list of instances that make up the DB cluster.

          • DBInstanceIdentifier — (String)

            Specifies the instance identifier for this member of the DB cluster.

          • IsClusterWriter — (Boolean)

            Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

          • DBClusterParameterGroupStatus — (String)

            Specifies the status of the DB cluster parameter group for this member of the DB cluster.

          • PromotionTier — (Integer)

            A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance.

        • VpcSecurityGroups — (Array<map>)

          Provides a list of VPC security groups that the DB cluster belongs to.

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • HostedZoneId — (String)

          Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

        • StorageEncrypted — (Boolean)

          Specifies whether the DB cluster is encrypted.

        • KmsKeyId — (String)

          If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster.

        • DbClusterResourceId — (String)

          The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.

        • DBClusterArn — (String)

          The Amazon Resource Name (ARN) for the DB cluster.

        • AssociatedRoles — (Array<map>)

          Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.

          • RoleArn — (String)

            The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.

          • Status — (String)

            Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:

            • ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other AWS services on your behalf.

            • PENDING - the IAM role ARN is being associated with the DB cluster.

            • INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other AWS services on your behalf.

        • IAMDatabaseAuthenticationEnabled — (Boolean)

          True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

        • CloneGroupId — (String)

          Identifies the clone group to which the DB cluster is associated.

        • ClusterCreateTime — (Date)

          Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

Returns:

  • (AWS.Request) —

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

modifyDBClusterParameterGroup(params = {}, callback) ⇒ AWS.Request

Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

Note: Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB cluster associated with the parameter group before the change can take effect.

After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon Neptune to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon Neptune console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.

Service Reference:

Examples:

Calling the modifyDBClusterParameterGroup operation

var params = {
  DBClusterParameterGroupName: '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 */
  ]
};
neptune.modifyDBClusterParameterGroup(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: {}) —
    • DBClusterParameterGroupName — (String)

      The name of the DB cluster parameter group to modify.

    • Parameters — (Array<map>)

      A list of parameters in the DB cluster parameter group to modify.

      • ParameterName — (String)

        Specifies the name of the parameter.

      • ParameterValue — (String)

        Specifies the value of the parameter.

      • Description — (String)

        Provides a description of the parameter.

      • Source — (String)

        Indicates the source of the parameter value.

      • ApplyType — (String)

        Specifies the engine specific parameters type.

      • DataType — (String)

        Specifies the valid data type for the parameter.

      • AllowedValues — (String)

        Specifies the valid range of values for the parameter.

      • IsModifiable — (Boolean)

        Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

      • MinimumEngineVersion — (String)

        The earliest engine version to which the parameter can apply.

      • ApplyMethod — (String)

        Indicates when to apply parameter updates.

        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:

      • DBClusterParameterGroupName — (String)

        The name of the DB cluster parameter group.

        Constraints:

        • Must be 1 to 255 letters or numbers.

        • First character must be a letter

        • Cannot end with a hyphen or contain two consecutive hyphens

        Note: This value is stored as a lowercase string.

Returns:

  • (AWS.Request) —

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

modifyDBClusterSnapshotAttribute(params = {}, callback) ⇒ AWS.Request

Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.

To share a manual DB cluster snapshot with other AWS accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual DB cluster snapshot. Use the value all to make the manual DB cluster snapshot public, which means that it can be copied or restored by all AWS accounts. Do not add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all AWS accounts. If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized AWS account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.

To view which AWS accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot public or private, use the DescribeDBClusterSnapshotAttributes API action.

Service Reference:

Examples:

Calling the modifyDBClusterSnapshotAttribute operation

var params = {
  AttributeName: 'STRING_VALUE', /* required */
  DBClusterSnapshotIdentifier: 'STRING_VALUE', /* required */
  ValuesToAdd: [
    'STRING_VALUE',
    /* more items */
  ],
  ValuesToRemove: [
    'STRING_VALUE',
    /* more items */
  ]
};
neptune.modifyDBClusterSnapshotAttribute(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: {}) —
    • DBClusterSnapshotIdentifier — (String)

      The identifier for the DB cluster snapshot to modify the attributes for.

    • AttributeName — (String)

      The name of the DB cluster snapshot attribute to modify.

      To manage authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, set this value to restore.

    • ValuesToAdd — (Array<String>)

      A list of DB cluster snapshot attributes to add to the attribute specified by AttributeName.

      To authorize other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more AWS account IDs, or all to make the manual DB cluster snapshot restorable by any AWS account. Do not add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all AWS accounts.

    • ValuesToRemove — (Array<String>)

      A list of DB cluster snapshot attributes to remove from the attribute specified by AttributeName.

      To remove authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more AWS account identifiers, or all to remove authorization for any AWS account to copy or restore the DB cluster snapshot. If you specify all, an AWS account whose account ID is explicitly added to the restore attribute can still copy or restore a manual DB cluster snapshot.

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:

      • DBClusterSnapshotAttributesResult — (map)

        Contains the results of a successful call to the DescribeDBClusterSnapshotAttributes API action.

        Manual DB cluster snapshot attributes are used to authorize other AWS accounts to copy or restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.

        • DBClusterSnapshotIdentifier — (String)

          The identifier of the manual DB cluster snapshot that the attributes apply to.

        • DBClusterSnapshotAttributes — (Array<map>)

          The list of attributes and values for the manual DB cluster snapshot.

          • AttributeName — (String)

            The name of the manual DB cluster snapshot attribute.

            The attribute named restore refers to the list of AWS accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.

          • AttributeValues — (Array<String>)

            The value(s) for the manual DB cluster snapshot attribute.

            If the AttributeName field is set to restore, then this element returns a list of IDs of the AWS accounts that are authorized to copy or restore the manual DB cluster snapshot. If a value of all is in the list, then the manual DB cluster snapshot is public and available for any AWS account to copy or restore.

Returns:

  • (AWS.Request) —

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

modifyDBInstance(params = {}, callback) ⇒ AWS.Request

Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. To learn what modifications you can make to your DB instance, call DescribeValidDBInstanceModifications before you call ModifyDBInstance.

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',
  CACertificateIdentifier: 'STRING_VALUE',
  CloudwatchLogsExportConfiguration: {
    DisableLogTypes: [
      'STRING_VALUE',
      /* more items */
    ],
    EnableLogTypes: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  CopyTagsToSnapshot: true || false,
  DBInstanceClass: 'STRING_VALUE',
  DBParameterGroupName: 'STRING_VALUE',
  DBPortNumber: 'NUMBER_VALUE',
  DBSecurityGroups: [
    'STRING_VALUE',
    /* more items */
  ],
  DBSubnetGroupName: 'STRING_VALUE',
  Domain: 'STRING_VALUE',
  DomainIAMRoleName: 'STRING_VALUE',
  EnableIAMDatabaseAuthentication: true || false,
  EnablePerformanceInsights: true || false,
  EngineVersion: 'STRING_VALUE',
  Iops: 'NUMBER_VALUE',
  LicenseModel: 'STRING_VALUE',
  MasterUserPassword: 'STRING_VALUE',
  MonitoringInterval: 'NUMBER_VALUE',
  MonitoringRoleArn: 'STRING_VALUE',
  MultiAZ: true || false,
  NewDBInstanceIdentifier: 'STRING_VALUE',
  OptionGroupName: 'STRING_VALUE',
  PerformanceInsightsKMSKeyId: 'STRING_VALUE',
  PreferredBackupWindow: 'STRING_VALUE',
  PreferredMaintenanceWindow: 'STRING_VALUE',
  PromotionTier: 'NUMBER_VALUE',
  PubliclyAccessible: true || false,
  StorageType: 'STRING_VALUE',
  TdeCredentialArn: 'STRING_VALUE',
  TdeCredentialPassword: 'STRING_VALUE',
  VpcSecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
neptune.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)

      The DB instance identifier. This value is stored as a lowercase string.

      Constraints:

      • Must match the identifier of an existing DBInstance.

    • AllocatedStorage — (Integer)

      The new amount of storage (in gibibytes) to allocate for the DB instance.

      Not applicable. Storage is managed by the DB Cluster.

    • DBInstanceClass — (String)

      The new compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions.

      If you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless ApplyImmediately is specified as true for this request.

      Default: Uses existing setting

    • DBSubnetGroupName — (String)

      The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC.

      Changing the subnet group causes an outage during the change. The change is applied during the next maintenance window, unless you specify true for the ApplyImmediately parameter.

      Constraints: If supplied, must match the name of an existing DBSubnetGroup.

      Example: mySubnetGroup

    • DBSecurityGroups — (Array<String>)

      A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an outage and the change is asynchronously applied as soon as possible.

      Constraints:

      • If supplied, must match existing DBSecurityGroups.

    • VpcSecurityGroupIds — (Array<String>)

      A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.

      Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster.

      Constraints:

      • If supplied, must match existing VpcSecurityGroupIds.

    • ApplyImmediately — (Boolean)

      Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance.

      If this parameter is set to false, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next call to RebootDBInstance, or the next failure reboot.

      Default: false

    • MasterUserPassword — (String)

      Not applicable.

    • DBParameterGroupName — (String)

      The name of the DB parameter group to apply to the DB instance. Changing this setting doesn't result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. The db instance will NOT be rebooted automatically and the parameter changes will NOT be applied during the next maintenance window.

      Default: Uses existing setting

      Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.

    • BackupRetentionPeriod — (Integer)

      Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.

      Default: Uses existing setting

    • PreferredBackupWindow — (String)

      The daily time range during which automated backups are created if automated backups are enabled.

      Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.

      Constraints:

      • Must be in the format hh24:mi-hh24:mi

      • Must be in Universal Time Coordinated (UTC)

      • Must not conflict with the preferred maintenance window

      • Must be at least 30 minutes

    • PreferredMaintenanceWindow — (String)

      The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter doesn't result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter will cause a reboot of the DB instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.

      Default: Uses existing setting

      Format: ddd:hh24:mi-ddd:hh24:mi

      Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

      Constraints: Must be at least 30 minutes

    • MultiAZ — (Boolean)

      Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

    • EngineVersion — (String)

      The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

      For major version upgrades, if a nondefault DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.

    • AllowMajorVersionUpgrade — (Boolean)

      Indicates that major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.

      Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.

    • AutoMinorVersionUpgrade — (Boolean)

      Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window. Changing this parameter doesn't result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to true during the maintenance window, and a newer minor version is available, and Neptune has enabled auto patching for that engine version.

    • LicenseModel — (String)

      Not supported.

    • Iops — (Integer)

      The new Provisioned IOPS (I/O operations per second) value for the instance.

      Changing this setting doesn't result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

      Default: Uses existing setting

    • OptionGroupName — (String)

      Indicates that the DB instance should be associated with the specified option group. Changing this parameter doesn't result in an outage except in the following case and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

      Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance

    • NewDBInstanceIdentifier — (String)

      The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot will occur immediately if you set Apply Immediately to true, or will occur during the next maintenance window if Apply Immediately to false. This value is stored as a lowercase string.

      Constraints:

      • Must contain from 1 to 63 letters, numbers, or hyphens.

      • The first character must be a letter.

      • Cannot end with a hyphen or contain two consecutive hyphens.

      Example: mydbinstance

    • StorageType — (String)

      Not supported.

    • TdeCredentialArn — (String)

      The ARN from the key store with which to associate the instance for TDE encryption.

    • TdeCredentialPassword — (String)

      The password for the given ARN from the key store in order to access the device.

    • CACertificateIdentifier — (String)

      Indicates the certificate that needs to be associated with the instance.

    • Domain — (String)

      Not supported.

    • CopyTagsToSnapshot — (Boolean)

      True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false.

    • MonitoringInterval — (Integer)

      The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.

      If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.

      Valid Values: 0, 1, 5, 10, 15, 30, 60

    • DBPortNumber — (Integer)

      The port number on which the database accepts connections.

      The value of the DBPortNumber parameter must not match any of the port values specified for options in the option group for the DB instance.

      Your database will restart when you change the DBPortNumber value regardless of the value of the ApplyImmediately parameter.

      Default: 8182

    • PubliclyAccessible — (Boolean)

      This flag should no longer be used.

    • MonitoringRoleArn — (String)

      The ARN for the IAM role that permits Neptune to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess.

      If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

    • DomainIAMRoleName — (String)

      Not supported

    • PromotionTier — (Integer)

      A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance.

      Default: 1

      Valid Values: 0 - 15

    • EnableIAMDatabaseAuthentication — (Boolean)

      True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

      You can enable IAM database authentication for the following database engines

      Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster. For more information, see ModifyDBCluster.

      Default: false

    • EnablePerformanceInsights — (Boolean)

      Not supported.

    • PerformanceInsightsKMSKeyId — (String)

      Not supported.

    • CloudwatchLogsExportConfiguration — (map)

      The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance or DB cluster.

      • EnableLogTypes — (Array<String>)

        The list of log types to enable.

      • DisableLogTypes — (Array<String>)

        The list of log types to disable.

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)

        Contains the details of an Amazon Neptune DB instance.

        This data type is used as a response element in the DescribeDBInstances action.

        • DBInstanceIdentifier — (String)

          Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

        • DBInstanceClass — (String)

          Contains the name of the compute and memory capacity class of the DB instance.

        • Engine — (String)

          Provides the name of the database engine to be used for this DB instance.

        • DBInstanceStatus — (String)

          Specifies the current state of this database.

        • MasterUsername — (String)

          Contains the master username for the DB instance.

        • DBName — (String)

          The database name.

        • Endpoint — (map)

          Specifies the connection endpoint.

          • Address — (String)

            Specifies the DNS address of the DB instance.

          • Port — (Integer)

            Specifies the port that the database engine is listening on.

          • HostedZoneId — (String)

            Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

        • AllocatedStorage — (Integer)

          Specifies the allocated storage size specified in gibibytes.

        • InstanceCreateTime — (Date)

          Provides the date and time the DB instance was created.

        • PreferredBackupWindow — (String)

          Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

        • BackupRetentionPeriod — (Integer)

          Specifies the number of days for which automatic DB snapshots are retained.

        • DBSecurityGroups — (Array<map>)

          Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

          • DBSecurityGroupName — (String)

            The name of the DB security group.

          • Status — (String)

            The status of the DB security group.

        • VpcSecurityGroups — (Array<map>)

          Provides a list of VPC security group elements that the DB instance belongs to.

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • DBParameterGroups — (Array<map>)

          Provides the list of DB parameter groups applied to this DB instance.

          • DBParameterGroupName — (String)

            The name of the DP parameter group.

          • ParameterApplyStatus — (String)

            The status of parameter updates.

        • AvailabilityZone — (String)

          Specifies the name of the Availability Zone the DB instance is located in.

        • DBSubnetGroup — (map)

          Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

          • DBSubnetGroupName — (String)

            The name of the DB subnet group.

          • DBSubnetGroupDescription — (String)

            Provides the description of the DB subnet group.

          • VpcId — (String)

            Provides the VpcId of the DB subnet group.

          • SubnetGroupStatus — (String)

            Provides the status of the DB subnet group.

          • Subnets — (Array<map>)

            Contains a list of Subnet elements.

            • SubnetIdentifier — (String)

              Specifies the identifier of the subnet.

            • SubnetAvailabilityZone — (map)

              Specifies the EC2 Availability Zone that the subnet is in.

              • Name — (String)

                The name of the availability zone.

            • SubnetStatus — (String)

              Specifies the status of the subnet.

          • DBSubnetGroupArn — (String)

            The Amazon Resource Name (ARN) for the DB subnet group.

        • PreferredMaintenanceWindow — (String)

          Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

        • PendingModifiedValues — (map)

          Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

          • DBInstanceClass — (String)

            Contains the new DBInstanceClass for the DB instance that will be applied or is currently being applied.

          • AllocatedStorage — (Integer)

            Contains the new AllocatedStorage size for the DB instance that will be applied or is currently being applied.

          • MasterUserPassword — (String)

            Contains the pending or currently-in-progress change of the master credentials for the DB instance.

          • Port — (Integer)

            Specifies the pending port for the DB instance.

          • BackupRetentionPeriod — (Integer)

            Specifies the pending number of days for which automated backups are retained.

          • MultiAZ — (Boolean)

            Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.

          • EngineVersion — (String)

            Indicates the database engine version.

          • LicenseModel — (String)

            The license model for the DB instance.

            Valid values: license-included | bring-your-own-license | general-public-license

          • Iops — (Integer)

            Specifies the new Provisioned IOPS value for the DB instance that will be applied or is currently being applied.

          • DBInstanceIdentifier — (String)

            Contains the new DBInstanceIdentifier for the DB instance that will be applied or is currently being applied.

          • StorageType — (String)

            Specifies the storage type to be associated with the DB instance.

          • CACertificateIdentifier — (String)

            Specifies the identifier of the CA certificate for the DB instance.

          • DBSubnetGroupName — (String)

            The new DB subnet group for the DB instance.

          • PendingCloudwatchLogsExports — (map)

            Specifies the CloudWatch logs to be exported.

            • LogTypesToEnable — (Array<String>)

              Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.

            • LogTypesToDisable — (Array<String>)

              Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.

        • LatestRestorableTime — (Date)

          Specifies the latest time to which a database can be restored with point-in-time restore.

        • MultiAZ — (Boolean)

          Specifies if the DB instance is a Multi-AZ deployment.

        • EngineVersion — (String)

          Indicates the database engine version.

        • AutoMinorVersionUpgrade — (Boolean)

          Indicates that minor version patches are applied automatically.

        • ReadReplicaSourceDBInstanceIdentifier — (String)

          Contains the identifier of the source DB instance if this DB instance is a Read Replica.

        • ReadReplicaDBInstanceIdentifiers — (Array<String>)

          Contains one or more identifiers of the Read Replicas associated with this DB instance.

        • ReadReplicaDBClusterIdentifiers — (Array<String>)

          Contains one or more identifiers of DB clusters that are Read Replicas of this DB instance.

        • LicenseModel — (String)

          License model information for this DB instance.

        • Iops — (Integer)

          Specifies the Provisioned IOPS (I/O operations per second) value.

        • OptionGroupMemberships — (Array<map>)

          Provides the list of option group memberships for this DB instance.

          • OptionGroupName — (String)

            The name of the option group that the instance belongs to.

          • Status — (String)

            The status of the DB instance's option group membership. Valid values are: in-sync, pending-apply, pending-removal, pending-maintenance-apply, pending-maintenance-removal, applying, removing, and failed.

        • CharacterSetName — (String)

          If present, specifies the name of the character set that this instance is associated with.

        • SecondaryAvailabilityZone — (String)

          If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

        • PubliclyAccessible — (Boolean)

          This flag should no longer be used.

        • StatusInfos — (Array<map>)

          The status of a Read Replica. If the instance is not a Read Replica, this is blank.

          • StatusType — (String)

            This value is currently "read replication."

          • Normal — (Boolean)

            Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

          • Status — (String)

            Status of the DB instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.

          • Message — (String)

            Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.

        • StorageType — (String)

          Specifies the storage type associated with DB instance.

        • TdeCredentialArn — (String)

          The ARN from the key store with which the instance is associated for TDE encryption.

        • DbInstancePort — (Integer)

          Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

        • DBClusterIdentifier — (String)

          If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

        • StorageEncrypted — (Boolean)

          Not supported: The encryption for DB instances is managed by the DB cluster.

        • KmsKeyId — (String)

          Not supported: The encryption for DB instances is managed by the DB cluster.

        • DbiResourceId — (String)

          The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.

        • CACertificateIdentifier — (String)

          The identifier of the CA certificate for this DB instance.

        • DomainMemberships — (Array<map>)

          Not supported

          • Domain — (String)

            The identifier of the Active Directory Domain.

          • Status — (String)

            The status of the DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).

          • FQDN — (String)

            The fully qualified domain name of the Active Directory Domain.

          • IAMRoleName — (String)

            The name of the IAM role to be used when making API calls to the Directory Service.

        • CopyTagsToSnapshot — (Boolean)

          Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

        • MonitoringInterval — (Integer)

          The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

        • EnhancedMonitoringResourceArn — (String)

          The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

        • MonitoringRoleArn — (String)

          The ARN for the IAM role that permits Neptune to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

        • PromotionTier — (Integer)

          A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance.

        • DBInstanceArn — (String)

          The Amazon Resource Name (ARN) for the DB instance.

        • Timezone — (String)

          Not supported.

        • IAMDatabaseAuthenticationEnabled — (Boolean)

          True if AWS Identity and Access Management (IAM) authentication is enabled, and otherwise false.

        • PerformanceInsightsEnabled — (Boolean)

          True if Performance Insights is enabled for the DB instance, and otherwise false.

        • PerformanceInsightsKMSKeyId — (String)

          The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

        • EnabledCloudwatchLogsExports — (Array<String>)

          A list of log types that this DB instance is configured to export to CloudWatch Logs.

Returns:

  • (AWS.Request) —

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

modifyDBParameterGroup(params = {}, callback) ⇒ AWS.Request

Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

Note: Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance associated with the parameter group before the change can take effect.

After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon Neptune to fully complete the modify action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon Neptune console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.

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 */
  ]
};
neptune.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)

      The name of the DB parameter group.

      Constraints:

      • If supplied, must match the name of an existing DBParameterGroup.

    • Parameters — (Array<map>)

      An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters can be modified in a single request.

      Valid Values (for the application method): immediate | pending-reboot

      Note: You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when you reboot the DB instance without failover.
      • ParameterName — (String)

        Specifies the name of the parameter.

      • ParameterValue — (String)

        Specifies the value of the parameter.

      • Description — (String)

        Provides a description of the parameter.

      • Source — (String)

        Indicates the source of the parameter value.

      • ApplyType — (String)

        Specifies the engine specific parameters type.

      • DataType — (String)

        Specifies the valid data type for the parameter.

      • AllowedValues — (String)

        Specifies the valid range of values for the parameter.

      • IsModifiable — (Boolean)

        Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

      • MinimumEngineVersion — (String)

        The earliest engine version to which the parameter can apply.

      • ApplyMethod — (String)

        Indicates when to apply parameter updates.

        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)

        Provides the name of the DB parameter group.

Returns:

  • (AWS.Request) —

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

modifyDBSubnetGroup(params = {}, callback) ⇒ AWS.Request

Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region.

Service Reference:

Examples:

Calling the modifyDBSubnetGroup operation

var params = {
  DBSubnetGroupName: 'STRING_VALUE', /* required */
  SubnetIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  DBSubnetGroupDescription: 'STRING_VALUE'
};
neptune.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)

      The name for the DB subnet group. This value is stored as a lowercase string. You can't modify the default subnet group.

      Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

      Example: mySubnetgroup

    • DBSubnetGroupDescription — (String)

      The description for the DB subnet group.

    • SubnetIds — (Array<String>)

      The EC2 subnet IDs for the DB subnet group.

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)

        Contains the details of an Amazon Neptune DB subnet group.

        This data type is used as a response element in the DescribeDBSubnetGroups action.

        • DBSubnetGroupName — (String)

          The name of the DB subnet group.

        • DBSubnetGroupDescription — (String)

          Provides the description of the DB subnet group.

        • VpcId — (String)

          Provides the VpcId of the DB subnet group.

        • SubnetGroupStatus — (String)

          Provides the status of the DB subnet group.

        • Subnets — (Array<map>)

          Contains a list of Subnet elements.

          • SubnetIdentifier — (String)

            Specifies the identifier of the subnet.

          • SubnetAvailabilityZone — (map)

            Specifies the EC2 Availability Zone that the subnet is in.

            • Name — (String)

              The name of the availability zone.

          • SubnetStatus — (String)

            Specifies the status of the subnet.

        • DBSubnetGroupArn — (String)

          The Amazon Resource Name (ARN) for the DB subnet group.

Returns:

  • (AWS.Request) —

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

modifyEventSubscription(params = {}, callback) ⇒ AWS.Request

Modifies an existing event notification subscription. Note that you can't modify the source identifiers using this call; to change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.

You can see a list of the event categories for a given SourceType by using the DescribeEventCategories action.

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'
};
neptune.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)

      The name of the event notification subscription.

    • SnsTopicArn — (String)

      The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

    • SourceType — (String)

      The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.

      Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot

    • EventCategories — (Array<String>)

      A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType by using the DescribeEventCategories action.

    • Enabled — (Boolean)

      A Boolean value; set to true to activate the subscription.

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)

        Contains the results of a successful invocation of the DescribeEventSubscriptions action.

        • CustomerAwsId — (String)

          The AWS customer account associated with the event notification subscription.

        • CustSubscriptionId — (String)

          The event notification subscription Id.

        • SnsTopicArn — (String)

          The topic ARN of the event notification subscription.

        • Status — (String)

          The status of the event notification subscription.

          Constraints:

          Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist

          The status "no-permission" indicates that Neptune no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.

        • SubscriptionCreationTime — (String)

          The time the event notification subscription was created.

        • SourceType — (String)

          The source type for the event notification subscription.

        • SourceIdsList — (Array<String>)

          A list of source IDs for the event notification subscription.

        • EventCategoriesList — (Array<String>)

          A list of event categories for the event notification subscription.

        • Enabled — (Boolean)

          A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

        • EventSubscriptionArn — (String)

          The Amazon Resource Name (ARN) for the event subscription.

Returns:

  • (AWS.Request) —

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

promoteReadReplicaDBCluster(params = {}, callback) ⇒ AWS.Request

Not supported.

Service Reference:

Examples:

Calling the promoteReadReplicaDBCluster operation

var params = {
  DBClusterIdentifier: 'STRING_VALUE' /* required */
};
neptune.promoteReadReplicaDBCluster(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: {}) —
    • DBClusterIdentifier — (String)

      Not supported.

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:

      • DBCluster — (map)

        Contains the details of an Amazon Neptune DB cluster.

        This data type is used as a response element in the DescribeDBClusters action.

        • AllocatedStorage — (Integer)

          AllocatedStorage always returns 1, because Neptune DB cluster storage size is not fixed, but instead automatically adjusts as needed.

        • AvailabilityZones — (Array<String>)

          Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.

        • BackupRetentionPeriod — (Integer)

          Specifies the number of days for which automatic DB snapshots are retained.

        • CharacterSetName — (String)

          If present, specifies the name of the character set that this cluster is associated with.

        • DatabaseName — (String)

          Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

        • DBClusterIdentifier — (String)

          Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

        • DBClusterParameterGroup — (String)

          Specifies the name of the DB cluster parameter group for the DB cluster.

        • DBSubnetGroup — (String)

          Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

        • Status — (String)

          Specifies the current state of this DB cluster.

        • PercentProgress — (String)

          Specifies the progress of the operation as a percentage.

        • EarliestRestorableTime — (Date)

          Specifies the earliest time to which a database can be restored with point-in-time restore.

        • Endpoint — (String)

          Specifies the connection endpoint for the primary instance of the DB cluster.

        • ReaderEndpoint — (String)

          The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Read Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Neptune distributes the connection requests among the Read Replicas in the DB cluster. This functionality can help balance your read workload across multiple Read Replicas in your DB cluster.

          If a failover occurs, and the Read Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Read Replicas in the cluster, you can then reconnect to the reader endpoint.

        • MultiAZ — (Boolean)

          Specifies whether the DB cluster has instances in multiple Availability Zones.

        • Engine — (String)

          Provides the name of the database engine to be used for this DB cluster.

        • EngineVersion — (String)

          Indicates the database engine version.

        • LatestRestorableTime — (Date)

          Specifies the latest time to which a database can be restored with point-in-time restore.

        • Port — (Integer)

          Specifies the port that the database engine is listening on.

        • MasterUsername — (String)

          Contains the master username for the DB cluster.

        • DBClusterOptionGroupMemberships — (Array<map>)

          Provides the list of option group memberships for this DB cluster.

          • DBClusterOptionGroupName — (String)

            Specifies the name of the DB cluster option group.

          • Status — (String)

            Specifies the status of the DB cluster option group.

        • PreferredBackupWindow — (String)

          Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

        • PreferredMaintenanceWindow — (String)

          Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

        • ReplicationSourceIdentifier — (String)

          Not supported by Neptune.

        • ReadReplicaIdentifiers — (Array<String>)

          Contains one or more identifiers of the Read Replicas associated with this DB cluster.

        • DBClusterMembers — (Array<map>)

          Provides the list of instances that make up the DB cluster.

          • DBInstanceIdentifier — (String)

            Specifies the instance identifier for this member of the DB cluster.

          • IsClusterWriter — (Boolean)

            Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

          • DBClusterParameterGroupStatus — (String)

            Specifies the status of the DB cluster parameter group for this member of the DB cluster.

          • PromotionTier — (Integer)

            A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance.

        • VpcSecurityGroups — (Array<map>)

          Provides a list of VPC security groups that the DB cluster belongs to.

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • HostedZoneId — (String)

          Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

        • StorageEncrypted — (Boolean)

          Specifies whether the DB cluster is encrypted.

        • KmsKeyId — (String)

          If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster.

        • DbClusterResourceId — (String)

          The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.

        • DBClusterArn — (String)

          The Amazon Resource Name (ARN) for the DB cluster.

        • AssociatedRoles — (Array<map>)

          Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.

          • RoleArn — (String)

            The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.

          • Status — (String)

            Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:

            • ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other AWS services on your behalf.

            • PENDING - the IAM role ARN is being associated with the DB cluster.

            • INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other AWS services on your behalf.

        • IAMDatabaseAuthenticationEnabled — (Boolean)

          True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

        • CloneGroupId — (String)

          Identifies the clone group to which the DB cluster is associated.

        • ClusterCreateTime — (Date)

          Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

Returns:

  • (AWS.Request) —

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

rebootDBInstance(params = {}, callback) ⇒ AWS.Request

You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect.

Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.

Service Reference:

Examples:

Calling the rebootDBInstance operation

var params = {
  DBInstanceIdentifier: 'STRING_VALUE', /* required */
  ForceFailover: true || false
};
neptune.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)

      The DB instance identifier. This parameter is stored as a lowercase string.

      Constraints:

      • Must match the identifier of an existing DBInstance.

    • ForceFailover — (Boolean)

      When true, the reboot is conducted through a MultiAZ failover.

      Constraint: You can't specify true if the instance is not configured for MultiAZ.

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)

        Contains the details of an Amazon Neptune DB instance.

        This data type is used as a response element in the DescribeDBInstances action.

        • DBInstanceIdentifier — (String)

          Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

        • DBInstanceClass — (String)

          Contains the name of the compute and memory capacity class of the DB instance.

        • Engine — (String)

          Provides the name of the database engine to be used for this DB instance.

        • DBInstanceStatus — (String)

          Specifies the current state of this database.

        • MasterUsername — (String)

          Contains the master username for the DB instance.

        • DBName — (String)

          The database name.

        • Endpoint — (map)

          Specifies the connection endpoint.

          • Address — (String)

            Specifies the DNS address of the DB instance.

          • Port — (Integer)

            Specifies the port that the database engine is listening on.

          • HostedZoneId — (String)

            Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

        • AllocatedStorage — (Integer)

          Specifies the allocated storage size specified in gibibytes.

        • InstanceCreateTime — (Date)

          Provides the date and time the DB instance was created.

        • PreferredBackupWindow — (String)

          Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

        • BackupRetentionPeriod — (Integer)

          Specifies the number of days for which automatic DB snapshots are retained.

        • DBSecurityGroups — (Array<map>)

          Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

          • DBSecurityGroupName — (String)

            The name of the DB security group.

          • Status — (String)

            The status of the DB security group.

        • VpcSecurityGroups — (Array<map>)

          Provides a list of VPC security group elements that the DB instance belongs to.

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • DBParameterGroups — (Array<map>)

          Provides the list of DB parameter groups applied to this DB instance.

          • DBParameterGroupName — (String)

            The name of the DP parameter group.

          • ParameterApplyStatus — (String)

            The status of parameter updates.

        • AvailabilityZone — (String)

          Specifies the name of the Availability Zone the DB instance is located in.

        • DBSubnetGroup — (map)

          Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

          • DBSubnetGroupName — (String)

            The name of the DB subnet group.

          • DBSubnetGroupDescription — (String)

            Provides the description of the DB subnet group.

          • VpcId — (String)

            Provides the VpcId of the DB subnet group.

          • SubnetGroupStatus — (String)

            Provides the status of the DB subnet group.

          • Subnets — (Array<map>)

            Contains a list of Subnet elements.

            • SubnetIdentifier — (String)

              Specifies the identifier of the subnet.

            • SubnetAvailabilityZone — (map)

              Specifies the EC2 Availability Zone that the subnet is in.

              • Name — (String)

                The name of the availability zone.

            • SubnetStatus — (String)

              Specifies the status of the subnet.

          • DBSubnetGroupArn — (String)

            The Amazon Resource Name (ARN) for the DB subnet group.

        • PreferredMaintenanceWindow — (String)

          Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

        • PendingModifiedValues — (map)

          Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

          • DBInstanceClass — (String)

            Contains the new DBInstanceClass for the DB instance that will be applied or is currently being applied.

          • AllocatedStorage — (Integer)

            Contains the new AllocatedStorage size for the DB instance that will be applied or is currently being applied.

          • MasterUserPassword — (String)

            Contains the pending or currently-in-progress change of the master credentials for the DB instance.

          • Port — (Integer)

            Specifies the pending port for the DB instance.

          • BackupRetentionPeriod — (Integer)

            Specifies the pending number of days for which automated backups are retained.

          • MultiAZ — (Boolean)

            Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.

          • EngineVersion — (String)

            Indicates the database engine version.

          • LicenseModel — (String)

            The license model for the DB instance.

            Valid values: license-included | bring-your-own-license | general-public-license

          • Iops — (Integer)

            Specifies the new Provisioned IOPS value for the DB instance that will be applied or is currently being applied.

          • DBInstanceIdentifier — (String)

            Contains the new DBInstanceIdentifier for the DB instance that will be applied or is currently being applied.

          • StorageType — (String)

            Specifies the storage type to be associated with the DB instance.

          • CACertificateIdentifier — (String)

            Specifies the identifier of the CA certificate for the DB instance.

          • DBSubnetGroupName — (String)

            The new DB subnet group for the DB instance.

          • PendingCloudwatchLogsExports — (map)

            Specifies the CloudWatch logs to be exported.

            • LogTypesToEnable — (Array<String>)

              Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.

            • LogTypesToDisable — (Array<String>)

              Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.

        • LatestRestorableTime — (Date)

          Specifies the latest time to which a database can be restored with point-in-time restore.

        • MultiAZ — (Boolean)

          Specifies if the DB instance is a Multi-AZ deployment.

        • EngineVersion — (String)

          Indicates the database engine version.

        • AutoMinorVersionUpgrade — (Boolean)

          Indicates that minor version patches are applied automatically.

        • ReadReplicaSourceDBInstanceIdentifier — (String)

          Contains the identifier of the source DB instance if this DB instance is a Read Replica.

        • ReadReplicaDBInstanceIdentifiers — (Array<String>)

          Contains one or more identifiers of the Read Replicas associated with this DB instance.

        • ReadReplicaDBClusterIdentifiers — (Array<String>)

          Contains one or more identifiers of DB clusters that are Read Replicas of this DB instance.

        • LicenseModel — (String)

          License model information for this DB instance.

        • Iops — (Integer)

          Specifies the Provisioned IOPS (I/O operations per second) value.

        • OptionGroupMemberships — (Array<map>)

          Provides the list of option group memberships for this DB instance.

          • OptionGroupName — (String)

            The name of the option group that the instance belongs to.

          • Status — (String)

            The status of the DB instance's option group membership. Valid values are: in-sync, pending-apply, pending-removal, pending-maintenance-apply, pending-maintenance-removal, applying, removing, and failed.

        • CharacterSetName — (String)

          If present, specifies the name of the character set that this instance is associated with.

        • SecondaryAvailabilityZone — (String)

          If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

        • PubliclyAccessible — (Boolean)

          This flag should no longer be used.

        • StatusInfos — (Array<map>)

          The status of a Read Replica. If the instance is not a Read Replica, this is blank.

          • StatusType — (String)

            This value is currently "read replication."

          • Normal — (Boolean)

            Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

          • Status — (String)

            Status of the DB instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.

          • Message — (String)

            Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.

        • StorageType — (String)

          Specifies the storage type associated with DB instance.

        • TdeCredentialArn — (String)

          The ARN from the key store with which the instance is associated for TDE encryption.

        • DbInstancePort — (Integer)

          Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

        • DBClusterIdentifier — (String)

          If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

        • StorageEncrypted — (Boolean)

          Not supported: The encryption for DB instances is managed by the DB cluster.

        • KmsKeyId — (String)

          Not supported: The encryption for DB instances is managed by the DB cluster.

        • DbiResourceId — (String)

          The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.

        • CACertificateIdentifier — (String)

          The identifier of the CA certificate for this DB instance.

        • DomainMemberships — (Array<map>)

          Not supported

          • Domain — (String)

            The identifier of the Active Directory Domain.

          • Status — (String)

            The status of the DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).

          • FQDN — (String)

            The fully qualified domain name of the Active Directory Domain.

          • IAMRoleName — (String)

            The name of the IAM role to be used when making API calls to the Directory Service.

        • CopyTagsToSnapshot — (Boolean)

          Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

        • MonitoringInterval — (Integer)

          The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

        • EnhancedMonitoringResourceArn — (String)

          The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

        • MonitoringRoleArn — (String)

          The ARN for the IAM role that permits Neptune to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

        • PromotionTier — (Integer)

          A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance.

        • DBInstanceArn — (String)

          The Amazon Resource Name (ARN) for the DB instance.

        • Timezone — (String)

          Not supported.

        • IAMDatabaseAuthenticationEnabled — (Boolean)

          True if AWS Identity and Access Management (IAM) authentication is enabled, and otherwise false.

        • PerformanceInsightsEnabled — (Boolean)

          True if Performance Insights is enabled for the DB instance, and otherwise false.

        • PerformanceInsightsKMSKeyId — (String)

          The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

        • EnabledCloudwatchLogsExports — (Array<String>)

          A list of log types that this DB instance is configured to export to CloudWatch Logs.

Returns:

  • (AWS.Request) —

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

removeRoleFromDBCluster(params = {}, callback) ⇒ AWS.Request

Disassociates an Identity and Access Management (IAM) role from a DB cluster.

Service Reference:

Examples:

Calling the removeRoleFromDBCluster operation

var params = {
  DBClusterIdentifier: 'STRING_VALUE', /* required */
  RoleArn: 'STRING_VALUE' /* required */
};
neptune.removeRoleFromDBCluster(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: {}) —
    • DBClusterIdentifier — (String)

      The name of the DB cluster to disassociate the IAM role from.

    • RoleArn — (String)

      The Amazon Resource Name (ARN) of the IAM role to disassociate from the DB cluster, for example arn:aws:iam::123456789012:role/NeptuneAccessRole.

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.

removeSourceIdentifierFromSubscription(params = {}, callback) ⇒ AWS.Request

Removes a source identifier from an existing event notification subscription.

Service Reference:

Examples:

Calling the removeSourceIdentifierFromSubscription operation

var params = {
  SourceIdentifier: 'STRING_VALUE', /* required */
  SubscriptionName: 'STRING_VALUE' /* required */
};
neptune.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)

      The name of the event notification subscription you want to remove a source identifier from.

    • SourceIdentifier — (String)

      The source identifier to be removed from the subscription, such as the DB instance identifier for a DB instance or the name of a security group.

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)

        Contains the results of a successful invocation of the DescribeEventSubscriptions action.

        • CustomerAwsId — (String)

          The AWS customer account associated with the event notification subscription.

        • CustSubscriptionId — (String)

          The event notification subscription Id.

        • SnsTopicArn — (String)

          The topic ARN of the event notification subscription.

        • Status — (String)

          The status of the event notification subscription.

          Constraints:

          Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist

          The status "no-permission" indicates that Neptune no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.

        • SubscriptionCreationTime — (String)

          The time the event notification subscription was created.

        • SourceType — (String)

          The source type for the event notification subscription.

        • SourceIdsList — (Array<String>)

          A list of source IDs for the event notification subscription.

        • EventCategoriesList — (Array<String>)

          A list of event categories for the event notification subscription.

        • Enabled — (Boolean)

          A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

        • EventSubscriptionArn — (String)

          The Amazon Resource Name (ARN) for the event subscription.

Returns:

  • (AWS.Request) —

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

removeTagsFromResource(params = {}, callback) ⇒ AWS.Request

Removes metadata tags from an Amazon Neptune resource.

Service Reference:

Examples:

Calling the removeTagsFromResource operation

var params = {
  ResourceName: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
neptune.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)

      The Amazon Neptune resource that the tags are removed from. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an Amazon Resource Name (ARN).

    • TagKeys — (Array<String>)

      The tag key (name) of the tag to be removed.

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.

resetDBClusterParameterGroup(params = {}, callback) ⇒ AWS.Request

Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters.

When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to.

Service Reference:

Examples:

Calling the resetDBClusterParameterGroup operation

var params = {
  DBClusterParameterGroupName: '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
};
neptune.resetDBClusterParameterGroup(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: {}) —
    • DBClusterParameterGroupName — (String)

      The name of the DB cluster parameter group to reset.

    • ResetAllParameters — (Boolean)

      A value that is set to true to reset all parameters in the DB cluster parameter group to their default values, and false otherwise. You can't use this parameter if there is a list of parameter names specified for the Parameters parameter.

    • Parameters — (Array<map>)

      A list of parameter names in the DB cluster parameter group to reset to the default values. You can't use this parameter if the ResetAllParameters parameter is set to true.

      • ParameterName — (String)

        Specifies the name of the parameter.

      • ParameterValue — (String)

        Specifies the value of the parameter.

      • Description — (String)

        Provides a description of the parameter.

      • Source — (String)

        Indicates the source of the parameter value.

      • ApplyType — (String)

        Specifies the engine specific parameters type.

      • DataType — (String)

        Specifies the valid data type for the parameter.

      • AllowedValues — (String)

        Specifies the valid range of values for the parameter.

      • IsModifiable — (Boolean)

        Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

      • MinimumEngineVersion — (String)

        The earliest engine version to which the parameter can apply.

      • ApplyMethod — (String)

        Indicates when to apply parameter updates.

        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:

      • DBClusterParameterGroupName — (String)

        The name of the DB cluster parameter group.

        Constraints:

        • Must be 1 to 255 letters or numbers.

        • First character must be a letter

        • Cannot end with a hyphen or contain two consecutive hyphens

        Note: This value is stored as a lowercase string.

Returns:

  • (AWS.Request) —

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

resetDBParameterGroup(params = {}, callback) ⇒ AWS.Request

Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request.

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
};
neptune.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)

      The name of the DB parameter group.

      Constraints:

      • Must match the name of an existing DBParameterGroup.

    • ResetAllParameters — (Boolean)

      Specifies whether (true) or not (false) to reset all parameters in the DB parameter group to default values.

      Default: true

    • Parameters — (Array<map>)

      To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

      Valid Values (for Apply method): pending-reboot

      • ParameterName — (String)

        Specifies the name of the parameter.

      • ParameterValue — (String)

        Specifies the value of the parameter.

      • Description — (String)

        Provides a description of the parameter.

      • Source — (String)

        Indicates the source of the parameter value.

      • ApplyType — (String)

        Specifies the engine specific parameters type.

      • DataType — (String)

        Specifies the valid data type for the parameter.

      • AllowedValues — (String)

        Specifies the valid range of values for the parameter.

      • IsModifiable — (Boolean)

        Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

      • MinimumEngineVersion — (String)

        The earliest engine version to which the parameter can apply.

      • ApplyMethod — (String)

        Indicates when to apply parameter updates.

        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)

        Provides the name of the DB parameter group.

Returns:

  • (AWS.Request) —

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

restoreDBClusterFromSnapshot(params = {}, callback) ⇒ AWS.Request

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.

If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

Service Reference:

Examples:

Calling the restoreDBClusterFromSnapshot operation

var params = {
  DBClusterIdentifier: 'STRING_VALUE', /* required */
  Engine: 'STRING_VALUE', /* required */
  SnapshotIdentifier: 'STRING_VALUE', /* required */
  AvailabilityZones: [
    'STRING_VALUE',
    /* more items */
  ],
  DBClusterParameterGroupName: 'STRING_VALUE',
  DBSubnetGroupName: 'STRING_VALUE',
  DatabaseName: 'STRING_VALUE',
  EnableIAMDatabaseAuthentication: true || false,
  EngineVersion: 'STRING_VALUE',
  KmsKeyId: 'STRING_VALUE',
  OptionGroupName: 'STRING_VALUE',
  Port: 'NUMBER_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  VpcSecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
neptune.restoreDBClusterFromSnapshot(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: {}) —
    • AvailabilityZones — (Array<String>)

      Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.

    • DBClusterIdentifier — (String)

      The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't case-sensitive.

      Constraints:

      • Must contain from 1 to 63 letters, numbers, or hyphens

      • First character must be a letter

      • Cannot end with a hyphen or contain two consecutive hyphens

      Example: my-snapshot-id

    • SnapshotIdentifier — (String)

      The identifier for the DB snapshot or DB cluster snapshot to restore from.

      You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.

      Constraints:

      • Must match the identifier of an existing Snapshot.

    • Engine — (String)

      The database engine to use for the new DB cluster.

      Default: The same as source

      Constraint: Must be compatible with the engine of the source

    • EngineVersion — (String)

      The version of the database engine to use for the new DB cluster.

    • Port — (Integer)

      The port number on which the new DB cluster accepts connections.

      Constraints: Value must be 1150-65535

      Default: The same port as the original DB cluster.

    • DBSubnetGroupName — (String)

      The name of the DB subnet group to use for the new DB cluster.

      Constraints: If supplied, must match the name of an existing DBSubnetGroup.

      Example: mySubnetgroup

    • DatabaseName — (String)

      Not supported.

    • OptionGroupName — (String)

      The name of the option group to use for the restored DB cluster.

    • VpcSecurityGroupIds — (Array<String>)

      A list of VPC security groups that the new DB cluster will belong to.

    • Tags — (Array<map>)

      The tags to be assigned to the restored DB cluster.

      • Key — (String)

        A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

      • Value — (String)

        A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

    • KmsKeyId — (String)

      The AWS KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.

      The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

      If you do not specify a value for the KmsKeyId parameter, then the following will occur:

      • If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot.

      • If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is not encrypted, then the restored DB cluster is not encrypted.

    • EnableIAMDatabaseAuthentication — (Boolean)

      True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

      Default: false

    • DBClusterParameterGroupName — (String)

      The name of the DB cluster parameter group to associate with the new DB cluster.

      Constraints:

      • If supplied, must match the name of an existing DBClusterParameterGroup.

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:

      • DBCluster — (map)

        Contains the details of an Amazon Neptune DB cluster.

        This data type is used as a response element in the DescribeDBClusters action.

        • AllocatedStorage — (Integer)

          AllocatedStorage always returns 1, because Neptune DB cluster storage size is not fixed, but instead automatically adjusts as needed.

        • AvailabilityZones — (Array<String>)

          Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.

        • BackupRetentionPeriod — (Integer)

          Specifies the number of days for which automatic DB snapshots are retained.

        • CharacterSetName — (String)

          If present, specifies the name of the character set that this cluster is associated with.

        • DatabaseName — (String)

          Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

        • DBClusterIdentifier — (String)

          Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

        • DBClusterParameterGroup — (String)

          Specifies the name of the DB cluster parameter group for the DB cluster.

        • DBSubnetGroup — (String)

          Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

        • Status — (String)

          Specifies the current state of this DB cluster.

        • PercentProgress — (String)

          Specifies the progress of the operation as a percentage.

        • EarliestRestorableTime — (Date)

          Specifies the earliest time to which a database can be restored with point-in-time restore.

        • Endpoint — (String)

          Specifies the connection endpoint for the primary instance of the DB cluster.

        • ReaderEndpoint — (String)

          The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Read Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Neptune distributes the connection requests among the Read Replicas in the DB cluster. This functionality can help balance your read workload across multiple Read Replicas in your DB cluster.

          If a failover occurs, and the Read Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Read Replicas in the cluster, you can then reconnect to the reader endpoint.

        • MultiAZ — (Boolean)

          Specifies whether the DB cluster has instances in multiple Availability Zones.

        • Engine — (String)

          Provides the name of the database engine to be used for this DB cluster.

        • EngineVersion — (String)

          Indicates the database engine version.

        • LatestRestorableTime — (Date)

          Specifies the latest time to which a database can be restored with point-in-time restore.

        • Port — (Integer)

          Specifies the port that the database engine is listening on.

        • MasterUsername — (String)

          Contains the master username for the DB cluster.

        • DBClusterOptionGroupMemberships — (Array<map>)

          Provides the list of option group memberships for this DB cluster.

          • DBClusterOptionGroupName — (String)

            Specifies the name of the DB cluster option group.

          • Status — (String)

            Specifies the status of the DB cluster option group.

        • PreferredBackupWindow — (String)

          Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

        • PreferredMaintenanceWindow — (String)

          Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

        • ReplicationSourceIdentifier — (String)

          Not supported by Neptune.

        • ReadReplicaIdentifiers — (Array<String>)

          Contains one or more identifiers of the Read Replicas associated with this DB cluster.

        • DBClusterMembers — (Array<map>)

          Provides the list of instances that make up the DB cluster.

          • DBInstanceIdentifier — (String)

            Specifies the instance identifier for this member of the DB cluster.

          • IsClusterWriter — (Boolean)

            Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

          • DBClusterParameterGroupStatus — (String)

            Specifies the status of the DB cluster parameter group for this member of the DB cluster.

          • PromotionTier — (Integer)

            A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance.

        • VpcSecurityGroups — (Array<map>)

          Provides a list of VPC security groups that the DB cluster belongs to.

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • HostedZoneId — (String)

          Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

        • StorageEncrypted — (Boolean)

          Specifies whether the DB cluster is encrypted.

        • KmsKeyId — (String)

          If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster.

        • DbClusterResourceId — (String)

          The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.

        • DBClusterArn — (String)

          The Amazon Resource Name (ARN) for the DB cluster.

        • AssociatedRoles — (Array<map>)

          Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.

          • RoleArn — (String)

            The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.

          • Status — (String)

            Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:

            • ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other AWS services on your behalf.

            • PENDING - the IAM role ARN is being associated with the DB cluster.

            • INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other AWS services on your behalf.

        • IAMDatabaseAuthenticationEnabled — (Boolean)

          True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

        • CloneGroupId — (String)

          Identifies the clone group to which the DB cluster is associated.

        • ClusterCreateTime — (Date)

          Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

Returns:

  • (AWS.Request) —

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

restoreDBClusterToPointInTime(params = {}, callback) ⇒ AWS.Request

Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group.

Note: This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterToPointInTime action has completed and the DB cluster is available.

Service Reference:

Examples:

Calling the restoreDBClusterToPointInTime operation

var params = {
  DBClusterIdentifier: 'STRING_VALUE', /* required */
  SourceDBClusterIdentifier: 'STRING_VALUE', /* required */
  DBClusterParameterGroupName: 'STRING_VALUE',
  DBSubnetGroupName: 'STRING_VALUE',
  EnableIAMDatabaseAuthentication: true || false,
  KmsKeyId: 'STRING_VALUE',
  OptionGroupName: 'STRING_VALUE',
  Port: 'NUMBER_VALUE',
  RestoreToTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  RestoreType: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  UseLatestRestorableTime: true || false,
  VpcSecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
neptune.restoreDBClusterToPointInTime(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: {}) —
    • DBClusterIdentifier — (String)

      The name of the new DB cluster to be created.

      Constraints:

      • Must contain from 1 to 63 letters, numbers, or hyphens

      • First character must be a letter

      • Cannot end with a hyphen or contain two consecutive hyphens

    • RestoreType — (String)

      The type of restore to be performed. The only type of restore currently supported is full-copy (the default).

    • SourceDBClusterIdentifier — (String)

      The identifier of the source DB cluster from which to restore.

      Constraints:

      • Must match the identifier of an existing DBCluster.

    • RestoreToTime — (Date)

      The date and time to restore the DB cluster to.

      Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

      Constraints:

      • Must be before the latest restorable time for the DB instance

      • Must be specified if UseLatestRestorableTime parameter is not provided

      • Cannot be specified if UseLatestRestorableTime parameter is true

      • Cannot be specified if RestoreType parameter is copy-on-write

      Example: 2015-03-07T23:45:00Z

    • UseLatestRestorableTime — (Boolean)

      A value that is set to true to restore the DB cluster to the latest restorable backup time, and false otherwise.

      Default: false

      Constraints: Cannot be specified if RestoreToTime parameter is provided.

    • Port — (Integer)

      The port number on which the new DB cluster accepts connections.

      Constraints: Value must be 1150-65535

      Default: The same port as the original DB cluster.

    • DBSubnetGroupName — (String)

      The DB subnet group name to use for the new DB cluster.

      Constraints: If supplied, must match the name of an existing DBSubnetGroup.

      Example: mySubnetgroup

    • OptionGroupName — (String)

      The name of the option group for the new DB cluster.

    • VpcSecurityGroupIds — (Array<String>)

      A list of VPC security groups that the new DB cluster belongs to.

    • Tags — (Array<map>)

      The tags to be applied to the restored DB cluster.

      • Key — (String)

        A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

      • Value — (String)

        A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can only contain only the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\\p{Z}\\p{N}.:/=+\-]*)$").

    • KmsKeyId — (String)

      The AWS KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.

      The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

      You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different than the KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key identified by the KmsKeyId parameter.

      If you do not specify a value for the KmsKeyId parameter, then the following will occur:

      • If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster.

      • If the DB cluster is not encrypted, then the restored DB cluster is not encrypted.

      If DBClusterIdentifier refers to a DB cluster that is not encrypted, then the restore request is rejected.

    • EnableIAMDatabaseAuthentication — (Boolean)

      True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

      Default: false

    • DBClusterParameterGroupName — (String)

      The name of the DB cluster parameter group to associate with the new DB cluster.

      Constraints:

      • If supplied, must match the name of an existing DBClusterParameterGroup.

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:

      • DBCluster — (map)

        Contains the details of an Amazon Neptune DB cluster.

        This data type is used as a response element in the DescribeDBClusters action.

        • AllocatedStorage — (Integer)

          AllocatedStorage always returns 1, because Neptune DB cluster storage size is not fixed, but instead automatically adjusts as needed.

        • AvailabilityZones — (Array<String>)

          Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.

        • BackupRetentionPeriod — (Integer)

          Specifies the number of days for which automatic DB snapshots are retained.

        • CharacterSetName — (String)

          If present, specifies the name of the character set that this cluster is associated with.

        • DatabaseName — (String)

          Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

        • DBClusterIdentifier — (String)

          Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

        • DBClusterParameterGroup — (String)

          Specifies the name of the DB cluster parameter group for the DB cluster.

        • DBSubnetGroup — (String)

          Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

        • Status — (String)

          Specifies the current state of this DB cluster.

        • PercentProgress — (String)

          Specifies the progress of the operation as a percentage.

        • EarliestRestorableTime — (Date)

          Specifies the earliest time to which a database can be restored with point-in-time restore.

        • Endpoint — (String)

          Specifies the connection endpoint for the primary instance of the DB cluster.

        • ReaderEndpoint — (String)

          The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Read Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Neptune distributes the connection requests among the Read Replicas in the DB cluster. This functionality can help balance your read workload across multiple Read Replicas in your DB cluster.

          If a failover occurs, and the Read Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Read Replicas in the cluster, you can then reconnect to the reader endpoint.

        • MultiAZ — (Boolean)

          Specifies whether the DB cluster has instances in multiple Availability Zones.

        • Engine — (String)

          Provides the name of the database engine to be used for this DB cluster.

        • EngineVersion — (String)

          Indicates the database engine version.

        • LatestRestorableTime — (Date)

          Specifies the latest time to which a database can be restored with point-in-time restore.

        • Port — (Integer)

          Specifies the port that the database engine is listening on.

        • MasterUsername — (String)

          Contains the master username for the DB cluster.

        • DBClusterOptionGroupMemberships — (Array<map>)

          Provides the list of option group memberships for this DB cluster.

          • DBClusterOptionGroupName — (String)

            Specifies the name of the DB cluster option group.

          • Status — (String)

            Specifies the status of the DB cluster option group.

        • PreferredBackupWindow — (String)

          Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

        • PreferredMaintenanceWindow — (String)

          Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

        • ReplicationSourceIdentifier — (String)

          Not supported by Neptune.

        • ReadReplicaIdentifiers — (Array<String>)

          Contains one or more identifiers of the Read Replicas associated with this DB cluster.

        • DBClusterMembers — (Array<map>)

          Provides the list of instances that make up the DB cluster.

          • DBInstanceIdentifier — (String)

            Specifies the instance identifier for this member of the DB cluster.

          • IsClusterWriter — (Boolean)

            Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

          • DBClusterParameterGroupStatus — (String)

            Specifies the status of the DB cluster parameter group for this member of the DB cluster.

          • PromotionTier — (Integer)

            A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance.

        • VpcSecurityGroups — (Array<map>)

          Provides a list of VPC security groups that the DB cluster belongs to.

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • HostedZoneId — (String)

          Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

        • StorageEncrypted — (Boolean)

          Specifies whether the DB cluster is encrypted.

        • KmsKeyId — (String)

          If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster.

        • DbClusterResourceId — (String)

          The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.

        • DBClusterArn — (String)

          The Amazon Resource Name (ARN) for the DB cluster.

        • AssociatedRoles — (Array<map>)

          Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.

          • RoleArn — (String)

            The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.

          • Status — (String)

            Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:

            • ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other AWS services on your behalf.

            • PENDING - the IAM role ARN is being associated with the DB cluster.

            • INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other AWS services on your behalf.

        • IAMDatabaseAuthenticationEnabled — (Boolean)

          True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

        • CloneGroupId — (String)

          Identifies the clone group to which the DB cluster is associated.

        • ClusterCreateTime — (Date)

          Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

Returns:

  • (AWS.Request) —

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

waitFor(state, params = {}, callback) ⇒ AWS.Request

Waits for a given Neptune resource. The final callback or 'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.

Examples:

Waiting for the dBInstanceAvailable state

var params = {
  // ... input parameters ...
};
neptune.waitFor('dBInstanceAvailable', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • state (String) —

    the resource state to wait for. Available states for this service are listed in "Waiter Resource States" below.

  • params (map) (defaults to: {}) —

    a list of parameters for the given state. See each waiter resource state for required parameters.

Callback (callback):

  • function(err, data) { ... }

    Callback containing error and data information. See the respective resource state for the expected error or data information.

    If the waiter times out its requests, it will return a ResourceNotReady error.

Returns:

  • (AWS.Request) —

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

Waiter Resource States:

Waiter Resource Details

neptune.waitFor('dBInstanceAvailable', params = {}, [callback]) ⇒ AWS.Request

Waits for the dBInstanceAvailable state by periodically calling the underlying Neptune.describeDBInstances() operation every 30 seconds (at most 60 times).

Examples:

Waiting for the dBInstanceAvailable state

var params = {
  // ... input parameters ...
};
neptune.waitFor('dBInstanceAvailable', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) —
    • DBInstanceIdentifier — (String)

      The user-supplied instance identifier. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case-sensitive.

      Constraints:

      • If supplied, must match the identifier of an existing DBInstance.

    • Filters — (Array<map>)

      A filter that specifies one or more DB instances to describe.

      Supported filters:

      • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB instances associated with the DB clusters identified by these ARNs.

      • db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list will only include information about the DB instances identified by these ARNs.

      • Name — required — (String)

        This parameter is not currently supported.

      • Values — required — (Array<String>)

        This parameter is not currently supported.

    • MaxRecords — (Integer)

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

      An optional pagination token provided by a previous DescribeDBInstances request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

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)

        An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

      • DBInstances — (Array<map>)

        A list of DBInstance instances.

        • DBInstanceIdentifier — (String)

          Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

        • DBInstanceClass — (String)

          Contains the name of the compute and memory capacity class of the DB instance.

        • Engine — (String)

          Provides the name of the database engine to be used for this DB instance.

        • DBInstanceStatus — (String)

          Specifies the current state of this database.

        • MasterUsername — (String)

          Contains the master username for the DB instance.

        • DBName — (String)

          The database name.

        • Endpoint — (map)

          Specifies the connection endpoint.

          • Address — (String)

            Specifies the DNS address of the DB instance.

          • Port — (Integer)

            Specifies the port that the database engine is listening on.

          • HostedZoneId — (String)

            Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

        • AllocatedStorage — (Integer)

          Specifies the allocated storage size specified in gibibytes.

        • InstanceCreateTime — (Date)

          Provides the date and time the DB instance was created.

        • PreferredBackupWindow — (String)

          Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

        • BackupRetentionPeriod — (Integer)

          Specifies the number of days for which automatic DB snapshots are retained.

        • DBSecurityGroups — (Array<map>)

          Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

          • DBSecurityGroupName — (String)

            The name of the DB security group.

          • Status — (String)

            The status of the DB security group.

        • VpcSecurityGroups — (Array<map>)

          Provides a list of VPC security group elements that the DB instance belongs to.

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • DBParameterGroups — (Array<map>)

          Provides the list of DB parameter groups applied to this DB instance.

          • DBParameterGroupName — (String)

            The name of the DP parameter group.

          • ParameterApplyStatus — (String)

            The status of parameter updates.

        • AvailabilityZone — (String)

          Specifies the name of the Availability Zone the DB instance is located in.

        • DBSubnetGroup — (map)

          Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

          • DBSubnetGroupName — (String)

            The name of the DB subnet group.

          • DBSubnetGroupDescription — (String)

            Provides the description of the DB subnet group.

          • VpcId — (String)

            Provides the VpcId of the DB subnet group.

          • SubnetGroupStatus — (String)

            Provides the status of the DB subnet group.

          • Subnets — (Array<map>)

            Contains a list of Subnet elements.

            • SubnetIdentifier — (String)

              Specifies the identifier of the subnet.

            • SubnetAvailabilityZone — (map)

              Specifies the EC2 Availability Zone that the subnet is in.

              • Name — (String)

                The name of the availability zone.

            • SubnetStatus — (String)

              Specifies the status of the subnet.

          • DBSubnetGroupArn — (String)

            The Amazon Resource Name (ARN) for the DB subnet group.

        • PreferredMaintenanceWindow — (String)

          Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

        • PendingModifiedValues — (map)

          Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

          • DBInstanceClass — (String)

            Contains the new DBInstanceClass for the DB instance that will be applied or is currently being applied.

          • AllocatedStorage — (Integer)

            Contains the new AllocatedStorage size for the DB instance that will be applied or is currently being applied.

          • MasterUserPassword — (String)

            Contains the pending or currently-in-progress change of the master credentials for the DB instance.

          • Port — (Integer)

            Specifies the pending port for the DB instance.

          • BackupRetentionPeriod — (Integer)

            Specifies the pending number of days for which automated backups are retained.

          • MultiAZ — (Boolean)

            Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.

          • EngineVersion — (String)

            Indicates the database engine version.

          • LicenseModel — (String)

            The license model for the DB instance.

            Valid values: license-included | bring-your-own-license | general-public-license

          • Iops — (Integer)

            Specifies the new Provisioned IOPS value for the DB instance that will be applied or is currently being applied.

          • DBInstanceIdentifier — (String)

            Contains the new DBInstanceIdentifier for the DB instance that will be applied or is currently being applied.

          • StorageType — (String)

            Specifies the storage type to be associated with the DB instance.

          • CACertificateIdentifier — (String)

            Specifies the identifier of the CA certificate for the DB instance.

          • DBSubnetGroupName — (String)

            The new DB subnet group for the DB instance.

          • PendingCloudwatchLogsExports — (map)

            Specifies the CloudWatch logs to be exported.

            • LogTypesToEnable — (Array<String>)

              Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.

            • LogTypesToDisable — (Array<String>)

              Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.

        • LatestRestorableTime — (Date)

          Specifies the latest time to which a database can be restored with point-in-time restore.

        • MultiAZ — (Boolean)

          Specifies if the DB instance is a Multi-AZ deployment.

        • EngineVersion — (String)

          Indicates the database engine version.

        • AutoMinorVersionUpgrade — (Boolean)

          Indicates that minor version patches are applied automatically.

        • ReadReplicaSourceDBInstanceIdentifier — (String)

          Contains the identifier of the source DB instance if this DB instance is a Read Replica.

        • ReadReplicaDBInstanceIdentifiers — (Array<String>)

          Contains one or more identifiers of the Read Replicas associated with this DB instance.

        • ReadReplicaDBClusterIdentifiers — (Array<String>)

          Contains one or more identifiers of DB clusters that are Read Replicas of this DB instance.

        • LicenseModel — (String)

          License model information for this DB instance.

        • Iops — (Integer)

          Specifies the Provisioned IOPS (I/O operations per second) value.

        • OptionGroupMemberships — (Array<map>)

          Provides the list of option group memberships for this DB instance.

          • OptionGroupName — (String)

            The name of the option group that the instance belongs to.

          • Status — (String)

            The status of the DB instance's option group membership. Valid values are: in-sync, pending-apply, pending-removal, pending-maintenance-apply, pending-maintenance-removal, applying, removing, and failed.

        • CharacterSetName — (String)

          If present, specifies the name of the character set that this instance is associated with.

        • SecondaryAvailabilityZone — (String)

          If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

        • PubliclyAccessible — (Boolean)

          This flag should no longer be used.

        • StatusInfos — (Array<map>)

          The status of a Read Replica. If the instance is not a Read Replica, this is blank.

          • StatusType — (String)

            This value is currently "read replication."

          • Normal — (Boolean)

            Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

          • Status — (String)

            Status of the DB instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.

          • Message — (String)

            Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.

        • StorageType — (String)

          Specifies the storage type associated with DB instance.

        • TdeCredentialArn — (String)

          The ARN from the key store with which the instance is associated for TDE encryption.

        • DbInstancePort — (Integer)

          Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

        • DBClusterIdentifier — (String)

          If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

        • StorageEncrypted — (Boolean)

          Not supported: The encryption for DB instances is managed by the DB cluster.

        • KmsKeyId — (String)

          Not supported: The encryption for DB instances is managed by the DB cluster.

        • DbiResourceId — (String)

          The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.

        • CACertificateIdentifier — (String)

          The identifier of the CA certificate for this DB instance.

        • DomainMemberships — (Array<map>)

          Not supported

          • Domain — (String)

            The identifier of the Active Directory Domain.

          • Status — (String)

            The status of the DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).

          • FQDN — (String)

            The fully qualified domain name of the Active Directory Domain.

          • IAMRoleName — (String)

            The name of the IAM role to be used when making API calls to the Directory Service.

        • CopyTagsToSnapshot — (Boolean)

          Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

        • MonitoringInterval — (Integer)

          The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

        • EnhancedMonitoringResourceArn — (String)

          The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

        • MonitoringRoleArn — (String)

          The ARN for the IAM role that permits Neptune to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

        • PromotionTier — (Integer)

          A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance.

        • DBInstanceArn — (String)

          The Amazon Resource Name (ARN) for the DB instance.

        • Timezone — (String)

          Not supported.

        • IAMDatabaseAuthenticationEnabled — (Boolean)

          True if AWS Identity and Access Management (IAM) authentication is enabled, and otherwise false.

        • PerformanceInsightsEnabled — (Boolean)

          True if Performance Insights is enabled for the DB instance, and otherwise false.

        • PerformanceInsightsKMSKeyId — (String)

          The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

        • EnabledCloudwatchLogsExports — (Array<String>)

          A list of log types that this DB instance is configured to export to CloudWatch Logs.

Returns:

  • (AWS.Request) —

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

See Also:

neptune.waitFor('dBInstanceDeleted', params = {}, [callback]) ⇒ AWS.Request

Waits for the dBInstanceDeleted state by periodically calling the underlying Neptune.describeDBInstances() operation every 30 seconds (at most 60 times).

Examples:

Waiting for the dBInstanceDeleted state

var params = {
  // ... input parameters ...
};
neptune.waitFor('dBInstanceDeleted', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) —
    • DBInstanceIdentifier — (String)

      The user-supplied instance identifier. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case-sensitive.

      Constraints:

      • If supplied, must match the identifier of an existing DBInstance.

    • Filters — (Array<map>)

      A filter that specifies one or more DB instances to describe.

      Supported filters:

      • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB instances associated with the DB clusters identified by these ARNs.

      • db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list will only include information about the DB instances identified by these ARNs.

      • Name — required — (String)

        This parameter is not currently supported.

      • Values — required — (Array<String>)

        This parameter is not currently supported.

    • MaxRecords — (Integer)

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

      Default: 100

      Constraints: Minimum 20, maximum 100.

    • Marker — (String)

      An optional pagination token provided by a previous DescribeDBInstances request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

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)

        An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

      • DBInstances — (Array<map>)

        A list of DBInstance instances.

        • DBInstanceIdentifier — (String)

          Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

        • DBInstanceClass — (String)

          Contains the name of the compute and memory capacity class of the DB instance.

        • Engine — (String)

          Provides the name of the database engine to be used for this DB instance.

        • DBInstanceStatus — (String)

          Specifies the current state of this database.

        • MasterUsername — (String)

          Contains the master username for the DB instance.

        • DBName — (String)

          The database name.

        • Endpoint — (map)

          Specifies the connection endpoint.

          • Address — (String)

            Specifies the DNS address of the DB instance.

          • Port — (Integer)

            Specifies the port that the database engine is listening on.

          • HostedZoneId — (String)

            Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

        • AllocatedStorage — (Integer)

          Specifies the allocated storage size specified in gibibytes.

        • InstanceCreateTime — (Date)

          Provides the date and time the DB instance was created.

        • PreferredBackupWindow — (String)

          Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

        • BackupRetentionPeriod — (Integer)

          Specifies the number of days for which automatic DB snapshots are retained.

        • DBSecurityGroups — (Array<map>)

          Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

          • DBSecurityGroupName — (String)

            The name of the DB security group.

          • Status — (String)

            The status of the DB security group.

        • VpcSecurityGroups — (Array<map>)

          Provides a list of VPC security group elements that the DB instance belongs to.

          • VpcSecurityGroupId — (String)

            The name of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • DBParameterGroups — (Array<map>)

          Provides the list of DB parameter groups applied to this DB instance.

          • DBParameterGroupName — (String)

            The name of the DP parameter group.

          • ParameterApplyStatus — (String)

            The status of parameter updates.

        • AvailabilityZone — (String)

          Specifies the name of the Availability Zone the DB instance is located in.

        • DBSubnetGroup — (map)

          Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

          • DBSubnetGroupName — (String)

            The name of the DB subnet group.

          • DBSubnetGroupDescription — (String)

            Provides the description of the DB subnet group.

          • VpcId — (String)

            Provides the VpcId of the DB subnet group.

          • SubnetGroupStatus — (String)

            Provides the status of the DB subnet group.

          • Subnets — (Array<map>)

            Contains a list of Subnet elements.

            • SubnetIdentifier — (String)

              Specifies the identifier of the subnet.

            • SubnetAvailabilityZone — (map)

              Specifies the EC2 Availability Zone that the subnet is in.

              • Name — (String)

                The name of the availability zone.

            • SubnetStatus — (String)

              Specifies the status of the subnet.

          • DBSubnetGroupArn — (String)

            The Amazon Resource Name (ARN) for the DB subnet group.

        • PreferredMaintenanceWindow — (String)

          Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

        • PendingModifiedValues — (map)

          Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

          • DBInstanceClass — (String)

            Contains the new DBInstanceClass for the DB instance that will be applied or is currently being applied.

          • AllocatedStorage — (Integer)

            Contains the new AllocatedStorage size for the DB instance that will be applied or is currently being applied.

          • MasterUserPassword — (String)

            Contains the pending or currently-in-progress change of the master credentials for the DB instance.

          • Port — (Integer)

            Specifies the pending port for the DB instance.

          • BackupRetentionPeriod — (Integer)

            Specifies the pending number of days for which automated backups are retained.

          • MultiAZ — (Boolean)

            Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.

          • EngineVersion — (String)

            Indicates the database engine version.

          • LicenseModel — (String)

            The license model for the DB instance.

            Valid values: license-included | bring-your-own-license | general-public-license

          • Iops — (Integer)

            Specifies the new Provisioned IOPS value for the DB instance that will be applied or is currently being applied.

          • DBInstanceIdentifier — (String)

            Contains the new DBInstanceIdentifier for the DB instance that will be applied or is currently being applied.

          • StorageType — (String)

            Specifies the storage type to be associated with the DB instance.

          • CACertificateIdentifier — (String)

            Specifies the identifier of the CA certificate for the DB instance.

          • DBSubnetGroupName — (String)

            The new DB subnet group for the DB instance.

          • PendingCloudwatchLogsExports — (map)

            Specifies the CloudWatch logs to be exported.

            • LogTypesToEnable — (Array<String>)

              Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.

            • LogTypesToDisable — (Array<String>)

              Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.

        • LatestRestorableTime — (Date)

          Specifies the latest time to which a database can be restored with point-in-time restore.

        • MultiAZ — (Boolean)

          Specifies if the DB instance is a Multi-AZ deployment.

        • EngineVersion — (String)

          Indicates the database engine version.

        • AutoMinorVersionUpgrade — (Boolean)

          Indicates that minor version patches are applied automatically.

        • ReadReplicaSourceDBInstanceIdentifier — (String)

          Contains the identifier of the source DB instance if this DB instance is a Read Replica.

        • ReadReplicaDBInstanceIdentifiers — (Array<String>)

          Contains one or more identifiers of the Read Replicas associated with this DB instance.

        • ReadReplicaDBClusterIdentifiers — (Array<String>)

          Contains one or more identifiers of DB clusters that are Read Replicas of this DB instance.

        • LicenseModel — (String)

          License model information for this DB instance.

        • Iops — (Integer)

          Specifies the Provisioned IOPS (I/O operations per second) value.

        • OptionGroupMemberships — (Array<map>)

          Provides the list of option group memberships for this DB instance.

          • OptionGroupName — (String)

            The name of the option group that the instance belongs to.

          • Status — (String)

            The status of the DB instance's option group membership. Valid values are: in-sync, pending-apply, pending-removal, pending-maintenance-apply, pending-maintenance-removal, applying, removing, and failed.

        • CharacterSetName — (String)

          If present, specifies the name of the character set that this instance is associated with.

        • SecondaryAvailabilityZone — (String)

          If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

        • PubliclyAccessible — (Boolean)

          This flag should no longer be used.

        • StatusInfos — (Array<map>)

          The status of a Read Replica. If the instance is not a Read Replica, this is blank.

          • StatusType — (String)

            This value is currently "read replication."

          • Normal — (Boolean)

            Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

          • Status — (String)

            Status of the DB instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.

          • Message — (String)

            Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.

        • StorageType — (String)

          Specifies the storage type associated with DB instance.

        • TdeCredentialArn — (String)

          The ARN from the key store with which the instance is associated for TDE encryption.

        • DbInstancePort — (Integer)

          Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

        • DBClusterIdentifier — (String)

          If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

        • StorageEncrypted — (Boolean)

          Not supported: The encryption for DB instances is managed by the DB cluster.

        • KmsKeyId — (String)

          Not supported: The encryption for DB instances is managed by the DB cluster.

        • DbiResourceId — (String)

          The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.

        • CACertificateIdentifier — (String)

          The identifier of the CA certificate for this DB instance.

        • DomainMemberships — (Array<map>)

          Not supported

          • Domain — (String)

            The identifier of the Active Directory Domain.

          • Status — (String)

            The status of the DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).

          • FQDN — (String)

            The fully qualified domain name of the Active Directory Domain.

          • IAMRoleName — (String)

            The name of the IAM role to be used when making API calls to the Directory Service.

        • CopyTagsToSnapshot — (Boolean)

          Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

        • MonitoringInterval — (Integer)

          The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

        • EnhancedMonitoringResourceArn — (String)

          The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

        • MonitoringRoleArn — (String)

          The ARN for the IAM role that permits Neptune to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

        • PromotionTier — (Integer)

          A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance.

        • DBInstanceArn — (String)

          The Amazon Resource Name (ARN) for the DB instance.

        • Timezone — (String)

          Not supported.

        • IAMDatabaseAuthenticationEnabled — (Boolean)

          True if AWS Identity and Access Management (IAM) authentication is enabled, and otherwise false.

        • PerformanceInsightsEnabled — (Boolean)

          True if Performance Insights is enabled for the DB instance, and otherwise false.

        • PerformanceInsightsKMSKeyId — (String)

          The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

        • EnabledCloudwatchLogsExports — (Array<String>)

          A list of log types that this DB instance is configured to export to CloudWatch Logs.

Returns:

  • (AWS.Request) —

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

See Also: