JavaScript is disabled on your browser.
Skip navigation links

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.
com.amazonaws.services.neptune

Interface AmazonNeptune

  • All Known Subinterfaces:
    AmazonNeptuneAsync
    All Known Implementing Classes:
    AbstractAmazonNeptune, AbstractAmazonNeptuneAsync, AmazonNeptuneAsyncClient, AmazonNeptuneClient 

    @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonNeptune
    Interface for accessing Amazon Neptune.

    Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonNeptune instead.

    Amazon Neptune

    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.

    • Method Detail

      • addTagsToResource

        AddTagsToResourceResult addTagsToResource(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.

        Parameters:
        addTagsToResourceRequest -
        Returns:
        Result of the AddTagsToResource operation returned by the service.
        Throws:
        DBInstanceNotFoundException - DBInstanceIdentifier does not refer to an existing DB instance.
        DBSnapshotNotFoundException - DBSnapshotIdentifier does not refer to an existing DB snapshot.
        DBClusterNotFoundException - DBClusterIdentifier does not refer to an existing DB cluster.
        See Also:
        AWS API Documentation

      • createDBClusterParameterGroup

        DBClusterParameterGroup createDBClusterParameterGroup(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.

        Parameters:
        createDBClusterParameterGroupRequest -
        Returns:
        Result of the CreateDBClusterParameterGroup operation returned by the service.
        Throws:
        DBParameterGroupQuotaExceededException - Request would result in user exceeding the allowed number of DB parameter groups.
        DBParameterGroupAlreadyExistsException - A DB parameter group with the same name exists.
        See Also:
        AWS API Documentation

      • createDBParameterGroup

        DBParameterGroup createDBParameterGroup(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.

        Parameters:
        createDBParameterGroupRequest -
        Returns:
        Result of the CreateDBParameterGroup operation returned by the service.
        Throws:
        DBParameterGroupQuotaExceededException - Request would result in user exceeding the allowed number of DB parameter groups.
        DBParameterGroupAlreadyExistsException - A DB parameter group with the same name exists.
        See Also:
        AWS API Documentation

      • createEventSubscription

        EventSubscription createEventSubscription(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.

        Parameters:
        createEventSubscriptionRequest -
        Returns:
        Result of the CreateEventSubscription operation returned by the service.
        Throws:
        EventSubscriptionQuotaExceededException - You have exceeded the number of events you can subscribe to.
        SubscriptionAlreadyExistException - This subscription already exists.
        SNSInvalidTopicException - The SNS topic is invalid.
        SNSNoAuthorizationException - There is no SNS authorization.
        SNSTopicArnNotFoundException - The ARN of the SNS topic could not be found.
        SubscriptionCategoryNotFoundException - The designated subscription category could not be found.
        SourceNotFoundException - The source could not be found.
        See Also:
        AWS API Documentation

      • createGlobalCluster

        GlobalCluster createGlobalCluster(CreateGlobalClusterRequest createGlobalClusterRequest)

        Creates a Neptune global database spread across multiple Amazon Regions. The global database contains a single primary cluster with read-write capability, and read-only secondary clusters that receive data from the primary cluster through high-speed replication performed by the Neptune storage subsystem.

        You can create a global database that is initially empty, and then add a primary cluster and secondary clusters to it, or you can specify an existing Neptune cluster during the create operation to become the primary cluster of the global database.

        Parameters:
        createGlobalClusterRequest -
        Returns:
        Result of the CreateGlobalCluster operation returned by the service.
        Throws:
        GlobalClusterAlreadyExistsException - The GlobalClusterIdentifier already exists. Choose a new global database identifier (unique name) to create a new global database cluster.
        GlobalClusterQuotaExceededException - The number of global database clusters for this account is already at the maximum allowed.
        InvalidDBClusterStateException - The DB cluster is not in a valid state.
        DBClusterNotFoundException - DBClusterIdentifier does not refer to an existing DB cluster.
        See Also:
        AWS API Documentation

      • deleteDBCluster

        DBCluster deleteDBCluster(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.

        Note that the DB Cluster cannot be deleted if deletion protection is enabled. To delete it, you must first set its DeletionProtection field to False.

        Parameters:
        deleteDBClusterRequest -
        Returns:
        Result of the DeleteDBCluster operation returned by the service.
        Throws:
        DBClusterNotFoundException - DBClusterIdentifier does not refer to an existing DB cluster.
        InvalidDBClusterStateException - The DB cluster is not in a valid state.
        DBClusterSnapshotAlreadyExistsException - User already has a DB cluster snapshot with the given identifier.
        SnapshotQuotaExceededException - Request would result in user exceeding the allowed number of DB snapshots.
        InvalidDBClusterSnapshotStateException - The supplied value is not a valid DB cluster snapshot state.
        See Also:
        AWS API Documentation

      • deleteDBClusterParameterGroup

        DeleteDBClusterParameterGroupResult deleteDBClusterParameterGroup(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.

        Parameters:
        deleteDBClusterParameterGroupRequest -
        Returns:
        Result of the DeleteDBClusterParameterGroup operation returned by the service.
        Throws:
        InvalidDBParameterGroupStateException - The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you cannot delete it when the parameter group is in this state.
        DBParameterGroupNotFoundException - DBParameterGroupName does not refer to an existing DB parameter group.
        See Also:
        AWS API Documentation

      • deleteDBInstance

        DBInstance deleteDBInstance(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.

        You can't delete a DB instance if it is the only instance in the DB cluster, or if it has deletion protection enabled.

        Parameters:
        deleteDBInstanceRequest -
        Returns:
        Result of the DeleteDBInstance operation returned by the service.
        Throws:
        DBInstanceNotFoundException - DBInstanceIdentifier does not refer to an existing DB instance.
        InvalidDBInstanceStateException - The specified DB instance is not in the available state.
        DBSnapshotAlreadyExistsException - DBSnapshotIdentifier is already used by an existing snapshot.
        SnapshotQuotaExceededException - Request would result in user exceeding the allowed number of DB snapshots.
        InvalidDBClusterStateException - The DB cluster is not in a valid state.
        See Also:
        AWS API Documentation

      • deleteDBParameterGroup

        DeleteDBParameterGroupResult deleteDBParameterGroup(DeleteDBParameterGroupRequest deleteDBParameterGroupRequest)

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

        Parameters:
        deleteDBParameterGroupRequest -
        Returns:
        Result of the DeleteDBParameterGroup operation returned by the service.
        Throws:
        InvalidDBParameterGroupStateException - The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you cannot delete it when the parameter group is in this state.
        DBParameterGroupNotFoundException - DBParameterGroupName does not refer to an existing DB parameter group.
        See Also:
        AWS API Documentation

      • describeDBClusterEndpoints

        DescribeDBClusterEndpointsResult describeDBClusterEndpoints(DescribeDBClusterEndpointsRequest describeDBClusterEndpointsRequest)

        Returns information about endpoints for an Amazon Neptune DB cluster.

        This operation can also return information for Amazon RDS clusters and Amazon DocDB clusters.

        Parameters:
        describeDBClusterEndpointsRequest -
        Returns:
        Result of the DescribeDBClusterEndpoints operation returned by the service.
        Throws:
        DBClusterNotFoundException - DBClusterIdentifier does not refer to an existing DB cluster.
        See Also:
        AWS API Documentation

      • describeDBClusterParameterGroups

        DescribeDBClusterParameterGroupsResult describeDBClusterParameterGroups(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.

        Parameters:
        describeDBClusterParameterGroupsRequest -
        Returns:
        Result of the DescribeDBClusterParameterGroups operation returned by the service.
        Throws:
        DBParameterGroupNotFoundException - DBParameterGroupName does not refer to an existing DB parameter group.
        See Also:
        AWS API Documentation

      • describeDBClusterSnapshotAttributes

        DBClusterSnapshotAttributesResult describeDBClusterSnapshotAttributes(DescribeDBClusterSnapshotAttributesRequest describeDBClusterSnapshotAttributesRequest)

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

        When sharing snapshots with other Amazon accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the Amazon 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 Amazon accounts.

        To add or remove access for an Amazon 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.

        Parameters:
        describeDBClusterSnapshotAttributesRequest -
        Returns:
        Result of the DescribeDBClusterSnapshotAttributes operation returned by the service.
        Throws:
        DBClusterSnapshotNotFoundException - DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.
        See Also:
        AWS API Documentation

      • describeDBClusters

        DescribeDBClustersResult describeDBClusters(DescribeDBClustersRequest describeDBClustersRequest)

        Returns information about provisioned DB clusters, and supports pagination.

        This operation can also return information for Amazon RDS clusters and Amazon DocDB clusters.

        Parameters:
        describeDBClustersRequest -
        Returns:
        Result of the DescribeDBClusters operation returned by the service.
        Throws:
        DBClusterNotFoundException - DBClusterIdentifier does not refer to an existing DB cluster.
        See Also:
        AWS API Documentation

      • describeDBInstances

        DescribeDBInstancesResult describeDBInstances(DescribeDBInstancesRequest describeDBInstancesRequest)

        Returns information about provisioned instances, and supports pagination.

        This operation can also return information for Amazon RDS instances and Amazon DocDB instances.

        Parameters:
        describeDBInstancesRequest -
        Returns:
        Result of the DescribeDBInstances operation returned by the service.
        Throws:
        DBInstanceNotFoundException - DBInstanceIdentifier does not refer to an existing DB instance.
        See Also:
        AWS API Documentation

      • describeDBParameterGroups

        DescribeDBParameterGroupsResult describeDBParameterGroups(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.

        Parameters:
        describeDBParameterGroupsRequest -
        Returns:
        Result of the DescribeDBParameterGroups operation returned by the service.
        Throws:
        DBParameterGroupNotFoundException - DBParameterGroupName does not refer to an existing DB parameter group.
        See Also:
        AWS API Documentation

      • describeEngineDefaultClusterParameters

        EngineDefaults describeEngineDefaultClusterParameters(DescribeEngineDefaultClusterParametersRequest describeEngineDefaultClusterParametersRequest)

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

        Parameters:
        describeEngineDefaultClusterParametersRequest -
        Returns:
        Result of the DescribeEngineDefaultClusterParameters operation returned by the service.
        See Also:
        AWS API Documentation

      • describeEngineDefaultParameters

        EngineDefaults describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest)

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

        Parameters:
        describeEngineDefaultParametersRequest -
        Returns:
        Result of the DescribeEngineDefaultParameters operation returned by the service.
        See Also:
        AWS API Documentation

      • describeEventCategories

        DescribeEventCategoriesResult describeEventCategories(DescribeEventCategoriesRequest describeEventCategoriesRequest)

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

        Parameters:
        describeEventCategoriesRequest -
        Returns:
        Result of the DescribeEventCategories operation returned by the service.
        See Also:
        AWS API Documentation

      • describeEventSubscriptions

        DescribeEventSubscriptionsResult describeEventSubscriptions(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.

        Parameters:
        describeEventSubscriptionsRequest -
        Returns:
        Result of the DescribeEventSubscriptions operation returned by the service.
        Throws:
        SubscriptionNotFoundException - The designated subscription could not be found.
        See Also:
        AWS API Documentation

      • describeEvents

        DescribeEventsResult describeEvents(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.

        Parameters:
        describeEventsRequest -
        Returns:
        Result of the DescribeEvents operation returned by the service.
        See Also:
        AWS API Documentation

      • failoverDBCluster

        DBCluster failoverDBCluster(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.

        Parameters:
        failoverDBClusterRequest -
        Returns:
        Result of the FailoverDBCluster operation returned by the service.
        Throws:
        DBClusterNotFoundException - DBClusterIdentifier does not refer to an existing DB cluster.
        InvalidDBClusterStateException - The DB cluster is not in a valid state.
        InvalidDBInstanceStateException - The specified DB instance is not in the available state.
        See Also:
        AWS API Documentation

      • failoverGlobalCluster

        GlobalCluster failoverGlobalCluster(FailoverGlobalClusterRequest failoverGlobalClusterRequest)

        Initiates the failover process for a Neptune global database.

        A failover for a Neptune global database promotes one of secondary read-only DB clusters to be the primary DB cluster and demotes the primary DB cluster to being a secondary (read-only) DB cluster. In other words, the role of the current primary DB cluster and the selected target secondary DB cluster are switched. The selected secondary DB cluster assumes full read/write capabilities for the Neptune global database.

        This action applies only to Neptune global databases. This action is only intended for use on healthy Neptune global databases with healthy Neptune DB clusters and no region-wide outages, to test disaster recovery scenarios or to reconfigure the global database topology.

        Parameters:
        failoverGlobalClusterRequest -
        Returns:
        Result of the FailoverGlobalCluster operation returned by the service.
        Throws:
        GlobalClusterNotFoundException - The GlobalClusterIdentifier doesn't refer to an existing global database cluster.
        InvalidGlobalClusterStateException - The global cluster is in an invalid state and can't perform the requested operation.
        InvalidDBClusterStateException - The DB cluster is not in a valid state.
        DBClusterNotFoundException - DBClusterIdentifier does not refer to an existing DB cluster.
        See Also:
        AWS API Documentation

      • modifyDBClusterParameterGroup

        ModifyDBClusterParameterGroupResult modifyDBClusterParameterGroup(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.

        Parameters:
        modifyDBClusterParameterGroupRequest -
        Returns:
        Result of the ModifyDBClusterParameterGroup operation returned by the service.
        Throws:
        DBParameterGroupNotFoundException - DBParameterGroupName does not refer to an existing DB parameter group.
        InvalidDBParameterGroupStateException - The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you cannot delete it when the parameter group is in this state.
        See Also:
        AWS API Documentation

      • modifyDBClusterSnapshotAttribute

        DBClusterSnapshotAttributesResult modifyDBClusterSnapshotAttribute(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 Amazon accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the Amazon 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 Amazon 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 Amazon accounts. If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.

        To view which Amazon 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.

        Parameters:
        modifyDBClusterSnapshotAttributeRequest -
        Returns:
        Result of the ModifyDBClusterSnapshotAttribute operation returned by the service.
        Throws:
        DBClusterSnapshotNotFoundException - DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.
        InvalidDBClusterSnapshotStateException - The supplied value is not a valid DB cluster snapshot state.
        SharedSnapshotQuotaExceededException - You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.
        See Also:
        AWS API Documentation

      • modifyDBParameterGroup

        ModifyDBParameterGroupResult modifyDBParameterGroup(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.

        Parameters:
        modifyDBParameterGroupRequest -
        Returns:
        Result of the ModifyDBParameterGroup operation returned by the service.
        Throws:
        DBParameterGroupNotFoundException - DBParameterGroupName does not refer to an existing DB parameter group.
        InvalidDBParameterGroupStateException - The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you cannot delete it when the parameter group is in this state.
        See Also:
        AWS API Documentation

      • modifyGlobalCluster

        GlobalCluster modifyGlobalCluster(ModifyGlobalClusterRequest modifyGlobalClusterRequest)

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

        Parameters:
        modifyGlobalClusterRequest -
        Returns:
        Result of the ModifyGlobalCluster operation returned by the service.
        Throws:
        GlobalClusterNotFoundException - The GlobalClusterIdentifier doesn't refer to an existing global database cluster.
        InvalidGlobalClusterStateException - The global cluster is in an invalid state and can't perform the requested operation.
        See Also:
        AWS API Documentation

      • rebootDBInstance

        DBInstance rebootDBInstance(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.

        Parameters:
        rebootDBInstanceRequest -
        Returns:
        Result of the RebootDBInstance operation returned by the service.
        Throws:
        InvalidDBInstanceStateException - The specified DB instance is not in the available state.
        DBInstanceNotFoundException - DBInstanceIdentifier does not refer to an existing DB instance.
        See Also:
        AWS API Documentation

      • removeFromGlobalCluster

        GlobalCluster removeFromGlobalCluster(RemoveFromGlobalClusterRequest removeFromGlobalClusterRequest)

        Detaches a Neptune DB cluster from a Neptune global database. A secondary cluster becomes a normal standalone cluster with read-write capability instead of being read-only, and no longer receives data from a the primary cluster.

        Parameters:
        removeFromGlobalClusterRequest -
        Returns:
        Result of the RemoveFromGlobalCluster operation returned by the service.
        Throws:
        GlobalClusterNotFoundException - The GlobalClusterIdentifier doesn't refer to an existing global database cluster.
        InvalidGlobalClusterStateException - The global cluster is in an invalid state and can't perform the requested operation.
        DBClusterNotFoundException - DBClusterIdentifier does not refer to an existing DB cluster.
        See Also:
        AWS API Documentation

      • resetDBClusterParameterGroup

        ResetDBClusterParameterGroupResult resetDBClusterParameterGroup(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.

        Parameters:
        resetDBClusterParameterGroupRequest -
        Returns:
        Result of the ResetDBClusterParameterGroup operation returned by the service.
        Throws:
        InvalidDBParameterGroupStateException - The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you cannot delete it when the parameter group is in this state.
        DBParameterGroupNotFoundException - DBParameterGroupName does not refer to an existing DB parameter group.
        See Also:
        AWS API Documentation

      • resetDBParameterGroup

        ResetDBParameterGroupResult resetDBParameterGroup(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.

        Parameters:
        resetDBParameterGroupRequest -
        Returns:
        Result of the ResetDBParameterGroup operation returned by the service.
        Throws:
        InvalidDBParameterGroupStateException - The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you cannot delete it when the parameter group is in this state.
        DBParameterGroupNotFoundException - DBParameterGroupName does not refer to an existing DB parameter group.
        See Also:
        AWS API Documentation

      • stopDBCluster

        DBCluster stopDBCluster(StopDBClusterRequest stopDBClusterRequest)

        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.

        Neptune also retains the transaction logs so you can do a point-in-time restore if necessary.

        Parameters:
        stopDBClusterRequest -
        Returns:
        Result of the StopDBCluster operation returned by the service.
        Throws:
        DBClusterNotFoundException - DBClusterIdentifier does not refer to an existing DB cluster.
        InvalidDBClusterStateException - The DB cluster is not in a valid state.
        InvalidDBInstanceStateException - The specified DB instance is not in the available state.
        See Also:
        AWS API Documentation

      • shutdown

        void shutdown()
        Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

      • getCachedResponseMetadata

        ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
        Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

        Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

        Parameters:
        request - The originally executed request.
        Returns:
        The response metadata for the specified request, or null if none is available.
Skip navigation links

AltStyle によって変換されたページ (->オリジナル) /