Class: AWS.Neptune

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

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

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.

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

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.

    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 Amazon Amazon 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 encrypted DB cluster snapshot from your Amazon 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 Amazon account, then you must specify a value for KmsKeyId.

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

    You cannot encrypt an unencrypted DB cluster snapshot when you copy it. If you try to copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

  • 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 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 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 a DB cluster snapshot. Must match the identifier of an existing snapshot.

        After you restore a DB cluster using a DBClusterSnapshotIdentifier, you must specify the same DBClusterSnapshotIdentifier for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed.

        However, if you don't specify the DBClusterSnapshotIdentifier, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the snapshot specified by the DBClusterSnapshotIdentifier, and the original DB cluster is deleted.

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

        Not supported by Neptune.

      • 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 Amazon 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 Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

      • StorageType — (String)

        The storage type associated with the DB cluster snapshot.

Returns:

• (AWS.Request) —

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

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

var params = {
  DBClusterIdentifier: 'STRING_VALUE', /* required */
  Engine: 'STRING_VALUE', /* required */
  AvailabilityZones: [
    'STRING_VALUE',
    /* more items */
  ],
  BackupRetentionPeriod: 'NUMBER_VALUE',
  CharacterSetName: 'STRING_VALUE',
  CopyTagsToSnapshot: true || false,
  DBClusterParameterGroupName: 'STRING_VALUE',
  DBSubnetGroupName: 'STRING_VALUE',
  DatabaseName: 'STRING_VALUE',
  DeletionProtection: true || false,
  EnableCloudwatchLogsExports: [
    'STRING_VALUE',
    /* more items */
  ],
  EnableIAMDatabaseAuthentication: true || false,
  EngineVersion: 'STRING_VALUE',
  GlobalClusterIdentifier: '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',
  ServerlessV2ScalingConfiguration: {
    MaxCapacity: 'NUMBER_VALUE',
    MinCapacity: 'NUMBER_VALUE'
  },
  StorageEncrypted: true || false,
  StorageType: 'STRING_VALUE',
  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)

    (Not supported by Neptune)

  • CopyTagsToSnapshot — (Boolean)

    If set to true, tags are copied to any snapshot of the DB cluster that is created.

  • 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 for the new DB cluster.

    Example: 1.0.2.1

  • Port — (Integer)

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

    Default: 8182

  • MasterUsername — (String)

    Not supported by Neptune.

  • MasterUserPassword — (String)

    Not supported by Neptune.

  • OptionGroupName — (String)

    (Not supported by Neptune)

  • 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 Amazon Region. To see the time blocks available, see Neptune 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 Amazon Region, occurring on a random day of the week. To see the time blocks available, see Neptune 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 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 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 Amazon 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 Amazon 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.

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

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

  • PreSignedUrl — (String)

    This parameter is not currently supported.

  • EnableIAMDatabaseAuthentication — (Boolean)

    If set to true, enables Amazon Identity and Access Management (IAM) authentication for the entire DB cluster (this cannot be set at an instance level).

    Default: false.

  • EnableCloudwatchLogsExports — (Array<String>)

    A list of the log types that this DB cluster should export to CloudWatch Logs. Valid log types are: audit (to publish audit logs) and slowquery (to publish slow-query logs). See Publishing Neptune logs to Amazon CloudWatch logs.

  • DeletionProtection — (Boolean)

    A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is enabled.

  • ServerlessV2ScalingConfiguration — (map)

    Contains the scaling configuration of a Neptune Serverless DB cluster.

    For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

    • MinCapacity — (Float)

      The minimum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 8, 8.5, 9, and so on.

    • MaxCapacity — (Float)

      The maximum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 40, 40.5, 41, and so on.

  • GlobalClusterIdentifier — (String)

    The ID of the Neptune global database to which this new DB cluster should be added.

  • StorageType — (String)

    The storage type to associate with the DB cluster.

    Valid Values:

    • standard | iopt1

    Default:

    • standard

    Note: When you create a Neptune cluster with the storage type set to iopt1, the storage type is returned in the response. The storage type isn't returned when you set it to standard.

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.

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

        Not supported by Neptune.

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

        Not supported by Neptune.

      • DBClusterOptionGroupMemberships — (Array<map>)

        Not supported by Neptune.

        • DBClusterOptionGroupName — (String)

          Not supported by Neptune.

        • Status — (String)

          Not supported by Neptune.

      • 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 Amazon KMS key identifier for the encrypted DB cluster.

      • DbClusterResourceId — (String)

        The Amazon Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon CloudTrail log entries whenever the Amazon 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 Amazon 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 Amazon 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 Amazon 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 Amazon services on your behalf.

        • FeatureName — (String)

          The name of the feature associated with the Amazon Identity and Access Management (IAM) role. For the list of supported feature names, see DescribeDBEngineVersions.

      • IAMDatabaseAuthenticationEnabled — (Boolean)

        True if mapping of Amazon 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).

      • CopyTagsToSnapshot — (Boolean)

        If set to true, tags are copied to any snapshot of the DB cluster that is created.

      • EnabledCloudwatchLogsExports — (Array<String>)

        A list of the log types that this DB cluster is configured to export to CloudWatch Logs. Valid log types are: audit (to publish audit logs to CloudWatch) and slowquery (to publish slow-query logs to CloudWatch). See Publishing Neptune logs to Amazon CloudWatch logs.

      • PendingModifiedValues — (map)

        This data type is used as a response element in the ModifyDBCluster operation and contains changes that will be applied during the next maintenance window.

        • PendingCloudwatchLogsExports — (map)

          This PendingCloudwatchLogsExports structure specifies pending changes to which CloudWatch logs are enabled and which are disabled.

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

        • DBClusterIdentifier — (String)

          The DBClusterIdentifier value for the DB cluster.

        • IAMDatabaseAuthenticationEnabled — (Boolean)

          A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

        • EngineVersion — (String)

          The database engine version.

        • BackupRetentionPeriod — (Integer)

          The number of days for which automatic DB snapshots are retained.

        • StorageType — (String)

          The storage type for the DB cluster.

        • AllocatedStorage — (Integer)

          The allocated storage size in gibibytes (GiB) for database engines. For Neptune, AllocatedStorage always returns 1, because Neptune DB cluster storage size isn't fixed, but instead automatically adjusts as needed.

        • Iops — (Integer)

          The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.

      • DeletionProtection — (Boolean)

        Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

      • CrossAccountClone — (Boolean)

        If set to true, the DB cluster can be cloned across accounts.

      • AutomaticRestartTime — (Date)

        Time at which the DB cluster will be automatically restarted.

      • ServerlessV2ScalingConfiguration — (map)

        Shows the scaling configuration for a Neptune Serverless DB cluster.

        For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

        • MinCapacity — (Float)

          The minimum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 8, 8.5, 9, and so on.

        • MaxCapacity — (Float)

          The maximum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 40, 40.5, 41, and so on.

      • GlobalClusterIdentifier — (String)

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

      • IOOptimizedNextAllowedModificationTime — (Date)

        The next time you can modify the DB cluster to use the iopt1 storage type.

      • StorageType — (String)

        The storage type associated with the DB cluster.

