Neptune class

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

Constructors

Neptune({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

shapes → Map<String, Shape>

final

Methods

addRoleToDBCluster({required String dBClusterIdentifier, required String roleArn, String? featureName}) → Future<void>

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

addSourceIdentifierToSubscription({required String sourceIdentifier, required String subscriptionName}) → Future<AddSourceIdentifierToSubscriptionResult>

Adds a source identifier to an existing event notification subscription.

addTagsToResource({required String resourceName, required List<Tag> tags}) → Future<void>

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

applyPendingMaintenanceAction({required String applyAction, required String optInType, required String resourceIdentifier}) → Future<ApplyPendingMaintenanceActionResult>

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

close() → void

Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.

copyDBClusterParameterGroup({required String sourceDBClusterParameterGroupIdentifier, required String targetDBClusterParameterGroupDescription, required String targetDBClusterParameterGroupIdentifier, List<Tag>? tags}) → Future<CopyDBClusterParameterGroupResult>

Copies the specified DB cluster parameter group.

copyDBClusterSnapshot({required String sourceDBClusterSnapshotIdentifier, required String targetDBClusterSnapshotIdentifier, bool? copyTags, String? kmsKeyId, String? preSignedUrl, List<Tag>? tags}) → Future<CopyDBClusterSnapshotResult>

Copies a snapshot of a DB cluster.

copyDBParameterGroup({required String sourceDBParameterGroupIdentifier, required String targetDBParameterGroupDescription, required String targetDBParameterGroupIdentifier, List<Tag>? tags}) → Future<CopyDBParameterGroupResult>

Copies the specified DB parameter group.

createDBCluster({required String dBClusterIdentifier, required String engine, List<String>? availabilityZones, int? backupRetentionPeriod, String? characterSetName, String? dBClusterParameterGroupName, String? dBSubnetGroupName, String? databaseName, bool? deletionProtection, List<String>? enableCloudwatchLogsExports, bool? enableIAMDatabaseAuthentication, String? engineVersion, String? kmsKeyId, String? masterUserPassword, String? masterUsername, String? optionGroupName, int? port, String? preSignedUrl, String? preferredBackupWindow, String? preferredMaintenanceWindow, String? replicationSourceIdentifier, bool? storageEncrypted, List<Tag>? tags, List<String>? vpcSecurityGroupIds}) → Future<CreateDBClusterResult>

Creates a new Amazon Neptune DB cluster.

createDBClusterEndpoint({required String dBClusterEndpointIdentifier, required String dBClusterIdentifier, required String endpointType, List<String>? excludedMembers, List<String>? staticMembers, List<Tag>? tags}) → Future<CreateDBClusterEndpointOutput>

Creates a new custom endpoint and associates it with an Amazon Neptune DB cluster.

createDBClusterParameterGroup({required String dBClusterParameterGroupName, required String dBParameterGroupFamily, required String description, List<Tag>? tags}) → Future<CreateDBClusterParameterGroupResult>

Creates a new DB cluster parameter group.

createDBClusterSnapshot({required String dBClusterIdentifier, required String dBClusterSnapshotIdentifier, List<Tag>? tags}) → Future<CreateDBClusterSnapshotResult>

Creates a snapshot of a DB cluster.

createDBInstance({required String dBInstanceClass, required String dBInstanceIdentifier, required String engine, int? allocatedStorage, bool? autoMinorVersionUpgrade, String? availabilityZone, int? backupRetentionPeriod, String? characterSetName, bool? copyTagsToSnapshot, String? dBClusterIdentifier, String? dBName, String? dBParameterGroupName, List<String>? dBSecurityGroups, String? dBSubnetGroupName, bool? deletionProtection, String? domain, String? domainIAMRoleName, List<String>? enableCloudwatchLogsExports, bool? enableIAMDatabaseAuthentication, bool? enablePerformanceInsights, String? engineVersion, int? iops, String? kmsKeyId, String? licenseModel, String? masterUserPassword, String? masterUsername, int? monitoringInterval, String? monitoringRoleArn, bool? multiAZ, String? optionGroupName, String? performanceInsightsKMSKeyId, int? port, String? preferredBackupWindow, String? preferredMaintenanceWindow, int? promotionTier, bool? publiclyAccessible, bool? storageEncrypted, String? storageType, List<Tag>? tags, String? tdeCredentialArn, String? tdeCredentialPassword, String? timezone, List<String>? vpcSecurityGroupIds}) → Future<CreateDBInstanceResult>

Creates a new DB instance.

createDBParameterGroup({required String dBParameterGroupFamily, required String dBParameterGroupName, required String description, List<Tag>? tags}) → Future<CreateDBParameterGroupResult>

Creates a new DB parameter group.

createDBSubnetGroup({required String dBSubnetGroupDescription, required String dBSubnetGroupName, required List<String> subnetIds, List<Tag>? tags}) → Future<CreateDBSubnetGroupResult>

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

createEventSubscription({required String snsTopicArn, required String subscriptionName, bool? enabled, List<String>? eventCategories, List<String>? sourceIds, String? sourceType, List<Tag>? tags}) → Future<CreateEventSubscriptionResult>

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

deleteDBCluster({required String dBClusterIdentifier, String? finalDBSnapshotIdentifier, bool? skipFinalSnapshot}) → Future<DeleteDBClusterResult>

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

deleteDBClusterEndpoint({required String dBClusterEndpointIdentifier}) → Future<DeleteDBClusterEndpointOutput>

Deletes a custom endpoint and removes it from an Amazon Neptune DB cluster.

deleteDBClusterParameterGroup({required String dBClusterParameterGroupName}) → Future<void>

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

deleteDBClusterSnapshot({required String dBClusterSnapshotIdentifier}) → Future<DeleteDBClusterSnapshotResult>

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

deleteDBInstance({required String dBInstanceIdentifier, String? finalDBSnapshotIdentifier, bool? skipFinalSnapshot}) → Future<DeleteDBInstanceResult>

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

deleteDBParameterGroup({required String dBParameterGroupName}) → Future<void>

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

deleteDBSubnetGroup({required String dBSubnetGroupName}) → Future<void>

Deletes a DB subnet group.

deleteEventSubscription({required String subscriptionName}) → Future<DeleteEventSubscriptionResult>

Deletes an event notification subscription.

describeDBClusterEndpoints({String? dBClusterEndpointIdentifier, String? dBClusterIdentifier, List<Filter>? filters, String? marker, int? maxRecords}) → Future<DBClusterEndpointMessage>

Returns information about endpoints for an Amazon Neptune DB cluster.

describeDBClusterParameterGroups({String? dBClusterParameterGroupName, List<Filter>? filters, String? marker, int? maxRecords}) → Future<DBClusterParameterGroupsMessage>

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

describeDBClusterParameters({required String dBClusterParameterGroupName, List<Filter>? filters, String? marker, int? maxRecords, String? source}) → Future<DBClusterParameterGroupDetails>

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

describeDBClusters({String? dBClusterIdentifier, List<Filter>? filters, String? marker, int? maxRecords}) → Future<DBClusterMessage>

Returns information about provisioned DB clusters, and supports pagination.

describeDBClusterSnapshotAttributes({required String dBClusterSnapshotIdentifier}) → Future<DescribeDBClusterSnapshotAttributesResult>

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

describeDBClusterSnapshots({String? dBClusterIdentifier, String? dBClusterSnapshotIdentifier, List<Filter>? filters, bool? includePublic, bool? includeShared, String? marker, int? maxRecords, String? snapshotType}) → Future<DBClusterSnapshotMessage>

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

describeDBEngineVersions({String? dBParameterGroupFamily, bool? defaultOnly, String? engine, String? engineVersion, List<Filter>? filters, bool? listSupportedCharacterSets, bool? listSupportedTimezones, String? marker, int? maxRecords}) → Future<DBEngineVersionMessage>

Returns a list of the available DB engines.

describeDBInstances({String? dBInstanceIdentifier, List<Filter>? filters, String? marker, int? maxRecords}) → Future<DBInstanceMessage>

Returns information about provisioned instances, and supports pagination.

describeDBParameterGroups({String? dBParameterGroupName, List<Filter>? filters, String? marker, int? maxRecords}) → Future<DBParameterGroupsMessage>

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

describeDBParameters({required String dBParameterGroupName, List<Filter>? filters, String? marker, int? maxRecords, String? source}) → Future<DBParameterGroupDetails>

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

describeDBSubnetGroups({String? dBSubnetGroupName, List<Filter>? filters, String? marker, int? maxRecords}) → Future<DBSubnetGroupMessage>

Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.

describeEngineDefaultClusterParameters({required String dBParameterGroupFamily, List<Filter>? filters, String? marker, int? maxRecords}) → Future<DescribeEngineDefaultClusterParametersResult>

Returns the default engine and system parameter information for the cluster database engine.

describeEngineDefaultParameters({required String dBParameterGroupFamily, List<Filter>? filters, String? marker, int? maxRecords}) → Future<DescribeEngineDefaultParametersResult>

Returns the default engine and system parameter information for the specified database engine.

describeEventCategories({List<Filter>? filters, String? sourceType}) → Future<EventCategoriesMessage>

Displays a list of categories for all event source types, or, if specified, for a specified source type.

describeEvents({int? duration, DateTime? endTime, List<String>? eventCategories, List<Filter>? filters, String? marker, int? maxRecords, String? sourceIdentifier, SourceType? sourceType, DateTime? startTime}) → Future<EventsMessage>

Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.

describeEventSubscriptions({List<Filter>? filters, String? marker, int? maxRecords, String? subscriptionName}) → Future<EventSubscriptionsMessage>

Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.

describeOrderableDBInstanceOptions({required String engine, String? dBInstanceClass, String? engineVersion, List<Filter>? filters, String? licenseModel, String? marker, int? maxRecords, bool? vpc}) → Future<OrderableDBInstanceOptionsMessage>

Returns a list of orderable DB instance options for the specified engine.

describePendingMaintenanceActions({List<Filter>? filters, String? marker, int? maxRecords, String? resourceIdentifier}) → Future<PendingMaintenanceActionsMessage>

Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.

describeValidDBInstanceModifications({required String dBInstanceIdentifier}) → Future<DescribeValidDBInstanceModificationsResult>

You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance.

failoverDBCluster({String? dBClusterIdentifier, String? targetDBInstanceIdentifier}) → Future<FailoverDBClusterResult>

Forces a failover for a DB cluster.

listTagsForResource({required String resourceName, List<Filter>? filters}) → Future<TagListMessage>

Lists all tags on an Amazon Neptune resource.

modifyDBCluster({required String dBClusterIdentifier, bool? applyImmediately, int? backupRetentionPeriod, CloudwatchLogsExportConfiguration? cloudwatchLogsExportConfiguration, String? dBClusterParameterGroupName, bool? deletionProtection, bool? enableIAMDatabaseAuthentication, String? engineVersion, String? masterUserPassword, String? newDBClusterIdentifier, String? optionGroupName, int? port, String? preferredBackupWindow, String? preferredMaintenanceWindow, List<String>? vpcSecurityGroupIds}) → Future<ModifyDBClusterResult>

Modify a setting for a DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.

modifyDBClusterEndpoint({required String dBClusterEndpointIdentifier, String? endpointType, List<String>? excludedMembers, List<String>? staticMembers}) → Future<ModifyDBClusterEndpointOutput>

Modifies the properties of an endpoint in an Amazon Neptune DB cluster.

modifyDBClusterParameterGroup({required String dBClusterParameterGroupName, required List<Parameter> parameters}) → Future<DBClusterParameterGroupNameMessage>

Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

modifyDBClusterSnapshotAttribute({required String attributeName, required String dBClusterSnapshotIdentifier, List<String>? valuesToAdd, List<String>? valuesToRemove}) → Future<ModifyDBClusterSnapshotAttributeResult>

Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.

modifyDBInstance({required String dBInstanceIdentifier, int? allocatedStorage, bool? allowMajorVersionUpgrade, bool? applyImmediately, bool? autoMinorVersionUpgrade, int? backupRetentionPeriod, String? cACertificateIdentifier, CloudwatchLogsExportConfiguration? cloudwatchLogsExportConfiguration, bool? copyTagsToSnapshot, String? dBInstanceClass, String? dBParameterGroupName, int? dBPortNumber, List<String>? dBSecurityGroups, String? dBSubnetGroupName, bool? deletionProtection, String? domain, String? domainIAMRoleName, bool? enableIAMDatabaseAuthentication, bool? enablePerformanceInsights, String? engineVersion, int? iops, String? licenseModel, String? masterUserPassword, int? monitoringInterval, String? monitoringRoleArn, bool? multiAZ, String? newDBInstanceIdentifier, String? optionGroupName, String? performanceInsightsKMSKeyId, String? preferredBackupWindow, String? preferredMaintenanceWindow, int? promotionTier, bool? publiclyAccessible, String? storageType, String? tdeCredentialArn, String? tdeCredentialPassword, List<String>? vpcSecurityGroupIds}) → Future<ModifyDBInstanceResult>

Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. To learn what modifications you can make to your DB instance, call DescribeValidDBInstanceModifications before you call ModifyDBInstance.

modifyDBParameterGroup({required String dBParameterGroupName, required List<Parameter> parameters}) → Future<DBParameterGroupNameMessage>

Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

modifyDBSubnetGroup({required String dBSubnetGroupName, required List<String> subnetIds, String? dBSubnetGroupDescription}) → Future<ModifyDBSubnetGroupResult>

Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region.

modifyEventSubscription({required String subscriptionName, bool? enabled, List<String>? eventCategories, String? snsTopicArn, String? sourceType}) → Future<ModifyEventSubscriptionResult>

Modifies an existing event notification subscription. Note that you can't modify the source identifiers using this call; to change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

promoteReadReplicaDBCluster({required String dBClusterIdentifier}) → Future<PromoteReadReplicaDBClusterResult>

Not supported.

rebootDBInstance({required String dBInstanceIdentifier, bool? forceFailover}) → Future<RebootDBInstanceResult>

You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect.

removeRoleFromDBCluster({required String dBClusterIdentifier, required String roleArn, String? featureName}) → Future<void>

Disassociates an Identity and Access Management (IAM) role from a DB cluster.

removeSourceIdentifierFromSubscription({required String sourceIdentifier, required String subscriptionName}) → Future<RemoveSourceIdentifierFromSubscriptionResult>

Removes a source identifier from an existing event notification subscription.

removeTagsFromResource({required String resourceName, required List<String> tagKeys}) → Future<void>

Removes metadata tags from an Amazon Neptune resource.

resetDBClusterParameterGroup({required String dBClusterParameterGroupName, List<Parameter>? parameters, bool? resetAllParameters}) → Future<DBClusterParameterGroupNameMessage>

Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters.

resetDBParameterGroup({required String dBParameterGroupName, List<Parameter>? parameters, bool? resetAllParameters}) → Future<DBParameterGroupNameMessage>

Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request.

restoreDBClusterFromSnapshot({required String dBClusterIdentifier, required String engine, required String snapshotIdentifier, List<String>? availabilityZones, String? dBClusterParameterGroupName, String? dBSubnetGroupName, String? databaseName, bool? deletionProtection, List<String>? enableCloudwatchLogsExports, bool? enableIAMDatabaseAuthentication, String? engineVersion, String? kmsKeyId, String? optionGroupName, int? port, List<Tag>? tags, List<String>? vpcSecurityGroupIds}) → Future<RestoreDBClusterFromSnapshotResult>

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

restoreDBClusterToPointInTime({required String dBClusterIdentifier, required String sourceDBClusterIdentifier, String? dBClusterParameterGroupName, String? dBSubnetGroupName, bool? deletionProtection, List<String>? enableCloudwatchLogsExports, bool? enableIAMDatabaseAuthentication, String? kmsKeyId, String? optionGroupName, int? port, DateTime? restoreToTime, String? restoreType, List<Tag>? tags, bool? useLatestRestorableTime, List<String>? vpcSecurityGroupIds}) → Future<RestoreDBClusterToPointInTimeResult>

Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group.

startDBCluster({required String dBClusterIdentifier}) → Future<StartDBClusterResult>

Starts an Amazon Neptune DB cluster that was stopped using the AWS console, the AWS CLI stop-db-cluster command, or the StopDBCluster API.

stopDBCluster({required String dBClusterIdentifier}) → Future<StopDBClusterResult>

Stops an Amazon Neptune DB cluster. When you stop a DB cluster, Neptune retains the DB cluster's metadata, including its endpoints and DB parameter groups.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited