@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonNeptuneAsync extends AmazonNeptune
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonNeptuneAsync instead.
Amazon Neptune is a fast, reliable, fully-managed graph database service that makes it easy to build and run applications that work with highly connected datasets. The core of Amazon Neptune is a purpose-built, high-performance graph database engine optimized for storing billions of relationships and querying the graph with milliseconds latency. Amazon Neptune supports popular graph models Property Graph and W3C's RDF, and their respective query languages Apache TinkerPop Gremlin and SPARQL, allowing you to easily build queries that efficiently navigate highly connected datasets. Neptune powers graph use cases such as recommendation engines, fraud detection, knowledge graphs, drug discovery, and network security.
This interface reference for Amazon Neptune contains documentation for a programming or command line interface you can use to manage Amazon Neptune. Note that Amazon Neptune is asynchronous, which means that some interfaces might require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. The reference structure is as follows, and we list following some related topics from the user guide.
Amazon Neptune API Reference
ENDPOINT_PREFIXaddRoleToDBCluster, addSourceIdentifierToSubscription, addTagsToResource, applyPendingMaintenanceAction, copyDBClusterParameterGroup, copyDBClusterSnapshot, copyDBParameterGroup, createDBCluster, createDBClusterParameterGroup, createDBClusterSnapshot, createDBInstance, createDBParameterGroup, createDBSubnetGroup, createEventSubscription, deleteDBCluster, deleteDBClusterParameterGroup, deleteDBClusterSnapshot, deleteDBInstance, deleteDBParameterGroup, deleteDBSubnetGroup, deleteEventSubscription, describeDBClusterParameterGroups, describeDBClusterParameters, describeDBClusters, describeDBClusterSnapshotAttributes, describeDBClusterSnapshots, describeDBEngineVersions, describeDBInstances, describeDBParameterGroups, describeDBParameters, describeDBSubnetGroups, describeEngineDefaultClusterParameters, describeEngineDefaultParameters, describeEventCategories, describeEvents, describeEventSubscriptions, describeOrderableDBInstanceOptions, describePendingMaintenanceActions, describeValidDBInstanceModifications, failoverDBCluster, getCachedResponseMetadata, listTagsForResource, modifyDBCluster, modifyDBClusterParameterGroup, modifyDBClusterSnapshotAttribute, modifyDBInstance, modifyDBParameterGroup, modifyDBSubnetGroup, modifyEventSubscription, promoteReadReplicaDBCluster, rebootDBInstance, removeRoleFromDBCluster, removeSourceIdentifierFromSubscription, removeTagsFromResource, resetDBClusterParameterGroup, resetDBParameterGroup, restoreDBClusterFromSnapshot, restoreDBClusterToPointInTime, shutdown, waitersFuture<AddRoleToDBClusterResult> addRoleToDBClusterAsync(AddRoleToDBClusterRequest addRoleToDBClusterRequest)
Associates an Identity and Access Management (IAM) role from an Neptune DB cluster.
addRoleToDBClusterRequest - Future<AddRoleToDBClusterResult> addRoleToDBClusterAsync(AddRoleToDBClusterRequest addRoleToDBClusterRequest, AsyncHandler<AddRoleToDBClusterRequest,AddRoleToDBClusterResult> asyncHandler)
Associates an Identity and Access Management (IAM) role from an Neptune DB cluster.
addRoleToDBClusterRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<EventSubscription> addSourceIdentifierToSubscriptionAsync(AddSourceIdentifierToSubscriptionRequest addSourceIdentifierToSubscriptionRequest)
Adds a source identifier to an existing event notification subscription.
addSourceIdentifierToSubscriptionRequest - Future<EventSubscription> addSourceIdentifierToSubscriptionAsync(AddSourceIdentifierToSubscriptionRequest addSourceIdentifierToSubscriptionRequest, AsyncHandler<AddSourceIdentifierToSubscriptionRequest,EventSubscription> asyncHandler)
Adds a source identifier to an existing event notification subscription.
addSourceIdentifierToSubscriptionRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<AddTagsToResourceResult> addTagsToResourceAsync(AddTagsToResourceRequest addTagsToResourceRequest)
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.
addTagsToResourceRequest - Future<AddTagsToResourceResult> addTagsToResourceAsync(AddTagsToResourceRequest addTagsToResourceRequest, AsyncHandler<AddTagsToResourceRequest,AddTagsToResourceResult> asyncHandler)
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.
addTagsToResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ResourcePendingMaintenanceActions> applyPendingMaintenanceActionAsync(ApplyPendingMaintenanceActionRequest applyPendingMaintenanceActionRequest)
Applies a pending maintenance action to a resource (for example, to a DB instance).
applyPendingMaintenanceActionRequest - Future<ResourcePendingMaintenanceActions> applyPendingMaintenanceActionAsync(ApplyPendingMaintenanceActionRequest applyPendingMaintenanceActionRequest, AsyncHandler<ApplyPendingMaintenanceActionRequest,ResourcePendingMaintenanceActions> asyncHandler)
Applies a pending maintenance action to a resource (for example, to a DB instance).
applyPendingMaintenanceActionRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DBClusterParameterGroup> copyDBClusterParameterGroupAsync(CopyDBClusterParameterGroupRequest copyDBClusterParameterGroupRequest)
Copies the specified DB cluster parameter group.
copyDBClusterParameterGroupRequest - Future<DBClusterParameterGroup> copyDBClusterParameterGroupAsync(CopyDBClusterParameterGroupRequest copyDBClusterParameterGroupRequest, AsyncHandler<CopyDBClusterParameterGroupRequest,DBClusterParameterGroup> asyncHandler)
Copies the specified DB cluster parameter group.
copyDBClusterParameterGroupRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DBClusterSnapshot> copyDBClusterSnapshotAsync(CopyDBClusterSnapshotRequest copyDBClusterSnapshotRequest)
Copies a snapshot of a DB cluster.
To copy a DB cluster snapshot from a shared manual DB cluster snapshot,
SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster
snapshot.
You can copy an encrypted DB cluster snapshot from another AWS Region. In that case, the AWS Region where you
call the CopyDBClusterSnapshot action is the destination AWS Region for the encrypted DB cluster
snapshot to be copied to. To copy an encrypted DB cluster snapshot from another AWS Region, you must provide the
following values:
KmsKeyId - The AWS Key Management System (AWS KMS) key identifier for the key to use to encrypt the
copy of the DB cluster snapshot in the destination AWS Region.
PreSignedUrl - A URL that contains a Signature Version 4 signed request for the
CopyDBClusterSnapshot action to be called in the source AWS Region where the DB cluster snapshot is
copied from. The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action
that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied.
The pre-signed URL request must contain the following parameter values:
KmsKeyId - The KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot
in the destination AWS Region. This is the same identifier for both the CopyDBClusterSnapshot action
that is called in the destination AWS Region, and the action contained in the pre-signed URL.
DestinationRegion - The name of the AWS Region that the DB cluster snapshot will be created in.
SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster
snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS
Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS Region, then your
SourceDBClusterSnapshotIdentifier looks like the following example:
arn:aws:rds:us-west-2:123456789012:cluster-snapshot:neptune-cluster1-snapshot-20161115.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.
TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in
the destination AWS Region.
SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster
snapshot to be copied. This identifier must be in the ARN format for the source AWS Region and is the same value
as the SourceDBClusterSnapshotIdentifier in the pre-signed URL.
To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified by
TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in "copying" status.
copyDBClusterSnapshotRequest - Future<DBClusterSnapshot> copyDBClusterSnapshotAsync(CopyDBClusterSnapshotRequest copyDBClusterSnapshotRequest, AsyncHandler<CopyDBClusterSnapshotRequest,DBClusterSnapshot> asyncHandler)
Copies a snapshot of a DB cluster.
To copy a DB cluster snapshot from a shared manual DB cluster snapshot,
SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster
snapshot.
You can copy an encrypted DB cluster snapshot from another AWS Region. In that case, the AWS Region where you
call the CopyDBClusterSnapshot action is the destination AWS Region for the encrypted DB cluster
snapshot to be copied to. To copy an encrypted DB cluster snapshot from another AWS Region, you must provide the
following values:
KmsKeyId - The AWS Key Management System (AWS KMS) key identifier for the key to use to encrypt the
copy of the DB cluster snapshot in the destination AWS Region.
PreSignedUrl - A URL that contains a Signature Version 4 signed request for the
CopyDBClusterSnapshot action to be called in the source AWS Region where the DB cluster snapshot is
copied from. The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action
that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied.
The pre-signed URL request must contain the following parameter values:
KmsKeyId - The KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot
in the destination AWS Region. This is the same identifier for both the CopyDBClusterSnapshot action
that is called in the destination AWS Region, and the action contained in the pre-signed URL.
DestinationRegion - The name of the AWS Region that the DB cluster snapshot will be created in.
SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster
snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS
Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS Region, then your
SourceDBClusterSnapshotIdentifier looks like the following example:
arn:aws:rds:us-west-2:123456789012:cluster-snapshot:neptune-cluster1-snapshot-20161115.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.
TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in
the destination AWS Region.
SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster
snapshot to be copied. This identifier must be in the ARN format for the source AWS Region and is the same value
as the SourceDBClusterSnapshotIdentifier in the pre-signed URL.
To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified by
TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in "copying" status.
copyDBClusterSnapshotRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DBParameterGroup> copyDBParameterGroupAsync(CopyDBParameterGroupRequest copyDBParameterGroupRequest)
Copies the specified DB parameter group.
copyDBParameterGroupRequest - Future<DBParameterGroup> copyDBParameterGroupAsync(CopyDBParameterGroupRequest copyDBParameterGroupRequest, AsyncHandler<CopyDBParameterGroupRequest,DBParameterGroup> asyncHandler)
Copies the specified DB parameter group.
copyDBParameterGroupRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DBCluster> createDBClusterAsync(CreateDBClusterRequest createDBClusterRequest)
Creates a new Amazon Neptune DB cluster.
You can use the ReplicationSourceIdentifier parameter to create the DB cluster as a Read Replica of
another DB cluster or Amazon Neptune DB instance. For cross-region replication where the DB cluster identified by
ReplicationSourceIdentifier is encrypted, you must also specify the PreSignedUrl
parameter.
createDBClusterRequest - Future<DBCluster> createDBClusterAsync(CreateDBClusterRequest createDBClusterRequest, AsyncHandler<CreateDBClusterRequest,DBCluster> asyncHandler)
Creates a new Amazon Neptune DB cluster.
You can use the ReplicationSourceIdentifier parameter to create the DB cluster as a Read Replica of
another DB cluster or Amazon Neptune DB instance. For cross-region replication where the DB cluster identified by
ReplicationSourceIdentifier is encrypted, you must also specify the PreSignedUrl
parameter.
createDBClusterRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DBClusterParameterGroup> createDBClusterParameterGroupAsync(CreateDBClusterParameterGroupRequest createDBClusterParameterGroupRequest)
Creates a new DB cluster parameter group.
Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.
A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster. When you associate a new DB cluster parameter group with a running DB cluster, you need to reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.
After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB
cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon Neptune to
fully complete the create action before the DB cluster parameter group is used as the default for a new DB
cluster. This is especially important for parameters that are critical when creating the default database for a
DB cluster, such as the character set for the default database defined by the character_set_database
parameter. You can use the Parameter Groups option of the Amazon Neptune console or the DescribeDBClusterParameters
command to verify that your DB cluster parameter group has been created or modified.
createDBClusterParameterGroupRequest - Future<DBClusterParameterGroup> createDBClusterParameterGroupAsync(CreateDBClusterParameterGroupRequest createDBClusterParameterGroupRequest, AsyncHandler<CreateDBClusterParameterGroupRequest,DBClusterParameterGroup> asyncHandler)
Creates a new DB cluster parameter group.
Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.
A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster. When you associate a new DB cluster parameter group with a running DB cluster, you need to reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.
After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB
cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon Neptune to
fully complete the create action before the DB cluster parameter group is used as the default for a new DB
cluster. This is especially important for parameters that are critical when creating the default database for a
DB cluster, such as the character set for the default database defined by the character_set_database
parameter. You can use the Parameter Groups option of the Amazon Neptune console or the DescribeDBClusterParameters
command to verify that your DB cluster parameter group has been created or modified.
createDBClusterParameterGroupRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DBClusterSnapshot> createDBClusterSnapshotAsync(CreateDBClusterSnapshotRequest createDBClusterSnapshotRequest)
Creates a snapshot of a DB cluster.
createDBClusterSnapshotRequest - Future<DBClusterSnapshot> createDBClusterSnapshotAsync(CreateDBClusterSnapshotRequest createDBClusterSnapshotRequest, AsyncHandler<CreateDBClusterSnapshotRequest,DBClusterSnapshot> asyncHandler)
Creates a snapshot of a DB cluster.
createDBClusterSnapshotRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DBInstance> createDBInstanceAsync(CreateDBInstanceRequest createDBInstanceRequest)
Creates a new DB instance.
createDBInstanceRequest - Future<DBInstance> createDBInstanceAsync(CreateDBInstanceRequest createDBInstanceRequest, AsyncHandler<CreateDBInstanceRequest,DBInstance> asyncHandler)
Creates a new DB instance.
createDBInstanceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DBParameterGroup> createDBParameterGroupAsync(CreateDBParameterGroupRequest createDBParameterGroupRequest)
Creates a new DB parameter group.
A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.
After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance
that uses that DB parameter group as the default parameter group. This allows Amazon Neptune to fully complete
the create action before the parameter group is used as the default for a new DB instance. This is especially
important for parameters that are critical when creating the default database for a DB instance, such as the
character set for the default database defined by the character_set_database parameter. You can use
the Parameter Groups option of the Amazon Neptune console or the DescribeDBParameters command to
verify that your DB parameter group has been created or modified.
createDBParameterGroupRequest - Future<DBParameterGroup> createDBParameterGroupAsync(CreateDBParameterGroupRequest createDBParameterGroupRequest, AsyncHandler<CreateDBParameterGroupRequest,DBParameterGroup> asyncHandler)
Creates a new DB parameter group.
A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.
After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance
that uses that DB parameter group as the default parameter group. This allows Amazon Neptune to fully complete
the create action before the parameter group is used as the default for a new DB instance. This is especially
important for parameters that are critical when creating the default database for a DB instance, such as the
character set for the default database defined by the character_set_database parameter. You can use
the Parameter Groups option of the Amazon Neptune console or the DescribeDBParameters command to
verify that your DB parameter group has been created or modified.
createDBParameterGroupRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DBSubnetGroup> createDBSubnetGroupAsync(CreateDBSubnetGroupRequest createDBSubnetGroupRequest)
Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region.
createDBSubnetGroupRequest - Future<DBSubnetGroup> createDBSubnetGroupAsync(CreateDBSubnetGroupRequest createDBSubnetGroupRequest, AsyncHandler<CreateDBSubnetGroupRequest,DBSubnetGroup> asyncHandler)
Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region.
createDBSubnetGroupRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<EventSubscription> createEventSubscriptionAsync(CreateEventSubscriptionRequest createEventSubscriptionRequest)
Creates an event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the Neptune console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.
You can specify the type of source (SourceType) you want to be notified of, provide a list of Neptune sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.
If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your Neptune sources. If you do not specify either the SourceType nor the SourceIdentifier, you are notified of events generated from all Neptune sources belonging to your customer account.
createEventSubscriptionRequest - Future<EventSubscription> createEventSubscriptionAsync(CreateEventSubscriptionRequest createEventSubscriptionRequest, AsyncHandler<CreateEventSubscriptionRequest,EventSubscription> asyncHandler)
Creates an event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the Neptune console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.
You can specify the type of source (SourceType) you want to be notified of, provide a list of Neptune sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.
If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your Neptune sources. If you do not specify either the SourceType nor the SourceIdentifier, you are notified of events generated from all Neptune sources belonging to your customer account.
createEventSubscriptionRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DBCluster> deleteDBClusterAsync(DeleteDBClusterRequest deleteDBClusterRequest)
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.
deleteDBClusterRequest - Future<DBCluster> deleteDBClusterAsync(DeleteDBClusterRequest deleteDBClusterRequest, AsyncHandler<DeleteDBClusterRequest,DBCluster> asyncHandler)
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.
deleteDBClusterRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteDBClusterParameterGroupResult> deleteDBClusterParameterGroupAsync(DeleteDBClusterParameterGroupRequest deleteDBClusterParameterGroupRequest)
Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.
deleteDBClusterParameterGroupRequest - Future<DeleteDBClusterParameterGroupResult> deleteDBClusterParameterGroupAsync(DeleteDBClusterParameterGroupRequest deleteDBClusterParameterGroupRequest, AsyncHandler<DeleteDBClusterParameterGroupRequest,DeleteDBClusterParameterGroupResult> asyncHandler)
Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.
deleteDBClusterParameterGroupRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DBClusterSnapshot> deleteDBClusterSnapshotAsync(DeleteDBClusterSnapshotRequest deleteDBClusterSnapshotRequest)
Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.
The DB cluster snapshot must be in the available state to be deleted.
deleteDBClusterSnapshotRequest - Future<DBClusterSnapshot> deleteDBClusterSnapshotAsync(DeleteDBClusterSnapshotRequest deleteDBClusterSnapshotRequest, AsyncHandler<DeleteDBClusterSnapshotRequest,DBClusterSnapshot> asyncHandler)
Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.
The DB cluster snapshot must be in the available state to be deleted.
deleteDBClusterSnapshotRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DBInstance> deleteDBInstanceAsync(DeleteDBInstanceRequest deleteDBInstanceRequest)
The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all
automated backups for that instance are deleted and can't be recovered. Manual DB snapshots of the DB instance to
be deleted by DeleteDBInstance are not deleted.
If you request a final DB snapshot the status of the Amazon Neptune DB instance is deleting until
the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this
operation. The action can't be canceled or reverted once submitted.
Note that when a DB instance is in a failure state and has a status of failed,
incompatible-restore, or incompatible-network, you can only delete it when the
SkipFinalSnapshot parameter is set to true.
If the specified DB instance is part of a DB cluster, you can't delete the DB instance if both of the following conditions are true:
The DB cluster is a Read Replica of another DB cluster.
The DB instance is the only instance in the DB cluster.
To delete a DB instance in this case, first call the PromoteReadReplicaDBCluster API action to promote the
DB cluster so it's no longer a Read Replica. After the promotion completes, then call the
DeleteDBInstance API action to delete the final instance in the DB cluster.
deleteDBInstanceRequest - Future<DBInstance> deleteDBInstanceAsync(DeleteDBInstanceRequest deleteDBInstanceRequest, AsyncHandler<DeleteDBInstanceRequest,DBInstance> asyncHandler)
The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all
automated backups for that instance are deleted and can't be recovered. Manual DB snapshots of the DB instance to
be deleted by DeleteDBInstance are not deleted.
If you request a final DB snapshot the status of the Amazon Neptune DB instance is deleting until
the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this
operation. The action can't be canceled or reverted once submitted.
Note that when a DB instance is in a failure state and has a status of failed,
incompatible-restore, or incompatible-network, you can only delete it when the
SkipFinalSnapshot parameter is set to true.
If the specified DB instance is part of a DB cluster, you can't delete the DB instance if both of the following conditions are true:
The DB cluster is a Read Replica of another DB cluster.
The DB instance is the only instance in the DB cluster.
To delete a DB instance in this case, first call the PromoteReadReplicaDBCluster API action to promote the
DB cluster so it's no longer a Read Replica. After the promotion completes, then call the
DeleteDBInstance API action to delete the final instance in the DB cluster.
deleteDBInstanceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteDBParameterGroupResult> deleteDBParameterGroupAsync(DeleteDBParameterGroupRequest deleteDBParameterGroupRequest)
Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted can't be associated with any DB instances.
deleteDBParameterGroupRequest - Future<DeleteDBParameterGroupResult> deleteDBParameterGroupAsync(DeleteDBParameterGroupRequest deleteDBParameterGroupRequest, AsyncHandler<DeleteDBParameterGroupRequest,DeleteDBParameterGroupResult> asyncHandler)
Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted can't be associated with any DB instances.
deleteDBParameterGroupRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteDBSubnetGroupResult> deleteDBSubnetGroupAsync(DeleteDBSubnetGroupRequest deleteDBSubnetGroupRequest)
Deletes a DB subnet group.
The specified database subnet group must not be associated with any DB instances.
deleteDBSubnetGroupRequest - Future<DeleteDBSubnetGroupResult> deleteDBSubnetGroupAsync(DeleteDBSubnetGroupRequest deleteDBSubnetGroupRequest, AsyncHandler<DeleteDBSubnetGroupRequest,DeleteDBSubnetGroupResult> asyncHandler)
Deletes a DB subnet group.
The specified database subnet group must not be associated with any DB instances.
deleteDBSubnetGroupRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<EventSubscription> deleteEventSubscriptionAsync(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest)
Deletes an event notification subscription.
deleteEventSubscriptionRequest - Future<EventSubscription> deleteEventSubscriptionAsync(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest, AsyncHandler<DeleteEventSubscriptionRequest,EventSubscription> asyncHandler)
Deletes an event notification subscription.
deleteEventSubscriptionRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeDBClusterParameterGroupsResult> describeDBClusterParameterGroupsAsync(DescribeDBClusterParameterGroupsRequest describeDBClusterParameterGroupsRequest)
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.
describeDBClusterParameterGroupsRequest - Future<DescribeDBClusterParameterGroupsResult> describeDBClusterParameterGroupsAsync(DescribeDBClusterParameterGroupsRequest describeDBClusterParameterGroupsRequest, AsyncHandler<DescribeDBClusterParameterGroupsRequest,DescribeDBClusterParameterGroupsResult> asyncHandler)
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.
describeDBClusterParameterGroupsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeDBClusterParametersResult> describeDBClusterParametersAsync(DescribeDBClusterParametersRequest describeDBClusterParametersRequest)
Returns the detailed parameter list for a particular DB cluster parameter group.
describeDBClusterParametersRequest - Future<DescribeDBClusterParametersResult> describeDBClusterParametersAsync(DescribeDBClusterParametersRequest describeDBClusterParametersRequest, AsyncHandler<DescribeDBClusterParametersRequest,DescribeDBClusterParametersResult> asyncHandler)
Returns the detailed parameter list for a particular DB cluster parameter group.
describeDBClusterParametersRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DBClusterSnapshotAttributesResult> describeDBClusterSnapshotAttributesAsync(DescribeDBClusterSnapshotAttributesRequest describeDBClusterSnapshotAttributesRequest)
Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.
When sharing snapshots with other AWS accounts, DescribeDBClusterSnapshotAttributes returns the
restore attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the
manual DB cluster snapshot. If all is included in the list of values for the restore
attribute, then the manual DB cluster snapshot is public and can be copied or restored by all AWS accounts.
To add or remove access for an AWS account to copy or restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.
describeDBClusterSnapshotAttributesRequest - Future<DBClusterSnapshotAttributesResult> describeDBClusterSnapshotAttributesAsync(DescribeDBClusterSnapshotAttributesRequest describeDBClusterSnapshotAttributesRequest, AsyncHandler<DescribeDBClusterSnapshotAttributesRequest,DBClusterSnapshotAttributesResult> asyncHandler)
Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.
When sharing snapshots with other AWS accounts, DescribeDBClusterSnapshotAttributes returns the
restore attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the
manual DB cluster snapshot. If all is included in the list of values for the restore
attribute, then the manual DB cluster snapshot is public and can be copied or restored by all AWS accounts.
To add or remove access for an AWS account to copy or restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.
describeDBClusterSnapshotAttributesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeDBClusterSnapshotsResult> describeDBClusterSnapshotsAsync(DescribeDBClusterSnapshotsRequest describeDBClusterSnapshotsRequest)
Returns information about DB cluster snapshots. This API action supports pagination.
describeDBClusterSnapshotsRequest - Future<DescribeDBClusterSnapshotsResult> describeDBClusterSnapshotsAsync(DescribeDBClusterSnapshotsRequest describeDBClusterSnapshotsRequest, AsyncHandler<DescribeDBClusterSnapshotsRequest,DescribeDBClusterSnapshotsResult> asyncHandler)
Returns information about DB cluster snapshots. This API action supports pagination.
describeDBClusterSnapshotsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeDBClustersResult> describeDBClustersAsync(DescribeDBClustersRequest describeDBClustersRequest)
Returns information about provisioned DB clusters. This API supports pagination.
describeDBClustersRequest - Future<DescribeDBClustersResult> describeDBClustersAsync(DescribeDBClustersRequest describeDBClustersRequest, AsyncHandler<DescribeDBClustersRequest,DescribeDBClustersResult> asyncHandler)
Returns information about provisioned DB clusters. This API supports pagination.
describeDBClustersRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeDBEngineVersionsResult> describeDBEngineVersionsAsync(DescribeDBEngineVersionsRequest describeDBEngineVersionsRequest)
Returns a list of the available DB engines.
describeDBEngineVersionsRequest - Future<DescribeDBEngineVersionsResult> describeDBEngineVersionsAsync(DescribeDBEngineVersionsRequest describeDBEngineVersionsRequest, AsyncHandler<DescribeDBEngineVersionsRequest,DescribeDBEngineVersionsResult> asyncHandler)
Returns a list of the available DB engines.
describeDBEngineVersionsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeDBInstancesResult> describeDBInstancesAsync(DescribeDBInstancesRequest describeDBInstancesRequest)
Returns information about provisioned instances. This API supports pagination.
describeDBInstancesRequest - Future<DescribeDBInstancesResult> describeDBInstancesAsync(DescribeDBInstancesRequest describeDBInstancesRequest, AsyncHandler<DescribeDBInstancesRequest,DescribeDBInstancesResult> asyncHandler)
Returns information about provisioned instances. This API supports pagination.
describeDBInstancesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeDBParameterGroupsResult> describeDBParameterGroupsAsync(DescribeDBParameterGroupsRequest describeDBParameterGroupsRequest)
Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is
specified, the list will contain only the description of the specified DB parameter group.
describeDBParameterGroupsRequest - Future<DescribeDBParameterGroupsResult> describeDBParameterGroupsAsync(DescribeDBParameterGroupsRequest describeDBParameterGroupsRequest, AsyncHandler<DescribeDBParameterGroupsRequest,DescribeDBParameterGroupsResult> asyncHandler)
Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is
specified, the list will contain only the description of the specified DB parameter group.
describeDBParameterGroupsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeDBParametersResult> describeDBParametersAsync(DescribeDBParametersRequest describeDBParametersRequest)
Returns the detailed parameter list for a particular DB parameter group.
describeDBParametersRequest - Future<DescribeDBParametersResult> describeDBParametersAsync(DescribeDBParametersRequest describeDBParametersRequest, AsyncHandler<DescribeDBParametersRequest,DescribeDBParametersResult> asyncHandler)
Returns the detailed parameter list for a particular DB parameter group.
describeDBParametersRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeDBSubnetGroupsResult> describeDBSubnetGroupsAsync(DescribeDBSubnetGroupsRequest describeDBSubnetGroupsRequest)
Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
describeDBSubnetGroupsRequest - Future<DescribeDBSubnetGroupsResult> describeDBSubnetGroupsAsync(DescribeDBSubnetGroupsRequest describeDBSubnetGroupsRequest, AsyncHandler<DescribeDBSubnetGroupsRequest,DescribeDBSubnetGroupsResult> asyncHandler)
Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.
For an overview of CIDR ranges, go to the Wikipedia Tutorial.
describeDBSubnetGroupsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<EngineDefaults> describeEngineDefaultClusterParametersAsync(DescribeEngineDefaultClusterParametersRequest describeEngineDefaultClusterParametersRequest)
Returns the default engine and system parameter information for the cluster database engine.
describeEngineDefaultClusterParametersRequest - Future<EngineDefaults> describeEngineDefaultClusterParametersAsync(DescribeEngineDefaultClusterParametersRequest describeEngineDefaultClusterParametersRequest, AsyncHandler<DescribeEngineDefaultClusterParametersRequest,EngineDefaults> asyncHandler)
Returns the default engine and system parameter information for the cluster database engine.
describeEngineDefaultClusterParametersRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<EngineDefaults> describeEngineDefaultParametersAsync(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest)
Returns the default engine and system parameter information for the specified database engine.
describeEngineDefaultParametersRequest - Future<EngineDefaults> describeEngineDefaultParametersAsync(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest, AsyncHandler<DescribeEngineDefaultParametersRequest,EngineDefaults> asyncHandler)
Returns the default engine and system parameter information for the specified database engine.
describeEngineDefaultParametersRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeEventCategoriesResult> describeEventCategoriesAsync(DescribeEventCategoriesRequest describeEventCategoriesRequest)
Displays a list of categories for all event source types, or, if specified, for a specified source type.
describeEventCategoriesRequest - Future<DescribeEventCategoriesResult> describeEventCategoriesAsync(DescribeEventCategoriesRequest describeEventCategoriesRequest, AsyncHandler<DescribeEventCategoriesRequest,DescribeEventCategoriesResult> asyncHandler)
Displays a list of categories for all event source types, or, if specified, for a specified source type.
describeEventCategoriesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeEventSubscriptionsResult> describeEventSubscriptionsAsync(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest)
Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.
If you specify a SubscriptionName, lists the description for that subscription.
describeEventSubscriptionsRequest - Future<DescribeEventSubscriptionsResult> describeEventSubscriptionsAsync(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest, AsyncHandler<DescribeEventSubscriptionsRequest,DescribeEventSubscriptionsResult> asyncHandler)
Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.
If you specify a SubscriptionName, lists the description for that subscription.
describeEventSubscriptionsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeEventsResult> describeEventsAsync(DescribeEventsRequest describeEventsRequest)
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.
describeEventsRequest - Future<DescribeEventsResult> describeEventsAsync(DescribeEventsRequest describeEventsRequest, AsyncHandler<DescribeEventsRequest,DescribeEventsResult> asyncHandler)
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.
describeEventsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeOrderableDBInstanceOptionsResult> describeOrderableDBInstanceOptionsAsync(DescribeOrderableDBInstanceOptionsRequest describeOrderableDBInstanceOptionsRequest)
Returns a list of orderable DB instance options for the specified engine.
describeOrderableDBInstanceOptionsRequest - Future<DescribeOrderableDBInstanceOptionsResult> describeOrderableDBInstanceOptionsAsync(DescribeOrderableDBInstanceOptionsRequest describeOrderableDBInstanceOptionsRequest, AsyncHandler<DescribeOrderableDBInstanceOptionsRequest,DescribeOrderableDBInstanceOptionsResult> asyncHandler)
Returns a list of orderable DB instance options for the specified engine.
describeOrderableDBInstanceOptionsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribePendingMaintenanceActionsResult> describePendingMaintenanceActionsAsync(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest)
Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
describePendingMaintenanceActionsRequest - Future<DescribePendingMaintenanceActionsResult> describePendingMaintenanceActionsAsync(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest, AsyncHandler<DescribePendingMaintenanceActionsRequest,DescribePendingMaintenanceActionsResult> asyncHandler)
Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
describePendingMaintenanceActionsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ValidDBInstanceModificationsMessage> describeValidDBInstanceModificationsAsync(DescribeValidDBInstanceModificationsRequest describeValidDBInstanceModificationsRequest)
You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance.
describeValidDBInstanceModificationsRequest - Future<ValidDBInstanceModificationsMessage> describeValidDBInstanceModificationsAsync(DescribeValidDBInstanceModificationsRequest describeValidDBInstanceModificationsRequest, AsyncHandler<DescribeValidDBInstanceModificationsRequest,ValidDBInstanceModificationsMessage> asyncHandler)
You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance.
describeValidDBInstanceModificationsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DBCluster> failoverDBClusterAsync(FailoverDBClusterRequest failoverDBClusterRequest)
Forces a failover for a DB cluster.
A failover for a DB cluster promotes one of the Read Replicas (read-only instances) in the DB cluster to be the primary instance (the cluster writer).
Amazon Neptune will automatically fail over to a Read Replica, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a primary instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.
failoverDBClusterRequest - Future<DBCluster> failoverDBClusterAsync(FailoverDBClusterRequest failoverDBClusterRequest, AsyncHandler<FailoverDBClusterRequest,DBCluster> asyncHandler)
Forces a failover for a DB cluster.
A failover for a DB cluster promotes one of the Read Replicas (read-only instances) in the DB cluster to be the primary instance (the cluster writer).
Amazon Neptune will automatically fail over to a Read Replica, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a primary instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.
failoverDBClusterRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all tags on an Amazon Neptune resource.
listTagsForResourceRequest - Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Lists all tags on an Amazon Neptune resource.
listTagsForResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DBCluster> modifyDBClusterAsync(ModifyDBClusterRequest modifyDBClusterRequest)
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.
modifyDBClusterRequest - Future<DBCluster> modifyDBClusterAsync(ModifyDBClusterRequest modifyDBClusterRequest, AsyncHandler<ModifyDBClusterRequest,DBCluster> asyncHandler)
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.
modifyDBClusterRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ModifyDBClusterParameterGroupResult> modifyDBClusterParameterGroupAsync(ModifyDBClusterParameterGroupRequest modifyDBClusterParameterGroupRequest)
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.
Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB cluster associated with the parameter group before the change can take effect.
After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB
cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon Neptune to
fully complete the create action before the parameter group is used as the default for a new DB cluster. This is
especially important for parameters that are critical when creating the default database for a DB cluster, such
as the character set for the default database defined by the character_set_database parameter. You
can use the Parameter Groups option of the Amazon Neptune console or the
DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or
modified.
modifyDBClusterParameterGroupRequest - Future<ModifyDBClusterParameterGroupResult> modifyDBClusterParameterGroupAsync(ModifyDBClusterParameterGroupRequest modifyDBClusterParameterGroupRequest, AsyncHandler<ModifyDBClusterParameterGroupRequest,ModifyDBClusterParameterGroupResult> asyncHandler)
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.
Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB cluster associated with the parameter group before the change can take effect.
After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB
cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon Neptune to
fully complete the create action before the parameter group is used as the default for a new DB cluster. This is
especially important for parameters that are critical when creating the default database for a DB cluster, such
as the character set for the default database defined by the character_set_database parameter. You
can use the Parameter Groups option of the Amazon Neptune console or the
DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or
modified.
modifyDBClusterParameterGroupRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DBClusterSnapshotAttributesResult> modifyDBClusterSnapshotAttributeAsync(ModifyDBClusterSnapshotAttributeRequest modifyDBClusterSnapshotAttributeRequest)
Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.
To share a manual DB cluster snapshot with other AWS accounts, specify restore as the
AttributeName and use the ValuesToAdd parameter to add a list of IDs of the AWS
accounts that are authorized to restore the manual DB cluster snapshot. Use the value all to make
the manual DB cluster snapshot public, which means that it can be copied or restored by all AWS accounts. Do not
add the all value for any manual DB cluster snapshots that contain private information that you
don't want available to all AWS accounts. If a manual DB cluster snapshot is encrypted, it can be shared, but
only by specifying a list of authorized AWS account IDs for the ValuesToAdd parameter. You can't use
all as a value for that parameter in this case.
To view which AWS accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot public or private, use the DescribeDBClusterSnapshotAttributes API action.
modifyDBClusterSnapshotAttributeRequest - Future<DBClusterSnapshotAttributesResult> modifyDBClusterSnapshotAttributeAsync(ModifyDBClusterSnapshotAttributeRequest modifyDBClusterSnapshotAttributeRequest, AsyncHandler<ModifyDBClusterSnapshotAttributeRequest,DBClusterSnapshotAttributesResult> asyncHandler)
Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.
To share a manual DB cluster snapshot with other AWS accounts, specify restore as the
AttributeName and use the ValuesToAdd parameter to add a list of IDs of the AWS
accounts that are authorized to restore the manual DB cluster snapshot. Use the value all to make
the manual DB cluster snapshot public, which means that it can be copied or restored by all AWS accounts. Do not
add the all value for any manual DB cluster snapshots that contain private information that you
don't want available to all AWS accounts. If a manual DB cluster snapshot is encrypted, it can be shared, but
only by specifying a list of authorized AWS account IDs for the ValuesToAdd parameter. You can't use
all as a value for that parameter in this case.
To view which AWS accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot public or private, use the DescribeDBClusterSnapshotAttributes API action.
modifyDBClusterSnapshotAttributeRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DBInstance> modifyDBInstanceAsync(ModifyDBInstanceRequest modifyDBInstanceRequest)
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.
modifyDBInstanceRequest - Future<DBInstance> modifyDBInstanceAsync(ModifyDBInstanceRequest modifyDBInstanceRequest, AsyncHandler<ModifyDBInstanceRequest,DBInstance> asyncHandler)
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.
modifyDBInstanceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ModifyDBParameterGroupResult> modifyDBParameterGroupAsync(ModifyDBParameterGroupRequest modifyDBParameterGroupRequest)
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.
Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance associated with the parameter group before the change can take effect.
After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance
that uses that DB parameter group as the default parameter group. This allows Amazon Neptune to fully complete
the modify action before the parameter group is used as the default for a new DB instance. This is especially
important for parameters that are critical when creating the default database for a DB instance, such as the
character set for the default database defined by the character_set_database parameter. You can use
the Parameter Groups option of the Amazon Neptune console or the DescribeDBParameters command to
verify that your DB parameter group has been created or modified.
modifyDBParameterGroupRequest - Future<ModifyDBParameterGroupResult> modifyDBParameterGroupAsync(ModifyDBParameterGroupRequest modifyDBParameterGroupRequest, AsyncHandler<ModifyDBParameterGroupRequest,ModifyDBParameterGroupResult> asyncHandler)
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.
Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance associated with the parameter group before the change can take effect.
After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance
that uses that DB parameter group as the default parameter group. This allows Amazon Neptune to fully complete
the modify action before the parameter group is used as the default for a new DB instance. This is especially
important for parameters that are critical when creating the default database for a DB instance, such as the
character set for the default database defined by the character_set_database parameter. You can use
the Parameter Groups option of the Amazon Neptune console or the DescribeDBParameters command to
verify that your DB parameter group has been created or modified.
modifyDBParameterGroupRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DBSubnetGroup> modifyDBSubnetGroupAsync(ModifyDBSubnetGroupRequest modifyDBSubnetGroupRequest)
Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region.
modifyDBSubnetGroupRequest - Future<DBSubnetGroup> modifyDBSubnetGroupAsync(ModifyDBSubnetGroupRequest modifyDBSubnetGroupRequest, AsyncHandler<ModifyDBSubnetGroupRequest,DBSubnetGroup> asyncHandler)
Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region.
modifyDBSubnetGroupRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<EventSubscription> modifyEventSubscriptionAsync(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest)
Modifies an existing event notification subscription. Note that you can't modify the source identifiers using this call; to change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.
You can see a list of the event categories for a given SourceType by using the DescribeEventCategories action.
modifyEventSubscriptionRequest - Future<EventSubscription> modifyEventSubscriptionAsync(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest, AsyncHandler<ModifyEventSubscriptionRequest,EventSubscription> asyncHandler)
Modifies an existing event notification subscription. Note that you can't modify the source identifiers using this call; to change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.
You can see a list of the event categories for a given SourceType by using the DescribeEventCategories action.
modifyEventSubscriptionRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DBCluster> promoteReadReplicaDBClusterAsync(PromoteReadReplicaDBClusterRequest promoteReadReplicaDBClusterRequest)
Promotes a Read Replica DB cluster to a standalone DB cluster.
promoteReadReplicaDBClusterRequest - Future<DBCluster> promoteReadReplicaDBClusterAsync(PromoteReadReplicaDBClusterRequest promoteReadReplicaDBClusterRequest, AsyncHandler<PromoteReadReplicaDBClusterRequest,DBCluster> asyncHandler)
Promotes a Read Replica DB cluster to a standalone DB cluster.
promoteReadReplicaDBClusterRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DBInstance> rebootDBInstanceAsync(RebootDBInstanceRequest rebootDBInstanceRequest)
You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect.
Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.
rebootDBInstanceRequest - Future<DBInstance> rebootDBInstanceAsync(RebootDBInstanceRequest rebootDBInstanceRequest, AsyncHandler<RebootDBInstanceRequest,DBInstance> asyncHandler)
You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect.
Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.
rebootDBInstanceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<RemoveRoleFromDBClusterResult> removeRoleFromDBClusterAsync(RemoveRoleFromDBClusterRequest removeRoleFromDBClusterRequest)
Disassociates an Identity and Access Management (IAM) role from a DB cluster.
removeRoleFromDBClusterRequest - Future<RemoveRoleFromDBClusterResult> removeRoleFromDBClusterAsync(RemoveRoleFromDBClusterRequest removeRoleFromDBClusterRequest, AsyncHandler<RemoveRoleFromDBClusterRequest,RemoveRoleFromDBClusterResult> asyncHandler)
Disassociates an Identity and Access Management (IAM) role from a DB cluster.
removeRoleFromDBClusterRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<EventSubscription> removeSourceIdentifierFromSubscriptionAsync(RemoveSourceIdentifierFromSubscriptionRequest removeSourceIdentifierFromSubscriptionRequest)
Removes a source identifier from an existing event notification subscription.
removeSourceIdentifierFromSubscriptionRequest - Future<EventSubscription> removeSourceIdentifierFromSubscriptionAsync(RemoveSourceIdentifierFromSubscriptionRequest removeSourceIdentifierFromSubscriptionRequest, AsyncHandler<RemoveSourceIdentifierFromSubscriptionRequest,EventSubscription> asyncHandler)
Removes a source identifier from an existing event notification subscription.
removeSourceIdentifierFromSubscriptionRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<RemoveTagsFromResourceResult> removeTagsFromResourceAsync(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
Removes metadata tags from an Amazon Neptune resource.
removeTagsFromResourceRequest - Future<RemoveTagsFromResourceResult> removeTagsFromResourceAsync(RemoveTagsFromResourceRequest removeTagsFromResourceRequest, AsyncHandler<RemoveTagsFromResourceRequest,RemoveTagsFromResourceResult> asyncHandler)
Removes metadata tags from an Amazon Neptune resource.
removeTagsFromResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ResetDBClusterParameterGroupResult> resetDBClusterParameterGroupAsync(ResetDBClusterParameterGroupRequest resetDBClusterParameterGroupRequest)
Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit
a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster
parameter group, specify the DBClusterParameterGroupName and ResetAllParameters
parameters.
When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to
pending-reboot to take effect on the next DB instance restart or RebootDBInstance request.
You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static
parameter to apply to.
resetDBClusterParameterGroupRequest - Future<ResetDBClusterParameterGroupResult> resetDBClusterParameterGroupAsync(ResetDBClusterParameterGroupRequest resetDBClusterParameterGroupRequest, AsyncHandler<ResetDBClusterParameterGroupRequest,ResetDBClusterParameterGroupResult> asyncHandler)
Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit
a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster
parameter group, specify the DBClusterParameterGroupName and ResetAllParameters
parameters.
When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to
pending-reboot to take effect on the next DB instance restart or RebootDBInstance request.
You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static
parameter to apply to.
resetDBClusterParameterGroupRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ResetDBParameterGroupResult> resetDBParameterGroupAsync(ResetDBParameterGroupRequest resetDBParameterGroupRequest)
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.
resetDBParameterGroupRequest - Future<ResetDBParameterGroupResult> resetDBParameterGroupAsync(ResetDBParameterGroupRequest resetDBParameterGroupRequest, AsyncHandler<ResetDBParameterGroupRequest,ResetDBParameterGroupResult> asyncHandler)
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.
resetDBParameterGroupRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DBCluster> restoreDBClusterFromSnapshotAsync(RestoreDBClusterFromSnapshotRequest restoreDBClusterFromSnapshotRequest)
Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
restoreDBClusterFromSnapshotRequest - Future<DBCluster> restoreDBClusterFromSnapshotAsync(RestoreDBClusterFromSnapshotRequest restoreDBClusterFromSnapshotRequest, AsyncHandler<RestoreDBClusterFromSnapshotRequest,DBCluster> asyncHandler)
Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
restoreDBClusterFromSnapshotRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DBCluster> restoreDBClusterToPointInTimeAsync(RestoreDBClusterToPointInTimeRequest restoreDBClusterToPointInTimeRequest)
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.
This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the
CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of
the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the
RestoreDBClusterToPointInTime action has completed and the DB cluster is available.
restoreDBClusterToPointInTimeRequest - Future<DBCluster> restoreDBClusterToPointInTimeAsync(RestoreDBClusterToPointInTimeRequest restoreDBClusterToPointInTimeRequest, AsyncHandler<RestoreDBClusterToPointInTimeRequest,DBCluster> asyncHandler)
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.
This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the
CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of
the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the
RestoreDBClusterToPointInTime action has completed and the DB cluster is available.
restoreDBClusterToPointInTimeRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Copyright © 2019. All rights reserved.