Returns:

• (AWS.Request) —

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

var params = {
  DBClusterEndpointIdentifier: 'STRING_VALUE', /* required */
  DBClusterIdentifier: 'STRING_VALUE', /* required */
  EndpointType: 'STRING_VALUE', /* required */
  ExcludedMembers: [
    'STRING_VALUE',
    /* more items */
  ],
  StaticMembers: [
    'STRING_VALUE',
    /* more items */
  ],
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
neptune.createDBClusterEndpoint(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 of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

  • DBClusterEndpointIdentifier — (String)

    The identifier to use for the new endpoint. This parameter is stored as a lowercase string.

  • EndpointType — (String)

    The type of the endpoint. One of: READER, WRITER, ANY.

  • StaticMembers — (Array<String>)

    List of DB instance identifiers that are part of the custom endpoint group.

  • ExcludedMembers — (Array<String>)

    List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.

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

    • DBClusterEndpointIdentifier — (String)

      The identifier associated with the endpoint. This parameter is stored as a lowercase string.

    • DBClusterIdentifier — (String)

      The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

    • DBClusterEndpointResourceIdentifier — (String)

      A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.

    • Endpoint — (String)

      The DNS address of the endpoint.

    • Status — (String)

      The current status of the endpoint. One of: creating, available, deleting, inactive, modifying. The inactive state applies to an endpoint that cannot be used for a certain kind of cluster, such as a writer endpoint for a read-only secondary cluster in a global database.

    • EndpointType — (String)

      The type of the endpoint. One of: READER, WRITER, CUSTOM.

    • CustomEndpointType — (String)

      The type associated with a custom endpoint. One of: READER, WRITER, ANY.

    • StaticMembers — (Array<String>)

      List of DB instance identifiers that are part of the custom endpoint group.

    • ExcludedMembers — (Array<String>)

      List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.

    • DBClusterEndpointArn — (String)

      The Amazon Resource Name (ARN) for the endpoint.

Returns:

• (AWS.Request) —

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

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

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 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 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 a DB cluster snapshot. Must match the identifier of an existing snapshot.

        After you restore a DB cluster using a DBClusterSnapshotIdentifier, you must specify the same DBClusterSnapshotIdentifier for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed.

        However, if you don't specify the DBClusterSnapshotIdentifier, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the snapshot specified by the DBClusterSnapshotIdentifier, and the original DB cluster is deleted.

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

        Not supported by Neptune.

      • 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 Amazon 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 Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

      • StorageType — (String)

        The storage type associated with the DB cluster snapshot.

Returns:

• (AWS.Request) —

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

var params = {
  DBClusterIdentifier: 'STRING_VALUE', /* required */
  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,
  DBName: 'STRING_VALUE',
  DBParameterGroupName: 'STRING_VALUE',
  DBSecurityGroups: [
    'STRING_VALUE',
    /* more items */
  ],
  DBSubnetGroupName: 'STRING_VALUE',
  DeletionProtection: true || false,
  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)

    Not supported by Neptune.

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

  • Engine — (String)

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

    Valid Values: neptune

  • MasterUsername — (String)

    Not supported by Neptune.

  • MasterUserPassword — (String)

    Not supported by Neptune.

  • 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 Amazon 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 Amazon 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 Amazon 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. Currently, setting this parameter has no effect.

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

    (Not supported by Neptune)

  • CharacterSetName — (String)

    (Not supported by Neptune)

  • 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 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 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 Amazon 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 Amazon 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. Amazon KMS creates the default encryption key for your Amazon account. Your Amazon account has a different default encryption key for each Amazon 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)

    Not supported by Neptune (ignored).

  • EnablePerformanceInsights — (Boolean)

    (Not supported by Neptune)

  • PerformanceInsightsKMSKeyId — (String)

    (Not supported by Neptune)

  • EnableCloudwatchLogsExports — (Array<String>)

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

  • DeletionProtection — (Boolean)

    A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. See Deleting a DB Instance.

    DB instances in a DB cluster can be deleted even when deletion protection is enabled in their parent DB cluster.

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)

        Not supported by Neptune.

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

        Not supported by Neptune.

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

          Not supported by Neptune.

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

          Not supported by Neptune.

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

          This PendingCloudwatchLogsExports structure specifies pending changes to which CloudWatch logs are enabled and which are disabled.

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

        (Not supported by Neptune)

        • OptionGroupName — (String)

          Not supported by Neptune.

        • Status — (String)

          Not supported by Neptune.

      • CharacterSetName — (String)

        (Not supported by Neptune)

      • 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 Amazon Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon CloudTrail log entries whenever the Amazon 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 Amazon Identity and Access Management (IAM) authentication is enabled, and otherwise false.

      • PerformanceInsightsEnabled — (Boolean)

        (Not supported by Neptune)

      • PerformanceInsightsKMSKeyId — (String)

        (Not supported by Neptune)

      • EnabledCloudwatchLogsExports — (Array<String>)

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

      • DeletionProtection — (Boolean)

        Indicates whether or not the DB instance has deletion protection enabled. The instance can't be deleted when deletion protection is enabled. See Deleting a DB Instance.

