Interface NeptuneClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
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.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptiondefault AddRoleToDbClusterResponse
addRoleToDBCluster
(Consumer<AddRoleToDbClusterRequest.Builder> addRoleToDbClusterRequest) Associates an Identity and Access Management (IAM) role with an Neptune DB cluster.default AddRoleToDbClusterResponse
addRoleToDBCluster
(AddRoleToDbClusterRequest addRoleToDbClusterRequest) Associates an Identity and Access Management (IAM) role with an Neptune DB cluster.addSourceIdentifierToSubscription
(Consumer<AddSourceIdentifierToSubscriptionRequest.Builder> addSourceIdentifierToSubscriptionRequest) Adds a source identifier to an existing event notification subscription.addSourceIdentifierToSubscription
(AddSourceIdentifierToSubscriptionRequest addSourceIdentifierToSubscriptionRequest) Adds a source identifier to an existing event notification subscription.default AddTagsToResourceResponse
addTagsToResource
(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest) Adds metadata tags to an Amazon Neptune resource.default AddTagsToResourceResponse
addTagsToResource
(AddTagsToResourceRequest addTagsToResourceRequest) Adds metadata tags to an Amazon Neptune resource.applyPendingMaintenanceAction
(Consumer<ApplyPendingMaintenanceActionRequest.Builder> applyPendingMaintenanceActionRequest) Applies a pending maintenance action to a resource (for example, to a DB instance).applyPendingMaintenanceAction
(ApplyPendingMaintenanceActionRequest applyPendingMaintenanceActionRequest) Applies a pending maintenance action to a resource (for example, to a DB instance).static NeptuneClientBuilder
builder()
Create a builder that can be used to configure and create aNeptuneClient
.copyDBClusterParameterGroup
(Consumer<CopyDbClusterParameterGroupRequest.Builder> copyDbClusterParameterGroupRequest) Copies the specified DB cluster parameter group.copyDBClusterParameterGroup
(CopyDbClusterParameterGroupRequest copyDbClusterParameterGroupRequest) Copies the specified DB cluster parameter group.default CopyDbClusterSnapshotResponse
copyDBClusterSnapshot
(Consumer<CopyDbClusterSnapshotRequest.Builder> copyDbClusterSnapshotRequest) Copies a snapshot of a DB cluster.default CopyDbClusterSnapshotResponse
copyDBClusterSnapshot
(CopyDbClusterSnapshotRequest copyDbClusterSnapshotRequest) Copies a snapshot of a DB cluster.default CopyDbParameterGroupResponse
copyDBParameterGroup
(Consumer<CopyDbParameterGroupRequest.Builder> copyDbParameterGroupRequest) Copies the specified DB parameter group.default CopyDbParameterGroupResponse
copyDBParameterGroup
(CopyDbParameterGroupRequest copyDbParameterGroupRequest) Copies the specified DB parameter group.static NeptuneClient
create()
Create aNeptuneClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateDbClusterResponse
createDBCluster
(Consumer<CreateDbClusterRequest.Builder> createDbClusterRequest) Creates a new Amazon Neptune DB cluster.default CreateDbClusterResponse
createDBCluster
(CreateDbClusterRequest createDbClusterRequest) Creates a new Amazon Neptune DB cluster.default CreateDbClusterEndpointResponse
createDBClusterEndpoint
(Consumer<CreateDbClusterEndpointRequest.Builder> createDbClusterEndpointRequest) Creates a new custom endpoint and associates it with an Amazon Neptune DB cluster.default CreateDbClusterEndpointResponse
createDBClusterEndpoint
(CreateDbClusterEndpointRequest createDbClusterEndpointRequest) Creates a new custom endpoint and associates it with an Amazon Neptune DB cluster.createDBClusterParameterGroup
(Consumer<CreateDbClusterParameterGroupRequest.Builder> createDbClusterParameterGroupRequest) Creates a new DB cluster parameter group.createDBClusterParameterGroup
(CreateDbClusterParameterGroupRequest createDbClusterParameterGroupRequest) Creates a new DB cluster parameter group.default CreateDbClusterSnapshotResponse
createDBClusterSnapshot
(Consumer<CreateDbClusterSnapshotRequest.Builder> createDbClusterSnapshotRequest) Creates a snapshot of a DB cluster.default CreateDbClusterSnapshotResponse
createDBClusterSnapshot
(CreateDbClusterSnapshotRequest createDbClusterSnapshotRequest) Creates a snapshot of a DB cluster.default CreateDbInstanceResponse
createDBInstance
(Consumer<CreateDbInstanceRequest.Builder> createDbInstanceRequest) Creates a new DB instance.default CreateDbInstanceResponse
createDBInstance
(CreateDbInstanceRequest createDbInstanceRequest) Creates a new DB instance.default CreateDbParameterGroupResponse
createDBParameterGroup
(Consumer<CreateDbParameterGroupRequest.Builder> createDbParameterGroupRequest) Creates a new DB parameter group.default CreateDbParameterGroupResponse
createDBParameterGroup
(CreateDbParameterGroupRequest createDbParameterGroupRequest) Creates a new DB parameter group.default CreateDbSubnetGroupResponse
createDBSubnetGroup
(Consumer<CreateDbSubnetGroupRequest.Builder> createDbSubnetGroupRequest) Creates a new DB subnet group.default CreateDbSubnetGroupResponse
createDBSubnetGroup
(CreateDbSubnetGroupRequest createDbSubnetGroupRequest) Creates a new DB subnet group.default CreateEventSubscriptionResponse
createEventSubscription
(Consumer<CreateEventSubscriptionRequest.Builder> createEventSubscriptionRequest) Creates an event notification subscription.default CreateEventSubscriptionResponse
createEventSubscription
(CreateEventSubscriptionRequest createEventSubscriptionRequest) Creates an event notification subscription.default CreateGlobalClusterResponse
createGlobalCluster
(Consumer<CreateGlobalClusterRequest.Builder> createGlobalClusterRequest) Creates a Neptune global database spread across multiple Amazon Regions.default CreateGlobalClusterResponse
createGlobalCluster
(CreateGlobalClusterRequest createGlobalClusterRequest) Creates a Neptune global database spread across multiple Amazon Regions.default DeleteDbClusterResponse
deleteDBCluster
(Consumer<DeleteDbClusterRequest.Builder> deleteDbClusterRequest) The DeleteDBCluster action deletes a previously provisioned DB cluster.default DeleteDbClusterResponse
deleteDBCluster
(DeleteDbClusterRequest deleteDbClusterRequest) The DeleteDBCluster action deletes a previously provisioned DB cluster.default DeleteDbClusterEndpointResponse
deleteDBClusterEndpoint
(Consumer<DeleteDbClusterEndpointRequest.Builder> deleteDbClusterEndpointRequest) Deletes a custom endpoint and removes it from an Amazon Neptune DB cluster.default DeleteDbClusterEndpointResponse
deleteDBClusterEndpoint
(DeleteDbClusterEndpointRequest deleteDbClusterEndpointRequest) Deletes a custom endpoint and removes it from an Amazon Neptune DB cluster.deleteDBClusterParameterGroup
(Consumer<DeleteDbClusterParameterGroupRequest.Builder> deleteDbClusterParameterGroupRequest) Deletes a specified DB cluster parameter group.deleteDBClusterParameterGroup
(DeleteDbClusterParameterGroupRequest deleteDbClusterParameterGroupRequest) Deletes a specified DB cluster parameter group.default DeleteDbClusterSnapshotResponse
deleteDBClusterSnapshot
(Consumer<DeleteDbClusterSnapshotRequest.Builder> deleteDbClusterSnapshotRequest) Deletes a DB cluster snapshot.default DeleteDbClusterSnapshotResponse
deleteDBClusterSnapshot
(DeleteDbClusterSnapshotRequest deleteDbClusterSnapshotRequest) Deletes a DB cluster snapshot.default DeleteDbInstanceResponse
deleteDBInstance
(Consumer<DeleteDbInstanceRequest.Builder> deleteDbInstanceRequest) The DeleteDBInstance action deletes a previously provisioned DB instance.default DeleteDbInstanceResponse
deleteDBInstance
(DeleteDbInstanceRequest deleteDbInstanceRequest) The DeleteDBInstance action deletes a previously provisioned DB instance.default DeleteDbParameterGroupResponse
deleteDBParameterGroup
(Consumer<DeleteDbParameterGroupRequest.Builder> deleteDbParameterGroupRequest) Deletes a specified DBParameterGroup.default DeleteDbParameterGroupResponse
deleteDBParameterGroup
(DeleteDbParameterGroupRequest deleteDbParameterGroupRequest) Deletes a specified DBParameterGroup.default DeleteDbSubnetGroupResponse
deleteDBSubnetGroup
(Consumer<DeleteDbSubnetGroupRequest.Builder> deleteDbSubnetGroupRequest) Deletes a DB subnet group.default DeleteDbSubnetGroupResponse
deleteDBSubnetGroup
(DeleteDbSubnetGroupRequest deleteDbSubnetGroupRequest) Deletes a DB subnet group.default DeleteEventSubscriptionResponse
deleteEventSubscription
(Consumer<DeleteEventSubscriptionRequest.Builder> deleteEventSubscriptionRequest) Deletes an event notification subscription.default DeleteEventSubscriptionResponse
deleteEventSubscription
(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest) Deletes an event notification subscription.default DeleteGlobalClusterResponse
deleteGlobalCluster
(Consumer<DeleteGlobalClusterRequest.Builder> deleteGlobalClusterRequest) Deletes a global database.default DeleteGlobalClusterResponse
deleteGlobalCluster
(DeleteGlobalClusterRequest deleteGlobalClusterRequest) Deletes a global database.describeDBClusterEndpoints
(Consumer<DescribeDbClusterEndpointsRequest.Builder> describeDbClusterEndpointsRequest) Returns information about endpoints for an Amazon Neptune DB cluster.describeDBClusterEndpoints
(DescribeDbClusterEndpointsRequest describeDbClusterEndpointsRequest) Returns information about endpoints for an Amazon Neptune DB cluster.describeDBClusterEndpointsPaginator
(Consumer<DescribeDbClusterEndpointsRequest.Builder> describeDbClusterEndpointsRequest) This is a variant ofdescribeDBClusterEndpoints(software.amazon.awssdk.services.neptune.model.DescribeDbClusterEndpointsRequest)
operation.describeDBClusterEndpointsPaginator
(DescribeDbClusterEndpointsRequest describeDbClusterEndpointsRequest) This is a variant ofdescribeDBClusterEndpoints(software.amazon.awssdk.services.neptune.model.DescribeDbClusterEndpointsRequest)
operation.Returns a list ofDBClusterParameterGroup
descriptions.describeDBClusterParameterGroups
(Consumer<DescribeDbClusterParameterGroupsRequest.Builder> describeDbClusterParameterGroupsRequest) Returns a list ofDBClusterParameterGroup
descriptions.describeDBClusterParameterGroups
(DescribeDbClusterParameterGroupsRequest describeDbClusterParameterGroupsRequest) Returns a list ofDBClusterParameterGroup
descriptions.This is a variant ofdescribeDBClusterParameterGroups(software.amazon.awssdk.services.neptune.model.DescribeDbClusterParameterGroupsRequest)
operation.describeDBClusterParameterGroupsPaginator
(Consumer<DescribeDbClusterParameterGroupsRequest.Builder> describeDbClusterParameterGroupsRequest) This is a variant ofdescribeDBClusterParameterGroups(software.amazon.awssdk.services.neptune.model.DescribeDbClusterParameterGroupsRequest)
operation.describeDBClusterParameterGroupsPaginator
(DescribeDbClusterParameterGroupsRequest describeDbClusterParameterGroupsRequest) This is a variant ofdescribeDBClusterParameterGroups(software.amazon.awssdk.services.neptune.model.DescribeDbClusterParameterGroupsRequest)
operation.describeDBClusterParameters
(Consumer<DescribeDbClusterParametersRequest.Builder> describeDbClusterParametersRequest) Returns the detailed parameter list for a particular DB cluster parameter group.describeDBClusterParameters
(DescribeDbClusterParametersRequest describeDbClusterParametersRequest) Returns the detailed parameter list for a particular DB cluster parameter group.describeDBClusterParametersPaginator
(Consumer<DescribeDbClusterParametersRequest.Builder> describeDbClusterParametersRequest) This is a variant ofdescribeDBClusterParameters(software.amazon.awssdk.services.neptune.model.DescribeDbClusterParametersRequest)
operation.describeDBClusterParametersPaginator
(DescribeDbClusterParametersRequest describeDbClusterParametersRequest) This is a variant ofdescribeDBClusterParameters(software.amazon.awssdk.services.neptune.model.DescribeDbClusterParametersRequest)
operation.default DescribeDbClustersResponse
Returns information about provisioned DB clusters, and supports pagination.default DescribeDbClustersResponse
describeDBClusters
(Consumer<DescribeDbClustersRequest.Builder> describeDbClustersRequest) Returns information about provisioned DB clusters, and supports pagination.default DescribeDbClustersResponse
describeDBClusters
(DescribeDbClustersRequest describeDbClustersRequest) Returns information about provisioned DB clusters, and supports pagination.describeDBClusterSnapshotAttributes
(Consumer<DescribeDbClusterSnapshotAttributesRequest.Builder> describeDbClusterSnapshotAttributesRequest) Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.describeDBClusterSnapshotAttributes
(DescribeDbClusterSnapshotAttributesRequest describeDbClusterSnapshotAttributesRequest) Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.Returns information about DB cluster snapshots.describeDBClusterSnapshots
(Consumer<DescribeDbClusterSnapshotsRequest.Builder> describeDbClusterSnapshotsRequest) Returns information about DB cluster snapshots.describeDBClusterSnapshots
(DescribeDbClusterSnapshotsRequest describeDbClusterSnapshotsRequest) Returns information about DB cluster snapshots.This is a variant ofdescribeDBClusterSnapshots(software.amazon.awssdk.services.neptune.model.DescribeDbClusterSnapshotsRequest)
operation.describeDBClusterSnapshotsPaginator
(Consumer<DescribeDbClusterSnapshotsRequest.Builder> describeDbClusterSnapshotsRequest) This is a variant ofdescribeDBClusterSnapshots(software.amazon.awssdk.services.neptune.model.DescribeDbClusterSnapshotsRequest)
operation.describeDBClusterSnapshotsPaginator
(DescribeDbClusterSnapshotsRequest describeDbClusterSnapshotsRequest) This is a variant ofdescribeDBClusterSnapshots(software.amazon.awssdk.services.neptune.model.DescribeDbClusterSnapshotsRequest)
operation.default DescribeDBClustersIterable
This is a variant ofdescribeDBClusters(software.amazon.awssdk.services.neptune.model.DescribeDbClustersRequest)
operation.default DescribeDBClustersIterable
describeDBClustersPaginator
(Consumer<DescribeDbClustersRequest.Builder> describeDbClustersRequest) This is a variant ofdescribeDBClusters(software.amazon.awssdk.services.neptune.model.DescribeDbClustersRequest)
operation.default DescribeDBClustersIterable
describeDBClustersPaginator
(DescribeDbClustersRequest describeDbClustersRequest) This is a variant ofdescribeDBClusters(software.amazon.awssdk.services.neptune.model.DescribeDbClustersRequest)
operation.default DescribeDbEngineVersionsResponse
Returns a list of the available DB engines.default DescribeDbEngineVersionsResponse
describeDBEngineVersions
(Consumer<DescribeDbEngineVersionsRequest.Builder> describeDbEngineVersionsRequest) Returns a list of the available DB engines.default DescribeDbEngineVersionsResponse
describeDBEngineVersions
(DescribeDbEngineVersionsRequest describeDbEngineVersionsRequest) Returns a list of the available DB engines.default DescribeDBEngineVersionsIterable
This is a variant ofdescribeDBEngineVersions(software.amazon.awssdk.services.neptune.model.DescribeDbEngineVersionsRequest)
operation.default DescribeDBEngineVersionsIterable
describeDBEngineVersionsPaginator
(Consumer<DescribeDbEngineVersionsRequest.Builder> describeDbEngineVersionsRequest) This is a variant ofdescribeDBEngineVersions(software.amazon.awssdk.services.neptune.model.DescribeDbEngineVersionsRequest)
operation.default DescribeDBEngineVersionsIterable
describeDBEngineVersionsPaginator
(DescribeDbEngineVersionsRequest describeDbEngineVersionsRequest) This is a variant ofdescribeDBEngineVersions(software.amazon.awssdk.services.neptune.model.DescribeDbEngineVersionsRequest)
operation.default DescribeDbInstancesResponse
Returns information about provisioned instances, and supports pagination.default DescribeDbInstancesResponse
describeDBInstances
(Consumer<DescribeDbInstancesRequest.Builder> describeDbInstancesRequest) Returns information about provisioned instances, and supports pagination.default DescribeDbInstancesResponse
describeDBInstances
(DescribeDbInstancesRequest describeDbInstancesRequest) Returns information about provisioned instances, and supports pagination.default DescribeDBInstancesIterable
This is a variant ofdescribeDBInstances(software.amazon.awssdk.services.neptune.model.DescribeDbInstancesRequest)
operation.default DescribeDBInstancesIterable
describeDBInstancesPaginator
(Consumer<DescribeDbInstancesRequest.Builder> describeDbInstancesRequest) This is a variant ofdescribeDBInstances(software.amazon.awssdk.services.neptune.model.DescribeDbInstancesRequest)
operation.default DescribeDBInstancesIterable
describeDBInstancesPaginator
(DescribeDbInstancesRequest describeDbInstancesRequest) This is a variant ofdescribeDBInstances(software.amazon.awssdk.services.neptune.model.DescribeDbInstancesRequest)
operation.Returns a list ofDBParameterGroup
descriptions.describeDBParameterGroups
(Consumer<DescribeDbParameterGroupsRequest.Builder> describeDbParameterGroupsRequest) Returns a list ofDBParameterGroup
descriptions.describeDBParameterGroups
(DescribeDbParameterGroupsRequest describeDbParameterGroupsRequest) Returns a list ofDBParameterGroup
descriptions.This is a variant ofdescribeDBParameterGroups(software.amazon.awssdk.services.neptune.model.DescribeDbParameterGroupsRequest)
operation.describeDBParameterGroupsPaginator
(Consumer<DescribeDbParameterGroupsRequest.Builder> describeDbParameterGroupsRequest) This is a variant ofdescribeDBParameterGroups(software.amazon.awssdk.services.neptune.model.DescribeDbParameterGroupsRequest)
operation.describeDBParameterGroupsPaginator
(DescribeDbParameterGroupsRequest describeDbParameterGroupsRequest) This is a variant ofdescribeDBParameterGroups(software.amazon.awssdk.services.neptune.model.DescribeDbParameterGroupsRequest)
operation.default DescribeDbParametersResponse
describeDBParameters
(Consumer<DescribeDbParametersRequest.Builder> describeDbParametersRequest) Returns the detailed parameter list for a particular DB parameter group.default DescribeDbParametersResponse
describeDBParameters
(DescribeDbParametersRequest describeDbParametersRequest) Returns the detailed parameter list for a particular DB parameter group.default DescribeDBParametersIterable
describeDBParametersPaginator
(Consumer<DescribeDbParametersRequest.Builder> describeDbParametersRequest) This is a variant ofdescribeDBParameters(software.amazon.awssdk.services.neptune.model.DescribeDbParametersRequest)
operation.default DescribeDBParametersIterable
describeDBParametersPaginator
(DescribeDbParametersRequest describeDbParametersRequest) This is a variant ofdescribeDBParameters(software.amazon.awssdk.services.neptune.model.DescribeDbParametersRequest)
operation.default DescribeDbSubnetGroupsResponse
Returns a list of DBSubnetGroup descriptions.default DescribeDbSubnetGroupsResponse
describeDBSubnetGroups
(Consumer<DescribeDbSubnetGroupsRequest.Builder> describeDbSubnetGroupsRequest) Returns a list of DBSubnetGroup descriptions.default DescribeDbSubnetGroupsResponse
describeDBSubnetGroups
(DescribeDbSubnetGroupsRequest describeDbSubnetGroupsRequest) Returns a list of DBSubnetGroup descriptions.default DescribeDBSubnetGroupsIterable
This is a variant ofdescribeDBSubnetGroups(software.amazon.awssdk.services.neptune.model.DescribeDbSubnetGroupsRequest)
operation.default DescribeDBSubnetGroupsIterable
describeDBSubnetGroupsPaginator
(Consumer<DescribeDbSubnetGroupsRequest.Builder> describeDbSubnetGroupsRequest) This is a variant ofdescribeDBSubnetGroups(software.amazon.awssdk.services.neptune.model.DescribeDbSubnetGroupsRequest)
operation.default DescribeDBSubnetGroupsIterable
describeDBSubnetGroupsPaginator
(DescribeDbSubnetGroupsRequest describeDbSubnetGroupsRequest) This is a variant ofdescribeDBSubnetGroups(software.amazon.awssdk.services.neptune.model.DescribeDbSubnetGroupsRequest)
operation.describeEngineDefaultClusterParameters
(Consumer<DescribeEngineDefaultClusterParametersRequest.Builder> describeEngineDefaultClusterParametersRequest) Returns the default engine and system parameter information for the cluster database engine.describeEngineDefaultClusterParameters
(DescribeEngineDefaultClusterParametersRequest describeEngineDefaultClusterParametersRequest) Returns the default engine and system parameter information for the cluster database engine.describeEngineDefaultParameters
(Consumer<DescribeEngineDefaultParametersRequest.Builder> describeEngineDefaultParametersRequest) Returns the default engine and system parameter information for the specified database engine.describeEngineDefaultParameters
(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest) Returns the default engine and system parameter information for the specified database engine.describeEngineDefaultParametersPaginator
(Consumer<DescribeEngineDefaultParametersRequest.Builder> describeEngineDefaultParametersRequest) This is a variant ofdescribeEngineDefaultParameters(software.amazon.awssdk.services.neptune.model.DescribeEngineDefaultParametersRequest)
operation.describeEngineDefaultParametersPaginator
(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest) This is a variant ofdescribeEngineDefaultParameters(software.amazon.awssdk.services.neptune.model.DescribeEngineDefaultParametersRequest)
operation.default DescribeEventCategoriesResponse
Displays a list of categories for all event source types, or, if specified, for a specified source type.default DescribeEventCategoriesResponse
describeEventCategories
(Consumer<DescribeEventCategoriesRequest.Builder> describeEventCategoriesRequest) Displays a list of categories for all event source types, or, if specified, for a specified source type.default DescribeEventCategoriesResponse
describeEventCategories
(DescribeEventCategoriesRequest describeEventCategoriesRequest) Displays a list of categories for all event source types, or, if specified, for a specified source type.default DescribeEventsResponse
Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days.default DescribeEventsResponse
describeEvents
(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days.default DescribeEventsResponse
describeEvents
(DescribeEventsRequest describeEventsRequest) Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days.default DescribeEventsIterable
This is a variant ofdescribeEvents(software.amazon.awssdk.services.neptune.model.DescribeEventsRequest)
operation.default DescribeEventsIterable
describeEventsPaginator
(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) This is a variant ofdescribeEvents(software.amazon.awssdk.services.neptune.model.DescribeEventsRequest)
operation.default DescribeEventsIterable
describeEventsPaginator
(DescribeEventsRequest describeEventsRequest) This is a variant ofdescribeEvents(software.amazon.awssdk.services.neptune.model.DescribeEventsRequest)
operation.Lists all the subscription descriptions for a customer account.describeEventSubscriptions
(Consumer<DescribeEventSubscriptionsRequest.Builder> describeEventSubscriptionsRequest) Lists all the subscription descriptions for a customer account.describeEventSubscriptions
(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest) Lists all the subscription descriptions for a customer account.This is a variant ofdescribeEventSubscriptions(software.amazon.awssdk.services.neptune.model.DescribeEventSubscriptionsRequest)
operation.describeEventSubscriptionsPaginator
(Consumer<DescribeEventSubscriptionsRequest.Builder> describeEventSubscriptionsRequest) This is a variant ofdescribeEventSubscriptions(software.amazon.awssdk.services.neptune.model.DescribeEventSubscriptionsRequest)
operation.describeEventSubscriptionsPaginator
(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest) This is a variant ofdescribeEventSubscriptions(software.amazon.awssdk.services.neptune.model.DescribeEventSubscriptionsRequest)
operation.default DescribeGlobalClustersResponse
describeGlobalClusters
(Consumer<DescribeGlobalClustersRequest.Builder> describeGlobalClustersRequest) Returns information about Neptune global database clusters.default DescribeGlobalClustersResponse
describeGlobalClusters
(DescribeGlobalClustersRequest describeGlobalClustersRequest) Returns information about Neptune global database clusters.default DescribeGlobalClustersIterable
describeGlobalClustersPaginator
(Consumer<DescribeGlobalClustersRequest.Builder> describeGlobalClustersRequest) This is a variant ofdescribeGlobalClusters(software.amazon.awssdk.services.neptune.model.DescribeGlobalClustersRequest)
operation.default DescribeGlobalClustersIterable
describeGlobalClustersPaginator
(DescribeGlobalClustersRequest describeGlobalClustersRequest) This is a variant ofdescribeGlobalClusters(software.amazon.awssdk.services.neptune.model.DescribeGlobalClustersRequest)
operation.describeOrderableDBInstanceOptions
(Consumer<DescribeOrderableDbInstanceOptionsRequest.Builder> describeOrderableDbInstanceOptionsRequest) Returns a list of orderable DB instance options for the specified engine.describeOrderableDBInstanceOptions
(DescribeOrderableDbInstanceOptionsRequest describeOrderableDbInstanceOptionsRequest) Returns a list of orderable DB instance options for the specified engine.describeOrderableDBInstanceOptionsPaginator
(Consumer<DescribeOrderableDbInstanceOptionsRequest.Builder> describeOrderableDbInstanceOptionsRequest) This is a variant ofdescribeOrderableDBInstanceOptions(software.amazon.awssdk.services.neptune.model.DescribeOrderableDbInstanceOptionsRequest)
operation.describeOrderableDBInstanceOptionsPaginator
(DescribeOrderableDbInstanceOptionsRequest describeOrderableDbInstanceOptionsRequest) This is a variant ofdescribeOrderableDBInstanceOptions(software.amazon.awssdk.services.neptune.model.DescribeOrderableDbInstanceOptionsRequest)
operation.Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.describePendingMaintenanceActions
(Consumer<DescribePendingMaintenanceActionsRequest.Builder> describePendingMaintenanceActionsRequest) Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.describePendingMaintenanceActions
(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest) Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.This is a variant ofdescribePendingMaintenanceActions(software.amazon.awssdk.services.neptune.model.DescribePendingMaintenanceActionsRequest)
operation.describePendingMaintenanceActionsPaginator
(Consumer<DescribePendingMaintenanceActionsRequest.Builder> describePendingMaintenanceActionsRequest) This is a variant ofdescribePendingMaintenanceActions(software.amazon.awssdk.services.neptune.model.DescribePendingMaintenanceActionsRequest)
operation.describePendingMaintenanceActionsPaginator
(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest) This is a variant ofdescribePendingMaintenanceActions(software.amazon.awssdk.services.neptune.model.DescribePendingMaintenanceActionsRequest)
operation.describeValidDBInstanceModifications
(Consumer<DescribeValidDbInstanceModificationsRequest.Builder> describeValidDbInstanceModificationsRequest) You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance.describeValidDBInstanceModifications
(DescribeValidDbInstanceModificationsRequest describeValidDbInstanceModificationsRequest) You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance.default FailoverDbClusterResponse
failoverDBCluster
(Consumer<FailoverDbClusterRequest.Builder> failoverDbClusterRequest) Forces a failover for a DB cluster.default FailoverDbClusterResponse
failoverDBCluster
(FailoverDbClusterRequest failoverDbClusterRequest) Forces a failover for a DB cluster.default FailoverGlobalClusterResponse
failoverGlobalCluster
(Consumer<FailoverGlobalClusterRequest.Builder> failoverGlobalClusterRequest) Initiates the failover process for a Neptune global database.default FailoverGlobalClusterResponse
failoverGlobalCluster
(FailoverGlobalClusterRequest failoverGlobalClusterRequest) Initiates the failover process for a Neptune global database.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists all tags on an Amazon Neptune resource.default ListTagsForResourceResponse
listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Lists all tags on an Amazon Neptune resource.default ModifyDbClusterResponse
modifyDBCluster
(Consumer<ModifyDbClusterRequest.Builder> modifyDbClusterRequest) Modify a setting for a DB cluster.default ModifyDbClusterResponse
modifyDBCluster
(ModifyDbClusterRequest modifyDbClusterRequest) Modify a setting for a DB cluster.default ModifyDbClusterEndpointResponse
modifyDBClusterEndpoint
(Consumer<ModifyDbClusterEndpointRequest.Builder> modifyDbClusterEndpointRequest) Modifies the properties of an endpoint in an Amazon Neptune DB cluster.default ModifyDbClusterEndpointResponse
modifyDBClusterEndpoint
(ModifyDbClusterEndpointRequest modifyDbClusterEndpointRequest) Modifies the properties of an endpoint in an Amazon Neptune DB cluster.modifyDBClusterParameterGroup
(Consumer<ModifyDbClusterParameterGroupRequest.Builder> modifyDbClusterParameterGroupRequest) Modifies the parameters of a DB cluster parameter group.modifyDBClusterParameterGroup
(ModifyDbClusterParameterGroupRequest modifyDbClusterParameterGroupRequest) Modifies the parameters of a DB cluster parameter group.modifyDBClusterSnapshotAttribute
(Consumer<ModifyDbClusterSnapshotAttributeRequest.Builder> modifyDbClusterSnapshotAttributeRequest) Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.modifyDBClusterSnapshotAttribute
(ModifyDbClusterSnapshotAttributeRequest modifyDbClusterSnapshotAttributeRequest) Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.default ModifyDbInstanceResponse
modifyDBInstance
(Consumer<ModifyDbInstanceRequest.Builder> modifyDbInstanceRequest) Modifies settings for a DB instance.default ModifyDbInstanceResponse
modifyDBInstance
(ModifyDbInstanceRequest modifyDbInstanceRequest) Modifies settings for a DB instance.default ModifyDbParameterGroupResponse
modifyDBParameterGroup
(Consumer<ModifyDbParameterGroupRequest.Builder> modifyDbParameterGroupRequest) Modifies the parameters of a DB parameter group.default ModifyDbParameterGroupResponse
modifyDBParameterGroup
(ModifyDbParameterGroupRequest modifyDbParameterGroupRequest) Modifies the parameters of a DB parameter group.default ModifyDbSubnetGroupResponse
modifyDBSubnetGroup
(Consumer<ModifyDbSubnetGroupRequest.Builder> modifyDbSubnetGroupRequest) Modifies an existing DB subnet group.default ModifyDbSubnetGroupResponse
modifyDBSubnetGroup
(ModifyDbSubnetGroupRequest modifyDbSubnetGroupRequest) Modifies an existing DB subnet group.default ModifyEventSubscriptionResponse
modifyEventSubscription
(Consumer<ModifyEventSubscriptionRequest.Builder> modifyEventSubscriptionRequest) Modifies an existing event notification subscription.default ModifyEventSubscriptionResponse
modifyEventSubscription
(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest) Modifies an existing event notification subscription.default ModifyGlobalClusterResponse
modifyGlobalCluster
(Consumer<ModifyGlobalClusterRequest.Builder> modifyGlobalClusterRequest) Modify a setting for an Amazon Neptune global cluster.default ModifyGlobalClusterResponse
modifyGlobalCluster
(ModifyGlobalClusterRequest modifyGlobalClusterRequest) Modify a setting for an Amazon Neptune global cluster.promoteReadReplicaDBCluster
(Consumer<PromoteReadReplicaDbClusterRequest.Builder> promoteReadReplicaDbClusterRequest) Not supported.promoteReadReplicaDBCluster
(PromoteReadReplicaDbClusterRequest promoteReadReplicaDbClusterRequest) Not supported.default RebootDbInstanceResponse
rebootDBInstance
(Consumer<RebootDbInstanceRequest.Builder> rebootDbInstanceRequest) You might need to reboot your DB instance, usually for maintenance reasons.default RebootDbInstanceResponse
rebootDBInstance
(RebootDbInstanceRequest rebootDbInstanceRequest) You might need to reboot your DB instance, usually for maintenance reasons.default RemoveFromGlobalClusterResponse
removeFromGlobalCluster
(Consumer<RemoveFromGlobalClusterRequest.Builder> removeFromGlobalClusterRequest) Detaches a Neptune DB cluster from a Neptune global database.default RemoveFromGlobalClusterResponse
removeFromGlobalCluster
(RemoveFromGlobalClusterRequest removeFromGlobalClusterRequest) Detaches a Neptune DB cluster from a Neptune global database.default RemoveRoleFromDbClusterResponse
removeRoleFromDBCluster
(Consumer<RemoveRoleFromDbClusterRequest.Builder> removeRoleFromDbClusterRequest) Disassociates an Identity and Access Management (IAM) role from a DB cluster.default RemoveRoleFromDbClusterResponse
removeRoleFromDBCluster
(RemoveRoleFromDbClusterRequest removeRoleFromDbClusterRequest) Disassociates an Identity and Access Management (IAM) role from a DB cluster.removeSourceIdentifierFromSubscription
(Consumer<RemoveSourceIdentifierFromSubscriptionRequest.Builder> removeSourceIdentifierFromSubscriptionRequest) Removes a source identifier from an existing event notification subscription.removeSourceIdentifierFromSubscription
(RemoveSourceIdentifierFromSubscriptionRequest removeSourceIdentifierFromSubscriptionRequest) Removes a source identifier from an existing event notification subscription.default RemoveTagsFromResourceResponse
removeTagsFromResource
(Consumer<RemoveTagsFromResourceRequest.Builder> removeTagsFromResourceRequest) Removes metadata tags from an Amazon Neptune resource.default RemoveTagsFromResourceResponse
removeTagsFromResource
(RemoveTagsFromResourceRequest removeTagsFromResourceRequest) Removes metadata tags from an Amazon Neptune resource.resetDBClusterParameterGroup
(Consumer<ResetDbClusterParameterGroupRequest.Builder> resetDbClusterParameterGroupRequest) Modifies the parameters of a DB cluster parameter group to the default value.resetDBClusterParameterGroup
(ResetDbClusterParameterGroupRequest resetDbClusterParameterGroupRequest) Modifies the parameters of a DB cluster parameter group to the default value.default ResetDbParameterGroupResponse
resetDBParameterGroup
(Consumer<ResetDbParameterGroupRequest.Builder> resetDbParameterGroupRequest) Modifies the parameters of a DB parameter group to the engine/system default value.default ResetDbParameterGroupResponse
resetDBParameterGroup
(ResetDbParameterGroupRequest resetDbParameterGroupRequest) Modifies the parameters of a DB parameter group to the engine/system default value.restoreDBClusterFromSnapshot
(Consumer<RestoreDbClusterFromSnapshotRequest.Builder> restoreDbClusterFromSnapshotRequest) Creates a new DB cluster from a DB snapshot or DB cluster snapshot.restoreDBClusterFromSnapshot
(RestoreDbClusterFromSnapshotRequest restoreDbClusterFromSnapshotRequest) Creates a new DB cluster from a DB snapshot or DB cluster snapshot.restoreDBClusterToPointInTime
(Consumer<RestoreDbClusterToPointInTimeRequest.Builder> restoreDbClusterToPointInTimeRequest) Restores a DB cluster to an arbitrary point in time.restoreDBClusterToPointInTime
(RestoreDbClusterToPointInTimeRequest restoreDbClusterToPointInTimeRequest) Restores a DB cluster to an arbitrary point in time.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default StartDbClusterResponse
startDBCluster
(Consumer<StartDbClusterRequest.Builder> startDbClusterRequest) Starts an Amazon Neptune DB cluster that was stopped using the Amazon console, the Amazon CLI stop-db-cluster command, or the StopDBCluster API.default StartDbClusterResponse
startDBCluster
(StartDbClusterRequest startDbClusterRequest) Starts an Amazon Neptune DB cluster that was stopped using the Amazon console, the Amazon CLI stop-db-cluster command, or the StopDBCluster API.default StopDbClusterResponse
stopDBCluster
(Consumer<StopDbClusterRequest.Builder> stopDbClusterRequest) Stops an Amazon Neptune DB cluster.default StopDbClusterResponse
stopDBCluster
(StopDbClusterRequest stopDbClusterRequest) Stops an Amazon Neptune DB cluster.default NeptuneWaiter
waiter()
Create an instance ofNeptuneWaiter
using this client.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
addRoleToDBCluster
default AddRoleToDbClusterResponse addRoleToDBCluster(AddRoleToDbClusterRequest addRoleToDbClusterRequest) throws DbClusterNotFoundException, DbClusterRoleAlreadyExistsException, InvalidDbClusterStateException, DbClusterRoleQuotaExceededException, AwsServiceException, SdkClientException, NeptuneException Associates an Identity and Access Management (IAM) role with an Neptune DB cluster.
- Parameters:
addRoleToDbClusterRequest
-- Returns:
- Result of the AddRoleToDBCluster operation returned by the service.
- See Also:
-
addRoleToDBCluster
default AddRoleToDbClusterResponse addRoleToDBCluster(Consumer<AddRoleToDbClusterRequest.Builder> addRoleToDbClusterRequest) throws DbClusterNotFoundException, DbClusterRoleAlreadyExistsException, InvalidDbClusterStateException, DbClusterRoleQuotaExceededException, AwsServiceException, SdkClientException, NeptuneException Associates an Identity and Access Management (IAM) role with an Neptune DB cluster.
This is a convenience which creates an instance of the
AddRoleToDbClusterRequest.Builder
avoiding the need to create one manually viaAddRoleToDbClusterRequest.builder()
- Parameters:
addRoleToDbClusterRequest
- AConsumer
that will call methods onAddRoleToDbClusterRequest.Builder
to create a request.- Returns:
- Result of the AddRoleToDBCluster operation returned by the service.
- See Also:
-
addSourceIdentifierToSubscription
default AddSourceIdentifierToSubscriptionResponse addSourceIdentifierToSubscription(AddSourceIdentifierToSubscriptionRequest addSourceIdentifierToSubscriptionRequest) throws SubscriptionNotFoundException, SourceNotFoundException, AwsServiceException, SdkClientException, NeptuneException Adds a source identifier to an existing event notification subscription.
- Parameters:
addSourceIdentifierToSubscriptionRequest
-- Returns:
- Result of the AddSourceIdentifierToSubscription operation returned by the service.
- See Also:
-
addSourceIdentifierToSubscription
default AddSourceIdentifierToSubscriptionResponse addSourceIdentifierToSubscription(Consumer<AddSourceIdentifierToSubscriptionRequest.Builder> addSourceIdentifierToSubscriptionRequest) throws SubscriptionNotFoundException, SourceNotFoundException, AwsServiceException, SdkClientException, NeptuneException Adds a source identifier to an existing event notification subscription.
This is a convenience which creates an instance of the
AddSourceIdentifierToSubscriptionRequest.Builder
avoiding the need to create one manually viaAddSourceIdentifierToSubscriptionRequest.builder()
- Parameters:
addSourceIdentifierToSubscriptionRequest
- AConsumer
that will call methods onAddSourceIdentifierToSubscriptionRequest.Builder
to create a request.- Returns:
- Result of the AddSourceIdentifierToSubscription operation returned by the service.
- See Also:
-
addTagsToResource
default AddTagsToResourceResponse addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest) throws DbInstanceNotFoundException, DbSnapshotNotFoundException, DbClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException 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.
- See Also:
-
addTagsToResource
default AddTagsToResourceResponse addTagsToResource(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest) throws DbInstanceNotFoundException, DbSnapshotNotFoundException, DbClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException 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.
This is a convenience which creates an instance of the
AddTagsToResourceRequest.Builder
avoiding the need to create one manually viaAddTagsToResourceRequest.builder()
- Parameters:
addTagsToResourceRequest
- AConsumer
that will call methods onAddTagsToResourceRequest.Builder
to create a request.- Returns:
- Result of the AddTagsToResource operation returned by the service.
- See Also:
-
applyPendingMaintenanceAction
default ApplyPendingMaintenanceActionResponse applyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest applyPendingMaintenanceActionRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneException Applies a pending maintenance action to a resource (for example, to a DB instance).
- Parameters:
applyPendingMaintenanceActionRequest
-- Returns:
- Result of the ApplyPendingMaintenanceAction operation returned by the service.
- See Also:
-
applyPendingMaintenanceAction
default ApplyPendingMaintenanceActionResponse applyPendingMaintenanceAction(Consumer<ApplyPendingMaintenanceActionRequest.Builder> applyPendingMaintenanceActionRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneException Applies a pending maintenance action to a resource (for example, to a DB instance).
This is a convenience which creates an instance of the
ApplyPendingMaintenanceActionRequest.Builder
avoiding the need to create one manually viaApplyPendingMaintenanceActionRequest.builder()
- Parameters:
applyPendingMaintenanceActionRequest
- AConsumer
that will call methods onApplyPendingMaintenanceActionRequest.Builder
to create a request.- Returns:
- Result of the ApplyPendingMaintenanceAction operation returned by the service.
- See Also:
-
copyDBClusterParameterGroup
default CopyDbClusterParameterGroupResponse copyDBClusterParameterGroup(CopyDbClusterParameterGroupRequest copyDbClusterParameterGroupRequest) throws DbParameterGroupNotFoundException, DbParameterGroupQuotaExceededException, DbParameterGroupAlreadyExistsException, AwsServiceException, SdkClientException, NeptuneException Copies the specified DB cluster parameter group.
- Parameters:
copyDbClusterParameterGroupRequest
-- Returns:
- Result of the CopyDBClusterParameterGroup operation returned by the service.
- See Also:
-
copyDBClusterParameterGroup
default CopyDbClusterParameterGroupResponse copyDBClusterParameterGroup(Consumer<CopyDbClusterParameterGroupRequest.Builder> copyDbClusterParameterGroupRequest) throws DbParameterGroupNotFoundException, DbParameterGroupQuotaExceededException, DbParameterGroupAlreadyExistsException, AwsServiceException, SdkClientException, NeptuneException Copies the specified DB cluster parameter group.
This is a convenience which creates an instance of the
CopyDbClusterParameterGroupRequest.Builder
avoiding the need to create one manually viaCopyDbClusterParameterGroupRequest.builder()
- Parameters:
copyDbClusterParameterGroupRequest
- AConsumer
that will call methods onCopyDbClusterParameterGroupRequest.Builder
to create a request.- Returns:
- Result of the CopyDBClusterParameterGroup operation returned by the service.
- See Also:
-
copyDBClusterSnapshot
default CopyDbClusterSnapshotResponse copyDBClusterSnapshot(CopyDbClusterSnapshotRequest copyDbClusterSnapshotRequest) throws DbClusterSnapshotAlreadyExistsException, DbClusterSnapshotNotFoundException, InvalidDbClusterStateException, InvalidDbClusterSnapshotStateException, SnapshotQuotaExceededException, KmsKeyNotAccessibleException, AwsServiceException, SdkClientException, NeptuneException 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.- Parameters:
copyDbClusterSnapshotRequest
-- Returns:
- Result of the CopyDBClusterSnapshot operation returned by the service.
- See Also:
-
copyDBClusterSnapshot
default CopyDbClusterSnapshotResponse copyDBClusterSnapshot(Consumer<CopyDbClusterSnapshotRequest.Builder> copyDbClusterSnapshotRequest) throws DbClusterSnapshotAlreadyExistsException, DbClusterSnapshotNotFoundException, InvalidDbClusterStateException, InvalidDbClusterSnapshotStateException, SnapshotQuotaExceededException, KmsKeyNotAccessibleException, AwsServiceException, SdkClientException, NeptuneException 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.
This is a convenience which creates an instance of the
CopyDbClusterSnapshotRequest.Builder
avoiding the need to create one manually viaCopyDbClusterSnapshotRequest.builder()
- Parameters:
copyDbClusterSnapshotRequest
- AConsumer
that will call methods onCopyDbClusterSnapshotRequest.Builder
to create a request.- Returns:
- Result of the CopyDBClusterSnapshot operation returned by the service.
- See Also:
-
copyDBParameterGroup
default CopyDbParameterGroupResponse copyDBParameterGroup(CopyDbParameterGroupRequest copyDbParameterGroupRequest) throws DbParameterGroupNotFoundException, DbParameterGroupAlreadyExistsException, DbParameterGroupQuotaExceededException, AwsServiceException, SdkClientException, NeptuneException Copies the specified DB parameter group.
- Parameters:
copyDbParameterGroupRequest
-- Returns:
- Result of the CopyDBParameterGroup operation returned by the service.
- See Also:
-
copyDBParameterGroup
default CopyDbParameterGroupResponse copyDBParameterGroup(Consumer<CopyDbParameterGroupRequest.Builder> copyDbParameterGroupRequest) throws DbParameterGroupNotFoundException, DbParameterGroupAlreadyExistsException, DbParameterGroupQuotaExceededException, AwsServiceException, SdkClientException, NeptuneException Copies the specified DB parameter group.
This is a convenience which creates an instance of the
CopyDbParameterGroupRequest.Builder
avoiding the need to create one manually viaCopyDbParameterGroupRequest.builder()
- Parameters:
copyDbParameterGroupRequest
- AConsumer
that will call methods onCopyDbParameterGroupRequest.Builder
to create a request.- Returns:
- Result of the CopyDBParameterGroup operation returned by the service.
- See Also:
-
createDBCluster
default CreateDbClusterResponse createDBCluster(CreateDbClusterRequest createDbClusterRequest) throws DbClusterAlreadyExistsException, InsufficientStorageClusterCapacityException, DbClusterQuotaExceededException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, InvalidVpcNetworkStateException, InvalidDbClusterStateException, InvalidDbSubnetGroupStateException, InvalidSubnetException, InvalidDbInstanceStateException, DbClusterParameterGroupNotFoundException, KmsKeyNotAccessibleException, DbClusterNotFoundException, DbInstanceNotFoundException, DbSubnetGroupDoesNotCoverEnoughAZsException, GlobalClusterNotFoundException, InvalidGlobalClusterStateException, AwsServiceException, SdkClientException, NeptuneException 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.Note that when you create a new cluster using
CreateDBCluster
directly, deletion protection is disabled by default (when you create a new production cluster in the console, deletion protection is enabled by default). You can only delete a DB cluster if itsDeletionProtection
field is set tofalse
.- Parameters:
createDbClusterRequest
-- Returns:
- Result of the CreateDBCluster operation returned by the service.
- See Also:
-
createDBCluster
default CreateDbClusterResponse createDBCluster(Consumer<CreateDbClusterRequest.Builder> createDbClusterRequest) throws DbClusterAlreadyExistsException, InsufficientStorageClusterCapacityException, DbClusterQuotaExceededException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, InvalidVpcNetworkStateException, InvalidDbClusterStateException, InvalidDbSubnetGroupStateException, InvalidSubnetException, InvalidDbInstanceStateException, DbClusterParameterGroupNotFoundException, KmsKeyNotAccessibleException, DbClusterNotFoundException, DbInstanceNotFoundException, DbSubnetGroupDoesNotCoverEnoughAZsException, GlobalClusterNotFoundException, InvalidGlobalClusterStateException, AwsServiceException, SdkClientException, NeptuneException 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.Note that when you create a new cluster using
CreateDBCluster
directly, deletion protection is disabled by default (when you create a new production cluster in the console, deletion protection is enabled by default). You can only delete a DB cluster if itsDeletionProtection
field is set tofalse
.
This is a convenience which creates an instance of the
CreateDbClusterRequest.Builder
avoiding the need to create one manually viaCreateDbClusterRequest.builder()
- Parameters:
createDbClusterRequest
- AConsumer
that will call methods onCreateDbClusterRequest.Builder
to create a request.- Returns:
- Result of the CreateDBCluster operation returned by the service.
- See Also:
-
createDBClusterEndpoint
default CreateDbClusterEndpointResponse createDBClusterEndpoint(CreateDbClusterEndpointRequest createDbClusterEndpointRequest) throws DbClusterEndpointQuotaExceededException, DbClusterEndpointAlreadyExistsException, DbClusterNotFoundException, InvalidDbClusterStateException, DbInstanceNotFoundException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, NeptuneException Creates a new custom endpoint and associates it with an Amazon Neptune DB cluster.
- Parameters:
createDbClusterEndpointRequest
-- Returns:
- Result of the CreateDBClusterEndpoint operation returned by the service.
- See Also:
-
createDBClusterEndpoint
default CreateDbClusterEndpointResponse createDBClusterEndpoint(Consumer<CreateDbClusterEndpointRequest.Builder> createDbClusterEndpointRequest) throws DbClusterEndpointQuotaExceededException, DbClusterEndpointAlreadyExistsException, DbClusterNotFoundException, InvalidDbClusterStateException, DbInstanceNotFoundException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, NeptuneException Creates a new custom endpoint and associates it with an Amazon Neptune DB cluster.
This is a convenience which creates an instance of the
CreateDbClusterEndpointRequest.Builder
avoiding the need to create one manually viaCreateDbClusterEndpointRequest.builder()
- Parameters:
createDbClusterEndpointRequest
- AConsumer
that will call methods onCreateDbClusterEndpointRequest.Builder
to create a request.- Returns:
- Result of the CreateDBClusterEndpoint operation returned by the service.
- See Also:
-
createDBClusterParameterGroup
default CreateDbClusterParameterGroupResponse createDBClusterParameterGroup(CreateDbClusterParameterGroupRequest createDbClusterParameterGroupRequest) throws DbParameterGroupQuotaExceededException, DbParameterGroupAlreadyExistsException, AwsServiceException, SdkClientException, NeptuneException 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.
- See Also:
-
createDBClusterParameterGroup
default CreateDbClusterParameterGroupResponse createDBClusterParameterGroup(Consumer<CreateDbClusterParameterGroupRequest.Builder> createDbClusterParameterGroupRequest) throws DbParameterGroupQuotaExceededException, DbParameterGroupAlreadyExistsException, AwsServiceException, SdkClientException, NeptuneException 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.
This is a convenience which creates an instance of the
CreateDbClusterParameterGroupRequest.Builder
avoiding the need to create one manually viaCreateDbClusterParameterGroupRequest.builder()
- Parameters:
createDbClusterParameterGroupRequest
- AConsumer
that will call methods onCreateDbClusterParameterGroupRequest.Builder
to create a request.- Returns:
- Result of the CreateDBClusterParameterGroup operation returned by the service.
- See Also:
-
createDBClusterSnapshot
default CreateDbClusterSnapshotResponse createDBClusterSnapshot(CreateDbClusterSnapshotRequest createDbClusterSnapshotRequest) throws DbClusterSnapshotAlreadyExistsException, InvalidDbClusterStateException, DbClusterNotFoundException, SnapshotQuotaExceededException, InvalidDbClusterSnapshotStateException, AwsServiceException, SdkClientException, NeptuneException Creates a snapshot of a DB cluster.
- Parameters:
createDbClusterSnapshotRequest
-- Returns:
- Result of the CreateDBClusterSnapshot operation returned by the service.
- See Also:
-
createDBClusterSnapshot
default CreateDbClusterSnapshotResponse createDBClusterSnapshot(Consumer<CreateDbClusterSnapshotRequest.Builder> createDbClusterSnapshotRequest) throws DbClusterSnapshotAlreadyExistsException, InvalidDbClusterStateException, DbClusterNotFoundException, SnapshotQuotaExceededException, InvalidDbClusterSnapshotStateException, AwsServiceException, SdkClientException, NeptuneException Creates a snapshot of a DB cluster.
This is a convenience which creates an instance of the
CreateDbClusterSnapshotRequest.Builder
avoiding the need to create one manually viaCreateDbClusterSnapshotRequest.builder()
- Parameters:
createDbClusterSnapshotRequest
- AConsumer
that will call methods onCreateDbClusterSnapshotRequest.Builder
to create a request.- Returns:
- Result of the CreateDBClusterSnapshot operation returned by the service.
- See Also:
-
createDBInstance
default CreateDbInstanceResponse createDBInstance(CreateDbInstanceRequest createDbInstanceRequest) throws DbInstanceAlreadyExistsException, InsufficientDbInstanceCapacityException, DbParameterGroupNotFoundException, DbSecurityGroupNotFoundException, InstanceQuotaExceededException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidDbClusterStateException, InvalidSubnetException, InvalidVpcNetworkStateException, ProvisionedIopsNotAvailableInAzException, OptionGroupNotFoundException, DbClusterNotFoundException, StorageTypeNotSupportedException, AuthorizationNotFoundException, KmsKeyNotAccessibleException, DomainNotFoundException, AwsServiceException, SdkClientException, NeptuneException Creates a new DB instance.
- Parameters:
createDbInstanceRequest
-- Returns:
- Result of the CreateDBInstance operation returned by the service.
- See Also:
-
createDBInstance
default CreateDbInstanceResponse createDBInstance(Consumer<CreateDbInstanceRequest.Builder> createDbInstanceRequest) throws DbInstanceAlreadyExistsException, InsufficientDbInstanceCapacityException, DbParameterGroupNotFoundException, DbSecurityGroupNotFoundException, InstanceQuotaExceededException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidDbClusterStateException, InvalidSubnetException, InvalidVpcNetworkStateException, ProvisionedIopsNotAvailableInAzException, OptionGroupNotFoundException, DbClusterNotFoundException, StorageTypeNotSupportedException, AuthorizationNotFoundException, KmsKeyNotAccessibleException, DomainNotFoundException, AwsServiceException, SdkClientException, NeptuneException Creates a new DB instance.
This is a convenience which creates an instance of the
CreateDbInstanceRequest.Builder
avoiding the need to create one manually viaCreateDbInstanceRequest.builder()
- Parameters:
createDbInstanceRequest
- AConsumer
that will call methods onCreateDbInstanceRequest.Builder
to create a request.- Returns:
- Result of the CreateDBInstance operation returned by the service.
- See Also:
-
createDBParameterGroup
default CreateDbParameterGroupResponse createDBParameterGroup(CreateDbParameterGroupRequest createDbParameterGroupRequest) throws DbParameterGroupQuotaExceededException, DbParameterGroupAlreadyExistsException, AwsServiceException, SdkClientException, NeptuneException 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.
- See Also:
-
createDBParameterGroup
default CreateDbParameterGroupResponse createDBParameterGroup(Consumer<CreateDbParameterGroupRequest.Builder> createDbParameterGroupRequest) throws DbParameterGroupQuotaExceededException, DbParameterGroupAlreadyExistsException, AwsServiceException, SdkClientException, NeptuneException 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.
This is a convenience which creates an instance of the
CreateDbParameterGroupRequest.Builder
avoiding the need to create one manually viaCreateDbParameterGroupRequest.builder()
- Parameters:
createDbParameterGroupRequest
- AConsumer
that will call methods onCreateDbParameterGroupRequest.Builder
to create a request.- Returns:
- Result of the CreateDBParameterGroup operation returned by the service.
- See Also:
-
createDBSubnetGroup
default CreateDbSubnetGroupResponse createDBSubnetGroup(CreateDbSubnetGroupRequest createDbSubnetGroupRequest) throws DbSubnetGroupAlreadyExistsException, DbSubnetGroupQuotaExceededException, DbSubnetQuotaExceededException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidSubnetException, AwsServiceException, SdkClientException, NeptuneException Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Region.
- Parameters:
createDbSubnetGroupRequest
-- Returns:
- Result of the CreateDBSubnetGroup operation returned by the service.
- See Also:
-
createDBSubnetGroup
default CreateDbSubnetGroupResponse createDBSubnetGroup(Consumer<CreateDbSubnetGroupRequest.Builder> createDbSubnetGroupRequest) throws DbSubnetGroupAlreadyExistsException, DbSubnetGroupQuotaExceededException, DbSubnetQuotaExceededException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidSubnetException, AwsServiceException, SdkClientException, NeptuneException Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Region.
This is a convenience which creates an instance of the
CreateDbSubnetGroupRequest.Builder
avoiding the need to create one manually viaCreateDbSubnetGroupRequest.builder()
- Parameters:
createDbSubnetGroupRequest
- AConsumer
that will call methods onCreateDbSubnetGroupRequest.Builder
to create a request.- Returns:
- Result of the CreateDBSubnetGroup operation returned by the service.
- See Also:
-
createEventSubscription
default CreateEventSubscriptionResponse createEventSubscription(CreateEventSubscriptionRequest createEventSubscriptionRequest) throws EventSubscriptionQuotaExceededException, SubscriptionAlreadyExistException, SnsInvalidTopicException, SnsNoAuthorizationException, SnsTopicArnNotFoundException, SubscriptionCategoryNotFoundException, SourceNotFoundException, AwsServiceException, SdkClientException, NeptuneException 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.
- See Also:
-
createEventSubscription
default CreateEventSubscriptionResponse createEventSubscription(Consumer<CreateEventSubscriptionRequest.Builder> createEventSubscriptionRequest) throws EventSubscriptionQuotaExceededException, SubscriptionAlreadyExistException, SnsInvalidTopicException, SnsNoAuthorizationException, SnsTopicArnNotFoundException, SubscriptionCategoryNotFoundException, SourceNotFoundException, AwsServiceException, SdkClientException, NeptuneException 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.
This is a convenience which creates an instance of the
CreateEventSubscriptionRequest.Builder
avoiding the need to create one manually viaCreateEventSubscriptionRequest.builder()
- Parameters:
createEventSubscriptionRequest
- AConsumer
that will call methods onCreateEventSubscriptionRequest.Builder
to create a request.- Returns:
- Result of the CreateEventSubscription operation returned by the service.
- See Also:
-
createGlobalCluster
default CreateGlobalClusterResponse createGlobalCluster(CreateGlobalClusterRequest createGlobalClusterRequest) throws GlobalClusterAlreadyExistsException, GlobalClusterQuotaExceededException, InvalidDbClusterStateException, DbClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException 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.
- See Also:
-
createGlobalCluster
default CreateGlobalClusterResponse createGlobalCluster(Consumer<CreateGlobalClusterRequest.Builder> createGlobalClusterRequest) throws GlobalClusterAlreadyExistsException, GlobalClusterQuotaExceededException, InvalidDbClusterStateException, DbClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException 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.
This is a convenience which creates an instance of the
CreateGlobalClusterRequest.Builder
avoiding the need to create one manually viaCreateGlobalClusterRequest.builder()
- Parameters:
createGlobalClusterRequest
- AConsumer
that will call methods onCreateGlobalClusterRequest.Builder
to create a request.- Returns:
- Result of the CreateGlobalCluster operation returned by the service.
- See Also:
-
deleteDBCluster
default DeleteDbClusterResponse deleteDBCluster(DeleteDbClusterRequest deleteDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, DbClusterSnapshotAlreadyExistsException, SnapshotQuotaExceededException, InvalidDbClusterSnapshotStateException, AwsServiceException, SdkClientException, NeptuneException 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 toFalse
.- Parameters:
deleteDbClusterRequest
-- Returns:
- Result of the DeleteDBCluster operation returned by the service.
- See Also:
-
deleteDBCluster
default DeleteDbClusterResponse deleteDBCluster(Consumer<DeleteDbClusterRequest.Builder> deleteDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, DbClusterSnapshotAlreadyExistsException, SnapshotQuotaExceededException, InvalidDbClusterSnapshotStateException, AwsServiceException, SdkClientException, NeptuneException 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 toFalse
.
This is a convenience which creates an instance of the
DeleteDbClusterRequest.Builder
avoiding the need to create one manually viaDeleteDbClusterRequest.builder()
- Parameters:
deleteDbClusterRequest
- AConsumer
that will call methods onDeleteDbClusterRequest.Builder
to create a request.- Returns:
- Result of the DeleteDBCluster operation returned by the service.
- See Also:
-
deleteDBClusterEndpoint
default DeleteDbClusterEndpointResponse deleteDBClusterEndpoint(DeleteDbClusterEndpointRequest deleteDbClusterEndpointRequest) throws InvalidDbClusterEndpointStateException, DbClusterEndpointNotFoundException, InvalidDbClusterStateException, AwsServiceException, SdkClientException, NeptuneException Deletes a custom endpoint and removes it from an Amazon Neptune DB cluster.
- Parameters:
deleteDbClusterEndpointRequest
-- Returns:
- Result of the DeleteDBClusterEndpoint operation returned by the service.
- See Also:
-
deleteDBClusterEndpoint
default DeleteDbClusterEndpointResponse deleteDBClusterEndpoint(Consumer<DeleteDbClusterEndpointRequest.Builder> deleteDbClusterEndpointRequest) throws InvalidDbClusterEndpointStateException, DbClusterEndpointNotFoundException, InvalidDbClusterStateException, AwsServiceException, SdkClientException, NeptuneException Deletes a custom endpoint and removes it from an Amazon Neptune DB cluster.
This is a convenience which creates an instance of the
DeleteDbClusterEndpointRequest.Builder
avoiding the need to create one manually viaDeleteDbClusterEndpointRequest.builder()
- Parameters:
deleteDbClusterEndpointRequest
- AConsumer
that will call methods onDeleteDbClusterEndpointRequest.Builder
to create a request.- Returns:
- Result of the DeleteDBClusterEndpoint operation returned by the service.
- See Also:
-
deleteDBClusterParameterGroup
default DeleteDbClusterParameterGroupResponse deleteDBClusterParameterGroup(DeleteDbClusterParameterGroupRequest deleteDbClusterParameterGroupRequest) throws InvalidDbParameterGroupStateException, DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException 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.
- See Also:
-
deleteDBClusterParameterGroup
default DeleteDbClusterParameterGroupResponse deleteDBClusterParameterGroup(Consumer<DeleteDbClusterParameterGroupRequest.Builder> deleteDbClusterParameterGroupRequest) throws InvalidDbParameterGroupStateException, DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.
This is a convenience which creates an instance of the
DeleteDbClusterParameterGroupRequest.Builder
avoiding the need to create one manually viaDeleteDbClusterParameterGroupRequest.builder()
- Parameters:
deleteDbClusterParameterGroupRequest
- AConsumer
that will call methods onDeleteDbClusterParameterGroupRequest.Builder
to create a request.- Returns:
- Result of the DeleteDBClusterParameterGroup operation returned by the service.
- See Also:
-
deleteDBClusterSnapshot
default DeleteDbClusterSnapshotResponse deleteDBClusterSnapshot(DeleteDbClusterSnapshotRequest deleteDbClusterSnapshotRequest) throws InvalidDbClusterSnapshotStateException, DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, NeptuneException 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.- Parameters:
deleteDbClusterSnapshotRequest
-- Returns:
- Result of the DeleteDBClusterSnapshot operation returned by the service.
- See Also:
-
deleteDBClusterSnapshot
default DeleteDbClusterSnapshotResponse deleteDBClusterSnapshot(Consumer<DeleteDbClusterSnapshotRequest.Builder> deleteDbClusterSnapshotRequest) throws InvalidDbClusterSnapshotStateException, DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, NeptuneException 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.
This is a convenience which creates an instance of the
DeleteDbClusterSnapshotRequest.Builder
avoiding the need to create one manually viaDeleteDbClusterSnapshotRequest.builder()
- Parameters:
deleteDbClusterSnapshotRequest
- AConsumer
that will call methods onDeleteDbClusterSnapshotRequest.Builder
to create a request.- Returns:
- Result of the DeleteDBClusterSnapshot operation returned by the service.
- See Also:
-
deleteDBInstance
default DeleteDbInstanceResponse deleteDBInstance(DeleteDbInstanceRequest deleteDbInstanceRequest) throws DbInstanceNotFoundException, InvalidDbInstanceStateException, DbSnapshotAlreadyExistsException, SnapshotQuotaExceededException, InvalidDbClusterStateException, AwsServiceException, SdkClientException, NeptuneException 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 actionDescribeDBInstance
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
, orincompatible-network
, you can only delete it when theSkipFinalSnapshot
parameter is set totrue
.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.
- See Also:
-
deleteDBInstance
default DeleteDbInstanceResponse deleteDBInstance(Consumer<DeleteDbInstanceRequest.Builder> deleteDbInstanceRequest) throws DbInstanceNotFoundException, InvalidDbInstanceStateException, DbSnapshotAlreadyExistsException, SnapshotQuotaExceededException, InvalidDbClusterStateException, AwsServiceException, SdkClientException, NeptuneException 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 actionDescribeDBInstance
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
, orincompatible-network
, you can only delete it when theSkipFinalSnapshot
parameter is set totrue
.You can't delete a DB instance if it is the only instance in the DB cluster, or if it has deletion protection enabled.
This is a convenience which creates an instance of the
DeleteDbInstanceRequest.Builder
avoiding the need to create one manually viaDeleteDbInstanceRequest.builder()
- Parameters:
deleteDbInstanceRequest
- AConsumer
that will call methods onDeleteDbInstanceRequest.Builder
to create a request.- Returns:
- Result of the DeleteDBInstance operation returned by the service.
- See Also:
-
deleteDBParameterGroup
default DeleteDbParameterGroupResponse deleteDBParameterGroup(DeleteDbParameterGroupRequest deleteDbParameterGroupRequest) throws InvalidDbParameterGroupStateException, DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException 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.
- See Also:
-
deleteDBParameterGroup
default DeleteDbParameterGroupResponse deleteDBParameterGroup(Consumer<DeleteDbParameterGroupRequest.Builder> deleteDbParameterGroupRequest) throws InvalidDbParameterGroupStateException, DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted can't be associated with any DB instances.
This is a convenience which creates an instance of the
DeleteDbParameterGroupRequest.Builder
avoiding the need to create one manually viaDeleteDbParameterGroupRequest.builder()
- Parameters:
deleteDbParameterGroupRequest
- AConsumer
that will call methods onDeleteDbParameterGroupRequest.Builder
to create a request.- Returns:
- Result of the DeleteDBParameterGroup operation returned by the service.
- See Also:
-
deleteDBSubnetGroup
default DeleteDbSubnetGroupResponse deleteDBSubnetGroup(DeleteDbSubnetGroupRequest deleteDbSubnetGroupRequest) throws InvalidDbSubnetGroupStateException, InvalidDbSubnetStateException, DbSubnetGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException Deletes a DB subnet group.
The specified database subnet group must not be associated with any DB instances.
- Parameters:
deleteDbSubnetGroupRequest
-- Returns:
- Result of the DeleteDBSubnetGroup operation returned by the service.
- See Also:
-
deleteDBSubnetGroup
default DeleteDbSubnetGroupResponse deleteDBSubnetGroup(Consumer<DeleteDbSubnetGroupRequest.Builder> deleteDbSubnetGroupRequest) throws InvalidDbSubnetGroupStateException, InvalidDbSubnetStateException, DbSubnetGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException Deletes a DB subnet group.
The specified database subnet group must not be associated with any DB instances.
This is a convenience which creates an instance of the
DeleteDbSubnetGroupRequest.Builder
avoiding the need to create one manually viaDeleteDbSubnetGroupRequest.builder()
- Parameters:
deleteDbSubnetGroupRequest
- AConsumer
that will call methods onDeleteDbSubnetGroupRequest.Builder
to create a request.- Returns:
- Result of the DeleteDBSubnetGroup operation returned by the service.
- See Also:
-
deleteEventSubscription
default DeleteEventSubscriptionResponse deleteEventSubscription(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest) throws SubscriptionNotFoundException, InvalidEventSubscriptionStateException, AwsServiceException, SdkClientException, NeptuneException Deletes an event notification subscription.
- Parameters:
deleteEventSubscriptionRequest
-- Returns:
- Result of the DeleteEventSubscription operation returned by the service.
- See Also:
-
deleteEventSubscription
default DeleteEventSubscriptionResponse deleteEventSubscription(Consumer<DeleteEventSubscriptionRequest.Builder> deleteEventSubscriptionRequest) throws SubscriptionNotFoundException, InvalidEventSubscriptionStateException, AwsServiceException, SdkClientException, NeptuneException Deletes an event notification subscription.
This is a convenience which creates an instance of the
DeleteEventSubscriptionRequest.Builder
avoiding the need to create one manually viaDeleteEventSubscriptionRequest.builder()
- Parameters:
deleteEventSubscriptionRequest
- AConsumer
that will call methods onDeleteEventSubscriptionRequest.Builder
to create a request.- Returns:
- Result of the DeleteEventSubscription operation returned by the service.
- See Also:
-
deleteGlobalCluster
default DeleteGlobalClusterResponse deleteGlobalCluster(DeleteGlobalClusterRequest deleteGlobalClusterRequest) throws GlobalClusterNotFoundException, InvalidGlobalClusterStateException, AwsServiceException, SdkClientException, NeptuneException Deletes a global database. The primary and all secondary clusters must already be detached or deleted first.
- Parameters:
deleteGlobalClusterRequest
-- Returns:
- Result of the DeleteGlobalCluster operation returned by the service.
- See Also:
-
deleteGlobalCluster
default DeleteGlobalClusterResponse deleteGlobalCluster(Consumer<DeleteGlobalClusterRequest.Builder> deleteGlobalClusterRequest) throws GlobalClusterNotFoundException, InvalidGlobalClusterStateException, AwsServiceException, SdkClientException, NeptuneException Deletes a global database. The primary and all secondary clusters must already be detached or deleted first.
This is a convenience which creates an instance of the
DeleteGlobalClusterRequest.Builder
avoiding the need to create one manually viaDeleteGlobalClusterRequest.builder()
- Parameters:
deleteGlobalClusterRequest
- AConsumer
that will call methods onDeleteGlobalClusterRequest.Builder
to create a request.- Returns:
- Result of the DeleteGlobalCluster operation returned by the service.
- See Also:
-
describeDBClusterEndpoints
default DescribeDbClusterEndpointsResponse describeDBClusterEndpoints(DescribeDbClusterEndpointsRequest describeDbClusterEndpointsRequest) throws DbClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException 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.
- See Also:
-
describeDBClusterEndpoints
default DescribeDbClusterEndpointsResponse describeDBClusterEndpoints(Consumer<DescribeDbClusterEndpointsRequest.Builder> describeDbClusterEndpointsRequest) throws DbClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException Returns information about endpoints for an Amazon Neptune DB cluster.
This operation can also return information for Amazon RDS clusters and Amazon DocDB clusters.
This is a convenience which creates an instance of the
DescribeDbClusterEndpointsRequest.Builder
avoiding the need to create one manually viaDescribeDbClusterEndpointsRequest.builder()
- Parameters:
describeDbClusterEndpointsRequest
- AConsumer
that will call methods onDescribeDbClusterEndpointsRequest.Builder
to create a request.- Returns:
- Result of the DescribeDBClusterEndpoints operation returned by the service.
- See Also:
-
describeDBClusterEndpointsPaginator
default DescribeDBClusterEndpointsIterable describeDBClusterEndpointsPaginator(DescribeDbClusterEndpointsRequest describeDbClusterEndpointsRequest) throws DbClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException This is a variant of
describeDBClusterEndpoints(software.amazon.awssdk.services.neptune.model.DescribeDbClusterEndpointsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClusterEndpointsIterable responses = client.describeDBClusterEndpointsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBClusterEndpointsIterable responses = client .describeDBClusterEndpointsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbClusterEndpointsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClusterEndpointsIterable responses = client.describeDBClusterEndpointsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusterEndpoints(software.amazon.awssdk.services.neptune.model.DescribeDbClusterEndpointsRequest)
operation.- Parameters:
describeDbClusterEndpointsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBClusterEndpointsPaginator
default DescribeDBClusterEndpointsIterable describeDBClusterEndpointsPaginator(Consumer<DescribeDbClusterEndpointsRequest.Builder> describeDbClusterEndpointsRequest) throws DbClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException This is a variant of
describeDBClusterEndpoints(software.amazon.awssdk.services.neptune.model.DescribeDbClusterEndpointsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClusterEndpointsIterable responses = client.describeDBClusterEndpointsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBClusterEndpointsIterable responses = client .describeDBClusterEndpointsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbClusterEndpointsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClusterEndpointsIterable responses = client.describeDBClusterEndpointsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusterEndpoints(software.amazon.awssdk.services.neptune.model.DescribeDbClusterEndpointsRequest)
operation.
This is a convenience which creates an instance of the
DescribeDbClusterEndpointsRequest.Builder
avoiding the need to create one manually viaDescribeDbClusterEndpointsRequest.builder()
- Parameters:
describeDbClusterEndpointsRequest
- AConsumer
that will call methods onDescribeDbClusterEndpointsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBClusterParameterGroups
default DescribeDbClusterParameterGroupsResponse describeDBClusterParameterGroups(DescribeDbClusterParameterGroupsRequest describeDbClusterParameterGroupsRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException Returns a list of
DBClusterParameterGroup
descriptions. If aDBClusterParameterGroupName
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.
- See Also:
-
describeDBClusterParameterGroups
default DescribeDbClusterParameterGroupsResponse describeDBClusterParameterGroups(Consumer<DescribeDbClusterParameterGroupsRequest.Builder> describeDbClusterParameterGroupsRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException Returns a list of
DBClusterParameterGroup
descriptions. If aDBClusterParameterGroupName
parameter is specified, the list will contain only the description of the specified DB cluster parameter group.
This is a convenience which creates an instance of the
DescribeDbClusterParameterGroupsRequest.Builder
avoiding the need to create one manually viaDescribeDbClusterParameterGroupsRequest.builder()
- Parameters:
describeDbClusterParameterGroupsRequest
- AConsumer
that will call methods onDescribeDbClusterParameterGroupsRequest.Builder
to create a request.- Returns:
- Result of the DescribeDBClusterParameterGroups operation returned by the service.
- See Also:
-
describeDBClusterParameterGroups
default DescribeDbClusterParameterGroupsResponse describeDBClusterParameterGroups() throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneExceptionReturns a list of
DBClusterParameterGroup
descriptions. If aDBClusterParameterGroupName
parameter is specified, the list will contain only the description of the specified DB cluster parameter group.- Returns:
- Result of the DescribeDBClusterParameterGroups operation returned by the service.
- See Also:
-
describeDBClusterParameterGroupsPaginator
default DescribeDBClusterParameterGroupsIterable describeDBClusterParameterGroupsPaginator() throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneExceptionThis is a variant of
describeDBClusterParameterGroups(software.amazon.awssdk.services.neptune.model.DescribeDbClusterParameterGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClusterParameterGroupsIterable responses = client.describeDBClusterParameterGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBClusterParameterGroupsIterable responses = client .describeDBClusterParameterGroupsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbClusterParameterGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClusterParameterGroupsIterable responses = client.describeDBClusterParameterGroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusterParameterGroups(software.amazon.awssdk.services.neptune.model.DescribeDbClusterParameterGroupsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBClusterParameterGroupsPaginator
default DescribeDBClusterParameterGroupsIterable describeDBClusterParameterGroupsPaginator(DescribeDbClusterParameterGroupsRequest describeDbClusterParameterGroupsRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException This is a variant of
describeDBClusterParameterGroups(software.amazon.awssdk.services.neptune.model.DescribeDbClusterParameterGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClusterParameterGroupsIterable responses = client.describeDBClusterParameterGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBClusterParameterGroupsIterable responses = client .describeDBClusterParameterGroupsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbClusterParameterGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClusterParameterGroupsIterable responses = client.describeDBClusterParameterGroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusterParameterGroups(software.amazon.awssdk.services.neptune.model.DescribeDbClusterParameterGroupsRequest)
operation.- Parameters:
describeDbClusterParameterGroupsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBClusterParameterGroupsPaginator
default DescribeDBClusterParameterGroupsIterable describeDBClusterParameterGroupsPaginator(Consumer<DescribeDbClusterParameterGroupsRequest.Builder> describeDbClusterParameterGroupsRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException This is a variant of
describeDBClusterParameterGroups(software.amazon.awssdk.services.neptune.model.DescribeDbClusterParameterGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClusterParameterGroupsIterable responses = client.describeDBClusterParameterGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBClusterParameterGroupsIterable responses = client .describeDBClusterParameterGroupsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbClusterParameterGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClusterParameterGroupsIterable responses = client.describeDBClusterParameterGroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusterParameterGroups(software.amazon.awssdk.services.neptune.model.DescribeDbClusterParameterGroupsRequest)
operation.
This is a convenience which creates an instance of the
DescribeDbClusterParameterGroupsRequest.Builder
avoiding the need to create one manually viaDescribeDbClusterParameterGroupsRequest.builder()
- Parameters:
describeDbClusterParameterGroupsRequest
- AConsumer
that will call methods onDescribeDbClusterParameterGroupsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBClusterParameters
default DescribeDbClusterParametersResponse describeDBClusterParameters(DescribeDbClusterParametersRequest describeDbClusterParametersRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException Returns the detailed parameter list for a particular DB cluster parameter group.
- Parameters:
describeDbClusterParametersRequest
-- Returns:
- Result of the DescribeDBClusterParameters operation returned by the service.
- See Also:
-
describeDBClusterParameters
default DescribeDbClusterParametersResponse describeDBClusterParameters(Consumer<DescribeDbClusterParametersRequest.Builder> describeDbClusterParametersRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException Returns the detailed parameter list for a particular DB cluster parameter group.
This is a convenience which creates an instance of the
DescribeDbClusterParametersRequest.Builder
avoiding the need to create one manually viaDescribeDbClusterParametersRequest.builder()
- Parameters:
describeDbClusterParametersRequest
- AConsumer
that will call methods onDescribeDbClusterParametersRequest.Builder
to create a request.- Returns:
- Result of the DescribeDBClusterParameters operation returned by the service.
- See Also:
-
describeDBClusterParametersPaginator
default DescribeDBClusterParametersIterable describeDBClusterParametersPaginator(DescribeDbClusterParametersRequest describeDbClusterParametersRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException This is a variant of
describeDBClusterParameters(software.amazon.awssdk.services.neptune.model.DescribeDbClusterParametersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClusterParametersIterable responses = client.describeDBClusterParametersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBClusterParametersIterable responses = client .describeDBClusterParametersPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbClusterParametersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClusterParametersIterable responses = client.describeDBClusterParametersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusterParameters(software.amazon.awssdk.services.neptune.model.DescribeDbClusterParametersRequest)
operation.- Parameters:
describeDbClusterParametersRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBClusterParametersPaginator
default DescribeDBClusterParametersIterable describeDBClusterParametersPaginator(Consumer<DescribeDbClusterParametersRequest.Builder> describeDbClusterParametersRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException This is a variant of
describeDBClusterParameters(software.amazon.awssdk.services.neptune.model.DescribeDbClusterParametersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClusterParametersIterable responses = client.describeDBClusterParametersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBClusterParametersIterable responses = client .describeDBClusterParametersPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbClusterParametersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClusterParametersIterable responses = client.describeDBClusterParametersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusterParameters(software.amazon.awssdk.services.neptune.model.DescribeDbClusterParametersRequest)
operation.
This is a convenience which creates an instance of the
DescribeDbClusterParametersRequest.Builder
avoiding the need to create one manually viaDescribeDbClusterParametersRequest.builder()
- Parameters:
describeDbClusterParametersRequest
- AConsumer
that will call methods onDescribeDbClusterParametersRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBClusterSnapshotAttributes
default DescribeDbClusterSnapshotAttributesResponse describeDBClusterSnapshotAttributes(DescribeDbClusterSnapshotAttributesRequest describeDbClusterSnapshotAttributesRequest) throws DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, NeptuneException 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 therestore
attribute and a list of IDs for the Amazon accounts that are authorized to copy or restore the manual DB cluster snapshot. Ifall
is included in the list of values for therestore
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.
- See Also:
-
describeDBClusterSnapshotAttributes
default DescribeDbClusterSnapshotAttributesResponse describeDBClusterSnapshotAttributes(Consumer<DescribeDbClusterSnapshotAttributesRequest.Builder> describeDbClusterSnapshotAttributesRequest) throws DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, NeptuneException 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 therestore
attribute and a list of IDs for the Amazon accounts that are authorized to copy or restore the manual DB cluster snapshot. Ifall
is included in the list of values for therestore
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.
This is a convenience which creates an instance of the
DescribeDbClusterSnapshotAttributesRequest.Builder
avoiding the need to create one manually viaDescribeDbClusterSnapshotAttributesRequest.builder()
- Parameters:
describeDbClusterSnapshotAttributesRequest
- AConsumer
that will call methods onDescribeDbClusterSnapshotAttributesRequest.Builder
to create a request.- Returns:
- Result of the DescribeDBClusterSnapshotAttributes operation returned by the service.
- See Also:
-
describeDBClusterSnapshots
default DescribeDbClusterSnapshotsResponse describeDBClusterSnapshots(DescribeDbClusterSnapshotsRequest describeDbClusterSnapshotsRequest) throws DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, NeptuneException Returns information about DB cluster snapshots. This API action supports pagination.
- Parameters:
describeDbClusterSnapshotsRequest
-- Returns:
- Result of the DescribeDBClusterSnapshots operation returned by the service.
- See Also:
-
describeDBClusterSnapshots
default DescribeDbClusterSnapshotsResponse describeDBClusterSnapshots(Consumer<DescribeDbClusterSnapshotsRequest.Builder> describeDbClusterSnapshotsRequest) throws DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, NeptuneException Returns information about DB cluster snapshots. This API action supports pagination.
This is a convenience which creates an instance of the
DescribeDbClusterSnapshotsRequest.Builder
avoiding the need to create one manually viaDescribeDbClusterSnapshotsRequest.builder()
- Parameters:
describeDbClusterSnapshotsRequest
- AConsumer
that will call methods onDescribeDbClusterSnapshotsRequest.Builder
to create a request.- Returns:
- Result of the DescribeDBClusterSnapshots operation returned by the service.
- See Also:
-
describeDBClusterSnapshots
default DescribeDbClusterSnapshotsResponse describeDBClusterSnapshots() throws DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, NeptuneExceptionReturns information about DB cluster snapshots. This API action supports pagination.
- Returns:
- Result of the DescribeDBClusterSnapshots operation returned by the service.
- See Also:
-
describeDBClusterSnapshotsPaginator
default DescribeDBClusterSnapshotsIterable describeDBClusterSnapshotsPaginator() throws DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, NeptuneExceptionThis is a variant of
describeDBClusterSnapshots(software.amazon.awssdk.services.neptune.model.DescribeDbClusterSnapshotsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClusterSnapshotsIterable responses = client.describeDBClusterSnapshotsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBClusterSnapshotsIterable responses = client .describeDBClusterSnapshotsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbClusterSnapshotsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClusterSnapshotsIterable responses = client.describeDBClusterSnapshotsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusterSnapshots(software.amazon.awssdk.services.neptune.model.DescribeDbClusterSnapshotsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBClusterSnapshotsPaginator
default DescribeDBClusterSnapshotsIterable describeDBClusterSnapshotsPaginator(DescribeDbClusterSnapshotsRequest describeDbClusterSnapshotsRequest) throws DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, NeptuneException This is a variant of
describeDBClusterSnapshots(software.amazon.awssdk.services.neptune.model.DescribeDbClusterSnapshotsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClusterSnapshotsIterable responses = client.describeDBClusterSnapshotsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBClusterSnapshotsIterable responses = client .describeDBClusterSnapshotsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbClusterSnapshotsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClusterSnapshotsIterable responses = client.describeDBClusterSnapshotsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusterSnapshots(software.amazon.awssdk.services.neptune.model.DescribeDbClusterSnapshotsRequest)
operation.- Parameters:
describeDbClusterSnapshotsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBClusterSnapshotsPaginator
default DescribeDBClusterSnapshotsIterable describeDBClusterSnapshotsPaginator(Consumer<DescribeDbClusterSnapshotsRequest.Builder> describeDbClusterSnapshotsRequest) throws DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, NeptuneException This is a variant of
describeDBClusterSnapshots(software.amazon.awssdk.services.neptune.model.DescribeDbClusterSnapshotsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClusterSnapshotsIterable responses = client.describeDBClusterSnapshotsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBClusterSnapshotsIterable responses = client .describeDBClusterSnapshotsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbClusterSnapshotsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClusterSnapshotsIterable responses = client.describeDBClusterSnapshotsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusterSnapshots(software.amazon.awssdk.services.neptune.model.DescribeDbClusterSnapshotsRequest)
operation.
This is a convenience which creates an instance of the
DescribeDbClusterSnapshotsRequest.Builder
avoiding the need to create one manually viaDescribeDbClusterSnapshotsRequest.builder()
- Parameters:
describeDbClusterSnapshotsRequest
- AConsumer
that will call methods onDescribeDbClusterSnapshotsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBClusters
default DescribeDbClustersResponse describeDBClusters(DescribeDbClustersRequest describeDbClustersRequest) throws DbClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException 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.
- See Also:
-
describeDBClusters
default DescribeDbClustersResponse describeDBClusters(Consumer<DescribeDbClustersRequest.Builder> describeDbClustersRequest) throws DbClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException Returns information about provisioned DB clusters, and supports pagination.
This operation can also return information for Amazon RDS clusters and Amazon DocDB clusters.
This is a convenience which creates an instance of the
DescribeDbClustersRequest.Builder
avoiding the need to create one manually viaDescribeDbClustersRequest.builder()
- Parameters:
describeDbClustersRequest
- AConsumer
that will call methods onDescribeDbClustersRequest.Builder
to create a request.- Returns:
- Result of the DescribeDBClusters operation returned by the service.
- See Also:
-
describeDBClusters
default DescribeDbClustersResponse describeDBClusters() throws DbClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneExceptionReturns information about provisioned DB clusters, and supports pagination.
This operation can also return information for Amazon RDS clusters and Amazon DocDB clusters.
- Returns:
- Result of the DescribeDBClusters operation returned by the service.
- See Also:
-
describeDBClustersPaginator
default DescribeDBClustersIterable describeDBClustersPaginator() throws DbClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneExceptionThis is a variant of
describeDBClusters(software.amazon.awssdk.services.neptune.model.DescribeDbClustersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClustersIterable responses = client.describeDBClustersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBClustersIterable responses = client .describeDBClustersPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbClustersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClustersIterable responses = client.describeDBClustersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusters(software.amazon.awssdk.services.neptune.model.DescribeDbClustersRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBClustersPaginator
default DescribeDBClustersIterable describeDBClustersPaginator(DescribeDbClustersRequest describeDbClustersRequest) throws DbClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException This is a variant of
describeDBClusters(software.amazon.awssdk.services.neptune.model.DescribeDbClustersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClustersIterable responses = client.describeDBClustersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBClustersIterable responses = client .describeDBClustersPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbClustersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClustersIterable responses = client.describeDBClustersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusters(software.amazon.awssdk.services.neptune.model.DescribeDbClustersRequest)
operation.- Parameters:
describeDbClustersRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBClustersPaginator
default DescribeDBClustersIterable describeDBClustersPaginator(Consumer<DescribeDbClustersRequest.Builder> describeDbClustersRequest) throws DbClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException This is a variant of
describeDBClusters(software.amazon.awssdk.services.neptune.model.DescribeDbClustersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClustersIterable responses = client.describeDBClustersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBClustersIterable responses = client .describeDBClustersPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbClustersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeDBClustersIterable responses = client.describeDBClustersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusters(software.amazon.awssdk.services.neptune.model.DescribeDbClustersRequest)
operation.
This is a convenience which creates an instance of the
DescribeDbClustersRequest.Builder
avoiding the need to create one manually viaDescribeDbClustersRequest.builder()
- Parameters:
describeDbClustersRequest
- AConsumer
that will call methods onDescribeDbClustersRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBEngineVersions
default DescribeDbEngineVersionsResponse describeDBEngineVersions(DescribeDbEngineVersionsRequest describeDbEngineVersionsRequest) throws AwsServiceException, SdkClientException, NeptuneException Returns a list of the available DB engines.
- Parameters:
describeDbEngineVersionsRequest
-- Returns:
- Result of the DescribeDBEngineVersions operation returned by the service.
- See Also:
-
describeDBEngineVersions
default DescribeDbEngineVersionsResponse describeDBEngineVersions(Consumer<DescribeDbEngineVersionsRequest.Builder> describeDbEngineVersionsRequest) throws AwsServiceException, SdkClientException, NeptuneException Returns a list of the available DB engines.
This is a convenience which creates an instance of the
DescribeDbEngineVersionsRequest.Builder
avoiding the need to create one manually viaDescribeDbEngineVersionsRequest.builder()
- Parameters:
describeDbEngineVersionsRequest
- AConsumer
that will call methods onDescribeDbEngineVersionsRequest.Builder
to create a request.- Returns:
- Result of the DescribeDBEngineVersions operation returned by the service.
- See Also:
-
describeDBEngineVersions
default DescribeDbEngineVersionsResponse describeDBEngineVersions() throws AwsServiceException, SdkClientException, NeptuneExceptionReturns a list of the available DB engines.
- Returns:
- Result of the DescribeDBEngineVersions operation returned by the service.
- See Also:
-
describeDBEngineVersionsPaginator
default DescribeDBEngineVersionsIterable describeDBEngineVersionsPaginator() throws AwsServiceException, SdkClientException, NeptuneExceptionThis is a variant of
describeDBEngineVersions(software.amazon.awssdk.services.neptune.model.DescribeDbEngineVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBEngineVersionsIterable responses = client.describeDBEngineVersionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBEngineVersionsIterable responses = client .describeDBEngineVersionsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbEngineVersionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeDBEngineVersionsIterable responses = client.describeDBEngineVersionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBEngineVersions(software.amazon.awssdk.services.neptune.model.DescribeDbEngineVersionsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBEngineVersionsPaginator
default DescribeDBEngineVersionsIterable describeDBEngineVersionsPaginator(DescribeDbEngineVersionsRequest describeDbEngineVersionsRequest) throws AwsServiceException, SdkClientException, NeptuneException This is a variant of
describeDBEngineVersions(software.amazon.awssdk.services.neptune.model.DescribeDbEngineVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBEngineVersionsIterable responses = client.describeDBEngineVersionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBEngineVersionsIterable responses = client .describeDBEngineVersionsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbEngineVersionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeDBEngineVersionsIterable responses = client.describeDBEngineVersionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBEngineVersions(software.amazon.awssdk.services.neptune.model.DescribeDbEngineVersionsRequest)
operation.- Parameters:
describeDbEngineVersionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBEngineVersionsPaginator
default DescribeDBEngineVersionsIterable describeDBEngineVersionsPaginator(Consumer<DescribeDbEngineVersionsRequest.Builder> describeDbEngineVersionsRequest) throws AwsServiceException, SdkClientException, NeptuneException This is a variant of
describeDBEngineVersions(software.amazon.awssdk.services.neptune.model.DescribeDbEngineVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBEngineVersionsIterable responses = client.describeDBEngineVersionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBEngineVersionsIterable responses = client .describeDBEngineVersionsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbEngineVersionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeDBEngineVersionsIterable responses = client.describeDBEngineVersionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBEngineVersions(software.amazon.awssdk.services.neptune.model.DescribeDbEngineVersionsRequest)
operation.
This is a convenience which creates an instance of the
DescribeDbEngineVersionsRequest.Builder
avoiding the need to create one manually viaDescribeDbEngineVersionsRequest.builder()
- Parameters:
describeDbEngineVersionsRequest
- AConsumer
that will call methods onDescribeDbEngineVersionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBInstances
default DescribeDbInstancesResponse describeDBInstances(DescribeDbInstancesRequest describeDbInstancesRequest) throws DbInstanceNotFoundException, AwsServiceException, SdkClientException, NeptuneException 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.
- See Also:
-
describeDBInstances
default DescribeDbInstancesResponse describeDBInstances(Consumer<DescribeDbInstancesRequest.Builder> describeDbInstancesRequest) throws DbInstanceNotFoundException, AwsServiceException, SdkClientException, NeptuneException Returns information about provisioned instances, and supports pagination.
This operation can also return information for Amazon RDS instances and Amazon DocDB instances.
This is a convenience which creates an instance of the
DescribeDbInstancesRequest.Builder
avoiding the need to create one manually viaDescribeDbInstancesRequest.builder()
- Parameters:
describeDbInstancesRequest
- AConsumer
that will call methods onDescribeDbInstancesRequest.Builder
to create a request.- Returns:
- Result of the DescribeDBInstances operation returned by the service.
- See Also:
-
describeDBInstances
default DescribeDbInstancesResponse describeDBInstances() throws DbInstanceNotFoundException, AwsServiceException, SdkClientException, NeptuneExceptionReturns information about provisioned instances, and supports pagination.
This operation can also return information for Amazon RDS instances and Amazon DocDB instances.
- Returns:
- Result of the DescribeDBInstances operation returned by the service.
- See Also:
-
describeDBInstancesPaginator
default DescribeDBInstancesIterable describeDBInstancesPaginator() throws DbInstanceNotFoundException, AwsServiceException, SdkClientException, NeptuneExceptionThis is a variant of
describeDBInstances(software.amazon.awssdk.services.neptune.model.DescribeDbInstancesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBInstancesIterable responses = client.describeDBInstancesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBInstancesIterable responses = client .describeDBInstancesPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbInstancesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeDBInstancesIterable responses = client.describeDBInstancesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBInstances(software.amazon.awssdk.services.neptune.model.DescribeDbInstancesRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBInstancesPaginator
default DescribeDBInstancesIterable describeDBInstancesPaginator(DescribeDbInstancesRequest describeDbInstancesRequest) throws DbInstanceNotFoundException, AwsServiceException, SdkClientException, NeptuneException This is a variant of
describeDBInstances(software.amazon.awssdk.services.neptune.model.DescribeDbInstancesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBInstancesIterable responses = client.describeDBInstancesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBInstancesIterable responses = client .describeDBInstancesPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbInstancesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeDBInstancesIterable responses = client.describeDBInstancesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBInstances(software.amazon.awssdk.services.neptune.model.DescribeDbInstancesRequest)
operation.- Parameters:
describeDbInstancesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBInstancesPaginator
default DescribeDBInstancesIterable describeDBInstancesPaginator(Consumer<DescribeDbInstancesRequest.Builder> describeDbInstancesRequest) throws DbInstanceNotFoundException, AwsServiceException, SdkClientException, NeptuneException This is a variant of
describeDBInstances(software.amazon.awssdk.services.neptune.model.DescribeDbInstancesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBInstancesIterable responses = client.describeDBInstancesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBInstancesIterable responses = client .describeDBInstancesPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbInstancesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeDBInstancesIterable responses = client.describeDBInstancesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBInstances(software.amazon.awssdk.services.neptune.model.DescribeDbInstancesRequest)
operation.
This is a convenience which creates an instance of the
DescribeDbInstancesRequest.Builder
avoiding the need to create one manually viaDescribeDbInstancesRequest.builder()
- Parameters:
describeDbInstancesRequest
- AConsumer
that will call methods onDescribeDbInstancesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBParameterGroups
default DescribeDbParameterGroupsResponse describeDBParameterGroups(DescribeDbParameterGroupsRequest describeDbParameterGroupsRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException Returns a list of
DBParameterGroup
descriptions. If aDBParameterGroupName
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.
- See Also:
-
describeDBParameterGroups
default DescribeDbParameterGroupsResponse describeDBParameterGroups(Consumer<DescribeDbParameterGroupsRequest.Builder> describeDbParameterGroupsRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException Returns a list of
DBParameterGroup
descriptions. If aDBParameterGroupName
is specified, the list will contain only the description of the specified DB parameter group.
This is a convenience which creates an instance of the
DescribeDbParameterGroupsRequest.Builder
avoiding the need to create one manually viaDescribeDbParameterGroupsRequest.builder()
- Parameters:
describeDbParameterGroupsRequest
- AConsumer
that will call methods onDescribeDbParameterGroupsRequest.Builder
to create a request.- Returns:
- Result of the DescribeDBParameterGroups operation returned by the service.
- See Also:
-
describeDBParameterGroups
default DescribeDbParameterGroupsResponse describeDBParameterGroups() throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneExceptionReturns a list of
DBParameterGroup
descriptions. If aDBParameterGroupName
is specified, the list will contain only the description of the specified DB parameter group.- Returns:
- Result of the DescribeDBParameterGroups operation returned by the service.
- See Also:
-
describeDBParameterGroupsPaginator
default DescribeDBParameterGroupsIterable describeDBParameterGroupsPaginator() throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneExceptionThis is a variant of
describeDBParameterGroups(software.amazon.awssdk.services.neptune.model.DescribeDbParameterGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBParameterGroupsIterable responses = client.describeDBParameterGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBParameterGroupsIterable responses = client .describeDBParameterGroupsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbParameterGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeDBParameterGroupsIterable responses = client.describeDBParameterGroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBParameterGroups(software.amazon.awssdk.services.neptune.model.DescribeDbParameterGroupsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBParameterGroupsPaginator
default DescribeDBParameterGroupsIterable describeDBParameterGroupsPaginator(DescribeDbParameterGroupsRequest describeDbParameterGroupsRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException This is a variant of
describeDBParameterGroups(software.amazon.awssdk.services.neptune.model.DescribeDbParameterGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBParameterGroupsIterable responses = client.describeDBParameterGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBParameterGroupsIterable responses = client .describeDBParameterGroupsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbParameterGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeDBParameterGroupsIterable responses = client.describeDBParameterGroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBParameterGroups(software.amazon.awssdk.services.neptune.model.DescribeDbParameterGroupsRequest)
operation.- Parameters:
describeDbParameterGroupsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBParameterGroupsPaginator
default DescribeDBParameterGroupsIterable describeDBParameterGroupsPaginator(Consumer<DescribeDbParameterGroupsRequest.Builder> describeDbParameterGroupsRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException This is a variant of
describeDBParameterGroups(software.amazon.awssdk.services.neptune.model.DescribeDbParameterGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBParameterGroupsIterable responses = client.describeDBParameterGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBParameterGroupsIterable responses = client .describeDBParameterGroupsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbParameterGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeDBParameterGroupsIterable responses = client.describeDBParameterGroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBParameterGroups(software.amazon.awssdk.services.neptune.model.DescribeDbParameterGroupsRequest)
operation.
This is a convenience which creates an instance of the
DescribeDbParameterGroupsRequest.Builder
avoiding the need to create one manually viaDescribeDbParameterGroupsRequest.builder()
- Parameters:
describeDbParameterGroupsRequest
- AConsumer
that will call methods onDescribeDbParameterGroupsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBParameters
default DescribeDbParametersResponse describeDBParameters(DescribeDbParametersRequest describeDbParametersRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException Returns the detailed parameter list for a particular DB parameter group.
- Parameters:
describeDbParametersRequest
-- Returns:
- Result of the DescribeDBParameters operation returned by the service.
- See Also:
-
describeDBParameters
default DescribeDbParametersResponse describeDBParameters(Consumer<DescribeDbParametersRequest.Builder> describeDbParametersRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException Returns the detailed parameter list for a particular DB parameter group.
This is a convenience which creates an instance of the
DescribeDbParametersRequest.Builder
avoiding the need to create one manually viaDescribeDbParametersRequest.builder()
- Parameters:
describeDbParametersRequest
- AConsumer
that will call methods onDescribeDbParametersRequest.Builder
to create a request.- Returns:
- Result of the DescribeDBParameters operation returned by the service.
- See Also:
-
describeDBParametersPaginator
default DescribeDBParametersIterable describeDBParametersPaginator(DescribeDbParametersRequest describeDbParametersRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException This is a variant of
describeDBParameters(software.amazon.awssdk.services.neptune.model.DescribeDbParametersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBParametersIterable responses = client.describeDBParametersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBParametersIterable responses = client .describeDBParametersPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbParametersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeDBParametersIterable responses = client.describeDBParametersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBParameters(software.amazon.awssdk.services.neptune.model.DescribeDbParametersRequest)
operation.- Parameters:
describeDbParametersRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBParametersPaginator
default DescribeDBParametersIterable describeDBParametersPaginator(Consumer<DescribeDbParametersRequest.Builder> describeDbParametersRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException This is a variant of
describeDBParameters(software.amazon.awssdk.services.neptune.model.DescribeDbParametersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBParametersIterable responses = client.describeDBParametersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBParametersIterable responses = client .describeDBParametersPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbParametersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeDBParametersIterable responses = client.describeDBParametersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBParameters(software.amazon.awssdk.services.neptune.model.DescribeDbParametersRequest)
operation.
This is a convenience which creates an instance of the
DescribeDbParametersRequest.Builder
avoiding the need to create one manually viaDescribeDbParametersRequest.builder()
- Parameters:
describeDbParametersRequest
- AConsumer
that will call methods onDescribeDbParametersRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBSubnetGroups
default DescribeDbSubnetGroupsResponse describeDBSubnetGroups(DescribeDbSubnetGroupsRequest describeDbSubnetGroupsRequest) throws DbSubnetGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException 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.
- Parameters:
describeDbSubnetGroupsRequest
-- Returns:
- Result of the DescribeDBSubnetGroups operation returned by the service.
- See Also:
-
describeDBSubnetGroups
default DescribeDbSubnetGroupsResponse describeDBSubnetGroups(Consumer<DescribeDbSubnetGroupsRequest.Builder> describeDbSubnetGroupsRequest) throws DbSubnetGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException 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.
This is a convenience which creates an instance of the
DescribeDbSubnetGroupsRequest.Builder
avoiding the need to create one manually viaDescribeDbSubnetGroupsRequest.builder()
- Parameters:
describeDbSubnetGroupsRequest
- AConsumer
that will call methods onDescribeDbSubnetGroupsRequest.Builder
to create a request.- Returns:
- Result of the DescribeDBSubnetGroups operation returned by the service.
- See Also:
-
describeDBSubnetGroups
default DescribeDbSubnetGroupsResponse describeDBSubnetGroups() throws DbSubnetGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneExceptionReturns 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.
- Returns:
- Result of the DescribeDBSubnetGroups operation returned by the service.
- See Also:
-
describeDBSubnetGroupsPaginator
default DescribeDBSubnetGroupsIterable describeDBSubnetGroupsPaginator() throws DbSubnetGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneExceptionThis is a variant of
describeDBSubnetGroups(software.amazon.awssdk.services.neptune.model.DescribeDbSubnetGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBSubnetGroupsIterable responses = client.describeDBSubnetGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBSubnetGroupsIterable responses = client .describeDBSubnetGroupsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbSubnetGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeDBSubnetGroupsIterable responses = client.describeDBSubnetGroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBSubnetGroups(software.amazon.awssdk.services.neptune.model.DescribeDbSubnetGroupsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBSubnetGroupsPaginator
default DescribeDBSubnetGroupsIterable describeDBSubnetGroupsPaginator(DescribeDbSubnetGroupsRequest describeDbSubnetGroupsRequest) throws DbSubnetGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException This is a variant of
describeDBSubnetGroups(software.amazon.awssdk.services.neptune.model.DescribeDbSubnetGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBSubnetGroupsIterable responses = client.describeDBSubnetGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBSubnetGroupsIterable responses = client .describeDBSubnetGroupsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbSubnetGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeDBSubnetGroupsIterable responses = client.describeDBSubnetGroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBSubnetGroups(software.amazon.awssdk.services.neptune.model.DescribeDbSubnetGroupsRequest)
operation.- Parameters:
describeDbSubnetGroupsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBSubnetGroupsPaginator
default DescribeDBSubnetGroupsIterable describeDBSubnetGroupsPaginator(Consumer<DescribeDbSubnetGroupsRequest.Builder> describeDbSubnetGroupsRequest) throws DbSubnetGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException This is a variant of
describeDBSubnetGroups(software.amazon.awssdk.services.neptune.model.DescribeDbSubnetGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.neptune.paginators.DescribeDBSubnetGroupsIterable responses = client.describeDBSubnetGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeDBSubnetGroupsIterable responses = client .describeDBSubnetGroupsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeDbSubnetGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeDBSubnetGroupsIterable responses = client.describeDBSubnetGroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBSubnetGroups(software.amazon.awssdk.services.neptune.model.DescribeDbSubnetGroupsRequest)
operation.
This is a convenience which creates an instance of the
DescribeDbSubnetGroupsRequest.Builder
avoiding the need to create one manually viaDescribeDbSubnetGroupsRequest.builder()
- Parameters:
describeDbSubnetGroupsRequest
- AConsumer
that will call methods onDescribeDbSubnetGroupsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeEngineDefaultClusterParameters
default DescribeEngineDefaultClusterParametersResponse describeEngineDefaultClusterParameters(DescribeEngineDefaultClusterParametersRequest describeEngineDefaultClusterParametersRequest) throws AwsServiceException, SdkClientException, NeptuneException 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:
-
describeEngineDefaultClusterParameters
default DescribeEngineDefaultClusterParametersResponse describeEngineDefaultClusterParameters(Consumer<DescribeEngineDefaultClusterParametersRequest.Builder> describeEngineDefaultClusterParametersRequest) throws AwsServiceException, SdkClientException, NeptuneException Returns the default engine and system parameter information for the cluster database engine.
This is a convenience which creates an instance of the
DescribeEngineDefaultClusterParametersRequest.Builder
avoiding the need to create one manually viaDescribeEngineDefaultClusterParametersRequest.builder()
- Parameters:
describeEngineDefaultClusterParametersRequest
- AConsumer
that will call methods onDescribeEngineDefaultClusterParametersRequest.Builder
to create a request.- Returns:
- Result of the DescribeEngineDefaultClusterParameters operation returned by the service.
- See Also:
-
describeEngineDefaultParameters
default DescribeEngineDefaultParametersResponse describeEngineDefaultParameters(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest) throws AwsServiceException, SdkClientException, NeptuneException 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:
-
describeEngineDefaultParameters
default DescribeEngineDefaultParametersResponse describeEngineDefaultParameters(Consumer<DescribeEngineDefaultParametersRequest.Builder> describeEngineDefaultParametersRequest) throws AwsServiceException, SdkClientException, NeptuneException Returns the default engine and system parameter information for the specified database engine.
This is a convenience which creates an instance of the
DescribeEngineDefaultParametersRequest.Builder
avoiding the need to create one manually viaDescribeEngineDefaultParametersRequest.builder()
- Parameters:
describeEngineDefaultParametersRequest
- AConsumer
that will call methods onDescribeEngineDefaultParametersRequest.Builder
to create a request.- Returns:
- Result of the DescribeEngineDefaultParameters operation returned by the service.
- See Also:
-
describeEngineDefaultParametersPaginator
default DescribeEngineDefaultParametersIterable describeEngineDefaultParametersPaginator(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest) throws AwsServiceException, SdkClientException, NeptuneException This is a variant of
describeEngineDefaultParameters(software.amazon.awssdk.services.neptune.model.DescribeEngineDefaultParametersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.neptune.paginators.DescribeEngineDefaultParametersIterable responses = client.describeEngineDefaultParametersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeEngineDefaultParametersIterable responses = client .describeEngineDefaultParametersPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeEngineDefaultParametersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeEngineDefaultParametersIterable responses = client.describeEngineDefaultParametersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEngineDefaultParameters(software.amazon.awssdk.services.neptune.model.DescribeEngineDefaultParametersRequest)
operation.- Parameters:
describeEngineDefaultParametersRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeEngineDefaultParametersPaginator
default DescribeEngineDefaultParametersIterable describeEngineDefaultParametersPaginator(Consumer<DescribeEngineDefaultParametersRequest.Builder> describeEngineDefaultParametersRequest) throws AwsServiceException, SdkClientException, NeptuneException This is a variant of
describeEngineDefaultParameters(software.amazon.awssdk.services.neptune.model.DescribeEngineDefaultParametersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.neptune.paginators.DescribeEngineDefaultParametersIterable responses = client.describeEngineDefaultParametersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeEngineDefaultParametersIterable responses = client .describeEngineDefaultParametersPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeEngineDefaultParametersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeEngineDefaultParametersIterable responses = client.describeEngineDefaultParametersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEngineDefaultParameters(software.amazon.awssdk.services.neptune.model.DescribeEngineDefaultParametersRequest)
operation.
This is a convenience which creates an instance of the
DescribeEngineDefaultParametersRequest.Builder
avoiding the need to create one manually viaDescribeEngineDefaultParametersRequest.builder()
- Parameters:
describeEngineDefaultParametersRequest
- AConsumer
that will call methods onDescribeEngineDefaultParametersRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeEventCategories
default DescribeEventCategoriesResponse describeEventCategories(DescribeEventCategoriesRequest describeEventCategoriesRequest) throws AwsServiceException, SdkClientException, NeptuneException 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:
-
describeEventCategories
default DescribeEventCategoriesResponse describeEventCategories(Consumer<DescribeEventCategoriesRequest.Builder> describeEventCategoriesRequest) throws AwsServiceException, SdkClientException, NeptuneException Displays a list of categories for all event source types, or, if specified, for a specified source type.
This is a convenience which creates an instance of the
DescribeEventCategoriesRequest.Builder
avoiding the need to create one manually viaDescribeEventCategoriesRequest.builder()
- Parameters:
describeEventCategoriesRequest
- AConsumer
that will call methods onDescribeEventCategoriesRequest.Builder
to create a request.- Returns:
- Result of the DescribeEventCategories operation returned by the service.
- See Also:
-
describeEventCategories
default DescribeEventCategoriesResponse describeEventCategories() throws AwsServiceException, SdkClientException, NeptuneExceptionDisplays a list of categories for all event source types, or, if specified, for a specified source type.
- Returns:
- Result of the DescribeEventCategories operation returned by the service.
- See Also:
-
describeEventSubscriptions
default DescribeEventSubscriptionsResponse describeEventSubscriptions(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest) throws SubscriptionNotFoundException, AwsServiceException, SdkClientException, NeptuneException 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.
- See Also:
-
describeEventSubscriptions
default DescribeEventSubscriptionsResponse describeEventSubscriptions(Consumer<DescribeEventSubscriptionsRequest.Builder> describeEventSubscriptionsRequest) throws SubscriptionNotFoundException, AwsServiceException, SdkClientException, NeptuneException 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.
This is a convenience which creates an instance of the
DescribeEventSubscriptionsRequest.Builder
avoiding the need to create one manually viaDescribeEventSubscriptionsRequest.builder()
- Parameters:
describeEventSubscriptionsRequest
- AConsumer
that will call methods onDescribeEventSubscriptionsRequest.Builder
to create a request.- Returns:
- Result of the DescribeEventSubscriptions operation returned by the service.
- See Also:
-
describeEventSubscriptions
default DescribeEventSubscriptionsResponse describeEventSubscriptions() throws SubscriptionNotFoundException, AwsServiceException, SdkClientException, NeptuneExceptionLists 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.
- Returns:
- Result of the DescribeEventSubscriptions operation returned by the service.
- See Also:
-
describeEventSubscriptionsPaginator
default DescribeEventSubscriptionsIterable describeEventSubscriptionsPaginator() throws SubscriptionNotFoundException, AwsServiceException, SdkClientException, NeptuneExceptionThis is a variant of
describeEventSubscriptions(software.amazon.awssdk.services.neptune.model.DescribeEventSubscriptionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.neptune.paginators.DescribeEventSubscriptionsIterable responses = client.describeEventSubscriptionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeEventSubscriptionsIterable responses = client .describeEventSubscriptionsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeEventSubscriptionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeEventSubscriptionsIterable responses = client.describeEventSubscriptionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEventSubscriptions(software.amazon.awssdk.services.neptune.model.DescribeEventSubscriptionsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeEventSubscriptionsPaginator
default DescribeEventSubscriptionsIterable describeEventSubscriptionsPaginator(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest) throws SubscriptionNotFoundException, AwsServiceException, SdkClientException, NeptuneException This is a variant of
describeEventSubscriptions(software.amazon.awssdk.services.neptune.model.DescribeEventSubscriptionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.neptune.paginators.DescribeEventSubscriptionsIterable responses = client.describeEventSubscriptionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeEventSubscriptionsIterable responses = client .describeEventSubscriptionsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeEventSubscriptionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeEventSubscriptionsIterable responses = client.describeEventSubscriptionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEventSubscriptions(software.amazon.awssdk.services.neptune.model.DescribeEventSubscriptionsRequest)
operation.- Parameters:
describeEventSubscriptionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeEventSubscriptionsPaginator
default DescribeEventSubscriptionsIterable describeEventSubscriptionsPaginator(Consumer<DescribeEventSubscriptionsRequest.Builder> describeEventSubscriptionsRequest) throws SubscriptionNotFoundException, AwsServiceException, SdkClientException, NeptuneException This is a variant of
describeEventSubscriptions(software.amazon.awssdk.services.neptune.model.DescribeEventSubscriptionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.neptune.paginators.DescribeEventSubscriptionsIterable responses = client.describeEventSubscriptionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeEventSubscriptionsIterable responses = client .describeEventSubscriptionsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeEventSubscriptionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeEventSubscriptionsIterable responses = client.describeEventSubscriptionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEventSubscriptions(software.amazon.awssdk.services.neptune.model.DescribeEventSubscriptionsRequest)
operation.
This is a convenience which creates an instance of the
DescribeEventSubscriptionsRequest.Builder
avoiding the need to create one manually viaDescribeEventSubscriptionsRequest.builder()
- Parameters:
describeEventSubscriptionsRequest
- AConsumer
that will call methods onDescribeEventSubscriptionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeEvents
default DescribeEventsResponse describeEvents(DescribeEventsRequest describeEventsRequest) throws AwsServiceException, SdkClientException, NeptuneException 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:
-
describeEvents
default DescribeEventsResponse describeEvents(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) throws AwsServiceException, SdkClientException, NeptuneException 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.
This is a convenience which creates an instance of the
DescribeEventsRequest.Builder
avoiding the need to create one manually viaDescribeEventsRequest.builder()
- Parameters:
describeEventsRequest
- AConsumer
that will call methods onDescribeEventsRequest.Builder
to create a request.- Returns:
- Result of the DescribeEvents operation returned by the service.
- See Also:
-
describeEvents
default DescribeEventsResponse describeEvents() throws AwsServiceException, SdkClientException, NeptuneExceptionReturns 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.
- Returns:
- Result of the DescribeEvents operation returned by the service.
- See Also:
-
describeEventsPaginator
default DescribeEventsIterable describeEventsPaginator() throws AwsServiceException, SdkClientException, NeptuneExceptionThis is a variant of
describeEvents(software.amazon.awssdk.services.neptune.model.DescribeEventsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.neptune.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeEventsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEvents(software.amazon.awssdk.services.neptune.model.DescribeEventsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeEventsPaginator
default DescribeEventsIterable describeEventsPaginator(DescribeEventsRequest describeEventsRequest) throws AwsServiceException, SdkClientException, NeptuneException This is a variant of
describeEvents(software.amazon.awssdk.services.neptune.model.DescribeEventsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.neptune.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeEventsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEvents(software.amazon.awssdk.services.neptune.model.DescribeEventsRequest)
operation.- Parameters:
describeEventsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeEventsPaginator
default DescribeEventsIterable describeEventsPaginator(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) throws AwsServiceException, SdkClientException, NeptuneException This is a variant of
describeEvents(software.amazon.awssdk.services.neptune.model.DescribeEventsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.neptune.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeEventsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEvents(software.amazon.awssdk.services.neptune.model.DescribeEventsRequest)
operation.
This is a convenience which creates an instance of the
DescribeEventsRequest.Builder
avoiding the need to create one manually viaDescribeEventsRequest.builder()
- Parameters:
describeEventsRequest
- AConsumer
that will call methods onDescribeEventsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeGlobalClusters
default DescribeGlobalClustersResponse describeGlobalClusters(DescribeGlobalClustersRequest describeGlobalClustersRequest) throws GlobalClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException Returns information about Neptune global database clusters. This API supports pagination.
- Parameters:
describeGlobalClustersRequest
-- Returns:
- Result of the DescribeGlobalClusters operation returned by the service.
- See Also:
-
describeGlobalClusters
default DescribeGlobalClustersResponse describeGlobalClusters(Consumer<DescribeGlobalClustersRequest.Builder> describeGlobalClustersRequest) throws GlobalClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException Returns information about Neptune global database clusters. This API supports pagination.
This is a convenience which creates an instance of the
DescribeGlobalClustersRequest.Builder
avoiding the need to create one manually viaDescribeGlobalClustersRequest.builder()
- Parameters:
describeGlobalClustersRequest
- AConsumer
that will call methods onDescribeGlobalClustersRequest.Builder
to create a request.- Returns:
- Result of the DescribeGlobalClusters operation returned by the service.
- See Also:
-
describeGlobalClustersPaginator
default DescribeGlobalClustersIterable describeGlobalClustersPaginator(DescribeGlobalClustersRequest describeGlobalClustersRequest) throws GlobalClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException This is a variant of
describeGlobalClusters(software.amazon.awssdk.services.neptune.model.DescribeGlobalClustersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.neptune.paginators.DescribeGlobalClustersIterable responses = client.describeGlobalClustersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeGlobalClustersIterable responses = client .describeGlobalClustersPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeGlobalClustersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeGlobalClustersIterable responses = client.describeGlobalClustersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeGlobalClusters(software.amazon.awssdk.services.neptune.model.DescribeGlobalClustersRequest)
operation.- Parameters:
describeGlobalClustersRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeGlobalClustersPaginator
default DescribeGlobalClustersIterable describeGlobalClustersPaginator(Consumer<DescribeGlobalClustersRequest.Builder> describeGlobalClustersRequest) throws GlobalClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException This is a variant of
describeGlobalClusters(software.amazon.awssdk.services.neptune.model.DescribeGlobalClustersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.neptune.paginators.DescribeGlobalClustersIterable responses = client.describeGlobalClustersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeGlobalClustersIterable responses = client .describeGlobalClustersPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeGlobalClustersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeGlobalClustersIterable responses = client.describeGlobalClustersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeGlobalClusters(software.amazon.awssdk.services.neptune.model.DescribeGlobalClustersRequest)
operation.
This is a convenience which creates an instance of the
DescribeGlobalClustersRequest.Builder
avoiding the need to create one manually viaDescribeGlobalClustersRequest.builder()
- Parameters:
describeGlobalClustersRequest
- AConsumer
that will call methods onDescribeGlobalClustersRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeOrderableDBInstanceOptions
default DescribeOrderableDbInstanceOptionsResponse describeOrderableDBInstanceOptions(DescribeOrderableDbInstanceOptionsRequest describeOrderableDbInstanceOptionsRequest) throws AwsServiceException, SdkClientException, NeptuneException Returns a list of orderable DB instance options for the specified engine.
- Parameters:
describeOrderableDbInstanceOptionsRequest
-- Returns:
- Result of the DescribeOrderableDBInstanceOptions operation returned by the service.
- See Also:
-
describeOrderableDBInstanceOptions
default DescribeOrderableDbInstanceOptionsResponse describeOrderableDBInstanceOptions(Consumer<DescribeOrderableDbInstanceOptionsRequest.Builder> describeOrderableDbInstanceOptionsRequest) throws AwsServiceException, SdkClientException, NeptuneException Returns a list of orderable DB instance options for the specified engine.
This is a convenience which creates an instance of the
DescribeOrderableDbInstanceOptionsRequest.Builder
avoiding the need to create one manually viaDescribeOrderableDbInstanceOptionsRequest.builder()
- Parameters:
describeOrderableDbInstanceOptionsRequest
- AConsumer
that will call methods onDescribeOrderableDbInstanceOptionsRequest.Builder
to create a request.- Returns:
- Result of the DescribeOrderableDBInstanceOptions operation returned by the service.
- See Also:
-
describeOrderableDBInstanceOptionsPaginator
default DescribeOrderableDBInstanceOptionsIterable describeOrderableDBInstanceOptionsPaginator(DescribeOrderableDbInstanceOptionsRequest describeOrderableDbInstanceOptionsRequest) throws AwsServiceException, SdkClientException, NeptuneException This is a variant of
describeOrderableDBInstanceOptions(software.amazon.awssdk.services.neptune.model.DescribeOrderableDbInstanceOptionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.neptune.paginators.DescribeOrderableDBInstanceOptionsIterable responses = client.describeOrderableDBInstanceOptionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeOrderableDBInstanceOptionsIterable responses = client .describeOrderableDBInstanceOptionsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeOrderableDbInstanceOptionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeOrderableDBInstanceOptionsIterable responses = client.describeOrderableDBInstanceOptionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeOrderableDBInstanceOptions(software.amazon.awssdk.services.neptune.model.DescribeOrderableDbInstanceOptionsRequest)
operation.- Parameters:
describeOrderableDbInstanceOptionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeOrderableDBInstanceOptionsPaginator
default DescribeOrderableDBInstanceOptionsIterable describeOrderableDBInstanceOptionsPaginator(Consumer<DescribeOrderableDbInstanceOptionsRequest.Builder> describeOrderableDbInstanceOptionsRequest) throws AwsServiceException, SdkClientException, NeptuneException This is a variant of
describeOrderableDBInstanceOptions(software.amazon.awssdk.services.neptune.model.DescribeOrderableDbInstanceOptionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.neptune.paginators.DescribeOrderableDBInstanceOptionsIterable responses = client.describeOrderableDBInstanceOptionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.neptune.paginators.DescribeOrderableDBInstanceOptionsIterable responses = client .describeOrderableDBInstanceOptionsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribeOrderableDbInstanceOptionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribeOrderableDBInstanceOptionsIterable responses = client.describeOrderableDBInstanceOptionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeOrderableDBInstanceOptions(software.amazon.awssdk.services.neptune.model.DescribeOrderableDbInstanceOptionsRequest)
operation.
This is a convenience which creates an instance of the
DescribeOrderableDbInstanceOptionsRequest.Builder
avoiding the need to create one manually viaDescribeOrderableDbInstanceOptionsRequest.builder()
- Parameters:
describeOrderableDbInstanceOptionsRequest
- AConsumer
that will call methods onDescribeOrderableDbInstanceOptionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describePendingMaintenanceActions
default DescribePendingMaintenanceActionsResponse describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneException Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
- Parameters:
describePendingMaintenanceActionsRequest
-- Returns:
- Result of the DescribePendingMaintenanceActions operation returned by the service.
- See Also:
-
describePendingMaintenanceActions
default DescribePendingMaintenanceActionsResponse describePendingMaintenanceActions(Consumer<DescribePendingMaintenanceActionsRequest.Builder> describePendingMaintenanceActionsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneException Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
This is a convenience which creates an instance of the
DescribePendingMaintenanceActionsRequest.Builder
avoiding the need to create one manually viaDescribePendingMaintenanceActionsRequest.builder()
- Parameters:
describePendingMaintenanceActionsRequest
- AConsumer
that will call methods onDescribePendingMaintenanceActionsRequest.Builder
to create a request.- Returns:
- Result of the DescribePendingMaintenanceActions operation returned by the service.
- See Also:
-
describePendingMaintenanceActions
default DescribePendingMaintenanceActionsResponse describePendingMaintenanceActions() throws ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneExceptionReturns a list of resources (for example, DB instances) that have at least one pending maintenance action.
- Returns:
- Result of the DescribePendingMaintenanceActions operation returned by the service.
- See Also:
-
describePendingMaintenanceActionsPaginator
default DescribePendingMaintenanceActionsIterable describePendingMaintenanceActionsPaginator() throws ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneExceptionThis is a variant of
describePendingMaintenanceActions(software.amazon.awssdk.services.neptune.model.DescribePendingMaintenanceActionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.neptune.paginators.DescribePendingMaintenanceActionsIterable responses = client.describePendingMaintenanceActionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.neptune.paginators.DescribePendingMaintenanceActionsIterable responses = client .describePendingMaintenanceActionsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribePendingMaintenanceActionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribePendingMaintenanceActionsIterable responses = client.describePendingMaintenanceActionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describePendingMaintenanceActions(software.amazon.awssdk.services.neptune.model.DescribePendingMaintenanceActionsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describePendingMaintenanceActionsPaginator
default DescribePendingMaintenanceActionsIterable describePendingMaintenanceActionsPaginator(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneException This is a variant of
describePendingMaintenanceActions(software.amazon.awssdk.services.neptune.model.DescribePendingMaintenanceActionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.neptune.paginators.DescribePendingMaintenanceActionsIterable responses = client.describePendingMaintenanceActionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.neptune.paginators.DescribePendingMaintenanceActionsIterable responses = client .describePendingMaintenanceActionsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribePendingMaintenanceActionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribePendingMaintenanceActionsIterable responses = client.describePendingMaintenanceActionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describePendingMaintenanceActions(software.amazon.awssdk.services.neptune.model.DescribePendingMaintenanceActionsRequest)
operation.- Parameters:
describePendingMaintenanceActionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describePendingMaintenanceActionsPaginator
default DescribePendingMaintenanceActionsIterable describePendingMaintenanceActionsPaginator(Consumer<DescribePendingMaintenanceActionsRequest.Builder> describePendingMaintenanceActionsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, NeptuneException This is a variant of
describePendingMaintenanceActions(software.amazon.awssdk.services.neptune.model.DescribePendingMaintenanceActionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.neptune.paginators.DescribePendingMaintenanceActionsIterable responses = client.describePendingMaintenanceActionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.neptune.paginators.DescribePendingMaintenanceActionsIterable responses = client .describePendingMaintenanceActionsPaginator(request); for (software.amazon.awssdk.services.neptune.model.DescribePendingMaintenanceActionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.neptune.paginators.DescribePendingMaintenanceActionsIterable responses = client.describePendingMaintenanceActionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describePendingMaintenanceActions(software.amazon.awssdk.services.neptune.model.DescribePendingMaintenanceActionsRequest)
operation.
This is a convenience which creates an instance of the
DescribePendingMaintenanceActionsRequest.Builder
avoiding the need to create one manually viaDescribePendingMaintenanceActionsRequest.builder()
- Parameters:
describePendingMaintenanceActionsRequest
- AConsumer
that will call methods onDescribePendingMaintenanceActionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeValidDBInstanceModifications
default DescribeValidDbInstanceModificationsResponse describeValidDBInstanceModifications(DescribeValidDbInstanceModificationsRequest describeValidDbInstanceModificationsRequest) throws DbInstanceNotFoundException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, NeptuneException You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance.
- Parameters:
describeValidDbInstanceModificationsRequest
-- Returns:
- Result of the DescribeValidDBInstanceModifications operation returned by the service.
- See Also:
-
describeValidDBInstanceModifications
default DescribeValidDbInstanceModificationsResponse describeValidDBInstanceModifications(Consumer<DescribeValidDbInstanceModificationsRequest.Builder> describeValidDbInstanceModificationsRequest) throws DbInstanceNotFoundException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, NeptuneException You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance.
This is a convenience which creates an instance of the
DescribeValidDbInstanceModificationsRequest.Builder
avoiding the need to create one manually viaDescribeValidDbInstanceModificationsRequest.builder()
- Parameters:
describeValidDbInstanceModificationsRequest
- AConsumer
that will call methods onDescribeValidDbInstanceModificationsRequest.Builder
to create a request.- Returns:
- Result of the DescribeValidDBInstanceModifications operation returned by the service.
- See Also:
-
failoverDBCluster
default FailoverDbClusterResponse failoverDBCluster(FailoverDbClusterRequest failoverDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, NeptuneException 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.
- See Also:
-
failoverDBCluster
default FailoverDbClusterResponse failoverDBCluster(Consumer<FailoverDbClusterRequest.Builder> failoverDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, NeptuneException 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.
This is a convenience which creates an instance of the
FailoverDbClusterRequest.Builder
avoiding the need to create one manually viaFailoverDbClusterRequest.builder()
- Parameters:
failoverDbClusterRequest
- AConsumer
that will call methods onFailoverDbClusterRequest.Builder
to create a request.- Returns:
- Result of the FailoverDBCluster operation returned by the service.
- See Also:
-
failoverGlobalCluster
default FailoverGlobalClusterResponse failoverGlobalCluster(FailoverGlobalClusterRequest failoverGlobalClusterRequest) throws GlobalClusterNotFoundException, InvalidGlobalClusterStateException, InvalidDbClusterStateException, DbClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException 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.
- See Also:
-
failoverGlobalCluster
default FailoverGlobalClusterResponse failoverGlobalCluster(Consumer<FailoverGlobalClusterRequest.Builder> failoverGlobalClusterRequest) throws GlobalClusterNotFoundException, InvalidGlobalClusterStateException, InvalidDbClusterStateException, DbClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException 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.
This is a convenience which creates an instance of the
FailoverGlobalClusterRequest.Builder
avoiding the need to create one manually viaFailoverGlobalClusterRequest.builder()
- Parameters:
failoverGlobalClusterRequest
- AConsumer
that will call methods onFailoverGlobalClusterRequest.Builder
to create a request.- Returns:
- Result of the FailoverGlobalCluster operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws DbInstanceNotFoundException, DbSnapshotNotFoundException, DbClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException Lists all tags on an Amazon Neptune resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws DbInstanceNotFoundException, DbSnapshotNotFoundException, DbClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException Lists all tags on an Amazon Neptune resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
modifyDBCluster
default ModifyDbClusterResponse modifyDBCluster(ModifyDbClusterRequest modifyDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, InvalidVpcNetworkStateException, InvalidDbSubnetGroupStateException, InvalidSubnetException, DbClusterParameterGroupNotFoundException, InvalidDbSecurityGroupStateException, InvalidDbInstanceStateException, DbClusterAlreadyExistsException, StorageTypeNotSupportedException, AwsServiceException, SdkClientException, NeptuneException 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.
- Parameters:
modifyDbClusterRequest
-- Returns:
- Result of the ModifyDBCluster operation returned by the service.
- See Also:
-
modifyDBCluster
default ModifyDbClusterResponse modifyDBCluster(Consumer<ModifyDbClusterRequest.Builder> modifyDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, InvalidVpcNetworkStateException, InvalidDbSubnetGroupStateException, InvalidSubnetException, DbClusterParameterGroupNotFoundException, InvalidDbSecurityGroupStateException, InvalidDbInstanceStateException, DbClusterAlreadyExistsException, StorageTypeNotSupportedException, AwsServiceException, SdkClientException, NeptuneException 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.
This is a convenience which creates an instance of the
ModifyDbClusterRequest.Builder
avoiding the need to create one manually viaModifyDbClusterRequest.builder()
- Parameters:
modifyDbClusterRequest
- AConsumer
that will call methods onModifyDbClusterRequest.Builder
to create a request.- Returns:
- Result of the ModifyDBCluster operation returned by the service.
- See Also:
-
modifyDBClusterEndpoint
default ModifyDbClusterEndpointResponse modifyDBClusterEndpoint(ModifyDbClusterEndpointRequest modifyDbClusterEndpointRequest) throws InvalidDbClusterStateException, InvalidDbClusterEndpointStateException, DbClusterEndpointNotFoundException, DbInstanceNotFoundException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, NeptuneException Modifies the properties of an endpoint in an Amazon Neptune DB cluster.
- Parameters:
modifyDbClusterEndpointRequest
-- Returns:
- Result of the ModifyDBClusterEndpoint operation returned by the service.
- See Also:
-
modifyDBClusterEndpoint
default ModifyDbClusterEndpointResponse modifyDBClusterEndpoint(Consumer<ModifyDbClusterEndpointRequest.Builder> modifyDbClusterEndpointRequest) throws InvalidDbClusterStateException, InvalidDbClusterEndpointStateException, DbClusterEndpointNotFoundException, DbInstanceNotFoundException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, NeptuneException Modifies the properties of an endpoint in an Amazon Neptune DB cluster.
This is a convenience which creates an instance of the
ModifyDbClusterEndpointRequest.Builder
avoiding the need to create one manually viaModifyDbClusterEndpointRequest.builder()
- Parameters:
modifyDbClusterEndpointRequest
- AConsumer
that will call methods onModifyDbClusterEndpointRequest.Builder
to create a request.- Returns:
- Result of the ModifyDBClusterEndpoint operation returned by the service.
- See Also:
-
modifyDBClusterParameterGroup
default ModifyDbClusterParameterGroupResponse modifyDBClusterParameterGroup(ModifyDbClusterParameterGroupRequest modifyDbClusterParameterGroupRequest) throws DbParameterGroupNotFoundException, InvalidDbParameterGroupStateException, AwsServiceException, SdkClientException, NeptuneException Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following:
ParameterName
,ParameterValue
, andApplyMethod
. 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.
- See Also:
-
modifyDBClusterParameterGroup
default ModifyDbClusterParameterGroupResponse modifyDBClusterParameterGroup(Consumer<ModifyDbClusterParameterGroupRequest.Builder> modifyDbClusterParameterGroupRequest) throws DbParameterGroupNotFoundException, InvalidDbParameterGroupStateException, AwsServiceException, SdkClientException, NeptuneException Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following:
ParameterName
,ParameterValue
, andApplyMethod
. 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.
This is a convenience which creates an instance of the
ModifyDbClusterParameterGroupRequest.Builder
avoiding the need to create one manually viaModifyDbClusterParameterGroupRequest.builder()
- Parameters:
modifyDbClusterParameterGroupRequest
- AConsumer
that will call methods onModifyDbClusterParameterGroupRequest.Builder
to create a request.- Returns:
- Result of the ModifyDBClusterParameterGroup operation returned by the service.
- See Also:
-
modifyDBClusterSnapshotAttribute
default ModifyDbClusterSnapshotAttributeResponse modifyDBClusterSnapshotAttribute(ModifyDbClusterSnapshotAttributeRequest modifyDbClusterSnapshotAttributeRequest) throws DbClusterSnapshotNotFoundException, InvalidDbClusterSnapshotStateException, SharedSnapshotQuotaExceededException, AwsServiceException, SdkClientException, NeptuneException 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 theAttributeName
and use theValuesToAdd
parameter to add a list of IDs of the Amazon accounts that are authorized to restore the manual DB cluster snapshot. Use the valueall
to make the manual DB cluster snapshot public, which means that it can be copied or restored by all Amazon accounts. Do not add theall
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 theValuesToAdd
parameter. You can't useall
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.
- See Also:
-
modifyDBClusterSnapshotAttribute
default ModifyDbClusterSnapshotAttributeResponse modifyDBClusterSnapshotAttribute(Consumer<ModifyDbClusterSnapshotAttributeRequest.Builder> modifyDbClusterSnapshotAttributeRequest) throws DbClusterSnapshotNotFoundException, InvalidDbClusterSnapshotStateException, SharedSnapshotQuotaExceededException, AwsServiceException, SdkClientException, NeptuneException 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 theAttributeName
and use theValuesToAdd
parameter to add a list of IDs of the Amazon accounts that are authorized to restore the manual DB cluster snapshot. Use the valueall
to make the manual DB cluster snapshot public, which means that it can be copied or restored by all Amazon accounts. Do not add theall
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 theValuesToAdd
parameter. You can't useall
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.
This is a convenience which creates an instance of the
ModifyDbClusterSnapshotAttributeRequest.Builder
avoiding the need to create one manually viaModifyDbClusterSnapshotAttributeRequest.builder()
- Parameters:
modifyDbClusterSnapshotAttributeRequest
- AConsumer
that will call methods onModifyDbClusterSnapshotAttributeRequest.Builder
to create a request.- Returns:
- Result of the ModifyDBClusterSnapshotAttribute operation returned by the service.
- See Also:
-
modifyDBInstance
default ModifyDbInstanceResponse modifyDBInstance(ModifyDbInstanceRequest modifyDbInstanceRequest) throws InvalidDbInstanceStateException, InvalidDbSecurityGroupStateException, DbInstanceAlreadyExistsException, DbInstanceNotFoundException, DbSecurityGroupNotFoundException, DbParameterGroupNotFoundException, InsufficientDbInstanceCapacityException, StorageQuotaExceededException, InvalidVpcNetworkStateException, ProvisionedIopsNotAvailableInAzException, OptionGroupNotFoundException, DbUpgradeDependencyFailureException, StorageTypeNotSupportedException, AuthorizationNotFoundException, CertificateNotFoundException, DomainNotFoundException, AwsServiceException, SdkClientException, NeptuneException 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.
- Parameters:
modifyDbInstanceRequest
-- Returns:
- Result of the ModifyDBInstance operation returned by the service.
- See Also:
-
modifyDBInstance
default ModifyDbInstanceResponse modifyDBInstance(Consumer<ModifyDbInstanceRequest.Builder> modifyDbInstanceRequest) throws InvalidDbInstanceStateException, InvalidDbSecurityGroupStateException, DbInstanceAlreadyExistsException, DbInstanceNotFoundException, DbSecurityGroupNotFoundException, DbParameterGroupNotFoundException, InsufficientDbInstanceCapacityException, StorageQuotaExceededException, InvalidVpcNetworkStateException, ProvisionedIopsNotAvailableInAzException, OptionGroupNotFoundException, DbUpgradeDependencyFailureException, StorageTypeNotSupportedException, AuthorizationNotFoundException, CertificateNotFoundException, DomainNotFoundException, AwsServiceException, SdkClientException, NeptuneException 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.
This is a convenience which creates an instance of the
ModifyDbInstanceRequest.Builder
avoiding the need to create one manually viaModifyDbInstanceRequest.builder()
- Parameters:
modifyDbInstanceRequest
- AConsumer
that will call methods onModifyDbInstanceRequest.Builder
to create a request.- Returns:
- Result of the ModifyDBInstance operation returned by the service.
- See Also:
-
modifyDBParameterGroup
default ModifyDbParameterGroupResponse modifyDBParameterGroup(ModifyDbParameterGroupRequest modifyDbParameterGroupRequest) throws DbParameterGroupNotFoundException, InvalidDbParameterGroupStateException, AwsServiceException, SdkClientException, NeptuneException Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following:
ParameterName
,ParameterValue
, andApplyMethod
. 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.
- See Also:
-
modifyDBParameterGroup
default ModifyDbParameterGroupResponse modifyDBParameterGroup(Consumer<ModifyDbParameterGroupRequest.Builder> modifyDbParameterGroupRequest) throws DbParameterGroupNotFoundException, InvalidDbParameterGroupStateException, AwsServiceException, SdkClientException, NeptuneException Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following:
ParameterName
,ParameterValue
, andApplyMethod
. 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.
This is a convenience which creates an instance of the
ModifyDbParameterGroupRequest.Builder
avoiding the need to create one manually viaModifyDbParameterGroupRequest.builder()
- Parameters:
modifyDbParameterGroupRequest
- AConsumer
that will call methods onModifyDbParameterGroupRequest.Builder
to create a request.- Returns:
- Result of the ModifyDBParameterGroup operation returned by the service.
- See Also:
-
modifyDBSubnetGroup
default ModifyDbSubnetGroupResponse modifyDBSubnetGroup(ModifyDbSubnetGroupRequest modifyDbSubnetGroupRequest) throws DbSubnetGroupNotFoundException, DbSubnetQuotaExceededException, SubnetAlreadyInUseException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidSubnetException, AwsServiceException, SdkClientException, NeptuneException Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Region.
- Parameters:
modifyDbSubnetGroupRequest
-- Returns:
- Result of the ModifyDBSubnetGroup operation returned by the service.
- See Also:
-
modifyDBSubnetGroup
default ModifyDbSubnetGroupResponse modifyDBSubnetGroup(Consumer<ModifyDbSubnetGroupRequest.Builder> modifyDbSubnetGroupRequest) throws DbSubnetGroupNotFoundException, DbSubnetQuotaExceededException, SubnetAlreadyInUseException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidSubnetException, AwsServiceException, SdkClientException, NeptuneException Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Region.
This is a convenience which creates an instance of the
ModifyDbSubnetGroupRequest.Builder
avoiding the need to create one manually viaModifyDbSubnetGroupRequest.builder()
- Parameters:
modifyDbSubnetGroupRequest
- AConsumer
that will call methods onModifyDbSubnetGroupRequest.Builder
to create a request.- Returns:
- Result of the ModifyDBSubnetGroup operation returned by the service.
- See Also:
-
modifyEventSubscription
default ModifyEventSubscriptionResponse modifyEventSubscription(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest) throws EventSubscriptionQuotaExceededException, SubscriptionNotFoundException, SnsInvalidTopicException, SnsNoAuthorizationException, SnsTopicArnNotFoundException, SubscriptionCategoryNotFoundException, AwsServiceException, SdkClientException, NeptuneException 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.
- Parameters:
modifyEventSubscriptionRequest
-- Returns:
- Result of the ModifyEventSubscription operation returned by the service.
- See Also:
-
modifyEventSubscription
default ModifyEventSubscriptionResponse modifyEventSubscription(Consumer<ModifyEventSubscriptionRequest.Builder> modifyEventSubscriptionRequest) throws EventSubscriptionQuotaExceededException, SubscriptionNotFoundException, SnsInvalidTopicException, SnsNoAuthorizationException, SnsTopicArnNotFoundException, SubscriptionCategoryNotFoundException, AwsServiceException, SdkClientException, NeptuneException 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.
This is a convenience which creates an instance of the
ModifyEventSubscriptionRequest.Builder
avoiding the need to create one manually viaModifyEventSubscriptionRequest.builder()
- Parameters:
modifyEventSubscriptionRequest
- AConsumer
that will call methods onModifyEventSubscriptionRequest.Builder
to create a request.- Returns:
- Result of the ModifyEventSubscription operation returned by the service.
- See Also:
-
modifyGlobalCluster
default ModifyGlobalClusterResponse modifyGlobalCluster(ModifyGlobalClusterRequest modifyGlobalClusterRequest) throws GlobalClusterNotFoundException, InvalidGlobalClusterStateException, AwsServiceException, SdkClientException, NeptuneException 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.
- See Also:
-
modifyGlobalCluster
default ModifyGlobalClusterResponse modifyGlobalCluster(Consumer<ModifyGlobalClusterRequest.Builder> modifyGlobalClusterRequest) throws GlobalClusterNotFoundException, InvalidGlobalClusterStateException, AwsServiceException, SdkClientException, NeptuneException 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.
This is a convenience which creates an instance of the
ModifyGlobalClusterRequest.Builder
avoiding the need to create one manually viaModifyGlobalClusterRequest.builder()
- Parameters:
modifyGlobalClusterRequest
- AConsumer
that will call methods onModifyGlobalClusterRequest.Builder
to create a request.- Returns:
- Result of the ModifyGlobalCluster operation returned by the service.
- See Also:
-
promoteReadReplicaDBCluster
default PromoteReadReplicaDbClusterResponse promoteReadReplicaDBCluster(PromoteReadReplicaDbClusterRequest promoteReadReplicaDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, AwsServiceException, SdkClientException, NeptuneException Not supported.
- Parameters:
promoteReadReplicaDbClusterRequest
-- Returns:
- Result of the PromoteReadReplicaDBCluster operation returned by the service.
- See Also:
-
promoteReadReplicaDBCluster
default PromoteReadReplicaDbClusterResponse promoteReadReplicaDBCluster(Consumer<PromoteReadReplicaDbClusterRequest.Builder> promoteReadReplicaDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, AwsServiceException, SdkClientException, NeptuneException Not supported.
This is a convenience which creates an instance of the
PromoteReadReplicaDbClusterRequest.Builder
avoiding the need to create one manually viaPromoteReadReplicaDbClusterRequest.builder()
- Parameters:
promoteReadReplicaDbClusterRequest
- AConsumer
that will call methods onPromoteReadReplicaDbClusterRequest.Builder
to create a request.- Returns:
- Result of the PromoteReadReplicaDBCluster operation returned by the service.
- See Also:
-
rebootDBInstance
default RebootDbInstanceResponse rebootDBInstance(RebootDbInstanceRequest rebootDbInstanceRequest) throws InvalidDbInstanceStateException, DbInstanceNotFoundException, AwsServiceException, SdkClientException, NeptuneException 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.
- See Also:
-
rebootDBInstance
default RebootDbInstanceResponse rebootDBInstance(Consumer<RebootDbInstanceRequest.Builder> rebootDbInstanceRequest) throws InvalidDbInstanceStateException, DbInstanceNotFoundException, AwsServiceException, SdkClientException, NeptuneException 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.
This is a convenience which creates an instance of the
RebootDbInstanceRequest.Builder
avoiding the need to create one manually viaRebootDbInstanceRequest.builder()
- Parameters:
rebootDbInstanceRequest
- AConsumer
that will call methods onRebootDbInstanceRequest.Builder
to create a request.- Returns:
- Result of the RebootDBInstance operation returned by the service.
- See Also:
-
removeFromGlobalCluster
default RemoveFromGlobalClusterResponse removeFromGlobalCluster(RemoveFromGlobalClusterRequest removeFromGlobalClusterRequest) throws GlobalClusterNotFoundException, InvalidGlobalClusterStateException, DbClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException 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.
- See Also:
-
removeFromGlobalCluster
default RemoveFromGlobalClusterResponse removeFromGlobalCluster(Consumer<RemoveFromGlobalClusterRequest.Builder> removeFromGlobalClusterRequest) throws GlobalClusterNotFoundException, InvalidGlobalClusterStateException, DbClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException 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.
This is a convenience which creates an instance of the
RemoveFromGlobalClusterRequest.Builder
avoiding the need to create one manually viaRemoveFromGlobalClusterRequest.builder()
- Parameters:
removeFromGlobalClusterRequest
- AConsumer
that will call methods onRemoveFromGlobalClusterRequest.Builder
to create a request.- Returns:
- Result of the RemoveFromGlobalCluster operation returned by the service.
- See Also:
-
removeRoleFromDBCluster
default RemoveRoleFromDbClusterResponse removeRoleFromDBCluster(RemoveRoleFromDbClusterRequest removeRoleFromDbClusterRequest) throws DbClusterNotFoundException, DbClusterRoleNotFoundException, InvalidDbClusterStateException, AwsServiceException, SdkClientException, NeptuneException Disassociates an Identity and Access Management (IAM) role from a DB cluster.
- Parameters:
removeRoleFromDbClusterRequest
-- Returns:
- Result of the RemoveRoleFromDBCluster operation returned by the service.
- See Also:
-
removeRoleFromDBCluster
default RemoveRoleFromDbClusterResponse removeRoleFromDBCluster(Consumer<RemoveRoleFromDbClusterRequest.Builder> removeRoleFromDbClusterRequest) throws DbClusterNotFoundException, DbClusterRoleNotFoundException, InvalidDbClusterStateException, AwsServiceException, SdkClientException, NeptuneException Disassociates an Identity and Access Management (IAM) role from a DB cluster.
This is a convenience which creates an instance of the
RemoveRoleFromDbClusterRequest.Builder
avoiding the need to create one manually viaRemoveRoleFromDbClusterRequest.builder()
- Parameters:
removeRoleFromDbClusterRequest
- AConsumer
that will call methods onRemoveRoleFromDbClusterRequest.Builder
to create a request.- Returns:
- Result of the RemoveRoleFromDBCluster operation returned by the service.
- See Also:
-
removeSourceIdentifierFromSubscription
default RemoveSourceIdentifierFromSubscriptionResponse removeSourceIdentifierFromSubscription(RemoveSourceIdentifierFromSubscriptionRequest removeSourceIdentifierFromSubscriptionRequest) throws SubscriptionNotFoundException, SourceNotFoundException, AwsServiceException, SdkClientException, NeptuneException Removes a source identifier from an existing event notification subscription.
- Parameters:
removeSourceIdentifierFromSubscriptionRequest
-- Returns:
- Result of the RemoveSourceIdentifierFromSubscription operation returned by the service.
- See Also:
-
removeSourceIdentifierFromSubscription
default RemoveSourceIdentifierFromSubscriptionResponse removeSourceIdentifierFromSubscription(Consumer<RemoveSourceIdentifierFromSubscriptionRequest.Builder> removeSourceIdentifierFromSubscriptionRequest) throws SubscriptionNotFoundException, SourceNotFoundException, AwsServiceException, SdkClientException, NeptuneException Removes a source identifier from an existing event notification subscription.
This is a convenience which creates an instance of the
RemoveSourceIdentifierFromSubscriptionRequest.Builder
avoiding the need to create one manually viaRemoveSourceIdentifierFromSubscriptionRequest.builder()
- Parameters:
removeSourceIdentifierFromSubscriptionRequest
- AConsumer
that will call methods onRemoveSourceIdentifierFromSubscriptionRequest.Builder
to create a request.- Returns:
- Result of the RemoveSourceIdentifierFromSubscription operation returned by the service.
- See Also:
-
removeTagsFromResource
default RemoveTagsFromResourceResponse removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest) throws DbInstanceNotFoundException, DbSnapshotNotFoundException, DbClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException Removes metadata tags from an Amazon Neptune resource.
- Parameters:
removeTagsFromResourceRequest
-- Returns:
- Result of the RemoveTagsFromResource operation returned by the service.
- See Also:
-
removeTagsFromResource
default RemoveTagsFromResourceResponse removeTagsFromResource(Consumer<RemoveTagsFromResourceRequest.Builder> removeTagsFromResourceRequest) throws DbInstanceNotFoundException, DbSnapshotNotFoundException, DbClusterNotFoundException, AwsServiceException, SdkClientException, NeptuneException Removes metadata tags from an Amazon Neptune resource.
This is a convenience which creates an instance of the
RemoveTagsFromResourceRequest.Builder
avoiding the need to create one manually viaRemoveTagsFromResourceRequest.builder()
- Parameters:
removeTagsFromResourceRequest
- AConsumer
that will call methods onRemoveTagsFromResourceRequest.Builder
to create a request.- Returns:
- Result of the RemoveTagsFromResource operation returned by the service.
- See Also:
-
resetDBClusterParameterGroup
default ResetDbClusterParameterGroupResponse resetDBClusterParameterGroup(ResetDbClusterParameterGroupRequest resetDbClusterParameterGroupRequest) throws InvalidDbParameterGroupStateException, DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following:
ParameterName
andApplyMethod
. To reset the entire DB cluster parameter group, specify theDBClusterParameterGroupName
andResetAllParameters
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.
- See Also:
-
resetDBClusterParameterGroup
default ResetDbClusterParameterGroupResponse resetDBClusterParameterGroup(Consumer<ResetDbClusterParameterGroupRequest.Builder> resetDbClusterParameterGroupRequest) throws InvalidDbParameterGroupStateException, DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following:
ParameterName
andApplyMethod
. To reset the entire DB cluster parameter group, specify theDBClusterParameterGroupName
andResetAllParameters
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.
This is a convenience which creates an instance of the
ResetDbClusterParameterGroupRequest.Builder
avoiding the need to create one manually viaResetDbClusterParameterGroupRequest.builder()
- Parameters:
resetDbClusterParameterGroupRequest
- AConsumer
that will call methods onResetDbClusterParameterGroupRequest.Builder
to create a request.- Returns:
- Result of the ResetDBClusterParameterGroup operation returned by the service.
- See Also:
-
resetDBParameterGroup
default ResetDbParameterGroupResponse resetDBParameterGroup(ResetDbParameterGroupRequest resetDbParameterGroupRequest) throws InvalidDbParameterGroupStateException, DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException 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
andApplyMethod
. To reset the entire DB parameter group, specify theDBParameterGroup
name andResetAllParameters
parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set topending-reboot
to take effect on the next DB instance restart orRebootDBInstance
request.- Parameters:
resetDbParameterGroupRequest
-- Returns:
- Result of the ResetDBParameterGroup operation returned by the service.
- See Also:
-
resetDBParameterGroup
default ResetDbParameterGroupResponse resetDBParameterGroup(Consumer<ResetDbParameterGroupRequest.Builder> resetDbParameterGroupRequest) throws InvalidDbParameterGroupStateException, DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException 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
andApplyMethod
. To reset the entire DB parameter group, specify theDBParameterGroup
name andResetAllParameters
parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set topending-reboot
to take effect on the next DB instance restart orRebootDBInstance
request.
This is a convenience which creates an instance of the
ResetDbParameterGroupRequest.Builder
avoiding the need to create one manually viaResetDbParameterGroupRequest.builder()
- Parameters:
resetDbParameterGroupRequest
- AConsumer
that will call methods onResetDbParameterGroupRequest.Builder
to create a request.- Returns:
- Result of the ResetDBParameterGroup operation returned by the service.
- See Also:
-
restoreDBClusterFromSnapshot
default RestoreDbClusterFromSnapshotResponse restoreDBClusterFromSnapshot(RestoreDbClusterFromSnapshotRequest restoreDbClusterFromSnapshotRequest) throws DbClusterAlreadyExistsException, DbClusterQuotaExceededException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, DbSnapshotNotFoundException, DbClusterSnapshotNotFoundException, InsufficientDbClusterCapacityException, InsufficientStorageClusterCapacityException, InvalidDbSnapshotStateException, InvalidDbClusterSnapshotStateException, InvalidVpcNetworkStateException, InvalidRestoreException, InvalidSubnetException, OptionGroupNotFoundException, KmsKeyNotAccessibleException, DbClusterParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException 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.
- Parameters:
restoreDbClusterFromSnapshotRequest
-- Returns:
- Result of the RestoreDBClusterFromSnapshot operation returned by the service.
- See Also:
-
restoreDBClusterFromSnapshot
default RestoreDbClusterFromSnapshotResponse restoreDBClusterFromSnapshot(Consumer<RestoreDbClusterFromSnapshotRequest.Builder> restoreDbClusterFromSnapshotRequest) throws DbClusterAlreadyExistsException, DbClusterQuotaExceededException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, DbSnapshotNotFoundException, DbClusterSnapshotNotFoundException, InsufficientDbClusterCapacityException, InsufficientStorageClusterCapacityException, InvalidDbSnapshotStateException, InvalidDbClusterSnapshotStateException, InvalidVpcNetworkStateException, InvalidRestoreException, InvalidSubnetException, OptionGroupNotFoundException, KmsKeyNotAccessibleException, DbClusterParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException 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.
This is a convenience which creates an instance of the
RestoreDbClusterFromSnapshotRequest.Builder
avoiding the need to create one manually viaRestoreDbClusterFromSnapshotRequest.builder()
- Parameters:
restoreDbClusterFromSnapshotRequest
- AConsumer
that will call methods onRestoreDbClusterFromSnapshotRequest.Builder
to create a request.- Returns:
- Result of the RestoreDBClusterFromSnapshot operation returned by the service.
- See Also:
-
restoreDBClusterToPointInTime
default RestoreDbClusterToPointInTimeResponse restoreDBClusterToPointInTime(RestoreDbClusterToPointInTimeRequest restoreDbClusterToPointInTimeRequest) throws DbClusterAlreadyExistsException, DbClusterNotFoundException, DbClusterQuotaExceededException, DbClusterSnapshotNotFoundException, DbSubnetGroupNotFoundException, InsufficientDbClusterCapacityException, InsufficientStorageClusterCapacityException, InvalidDbClusterSnapshotStateException, InvalidDbClusterStateException, InvalidDbSnapshotStateException, InvalidRestoreException, InvalidSubnetException, InvalidVpcNetworkStateException, KmsKeyNotAccessibleException, OptionGroupNotFoundException, StorageQuotaExceededException, DbClusterParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before
LatestRestorableTime
for up toBackupRetentionPeriod
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 theRestoreDBClusterToPointInTime
action has completed and the DB cluster is available.- Parameters:
restoreDbClusterToPointInTimeRequest
-- Returns:
- Result of the RestoreDBClusterToPointInTime operation returned by the service.
- See Also:
-
restoreDBClusterToPointInTime
default RestoreDbClusterToPointInTimeResponse restoreDBClusterToPointInTime(Consumer<RestoreDbClusterToPointInTimeRequest.Builder> restoreDbClusterToPointInTimeRequest) throws DbClusterAlreadyExistsException, DbClusterNotFoundException, DbClusterQuotaExceededException, DbClusterSnapshotNotFoundException, DbSubnetGroupNotFoundException, InsufficientDbClusterCapacityException, InsufficientStorageClusterCapacityException, InvalidDbClusterSnapshotStateException, InvalidDbClusterStateException, InvalidDbSnapshotStateException, InvalidRestoreException, InvalidSubnetException, InvalidVpcNetworkStateException, KmsKeyNotAccessibleException, OptionGroupNotFoundException, StorageQuotaExceededException, DbClusterParameterGroupNotFoundException, AwsServiceException, SdkClientException, NeptuneException Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before
LatestRestorableTime
for up toBackupRetentionPeriod
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 theRestoreDBClusterToPointInTime
action has completed and the DB cluster is available.
This is a convenience which creates an instance of the
RestoreDbClusterToPointInTimeRequest.Builder
avoiding the need to create one manually viaRestoreDbClusterToPointInTimeRequest.builder()
- Parameters:
restoreDbClusterToPointInTimeRequest
- AConsumer
that will call methods onRestoreDbClusterToPointInTimeRequest.Builder
to create a request.- Returns:
- Result of the RestoreDBClusterToPointInTime operation returned by the service.
- See Also:
-
startDBCluster
default StartDbClusterResponse startDBCluster(StartDbClusterRequest startDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, NeptuneException Starts an Amazon Neptune DB cluster that was stopped using the Amazon console, the Amazon CLI stop-db-cluster command, or the StopDBCluster API.
- Parameters:
startDbClusterRequest
-- Returns:
- Result of the StartDBCluster operation returned by the service.
- See Also:
-
startDBCluster
default StartDbClusterResponse startDBCluster(Consumer<StartDbClusterRequest.Builder> startDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, NeptuneException Starts an Amazon Neptune DB cluster that was stopped using the Amazon console, the Amazon CLI stop-db-cluster command, or the StopDBCluster API.
This is a convenience which creates an instance of the
StartDbClusterRequest.Builder
avoiding the need to create one manually viaStartDbClusterRequest.builder()
- Parameters:
startDbClusterRequest
- AConsumer
that will call methods onStartDbClusterRequest.Builder
to create a request.- Returns:
- Result of the StartDBCluster operation returned by the service.
- See Also:
-
stopDBCluster
default StopDbClusterResponse stopDBCluster(StopDbClusterRequest stopDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, NeptuneException 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.
- See Also:
-
stopDBCluster
default StopDbClusterResponse stopDBCluster(Consumer<StopDbClusterRequest.Builder> stopDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, NeptuneException 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.
This is a convenience which creates an instance of the
StopDbClusterRequest.Builder
avoiding the need to create one manually viaStopDbClusterRequest.builder()
- Parameters:
stopDbClusterRequest
- AConsumer
that will call methods onStopDbClusterRequest.Builder
to create a request.- Returns:
- Result of the StopDBCluster operation returned by the service.
- See Also:
-
waiter
Create an instance ofNeptuneWaiter
using this client.Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
- Returns:
- an instance of
NeptuneWaiter
-
create
Create aNeptuneClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aNeptuneClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-