Returns:

• (AWS.Request) —

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

var params = {
  DBParameterGroupFamily: 'STRING_VALUE', /* required */
  DBParameterGroupName: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE', /* required */
  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 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 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.

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

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

var params = {
  GlobalClusterIdentifier: 'STRING_VALUE', /* required */
  DeletionProtection: true || false,
  Engine: 'STRING_VALUE',
  EngineVersion: 'STRING_VALUE',
  SourceDBClusterIdentifier: 'STRING_VALUE',
  StorageEncrypted: true || false
};
neptune.createGlobalCluster(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: {}) —
  • GlobalClusterIdentifier — (String)

    The cluster identifier of the new global database cluster.

  • SourceDBClusterIdentifier — (String)

    (Optional) The Amazon Resource Name (ARN) of an existing Neptune DB cluster to use as the primary cluster of the new global database.

  • Engine — (String)

    The name of the database engine to be used in the global database.

    Valid values: neptune

  • EngineVersion — (String)

    The Neptune engine version to be used by the global database.

    Valid values: 1.2.0.0 or above.

  • DeletionProtection — (Boolean)

    The deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled.

  • StorageEncrypted — (Boolean)

    The storage encryption setting for the new global database cluster.

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:

    • GlobalCluster — (map)

      Contains the details of an Amazon Neptune global database.

      This data type is used as a response element for the CreateGlobalCluster, DescribeGlobalClusters, ModifyGlobalCluster, DeleteGlobalCluster, FailoverGlobalCluster, and RemoveFromGlobalCluster actions.

      • GlobalClusterIdentifier — (String)

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

      • GlobalClusterResourceId — (String)

        An immutable identifier for the global database that is unique within in all regions. This identifier is found in CloudTrail log entries whenever the KMS key for the DB cluster is accessed.

      • GlobalClusterArn — (String)

        The Amazon Resource Name (ARN) for the global database.

      • Status — (String)

        Specifies the current state of this global database.

      • Engine — (String)

        The Neptune database engine used by the global database ("neptune").

      • EngineVersion — (String)

        The Neptune engine version used by the global database.

      • StorageEncrypted — (Boolean)

        The storage encryption setting for the global database.

      • DeletionProtection — (Boolean)

        The deletion protection setting for the global database.

      • GlobalClusterMembers — (Array<map>)

        A list of cluster ARNs and instance ARNs for all the DB clusters that are part of the global database.

        • DBClusterArn — (String)

          The Amazon Resource Name (ARN) for each Neptune cluster.

        • Readers — (Array<String>)

          The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Neptune global database.

        • IsWriter — (Boolean)

          Specifies whether the Neptune cluster is the primary cluster (that is, has read-write capability) for the Neptune global database with which it is associated.

Returns:

• (AWS.Request) —

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

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.

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

        Not supported by Neptune.

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

        Not supported by Neptune.

      • DBClusterOptionGroupMemberships — (Array<map>)

        Not supported by Neptune.

        • DBClusterOptionGroupName — (String)

          Not supported by Neptune.

        • Status — (String)

          Not supported by Neptune.

      • 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 Amazon KMS key identifier for the encrypted DB cluster.

      • DbClusterResourceId — (String)

        The Amazon Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon CloudTrail log entries whenever the Amazon 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 Amazon 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 Amazon 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 Amazon 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 Amazon services on your behalf.

        • FeatureName — (String)

          The name of the feature associated with the Amazon Identity and Access Management (IAM) role. For the list of supported feature names, see DescribeDBEngineVersions.

      • IAMDatabaseAuthenticationEnabled — (Boolean)

        True if mapping of Amazon 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).

      • CopyTagsToSnapshot — (Boolean)

        If set to true, tags are copied to any snapshot of the DB cluster that is created.

      • EnabledCloudwatchLogsExports — (Array<String>)

        A list of the log types that this DB cluster is configured to export to CloudWatch Logs. Valid log types are: audit (to publish audit logs to CloudWatch) and slowquery (to publish slow-query logs to CloudWatch). See Publishing Neptune logs to Amazon CloudWatch logs.

      • PendingModifiedValues — (map)

        This data type is used as a response element in the ModifyDBCluster operation and contains changes that will be applied during the next maintenance window.

        • PendingCloudwatchLogsExports — (map)

          This PendingCloudwatchLogsExports structure specifies pending changes to which CloudWatch logs are enabled and which are disabled.

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

        • DBClusterIdentifier — (String)

          The DBClusterIdentifier value for the DB cluster.

        • IAMDatabaseAuthenticationEnabled — (Boolean)

          A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

        • EngineVersion — (String)

          The database engine version.

        • BackupRetentionPeriod — (Integer)

          The number of days for which automatic DB snapshots are retained.

        • StorageType — (String)

          The storage type for the DB cluster.

        • AllocatedStorage — (Integer)

          The allocated storage size in gibibytes (GiB) for database engines. For Neptune, AllocatedStorage always returns 1, because Neptune DB cluster storage size isn't fixed, but instead automatically adjusts as needed.

        • Iops — (Integer)

          The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.

      • DeletionProtection — (Boolean)

        Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

      • CrossAccountClone — (Boolean)

        If set to true, the DB cluster can be cloned across accounts.

      • AutomaticRestartTime — (Date)

        Time at which the DB cluster will be automatically restarted.

      • ServerlessV2ScalingConfiguration — (map)

        Shows the scaling configuration for a Neptune Serverless DB cluster.

        For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

        • MinCapacity — (Float)

          The minimum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 8, 8.5, 9, and so on.

        • MaxCapacity — (Float)

          The maximum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 40, 40.5, 41, and so on.

      • GlobalClusterIdentifier — (String)

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

      • IOOptimizedNextAllowedModificationTime — (Date)

        The next time you can modify the DB cluster to use the iopt1 storage type.

      • StorageType — (String)

        The storage type associated with the DB cluster.

Returns:

• (AWS.Request) —

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

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

    The identifier associated with the custom endpoint. This parameter is stored as a lowercase string.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • DBClusterEndpointIdentifier — (String)

      The identifier associated with the endpoint. This parameter is stored as a lowercase string.

    • DBClusterIdentifier — (String)

      The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

    • DBClusterEndpointResourceIdentifier — (String)

      A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.

    • Endpoint — (String)

      The DNS address of the endpoint.

    • Status — (String)

      The current status of the endpoint. One of: creating, available, deleting, inactive, modifying. The inactive state applies to an endpoint that cannot be used for a certain kind of cluster, such as a writer endpoint for a read-only secondary cluster in a global database.

    • EndpointType — (String)

      The type of the endpoint. One of: READER, WRITER, CUSTOM.

    • CustomEndpointType — (String)

      The type associated with a custom endpoint. One of: READER, WRITER, ANY.

    • StaticMembers — (Array<String>)

      List of DB instance identifiers that are part of the custom endpoint group.

    • ExcludedMembers — (Array<String>)

      List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.

    • DBClusterEndpointArn — (String)

      The Amazon Resource Name (ARN) for the endpoint.

Returns:

• (AWS.Request) —

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

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.

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 a DB cluster snapshot. Must match the identifier of an existing snapshot.

        After you restore a DB cluster using a DBClusterSnapshotIdentifier, you must specify the same DBClusterSnapshotIdentifier for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed.

        However, if you don't specify the DBClusterSnapshotIdentifier, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the snapshot specified by the DBClusterSnapshotIdentifier, and the original DB cluster is deleted.

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

        Not supported by Neptune.

      • 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 Amazon 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 Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

      • StorageType — (String)

        The storage type associated with the DB cluster snapshot.

Returns:

• (AWS.Request) —

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

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

        Not supported by Neptune.

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

        Not supported by Neptune.

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

          Not supported by Neptune.

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

          Not supported by Neptune.

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

          This PendingCloudwatchLogsExports structure specifies pending changes to which CloudWatch logs are enabled and which are disabled.

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

        (Not supported by Neptune)

        • OptionGroupName — (String)

          Not supported by Neptune.

        • Status — (String)

          Not supported by Neptune.

      • CharacterSetName — (String)

        (Not supported by Neptune)

      • 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 Amazon Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon CloudTrail log entries whenever the Amazon 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 Amazon Identity and Access Management (IAM) authentication is enabled, and otherwise false.

      • PerformanceInsightsEnabled — (Boolean)

        (Not supported by Neptune)

      • PerformanceInsightsKMSKeyId — (String)

        (Not supported by Neptune)

      • EnabledCloudwatchLogsExports — (Array<String>)

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

      • DeletionProtection — (Boolean)

        Indicates whether or not the DB instance has deletion protection enabled. The instance can't be deleted when deletion protection is enabled. See Deleting a DB Instance.

Returns:

• (AWS.Request) —

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

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.

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.

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

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

    The cluster identifier of the global database cluster being deleted.

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:

    • GlobalCluster — (map)

      Contains the details of an Amazon Neptune global database.

      This data type is used as a response element for the CreateGlobalCluster, DescribeGlobalClusters, ModifyGlobalCluster, DeleteGlobalCluster, FailoverGlobalCluster, and RemoveFromGlobalCluster actions.

      • GlobalClusterIdentifier — (String)

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

      • GlobalClusterResourceId — (String)

        An immutable identifier for the global database that is unique within in all regions. This identifier is found in CloudTrail log entries whenever the KMS key for the DB cluster is accessed.

      • GlobalClusterArn — (String)

        The Amazon Resource Name (ARN) for the global database.

      • Status — (String)

        Specifies the current state of this global database.

      • Engine — (String)

        The Neptune database engine used by the global database ("neptune").

      • EngineVersion — (String)

        The Neptune engine version used by the global database.

      • StorageEncrypted — (Boolean)

        The storage encryption setting for the global database.

      • DeletionProtection — (Boolean)

        The deletion protection setting for the global database.

      • GlobalClusterMembers — (Array<map>)

        A list of cluster ARNs and instance ARNs for all the DB clusters that are part of the global database.

        • DBClusterArn — (String)

          The Amazon Resource Name (ARN) for each Neptune cluster.

        • Readers — (Array<String>)

          The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Neptune global database.

        • IsWriter — (Boolean)

          Specifies whether the Neptune cluster is the primary cluster (that is, has read-write capability) for the Neptune global database with which it is associated.

Returns:

• (AWS.Request) —

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

var params = {
  DBClusterEndpointIdentifier: 'STRING_VALUE',
  DBClusterIdentifier: 'STRING_VALUE',
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE'
};
neptune.describeDBClusterEndpoints(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 of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

  • DBClusterEndpointIdentifier — (String)

    The identifier of the endpoint to describe. This parameter is stored as a lowercase string.

  • Filters — (Array<map>)

    A set of name-value pairs that define which endpoints to include in the output. The filters are specified as name-value pairs, in the format Name=endpoint_type,Values=endpoint_type1,endpoint_type2,.... Name can be one of: db-cluster-endpoint-type, db-cluster-endpoint-custom-type, db-cluster-endpoint-id, db-cluster-endpoint-status. Values for the db-cluster-endpoint-type filter can be one or more of: reader, writer, custom. Values for the db-cluster-endpoint-custom-type filter can be one or more of: reader, any. Values for the db-cluster-endpoint-status filter can be one or more of: available, creating, deleting, inactive, modifying.

    • 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 you can retrieve the remaining results.

    Default: 100

    Constraints: Minimum 20, maximum 100.

  • Marker — (String)

    An optional pagination token provided by a previous DescribeDBClusterEndpoints 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 DescribeDBClusterEndpoints request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    • DBClusterEndpoints — (Array<map>)

      Contains the details of the endpoints associated with the cluster and matching any filter conditions.

      • DBClusterEndpointIdentifier — (String)

        The identifier associated with the endpoint. This parameter is stored as a lowercase string.

      • DBClusterIdentifier — (String)

        The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

      • DBClusterEndpointResourceIdentifier — (String)

        A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.

      • Endpoint — (String)

        The DNS address of the endpoint.

      • Status — (String)

        The current status of the endpoint. One of: creating, available, deleting, inactive, modifying. The inactive state applies to an endpoint that cannot be used for a certain kind of cluster, such as a writer endpoint for a read-only secondary cluster in a global database.

      • EndpointType — (String)

        The type of the endpoint. One of: READER, WRITER, CUSTOM.

      • CustomEndpointType — (String)

        The type associated with a custom endpoint. One of: READER, WRITER, ANY.

      • StaticMembers — (Array<String>)

        List of DB instance identifiers that are part of the custom endpoint group.

      • ExcludedMembers — (Array<String>)

        List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.

      • DBClusterEndpointArn — (String)

        The Amazon Resource Name (ARN) for the endpoint.

Returns:

• (AWS.Request) —

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

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.

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.

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.

    • engine - Accepts an engine name (such as neptune), and restricts the results list to DB clusters created by that engine.

    For example, to invoke this API from the Amazon CLI and filter so that only Neptune DB clusters are returned, you could use the following command:

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

        Not supported by Neptune.

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

        Not supported by Neptune.

      • DBClusterOptionGroupMemberships — (Array<map>)

        Not supported by Neptune.

        • DBClusterOptionGroupName — (String)

          Not supported by Neptune.

        • Status — (String)

          Not supported by Neptune.

      • 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 Amazon KMS key identifier for the encrypted DB cluster.

      • DbClusterResourceId — (String)

        The Amazon Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon CloudTrail log entries whenever the Amazon 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 Amazon 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 Amazon 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 Amazon 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 Amazon services on your behalf.

        • FeatureName — (String)

          The name of the feature associated with the Amazon Identity and Access Management (IAM) role. For the list of supported feature names, see DescribeDBEngineVersions.

      • IAMDatabaseAuthenticationEnabled — (Boolean)

        True if mapping of Amazon 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).

      • CopyTagsToSnapshot — (Boolean)

        If set to true, tags are copied to any snapshot of the DB cluster that is created.

      • EnabledCloudwatchLogsExports — (Array<String>)

        A list of the log types that this DB cluster is configured to export to CloudWatch Logs. Valid log types are: audit (to publish audit logs to CloudWatch) and slowquery (to publish slow-query logs to CloudWatch). See Publishing Neptune logs to Amazon CloudWatch logs.

      • PendingModifiedValues — (map)

        This data type is used as a response element in the ModifyDBCluster operation and contains changes that will be applied during the next maintenance window.

        • PendingCloudwatchLogsExports — (map)

          This PendingCloudwatchLogsExports structure specifies pending changes to which CloudWatch logs are enabled and which are disabled.

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

        • DBClusterIdentifier — (String)

          The DBClusterIdentifier value for the DB cluster.

        • IAMDatabaseAuthenticationEnabled — (Boolean)

          A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

        • EngineVersion — (String)

          The database engine version.

        • BackupRetentionPeriod — (Integer)

          The number of days for which automatic DB snapshots are retained.

        • StorageType — (String)

          The storage type for the DB cluster.

        • AllocatedStorage — (Integer)

          The allocated storage size in gibibytes (GiB) for database engines. For Neptune, AllocatedStorage always returns 1, because Neptune DB cluster storage size isn't fixed, but instead automatically adjusts as needed.

        • Iops — (Integer)

          The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.

      • DeletionProtection — (Boolean)

        Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

      • CrossAccountClone — (Boolean)

        If set to true, the DB cluster can be cloned across accounts.

      • AutomaticRestartTime — (Date)

        Time at which the DB cluster will be automatically restarted.

      • ServerlessV2ScalingConfiguration — (map)

        Shows the scaling configuration for a Neptune Serverless DB cluster.

        For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

        • MinCapacity — (Float)

          The minimum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 8, 8.5, 9, and so on.

        • MaxCapacity — (Float)

          The maximum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 40, 40.5, 41, and so on.

      • GlobalClusterIdentifier — (String)

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

      • IOOptimizedNextAllowedModificationTime — (Date)

        The next time you can modify the DB cluster to use the iopt1 storage type.

      • StorageType — (String)

        The storage type associated with the DB cluster.

Returns:

• (AWS.Request) —

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

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 Amazon 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 Amazon 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 Amazon 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 Amazon account to copy or restore.