@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface DocDbAsyncClient extends SdkClient
builder()
method.
Amazon DocumentDB API documentation
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default CompletableFuture<AddSourceIdentifierToSubscriptionResponse> |
addSourceIdentifierToSubscription(AddSourceIdentifierToSubscriptionRequest addSourceIdentifierToSubscriptionRequest)
Adds a source identifier to an existing event notification subscription.
|
default CompletableFuture<AddSourceIdentifierToSubscriptionResponse> |
addSourceIdentifierToSubscription(Consumer<AddSourceIdentifierToSubscriptionRequest.Builder> addSourceIdentifierToSubscriptionRequest)
Adds a source identifier to an existing event notification subscription.
|
default CompletableFuture<AddTagsToResourceResponse> |
addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)
Adds metadata tags to an Amazon DocumentDB resource.
|
default CompletableFuture<AddTagsToResourceResponse> |
addTagsToResource(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest)
Adds metadata tags to an Amazon DocumentDB resource.
|
default CompletableFuture<ApplyPendingMaintenanceActionResponse> |
applyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest applyPendingMaintenanceActionRequest)
Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance).
|
default CompletableFuture<ApplyPendingMaintenanceActionResponse> |
applyPendingMaintenanceAction(Consumer<ApplyPendingMaintenanceActionRequest.Builder> applyPendingMaintenanceActionRequest)
Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance).
|
static DocDbAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
DocDbAsyncClient. |
default CompletableFuture<CopyDbClusterParameterGroupResponse> |
copyDBClusterParameterGroup(Consumer<CopyDbClusterParameterGroupRequest.Builder> copyDbClusterParameterGroupRequest)
Copies the specified cluster parameter group.
|
default CompletableFuture<CopyDbClusterParameterGroupResponse> |
copyDBClusterParameterGroup(CopyDbClusterParameterGroupRequest copyDbClusterParameterGroupRequest)
Copies the specified cluster parameter group.
|
default CompletableFuture<CopyDbClusterSnapshotResponse> |
copyDBClusterSnapshot(Consumer<CopyDbClusterSnapshotRequest.Builder> copyDbClusterSnapshotRequest)
Copies a snapshot of a cluster.
|
default CompletableFuture<CopyDbClusterSnapshotResponse> |
copyDBClusterSnapshot(CopyDbClusterSnapshotRequest copyDbClusterSnapshotRequest)
Copies a snapshot of a cluster.
|
static DocDbAsyncClient |
create()
Create a
DocDbAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<CreateDbClusterResponse> |
createDBCluster(Consumer<CreateDbClusterRequest.Builder> createDbClusterRequest)
Creates a new Amazon DocumentDB cluster.
|
default CompletableFuture<CreateDbClusterResponse> |
createDBCluster(CreateDbClusterRequest createDbClusterRequest)
Creates a new Amazon DocumentDB cluster.
|
default CompletableFuture<CreateDbClusterParameterGroupResponse> |
createDBClusterParameterGroup(Consumer<CreateDbClusterParameterGroupRequest.Builder> createDbClusterParameterGroupRequest)
Creates a new cluster parameter group.
|
default CompletableFuture<CreateDbClusterParameterGroupResponse> |
createDBClusterParameterGroup(CreateDbClusterParameterGroupRequest createDbClusterParameterGroupRequest)
Creates a new cluster parameter group.
|
default CompletableFuture<CreateDbClusterSnapshotResponse> |
createDBClusterSnapshot(Consumer<CreateDbClusterSnapshotRequest.Builder> createDbClusterSnapshotRequest)
Creates a snapshot of a cluster.
|
default CompletableFuture<CreateDbClusterSnapshotResponse> |
createDBClusterSnapshot(CreateDbClusterSnapshotRequest createDbClusterSnapshotRequest)
Creates a snapshot of a cluster.
|
default CompletableFuture<CreateDbInstanceResponse> |
createDBInstance(Consumer<CreateDbInstanceRequest.Builder> createDbInstanceRequest)
Creates a new instance.
|
default CompletableFuture<CreateDbInstanceResponse> |
createDBInstance(CreateDbInstanceRequest createDbInstanceRequest)
Creates a new instance.
|
default CompletableFuture<CreateDbSubnetGroupResponse> |
createDBSubnetGroup(Consumer<CreateDbSubnetGroupRequest.Builder> createDbSubnetGroupRequest)
Creates a new subnet group.
|
default CompletableFuture<CreateDbSubnetGroupResponse> |
createDBSubnetGroup(CreateDbSubnetGroupRequest createDbSubnetGroupRequest)
Creates a new subnet group.
|
default CompletableFuture<CreateEventSubscriptionResponse> |
createEventSubscription(Consumer<CreateEventSubscriptionRequest.Builder> createEventSubscriptionRequest)
Creates an Amazon DocumentDB event notification subscription.
|
default CompletableFuture<CreateEventSubscriptionResponse> |
createEventSubscription(CreateEventSubscriptionRequest createEventSubscriptionRequest)
Creates an Amazon DocumentDB event notification subscription.
|
default CompletableFuture<CreateGlobalClusterResponse> |
createGlobalCluster(Consumer<CreateGlobalClusterRequest.Builder> createGlobalClusterRequest)
Creates an Amazon DocumentDB global cluster that can span multiple multiple Regions.
|
default CompletableFuture<CreateGlobalClusterResponse> |
createGlobalCluster(CreateGlobalClusterRequest createGlobalClusterRequest)
Creates an Amazon DocumentDB global cluster that can span multiple multiple Regions.
|
default CompletableFuture<DeleteDbClusterResponse> |
deleteDBCluster(Consumer<DeleteDbClusterRequest.Builder> deleteDbClusterRequest)
Deletes a previously provisioned cluster.
|
default CompletableFuture<DeleteDbClusterResponse> |
deleteDBCluster(DeleteDbClusterRequest deleteDbClusterRequest)
Deletes a previously provisioned cluster.
|
default CompletableFuture<DeleteDbClusterParameterGroupResponse> |
deleteDBClusterParameterGroup(Consumer<DeleteDbClusterParameterGroupRequest.Builder> deleteDbClusterParameterGroupRequest)
Deletes a specified cluster parameter group.
|
default CompletableFuture<DeleteDbClusterParameterGroupResponse> |
deleteDBClusterParameterGroup(DeleteDbClusterParameterGroupRequest deleteDbClusterParameterGroupRequest)
Deletes a specified cluster parameter group.
|
default CompletableFuture<DeleteDbClusterSnapshotResponse> |
deleteDBClusterSnapshot(Consumer<DeleteDbClusterSnapshotRequest.Builder> deleteDbClusterSnapshotRequest)
Deletes a cluster snapshot.
|
default CompletableFuture<DeleteDbClusterSnapshotResponse> |
deleteDBClusterSnapshot(DeleteDbClusterSnapshotRequest deleteDbClusterSnapshotRequest)
Deletes a cluster snapshot.
|
default CompletableFuture<DeleteDbInstanceResponse> |
deleteDBInstance(Consumer<DeleteDbInstanceRequest.Builder> deleteDbInstanceRequest)
Deletes a previously provisioned instance.
|
default CompletableFuture<DeleteDbInstanceResponse> |
deleteDBInstance(DeleteDbInstanceRequest deleteDbInstanceRequest)
Deletes a previously provisioned instance.
|
default CompletableFuture<DeleteDbSubnetGroupResponse> |
deleteDBSubnetGroup(Consumer<DeleteDbSubnetGroupRequest.Builder> deleteDbSubnetGroupRequest)
Deletes a subnet group.
|
default CompletableFuture<DeleteDbSubnetGroupResponse> |
deleteDBSubnetGroup(DeleteDbSubnetGroupRequest deleteDbSubnetGroupRequest)
Deletes a subnet group.
|
default CompletableFuture<DeleteEventSubscriptionResponse> |
deleteEventSubscription(Consumer<DeleteEventSubscriptionRequest.Builder> deleteEventSubscriptionRequest)
Deletes an Amazon DocumentDB event notification subscription.
|
default CompletableFuture<DeleteEventSubscriptionResponse> |
deleteEventSubscription(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest)
Deletes an Amazon DocumentDB event notification subscription.
|
default CompletableFuture<DeleteGlobalClusterResponse> |
deleteGlobalCluster(Consumer<DeleteGlobalClusterRequest.Builder> deleteGlobalClusterRequest)
Deletes a global cluster.
|
default CompletableFuture<DeleteGlobalClusterResponse> |
deleteGlobalCluster(DeleteGlobalClusterRequest deleteGlobalClusterRequest)
Deletes a global cluster.
|
default CompletableFuture<DescribeCertificatesResponse> |
describeCertificates(Consumer<DescribeCertificatesRequest.Builder> describeCertificatesRequest)
Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this account.
|
default CompletableFuture<DescribeCertificatesResponse> |
describeCertificates(DescribeCertificatesRequest describeCertificatesRequest)
Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this account.
|
default DescribeCertificatesPublisher |
describeCertificatesPaginator(Consumer<DescribeCertificatesRequest.Builder> describeCertificatesRequest)
Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this account.
|
default DescribeCertificatesPublisher |
describeCertificatesPaginator(DescribeCertificatesRequest describeCertificatesRequest)
Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this account.
|
default CompletableFuture<DescribeDbClusterParameterGroupsResponse> |
describeDBClusterParameterGroups()
Returns a list of
DBClusterParameterGroup descriptions. |
default CompletableFuture<DescribeDbClusterParameterGroupsResponse> |
describeDBClusterParameterGroups(Consumer<DescribeDbClusterParameterGroupsRequest.Builder> describeDbClusterParameterGroupsRequest)
Returns a list of
DBClusterParameterGroup descriptions. |
default CompletableFuture<DescribeDbClusterParameterGroupsResponse> |
describeDBClusterParameterGroups(DescribeDbClusterParameterGroupsRequest describeDbClusterParameterGroupsRequest)
Returns a list of
DBClusterParameterGroup descriptions. |
default DescribeDBClusterParameterGroupsPublisher |
describeDBClusterParameterGroupsPaginator()
Returns a list of
DBClusterParameterGroup descriptions. |
default DescribeDBClusterParameterGroupsPublisher |
describeDBClusterParameterGroupsPaginator(Consumer<DescribeDbClusterParameterGroupsRequest.Builder> describeDbClusterParameterGroupsRequest)
Returns a list of
DBClusterParameterGroup descriptions. |
default DescribeDBClusterParameterGroupsPublisher |
describeDBClusterParameterGroupsPaginator(DescribeDbClusterParameterGroupsRequest describeDbClusterParameterGroupsRequest)
Returns a list of
DBClusterParameterGroup descriptions. |
default CompletableFuture<DescribeDbClusterParametersResponse> |
describeDBClusterParameters(Consumer<DescribeDbClusterParametersRequest.Builder> describeDbClusterParametersRequest)
Returns the detailed parameter list for a particular cluster parameter group.
|
default CompletableFuture<DescribeDbClusterParametersResponse> |
describeDBClusterParameters(DescribeDbClusterParametersRequest describeDbClusterParametersRequest)
Returns the detailed parameter list for a particular cluster parameter group.
|
default DescribeDBClusterParametersPublisher |
describeDBClusterParametersPaginator(Consumer<DescribeDbClusterParametersRequest.Builder> describeDbClusterParametersRequest)
Returns the detailed parameter list for a particular cluster parameter group.
|
default DescribeDBClusterParametersPublisher |
describeDBClusterParametersPaginator(DescribeDbClusterParametersRequest describeDbClusterParametersRequest)
Returns the detailed parameter list for a particular cluster parameter group.
|
default CompletableFuture<DescribeDbClustersResponse> |
describeDBClusters()
Returns information about provisioned Amazon DocumentDB clusters.
|
default CompletableFuture<DescribeDbClustersResponse> |
describeDBClusters(Consumer<DescribeDbClustersRequest.Builder> describeDbClustersRequest)
Returns information about provisioned Amazon DocumentDB clusters.
|
default CompletableFuture<DescribeDbClustersResponse> |
describeDBClusters(DescribeDbClustersRequest describeDbClustersRequest)
Returns information about provisioned Amazon DocumentDB clusters.
|
default CompletableFuture<DescribeDbClusterSnapshotAttributesResponse> |
describeDBClusterSnapshotAttributes(Consumer<DescribeDbClusterSnapshotAttributesRequest.Builder> describeDbClusterSnapshotAttributesRequest)
Returns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot.
|
default CompletableFuture<DescribeDbClusterSnapshotAttributesResponse> |
describeDBClusterSnapshotAttributes(DescribeDbClusterSnapshotAttributesRequest describeDbClusterSnapshotAttributesRequest)
Returns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot.
|
default CompletableFuture<DescribeDbClusterSnapshotsResponse> |
describeDBClusterSnapshots()
Returns information about cluster snapshots.
|
default CompletableFuture<DescribeDbClusterSnapshotsResponse> |
describeDBClusterSnapshots(Consumer<DescribeDbClusterSnapshotsRequest.Builder> describeDbClusterSnapshotsRequest)
Returns information about cluster snapshots.
|
default CompletableFuture<DescribeDbClusterSnapshotsResponse> |
describeDBClusterSnapshots(DescribeDbClusterSnapshotsRequest describeDbClusterSnapshotsRequest)
Returns information about cluster snapshots.
|
default DescribeDBClusterSnapshotsPublisher |
describeDBClusterSnapshotsPaginator()
Returns information about cluster snapshots.
|
default DescribeDBClusterSnapshotsPublisher |
describeDBClusterSnapshotsPaginator(Consumer<DescribeDbClusterSnapshotsRequest.Builder> describeDbClusterSnapshotsRequest)
Returns information about cluster snapshots.
|
default DescribeDBClusterSnapshotsPublisher |
describeDBClusterSnapshotsPaginator(DescribeDbClusterSnapshotsRequest describeDbClusterSnapshotsRequest)
Returns information about cluster snapshots.
|
default DescribeDBClustersPublisher |
describeDBClustersPaginator()
Returns information about provisioned Amazon DocumentDB clusters.
|
default DescribeDBClustersPublisher |
describeDBClustersPaginator(Consumer<DescribeDbClustersRequest.Builder> describeDbClustersRequest)
Returns information about provisioned Amazon DocumentDB clusters.
|
default DescribeDBClustersPublisher |
describeDBClustersPaginator(DescribeDbClustersRequest describeDbClustersRequest)
Returns information about provisioned Amazon DocumentDB clusters.
|
default CompletableFuture<DescribeDbEngineVersionsResponse> |
describeDBEngineVersions()
Returns a list of the available engines.
|
default CompletableFuture<DescribeDbEngineVersionsResponse> |
describeDBEngineVersions(Consumer<DescribeDbEngineVersionsRequest.Builder> describeDbEngineVersionsRequest)
Returns a list of the available engines.
|
default CompletableFuture<DescribeDbEngineVersionsResponse> |
describeDBEngineVersions(DescribeDbEngineVersionsRequest describeDbEngineVersionsRequest)
Returns a list of the available engines.
|
default DescribeDBEngineVersionsPublisher |
describeDBEngineVersionsPaginator()
Returns a list of the available engines.
|
default DescribeDBEngineVersionsPublisher |
describeDBEngineVersionsPaginator(Consumer<DescribeDbEngineVersionsRequest.Builder> describeDbEngineVersionsRequest)
Returns a list of the available engines.
|
default DescribeDBEngineVersionsPublisher |
describeDBEngineVersionsPaginator(DescribeDbEngineVersionsRequest describeDbEngineVersionsRequest)
Returns a list of the available engines.
|
default CompletableFuture<DescribeDbInstancesResponse> |
describeDBInstances()
Returns information about provisioned Amazon DocumentDB instances.
|
default CompletableFuture<DescribeDbInstancesResponse> |
describeDBInstances(Consumer<DescribeDbInstancesRequest.Builder> describeDbInstancesRequest)
Returns information about provisioned Amazon DocumentDB instances.
|
default CompletableFuture<DescribeDbInstancesResponse> |
describeDBInstances(DescribeDbInstancesRequest describeDbInstancesRequest)
Returns information about provisioned Amazon DocumentDB instances.
|
default DescribeDBInstancesPublisher |
describeDBInstancesPaginator()
Returns information about provisioned Amazon DocumentDB instances.
|
default DescribeDBInstancesPublisher |
describeDBInstancesPaginator(Consumer<DescribeDbInstancesRequest.Builder> describeDbInstancesRequest)
Returns information about provisioned Amazon DocumentDB instances.
|
default DescribeDBInstancesPublisher |
describeDBInstancesPaginator(DescribeDbInstancesRequest describeDbInstancesRequest)
Returns information about provisioned Amazon DocumentDB instances.
|
default CompletableFuture<DescribeDbSubnetGroupsResponse> |
describeDBSubnetGroups()
Returns a list of
DBSubnetGroup descriptions. |
default CompletableFuture<DescribeDbSubnetGroupsResponse> |
describeDBSubnetGroups(Consumer<DescribeDbSubnetGroupsRequest.Builder> describeDbSubnetGroupsRequest)
Returns a list of
DBSubnetGroup descriptions. |
default CompletableFuture<DescribeDbSubnetGroupsResponse> |
describeDBSubnetGroups(DescribeDbSubnetGroupsRequest describeDbSubnetGroupsRequest)
Returns a list of
DBSubnetGroup descriptions. |
default DescribeDBSubnetGroupsPublisher |
describeDBSubnetGroupsPaginator()
Returns a list of
DBSubnetGroup descriptions. |
default DescribeDBSubnetGroupsPublisher |
describeDBSubnetGroupsPaginator(Consumer<DescribeDbSubnetGroupsRequest.Builder> describeDbSubnetGroupsRequest)
Returns a list of
DBSubnetGroup descriptions. |
default DescribeDBSubnetGroupsPublisher |
describeDBSubnetGroupsPaginator(DescribeDbSubnetGroupsRequest describeDbSubnetGroupsRequest)
Returns a list of
DBSubnetGroup descriptions. |
default CompletableFuture<DescribeEngineDefaultClusterParametersResponse> |
describeEngineDefaultClusterParameters(Consumer<DescribeEngineDefaultClusterParametersRequest.Builder> describeEngineDefaultClusterParametersRequest)
Returns the default engine and system parameter information for the cluster database engine.
|
default CompletableFuture<DescribeEngineDefaultClusterParametersResponse> |
describeEngineDefaultClusterParameters(DescribeEngineDefaultClusterParametersRequest describeEngineDefaultClusterParametersRequest)
Returns the default engine and system parameter information for the cluster database engine.
|
default CompletableFuture<DescribeEventCategoriesResponse> |
describeEventCategories()
Displays a list of categories for all event source types, or, if specified, for a specified source type.
|
default CompletableFuture<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 CompletableFuture<DescribeEventCategoriesResponse> |
describeEventCategories(DescribeEventCategoriesRequest describeEventCategoriesRequest)
Displays a list of categories for all event source types, or, if specified, for a specified source type.
|
default CompletableFuture<DescribeEventsResponse> |
describeEvents()
Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days.
|
default CompletableFuture<DescribeEventsResponse> |
describeEvents(Consumer<DescribeEventsRequest.Builder> describeEventsRequest)
Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days.
|
default CompletableFuture<DescribeEventsResponse> |
describeEvents(DescribeEventsRequest describeEventsRequest)
Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days.
|
default DescribeEventsPublisher |
describeEventsPaginator()
Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days.
|
default DescribeEventsPublisher |
describeEventsPaginator(Consumer<DescribeEventsRequest.Builder> describeEventsRequest)
Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days.
|
default DescribeEventsPublisher |
describeEventsPaginator(DescribeEventsRequest describeEventsRequest)
Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days.
|
default CompletableFuture<DescribeEventSubscriptionsResponse> |
describeEventSubscriptions(Consumer<DescribeEventSubscriptionsRequest.Builder> describeEventSubscriptionsRequest)
Lists all the subscription descriptions for a customer account.
|
default CompletableFuture<DescribeEventSubscriptionsResponse> |
describeEventSubscriptions(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest)
Lists all the subscription descriptions for a customer account.
|
default DescribeEventSubscriptionsPublisher |
describeEventSubscriptionsPaginator(Consumer<DescribeEventSubscriptionsRequest.Builder> describeEventSubscriptionsRequest)
Lists all the subscription descriptions for a customer account.
|
default DescribeEventSubscriptionsPublisher |
describeEventSubscriptionsPaginator(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest)
Lists all the subscription descriptions for a customer account.
|
default CompletableFuture<DescribeGlobalClustersResponse> |
describeGlobalClusters(Consumer<DescribeGlobalClustersRequest.Builder> describeGlobalClustersRequest)
Returns information about Amazon DocumentDB global clusters.
|
default CompletableFuture<DescribeGlobalClustersResponse> |
describeGlobalClusters(DescribeGlobalClustersRequest describeGlobalClustersRequest)
Returns information about Amazon DocumentDB global clusters.
|
default DescribeGlobalClustersPublisher |
describeGlobalClustersPaginator(Consumer<DescribeGlobalClustersRequest.Builder> describeGlobalClustersRequest)
Returns information about Amazon DocumentDB global clusters.
|
default DescribeGlobalClustersPublisher |
describeGlobalClustersPaginator(DescribeGlobalClustersRequest describeGlobalClustersRequest)
Returns information about Amazon DocumentDB global clusters.
|
default CompletableFuture<DescribeOrderableDbInstanceOptionsResponse> |
describeOrderableDBInstanceOptions(Consumer<DescribeOrderableDbInstanceOptionsRequest.Builder> describeOrderableDbInstanceOptionsRequest)
Returns a list of orderable instance options for the specified engine.
|
default CompletableFuture<DescribeOrderableDbInstanceOptionsResponse> |
describeOrderableDBInstanceOptions(DescribeOrderableDbInstanceOptionsRequest describeOrderableDbInstanceOptionsRequest)
Returns a list of orderable instance options for the specified engine.
|
default DescribeOrderableDBInstanceOptionsPublisher |
describeOrderableDBInstanceOptionsPaginator(Consumer<DescribeOrderableDbInstanceOptionsRequest.Builder> describeOrderableDbInstanceOptionsRequest)
Returns a list of orderable instance options for the specified engine.
|
default DescribeOrderableDBInstanceOptionsPublisher |
describeOrderableDBInstanceOptionsPaginator(DescribeOrderableDbInstanceOptionsRequest describeOrderableDbInstanceOptionsRequest)
Returns a list of orderable instance options for the specified engine.
|
default CompletableFuture<DescribePendingMaintenanceActionsResponse> |
describePendingMaintenanceActions()
Returns a list of resources (for example, instances) that have at least one pending maintenance action.
|
default CompletableFuture<DescribePendingMaintenanceActionsResponse> |
describePendingMaintenanceActions(Consumer<DescribePendingMaintenanceActionsRequest.Builder> describePendingMaintenanceActionsRequest)
Returns a list of resources (for example, instances) that have at least one pending maintenance action.
|
default CompletableFuture<DescribePendingMaintenanceActionsResponse> |
describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest)
Returns a list of resources (for example, instances) that have at least one pending maintenance action.
|
default DescribePendingMaintenanceActionsPublisher |
describePendingMaintenanceActionsPaginator()
Returns a list of resources (for example, instances) that have at least one pending maintenance action.
|
default DescribePendingMaintenanceActionsPublisher |
describePendingMaintenanceActionsPaginator(Consumer<DescribePendingMaintenanceActionsRequest.Builder> describePendingMaintenanceActionsRequest)
Returns a list of resources (for example, instances) that have at least one pending maintenance action.
|
default DescribePendingMaintenanceActionsPublisher |
describePendingMaintenanceActionsPaginator(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest)
Returns a list of resources (for example, instances) that have at least one pending maintenance action.
|
default CompletableFuture<FailoverDbClusterResponse> |
failoverDBCluster(Consumer<FailoverDbClusterRequest.Builder> failoverDbClusterRequest)
Forces a failover for a cluster.
|
default CompletableFuture<FailoverDbClusterResponse> |
failoverDBCluster(FailoverDbClusterRequest failoverDbClusterRequest)
Forces a failover for a cluster.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists all tags on an Amazon DocumentDB resource.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all tags on an Amazon DocumentDB resource.
|
default CompletableFuture<ModifyDbClusterResponse> |
modifyDBCluster(Consumer<ModifyDbClusterRequest.Builder> modifyDbClusterRequest)
Modifies a setting for an Amazon DocumentDB cluster.
|
default CompletableFuture<ModifyDbClusterResponse> |
modifyDBCluster(ModifyDbClusterRequest modifyDbClusterRequest)
Modifies a setting for an Amazon DocumentDB cluster.
|
default CompletableFuture<ModifyDbClusterParameterGroupResponse> |
modifyDBClusterParameterGroup(Consumer<ModifyDbClusterParameterGroupRequest.Builder> modifyDbClusterParameterGroupRequest)
Modifies the parameters of a cluster parameter group.
|
default CompletableFuture<ModifyDbClusterParameterGroupResponse> |
modifyDBClusterParameterGroup(ModifyDbClusterParameterGroupRequest modifyDbClusterParameterGroupRequest)
Modifies the parameters of a cluster parameter group.
|
default CompletableFuture<ModifyDbClusterSnapshotAttributeResponse> |
modifyDBClusterSnapshotAttribute(Consumer<ModifyDbClusterSnapshotAttributeRequest.Builder> modifyDbClusterSnapshotAttributeRequest)
Adds an attribute and values to, or removes an attribute and values from, a manual cluster snapshot.
|
default CompletableFuture<ModifyDbClusterSnapshotAttributeResponse> |
modifyDBClusterSnapshotAttribute(ModifyDbClusterSnapshotAttributeRequest modifyDbClusterSnapshotAttributeRequest)
Adds an attribute and values to, or removes an attribute and values from, a manual cluster snapshot.
|
default CompletableFuture<ModifyDbInstanceResponse> |
modifyDBInstance(Consumer<ModifyDbInstanceRequest.Builder> modifyDbInstanceRequest)
Modifies settings for an instance.
|
default CompletableFuture<ModifyDbInstanceResponse> |
modifyDBInstance(ModifyDbInstanceRequest modifyDbInstanceRequest)
Modifies settings for an instance.
|
default CompletableFuture<ModifyDbSubnetGroupResponse> |
modifyDBSubnetGroup(Consumer<ModifyDbSubnetGroupRequest.Builder> modifyDbSubnetGroupRequest)
Modifies an existing subnet group.
|
default CompletableFuture<ModifyDbSubnetGroupResponse> |
modifyDBSubnetGroup(ModifyDbSubnetGroupRequest modifyDbSubnetGroupRequest)
Modifies an existing subnet group.
|
default CompletableFuture<ModifyEventSubscriptionResponse> |
modifyEventSubscription(Consumer<ModifyEventSubscriptionRequest.Builder> modifyEventSubscriptionRequest)
Modifies an existing Amazon DocumentDB event notification subscription.
|
default CompletableFuture<ModifyEventSubscriptionResponse> |
modifyEventSubscription(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest)
Modifies an existing Amazon DocumentDB event notification subscription.
|
default CompletableFuture<ModifyGlobalClusterResponse> |
modifyGlobalCluster(Consumer<ModifyGlobalClusterRequest.Builder> modifyGlobalClusterRequest)
Modify a setting for an Amazon DocumentDB global cluster.
|
default CompletableFuture<ModifyGlobalClusterResponse> |
modifyGlobalCluster(ModifyGlobalClusterRequest modifyGlobalClusterRequest)
Modify a setting for an Amazon DocumentDB global cluster.
|
default CompletableFuture<RebootDbInstanceResponse> |
rebootDBInstance(Consumer<RebootDbInstanceRequest.Builder> rebootDbInstanceRequest)
You might need to reboot your instance, usually for maintenance reasons.
|
default CompletableFuture<RebootDbInstanceResponse> |
rebootDBInstance(RebootDbInstanceRequest rebootDbInstanceRequest)
You might need to reboot your instance, usually for maintenance reasons.
|
default CompletableFuture<RemoveFromGlobalClusterResponse> |
removeFromGlobalCluster(Consumer<RemoveFromGlobalClusterRequest.Builder> removeFromGlobalClusterRequest)
Detaches an Amazon DocumentDB secondary cluster from a global cluster.
|
default CompletableFuture<RemoveFromGlobalClusterResponse> |
removeFromGlobalCluster(RemoveFromGlobalClusterRequest removeFromGlobalClusterRequest)
Detaches an Amazon DocumentDB secondary cluster from a global cluster.
|
default CompletableFuture<RemoveSourceIdentifierFromSubscriptionResponse> |
removeSourceIdentifierFromSubscription(Consumer<RemoveSourceIdentifierFromSubscriptionRequest.Builder> removeSourceIdentifierFromSubscriptionRequest)
Removes a source identifier from an existing Amazon DocumentDB event notification subscription.
|
default CompletableFuture<RemoveSourceIdentifierFromSubscriptionResponse> |
removeSourceIdentifierFromSubscription(RemoveSourceIdentifierFromSubscriptionRequest removeSourceIdentifierFromSubscriptionRequest)
Removes a source identifier from an existing Amazon DocumentDB event notification subscription.
|
default CompletableFuture<RemoveTagsFromResourceResponse> |
removeTagsFromResource(Consumer<RemoveTagsFromResourceRequest.Builder> removeTagsFromResourceRequest)
Removes metadata tags from an Amazon DocumentDB resource.
|
default CompletableFuture<RemoveTagsFromResourceResponse> |
removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
Removes metadata tags from an Amazon DocumentDB resource.
|
default CompletableFuture<ResetDbClusterParameterGroupResponse> |
resetDBClusterParameterGroup(Consumer<ResetDbClusterParameterGroupRequest.Builder> resetDbClusterParameterGroupRequest)
Modifies the parameters of a cluster parameter group to the default value.
|
default CompletableFuture<ResetDbClusterParameterGroupResponse> |
resetDBClusterParameterGroup(ResetDbClusterParameterGroupRequest resetDbClusterParameterGroupRequest)
Modifies the parameters of a cluster parameter group to the default value.
|
default CompletableFuture<RestoreDbClusterFromSnapshotResponse> |
restoreDBClusterFromSnapshot(Consumer<RestoreDbClusterFromSnapshotRequest.Builder> restoreDbClusterFromSnapshotRequest)
Creates a new cluster from a snapshot or cluster snapshot.
|
default CompletableFuture<RestoreDbClusterFromSnapshotResponse> |
restoreDBClusterFromSnapshot(RestoreDbClusterFromSnapshotRequest restoreDbClusterFromSnapshotRequest)
Creates a new cluster from a snapshot or cluster snapshot.
|
default CompletableFuture<RestoreDbClusterToPointInTimeResponse> |
restoreDBClusterToPointInTime(Consumer<RestoreDbClusterToPointInTimeRequest.Builder> restoreDbClusterToPointInTimeRequest)
Restores a cluster to an arbitrary point in time.
|
default CompletableFuture<RestoreDbClusterToPointInTimeResponse> |
restoreDBClusterToPointInTime(RestoreDbClusterToPointInTimeRequest restoreDbClusterToPointInTimeRequest)
Restores a cluster to an arbitrary point in time.
|
default CompletableFuture<StartDbClusterResponse> |
startDBCluster(Consumer<StartDbClusterRequest.Builder> startDbClusterRequest)
Restarts the stopped cluster that is specified by
DBClusterIdentifier. |
default CompletableFuture<StartDbClusterResponse> |
startDBCluster(StartDbClusterRequest startDbClusterRequest)
Restarts the stopped cluster that is specified by
DBClusterIdentifier. |
default CompletableFuture<StopDbClusterResponse> |
stopDBCluster(Consumer<StopDbClusterRequest.Builder> stopDbClusterRequest)
Stops the running cluster that is specified by
DBClusterIdentifier. |
default CompletableFuture<StopDbClusterResponse> |
stopDBCluster(StopDbClusterRequest stopDbClusterRequest)
Stops the running cluster that is specified by
DBClusterIdentifier. |
default DocDbAsyncWaiter |
waiter()
Create an instance of
DocDbAsyncWaiter using this client. |
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static DocDbAsyncClient create()
DocDbAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static DocDbAsyncClientBuilder builder()
DocDbAsyncClient.default CompletableFuture<AddSourceIdentifierToSubscriptionResponse> addSourceIdentifierToSubscription(AddSourceIdentifierToSubscriptionRequest addSourceIdentifierToSubscriptionRequest)
Adds a source identifier to an existing event notification subscription.
addSourceIdentifierToSubscriptionRequest - Represents the input to AddSourceIdentifierToSubscription.default CompletableFuture<AddSourceIdentifierToSubscriptionResponse> addSourceIdentifierToSubscription(Consumer<AddSourceIdentifierToSubscriptionRequest.Builder> addSourceIdentifierToSubscriptionRequest)
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 via AddSourceIdentifierToSubscriptionRequest.builder()
addSourceIdentifierToSubscriptionRequest - A Consumer that will call methods on AddSourceIdentifierToSubscriptionMessage.Builder to
create a request. Represents the input to AddSourceIdentifierToSubscription.default CompletableFuture<AddTagsToResourceResponse> addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)
Adds metadata tags to an Amazon DocumentDB resource. You can use these tags with cost allocation reporting to
track costs that are associated with Amazon DocumentDB resources or in a Condition statement in an
Identity and Access Management (IAM) policy for Amazon DocumentDB.
addTagsToResourceRequest - Represents the input to AddTagsToResource.DBInstanceIdentifier doesn't refer to an existing instance.DBSnapshotIdentifier doesn't refer to an existing snapshot.DBClusterIdentifier doesn't refer to an existing cluster.default CompletableFuture<AddTagsToResourceResponse> addTagsToResource(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest)
Adds metadata tags to an Amazon DocumentDB resource. You can use these tags with cost allocation reporting to
track costs that are associated with Amazon DocumentDB resources or in a Condition statement in an
Identity and Access Management (IAM) policy for Amazon DocumentDB.
This is a convenience which creates an instance of the AddTagsToResourceRequest.Builder avoiding the need
to create one manually via AddTagsToResourceRequest.builder()
addTagsToResourceRequest - A Consumer that will call methods on AddTagsToResourceMessage.Builder to create a request.
Represents the input to AddTagsToResource.DBInstanceIdentifier doesn't refer to an existing instance.DBSnapshotIdentifier doesn't refer to an existing snapshot.DBClusterIdentifier doesn't refer to an existing cluster.default CompletableFuture<ApplyPendingMaintenanceActionResponse> applyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest applyPendingMaintenanceActionRequest)
Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance).
applyPendingMaintenanceActionRequest - Represents the input to ApplyPendingMaintenanceAction.default CompletableFuture<ApplyPendingMaintenanceActionResponse> applyPendingMaintenanceAction(Consumer<ApplyPendingMaintenanceActionRequest.Builder> applyPendingMaintenanceActionRequest)
Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance).
This is a convenience which creates an instance of the ApplyPendingMaintenanceActionRequest.Builder
avoiding the need to create one manually via ApplyPendingMaintenanceActionRequest.builder()
applyPendingMaintenanceActionRequest - A Consumer that will call methods on ApplyPendingMaintenanceActionMessage.Builder to
create a request. Represents the input to ApplyPendingMaintenanceAction.default CompletableFuture<CopyDbClusterParameterGroupResponse> copyDBClusterParameterGroup(CopyDbClusterParameterGroupRequest copyDbClusterParameterGroupRequest)
Copies the specified cluster parameter group.
copyDbClusterParameterGroupRequest - Represents the input to CopyDBClusterParameterGroup.DBParameterGroupName doesn't refer to an existing
parameter group.default CompletableFuture<CopyDbClusterParameterGroupResponse> copyDBClusterParameterGroup(Consumer<CopyDbClusterParameterGroupRequest.Builder> copyDbClusterParameterGroupRequest)
Copies the specified cluster parameter group.
This is a convenience which creates an instance of the CopyDbClusterParameterGroupRequest.Builder
avoiding the need to create one manually via CopyDbClusterParameterGroupRequest.builder()
copyDbClusterParameterGroupRequest - A Consumer that will call methods on CopyDBClusterParameterGroupMessage.Builder to create
a request. Represents the input to CopyDBClusterParameterGroup.DBParameterGroupName doesn't refer to an existing
parameter group.default CompletableFuture<CopyDbClusterSnapshotResponse> copyDBClusterSnapshot(CopyDbClusterSnapshotRequest copyDbClusterSnapshotRequest)
Copies a snapshot of a cluster.
To copy a cluster snapshot from a shared manual cluster snapshot, SourceDBClusterSnapshotIdentifier
must be the Amazon Resource Name (ARN) of the shared cluster snapshot. You can only copy a shared DB cluster
snapshot, whether encrypted or not, in the same Region.
To cancel the copy operation after it is in progress, delete the target cluster snapshot identified by
TargetDBClusterSnapshotIdentifier while that cluster snapshot is in the copying status.
copyDbClusterSnapshotRequest - Represents the input to CopyDBClusterSnapshot.DBClusterSnapshotIdentifier doesn't refer to an
existing cluster snapshot.default CompletableFuture<CopyDbClusterSnapshotResponse> copyDBClusterSnapshot(Consumer<CopyDbClusterSnapshotRequest.Builder> copyDbClusterSnapshotRequest)
Copies a snapshot of a cluster.
To copy a cluster snapshot from a shared manual cluster snapshot, SourceDBClusterSnapshotIdentifier
must be the Amazon Resource Name (ARN) of the shared cluster snapshot. You can only copy a shared DB cluster
snapshot, whether encrypted or not, in the same Region.
To cancel the copy operation after it is in progress, delete the target cluster snapshot identified by
TargetDBClusterSnapshotIdentifier while that cluster snapshot is in the copying status.
This is a convenience which creates an instance of the CopyDbClusterSnapshotRequest.Builder avoiding the
need to create one manually via CopyDbClusterSnapshotRequest.builder()
copyDbClusterSnapshotRequest - A Consumer that will call methods on CopyDBClusterSnapshotMessage.Builder to create a
request. Represents the input to CopyDBClusterSnapshot.DBClusterSnapshotIdentifier doesn't refer to an
existing cluster snapshot.default CompletableFuture<CreateDbClusterResponse> createDBCluster(CreateDbClusterRequest createDbClusterRequest)
Creates a new Amazon DocumentDB cluster.
createDbClusterRequest - Represents the input to CreateDBCluster.DBSubnetGroupName doesn't refer to an existing subnet
group.DBClusterParameterGroupName doesn't refer to an
existing cluster parameter group.DBClusterIdentifier doesn't refer to an existing cluster.DBInstanceIdentifier doesn't refer to an existing instance.GlobalClusterIdentifier doesn't refer to an existing
global cluster.default CompletableFuture<CreateDbClusterResponse> createDBCluster(Consumer<CreateDbClusterRequest.Builder> createDbClusterRequest)
Creates a new Amazon DocumentDB cluster.
This is a convenience which creates an instance of the CreateDbClusterRequest.Builder avoiding the need
to create one manually via CreateDbClusterRequest.builder()
createDbClusterRequest - A Consumer that will call methods on CreateDBClusterMessage.Builder to create a request.
Represents the input to CreateDBCluster.DBSubnetGroupName doesn't refer to an existing subnet
group.DBClusterParameterGroupName doesn't refer to an
existing cluster parameter group.DBClusterIdentifier doesn't refer to an existing cluster.DBInstanceIdentifier doesn't refer to an existing instance.GlobalClusterIdentifier doesn't refer to an existing
global cluster.default CompletableFuture<CreateDbClusterParameterGroupResponse> createDBClusterParameterGroup(CreateDbClusterParameterGroupRequest createDbClusterParameterGroupRequest)
Creates a new cluster parameter group.
Parameters in a cluster parameter group apply to all of the instances in a cluster.
A cluster parameter group is initially created with the default parameters for the database engine used by
instances in the cluster. In Amazon DocumentDB, you cannot make modifications directly to the
default.docdb3.6 cluster parameter group. If your Amazon DocumentDB cluster is using the default
cluster parameter group and you want to modify a value in it, you must first create a
new parameter group or copy an
existing parameter group, modify it, and then apply the modified parameter group to your cluster. For the new
cluster parameter group and associated settings to take effect, you must then reboot the instances in the cluster
without failover. For more information, see
Modifying Amazon DocumentDB Cluster Parameter Groups.
createDbClusterParameterGroupRequest - Represents the input of CreateDBClusterParameterGroup.default CompletableFuture<CreateDbClusterParameterGroupResponse> createDBClusterParameterGroup(Consumer<CreateDbClusterParameterGroupRequest.Builder> createDbClusterParameterGroupRequest)
Creates a new cluster parameter group.
Parameters in a cluster parameter group apply to all of the instances in a cluster.
A cluster parameter group is initially created with the default parameters for the database engine used by
instances in the cluster. In Amazon DocumentDB, you cannot make modifications directly to the
default.docdb3.6 cluster parameter group. If your Amazon DocumentDB cluster is using the default
cluster parameter group and you want to modify a value in it, you must first create a
new parameter group or copy an
existing parameter group, modify it, and then apply the modified parameter group to your cluster. For the new
cluster parameter group and associated settings to take effect, you must then reboot the instances in the cluster
without failover. For more information, see
Modifying Amazon DocumentDB Cluster Parameter Groups.
This is a convenience which creates an instance of the CreateDbClusterParameterGroupRequest.Builder
avoiding the need to create one manually via CreateDbClusterParameterGroupRequest.builder()
createDbClusterParameterGroupRequest - A Consumer that will call methods on CreateDBClusterParameterGroupMessage.Builder to
create a request. Represents the input of CreateDBClusterParameterGroup.default CompletableFuture<CreateDbClusterSnapshotResponse> createDBClusterSnapshot(CreateDbClusterSnapshotRequest createDbClusterSnapshotRequest)
Creates a snapshot of a cluster.
createDbClusterSnapshotRequest - Represents the input of CreateDBClusterSnapshot.DBClusterIdentifier doesn't refer to an existing cluster.default CompletableFuture<CreateDbClusterSnapshotResponse> createDBClusterSnapshot(Consumer<CreateDbClusterSnapshotRequest.Builder> createDbClusterSnapshotRequest)
Creates a snapshot of a cluster.
This is a convenience which creates an instance of the CreateDbClusterSnapshotRequest.Builder avoiding
the need to create one manually via CreateDbClusterSnapshotRequest.builder()
createDbClusterSnapshotRequest - A Consumer that will call methods on CreateDBClusterSnapshotMessage.Builder to create a
request. Represents the input of CreateDBClusterSnapshot.DBClusterIdentifier doesn't refer to an existing cluster.default CompletableFuture<CreateDbInstanceResponse> createDBInstance(CreateDbInstanceRequest createDbInstanceRequest)
Creates a new instance.
createDbInstanceRequest - Represents the input to CreateDBInstance.DBParameterGroupName doesn't refer to an existing
parameter group.DBSecurityGroupName doesn't refer to an existing
security group.DBSubnetGroupName doesn't refer to an existing subnet
group.DBClusterIdentifier doesn't refer to an existing cluster.StorageType can't be
associated with the DB instance.Amazon DocumentDB also might not be authorized to perform necessary actions on your behalf using IAM.
default CompletableFuture<CreateDbInstanceResponse> createDBInstance(Consumer<CreateDbInstanceRequest.Builder> createDbInstanceRequest)
Creates a new instance.
This is a convenience which creates an instance of the CreateDbInstanceRequest.Builder avoiding the need
to create one manually via CreateDbInstanceRequest.builder()
createDbInstanceRequest - A Consumer that will call methods on CreateDBInstanceMessage.Builder to create a request.
Represents the input to CreateDBInstance.DBParameterGroupName doesn't refer to an existing
parameter group.DBSecurityGroupName doesn't refer to an existing
security group.DBSubnetGroupName doesn't refer to an existing subnet
group.DBClusterIdentifier doesn't refer to an existing cluster.StorageType can't be
associated with the DB instance.Amazon DocumentDB also might not be authorized to perform necessary actions on your behalf using IAM.
default CompletableFuture<CreateDbSubnetGroupResponse> createDBSubnetGroup(CreateDbSubnetGroupRequest createDbSubnetGroupRequest)
Creates a new subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Region.
createDbSubnetGroupRequest - Represents the input to CreateDBSubnetGroup.DBSubnetGroupName is already being used by an
existing subnet group.default CompletableFuture<CreateDbSubnetGroupResponse> createDBSubnetGroup(Consumer<CreateDbSubnetGroupRequest.Builder> createDbSubnetGroupRequest)
Creates a new subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Region.
This is a convenience which creates an instance of the CreateDbSubnetGroupRequest.Builder avoiding the
need to create one manually via CreateDbSubnetGroupRequest.builder()
createDbSubnetGroupRequest - A Consumer that will call methods on CreateDBSubnetGroupMessage.Builder to create a
request. Represents the input to CreateDBSubnetGroup.DBSubnetGroupName is already being used by an
existing subnet group.default CompletableFuture<CreateEventSubscriptionResponse> createEventSubscription(CreateEventSubscriptionRequest createEventSubscriptionRequest)
Creates an Amazon DocumentDB event notification subscription. This action requires a topic Amazon Resource Name (ARN) created by using the Amazon DocumentDB console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the Amazon SNS console.
You can specify the type of source (SourceType) that you want to be notified of. You can also
provide a list of Amazon DocumentDB sources (SourceIds) that trigger the events, and you can provide
a list of event categories (EventCategories) for events that 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
Amazon DocumentDB sources. If you do not specify either the SourceType or the
SourceIdentifier, you are notified of events generated from all Amazon DocumentDB sources belonging
to your customer account.
createEventSubscriptionRequest - Represents the input to CreateEventSubscription.default CompletableFuture<CreateEventSubscriptionResponse> createEventSubscription(Consumer<CreateEventSubscriptionRequest.Builder> createEventSubscriptionRequest)
Creates an Amazon DocumentDB event notification subscription. This action requires a topic Amazon Resource Name (ARN) created by using the Amazon DocumentDB console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the Amazon SNS console.
You can specify the type of source (SourceType) that you want to be notified of. You can also
provide a list of Amazon DocumentDB sources (SourceIds) that trigger the events, and you can provide
a list of event categories (EventCategories) for events that 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
Amazon DocumentDB sources. If you do not specify either the SourceType or the
SourceIdentifier, you are notified of events generated from all Amazon DocumentDB 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 via CreateEventSubscriptionRequest.builder()
createEventSubscriptionRequest - A Consumer that will call methods on CreateEventSubscriptionMessage.Builder to create a
request. Represents the input to CreateEventSubscription.default CompletableFuture<CreateGlobalClusterResponse> createGlobalCluster(CreateGlobalClusterRequest createGlobalClusterRequest)
Creates an Amazon DocumentDB global cluster that can span multiple multiple Regions. The global cluster contains one primary cluster with read-write capability, and up-to give read-only secondary clusters. Global clusters uses storage-based fast replication across regions with latencies less than one second, using dedicated infrastructure with no impact to your workload’s performance.
You can create a global cluster that is initially empty, and then add a primary and a secondary to it. Or you can specify an existing cluster during the create operation, and this cluster becomes the primary of the global cluster.
This action only applies to Amazon DocumentDB clusters.
createGlobalClusterRequest - Represents the input to CreateGlobalCluster.GlobalClusterIdentifier already exists. Choose a
new global cluster identifier (unique name) to create a new global cluster.DBClusterIdentifier doesn't refer to an existing cluster.default CompletableFuture<CreateGlobalClusterResponse> createGlobalCluster(Consumer<CreateGlobalClusterRequest.Builder> createGlobalClusterRequest)
Creates an Amazon DocumentDB global cluster that can span multiple multiple Regions. The global cluster contains one primary cluster with read-write capability, and up-to give read-only secondary clusters. Global clusters uses storage-based fast replication across regions with latencies less than one second, using dedicated infrastructure with no impact to your workload’s performance.
You can create a global cluster that is initially empty, and then add a primary and a secondary to it. Or you can specify an existing cluster during the create operation, and this cluster becomes the primary of the global cluster.
This action only applies to Amazon DocumentDB clusters.
This is a convenience which creates an instance of the CreateGlobalClusterRequest.Builder avoiding the
need to create one manually via CreateGlobalClusterRequest.builder()
createGlobalClusterRequest - A Consumer that will call methods on CreateGlobalClusterMessage.Builder to create a
request. Represents the input to CreateGlobalCluster.GlobalClusterIdentifier already exists. Choose a
new global cluster identifier (unique name) to create a new global cluster.DBClusterIdentifier doesn't refer to an existing cluster.default CompletableFuture<DeleteDbClusterResponse> deleteDBCluster(DeleteDbClusterRequest deleteDbClusterRequest)
Deletes a previously provisioned cluster. When you delete a cluster, all automated backups for that cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified cluster are not deleted.
deleteDbClusterRequest - Represents the input to DeleteDBCluster.DBClusterIdentifier doesn't refer to an existing cluster.
default CompletableFuture<DeleteDbClusterResponse> deleteDBCluster(Consumer<DeleteDbClusterRequest.Builder> deleteDbClusterRequest)
Deletes a previously provisioned cluster. When you delete a cluster, all automated backups for that cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified cluster are not deleted.
This is a convenience which creates an instance of the DeleteDbClusterRequest.Builder avoiding the need
to create one manually via DeleteDbClusterRequest.builder()
deleteDbClusterRequest - A Consumer that will call methods on DeleteDBClusterMessage.Builder to create a request.
Represents the input to DeleteDBCluster.DBClusterIdentifier doesn't refer to an existing cluster.default CompletableFuture<DeleteDbClusterParameterGroupResponse> deleteDBClusterParameterGroup(DeleteDbClusterParameterGroupRequest deleteDbClusterParameterGroupRequest)
Deletes a specified cluster parameter group. The cluster parameter group to be deleted can't be associated with any clusters.
deleteDbClusterParameterGroupRequest - Represents the input to DeleteDBClusterParameterGroup.DBParameterGroupName doesn't refer to an existing
parameter group.default CompletableFuture<DeleteDbClusterParameterGroupResponse> deleteDBClusterParameterGroup(Consumer<DeleteDbClusterParameterGroupRequest.Builder> deleteDbClusterParameterGroupRequest)
Deletes a specified cluster parameter group. The cluster parameter group to be deleted can't be associated with any clusters.
This is a convenience which creates an instance of the DeleteDbClusterParameterGroupRequest.Builder
avoiding the need to create one manually via DeleteDbClusterParameterGroupRequest.builder()
deleteDbClusterParameterGroupRequest - A Consumer that will call methods on DeleteDBClusterParameterGroupMessage.Builder to
create a request. Represents the input to DeleteDBClusterParameterGroup.DBParameterGroupName doesn't refer to an existing
parameter group.default CompletableFuture<DeleteDbClusterSnapshotResponse> deleteDBClusterSnapshot(DeleteDbClusterSnapshotRequest deleteDbClusterSnapshotRequest)
Deletes a cluster snapshot. If the snapshot is being copied, the copy operation is terminated.
The cluster snapshot must be in the available state to be deleted.
deleteDbClusterSnapshotRequest - Represents the input to DeleteDBClusterSnapshot.DBClusterSnapshotIdentifier doesn't refer to an
existing cluster snapshot.default CompletableFuture<DeleteDbClusterSnapshotResponse> deleteDBClusterSnapshot(Consumer<DeleteDbClusterSnapshotRequest.Builder> deleteDbClusterSnapshotRequest)
Deletes a cluster snapshot. If the snapshot is being copied, the copy operation is terminated.
The 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 via DeleteDbClusterSnapshotRequest.builder()
deleteDbClusterSnapshotRequest - A Consumer that will call methods on DeleteDBClusterSnapshotMessage.Builder to create a
request. Represents the input to DeleteDBClusterSnapshot.DBClusterSnapshotIdentifier doesn't refer to an
existing cluster snapshot.default CompletableFuture<DeleteDbInstanceResponse> deleteDBInstance(DeleteDbInstanceRequest deleteDbInstanceRequest)
Deletes a previously provisioned instance.
deleteDbInstanceRequest - Represents the input to DeleteDBInstance.DBInstanceIdentifier doesn't refer to an existing instance.DBSnapshotIdentifier is already being used by an
existing snapshot.default CompletableFuture<DeleteDbInstanceResponse> deleteDBInstance(Consumer<DeleteDbInstanceRequest.Builder> deleteDbInstanceRequest)
Deletes a previously provisioned instance.
This is a convenience which creates an instance of the DeleteDbInstanceRequest.Builder avoiding the need
to create one manually via DeleteDbInstanceRequest.builder()
deleteDbInstanceRequest - A Consumer that will call methods on DeleteDBInstanceMessage.Builder to create a request.
Represents the input to DeleteDBInstance.DBInstanceIdentifier doesn't refer to an existing instance.DBSnapshotIdentifier is already being used by an
existing snapshot.default CompletableFuture<DeleteDbSubnetGroupResponse> deleteDBSubnetGroup(DeleteDbSubnetGroupRequest deleteDbSubnetGroupRequest)
Deletes a subnet group.
The specified database subnet group must not be associated with any DB instances.
deleteDbSubnetGroupRequest - Represents the input to DeleteDBSubnetGroup.DBSubnetGroupName doesn't refer to an existing subnet
group.default CompletableFuture<DeleteDbSubnetGroupResponse> deleteDBSubnetGroup(Consumer<DeleteDbSubnetGroupRequest.Builder> deleteDbSubnetGroupRequest)
Deletes a 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 via DeleteDbSubnetGroupRequest.builder()
deleteDbSubnetGroupRequest - A Consumer that will call methods on DeleteDBSubnetGroupMessage.Builder to create a
request. Represents the input to DeleteDBSubnetGroup.DBSubnetGroupName doesn't refer to an existing subnet
group.default CompletableFuture<DeleteEventSubscriptionResponse> deleteEventSubscription(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest)
Deletes an Amazon DocumentDB event notification subscription.
deleteEventSubscriptionRequest - Represents the input to DeleteEventSubscription.default CompletableFuture<DeleteEventSubscriptionResponse> deleteEventSubscription(Consumer<DeleteEventSubscriptionRequest.Builder> deleteEventSubscriptionRequest)
Deletes an Amazon DocumentDB event notification subscription.
This is a convenience which creates an instance of the DeleteEventSubscriptionRequest.Builder avoiding
the need to create one manually via DeleteEventSubscriptionRequest.builder()
deleteEventSubscriptionRequest - A Consumer that will call methods on DeleteEventSubscriptionMessage.Builder to create a
request. Represents the input to DeleteEventSubscription.default CompletableFuture<DeleteGlobalClusterResponse> deleteGlobalCluster(DeleteGlobalClusterRequest deleteGlobalClusterRequest)
Deletes a global cluster. The primary and secondary clusters must already be detached or deleted before attempting to delete a global cluster.
This action only applies to Amazon DocumentDB clusters.
deleteGlobalClusterRequest - Represents the input to DeleteGlobalCluster.GlobalClusterIdentifier doesn't refer to an existing
global cluster.default CompletableFuture<DeleteGlobalClusterResponse> deleteGlobalCluster(Consumer<DeleteGlobalClusterRequest.Builder> deleteGlobalClusterRequest)
Deletes a global cluster. The primary and secondary clusters must already be detached or deleted before attempting to delete a global cluster.
This action only applies to Amazon DocumentDB clusters.
This is a convenience which creates an instance of the DeleteGlobalClusterRequest.Builder avoiding the
need to create one manually via DeleteGlobalClusterRequest.builder()
deleteGlobalClusterRequest - A Consumer that will call methods on DeleteGlobalClusterMessage.Builder to create a
request. Represents the input to DeleteGlobalCluster.GlobalClusterIdentifier doesn't refer to an existing
global cluster.default CompletableFuture<DescribeCertificatesResponse> describeCertificates(DescribeCertificatesRequest describeCertificatesRequest)
Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this account.
describeCertificatesRequest - CertificateIdentifier doesn't refer to an existing
certificate.default CompletableFuture<DescribeCertificatesResponse> describeCertificates(Consumer<DescribeCertificatesRequest.Builder> describeCertificatesRequest)
Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this account.
This is a convenience which creates an instance of the DescribeCertificatesRequest.Builder avoiding the
need to create one manually via DescribeCertificatesRequest.builder()
describeCertificatesRequest - A Consumer that will call methods on DescribeCertificatesMessage.Builder to create a
request.CertificateIdentifier doesn't refer to an existing
certificate.default DescribeCertificatesPublisher describeCertificatesPaginator(DescribeCertificatesRequest describeCertificatesRequest)
Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this account.
This is a variant of
describeCertificates(software.amazon.awssdk.services.docdb.model.DescribeCertificatesRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.docdb.paginators.DescribeCertificatesPublisher publisher = client.describeCertificatesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.docdb.paginators.DescribeCertificatesPublisher publisher = client.describeCertificatesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.docdb.model.DescribeCertificatesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.docdb.model.DescribeCertificatesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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
describeCertificates(software.amazon.awssdk.services.docdb.model.DescribeCertificatesRequest)
operation.
describeCertificatesRequest - CertificateIdentifier doesn't refer to an existing
certificate.default DescribeCertificatesPublisher describeCertificatesPaginator(Consumer<DescribeCertificatesRequest.Builder> describeCertificatesRequest)
Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this account.
This is a variant of
describeCertificates(software.amazon.awssdk.services.docdb.model.DescribeCertificatesRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.docdb.paginators.DescribeCertificatesPublisher publisher = client.describeCertificatesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.docdb.paginators.DescribeCertificatesPublisher publisher = client.describeCertificatesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.docdb.model.DescribeCertificatesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.docdb.model.DescribeCertificatesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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
describeCertificates(software.amazon.awssdk.services.docdb.model.DescribeCertificatesRequest)
operation.
This is a convenience which creates an instance of the DescribeCertificatesRequest.Builder avoiding the
need to create one manually via DescribeCertificatesRequest.builder()
describeCertificatesRequest - A Consumer that will call methods on DescribeCertificatesMessage.Builder to create a
request.CertificateIdentifier doesn't refer to an existing
certificate.default CompletableFuture<DescribeDbClusterParameterGroupsResponse> describeDBClusterParameterGroups(DescribeDbClusterParameterGroupsRequest describeDbClusterParameterGroupsRequest)
Returns a list of DBClusterParameterGroup descriptions. If a
DBClusterParameterGroupName parameter is specified, the list contains only the description of the
specified cluster parameter group.
describeDbClusterParameterGroupsRequest - Represents the input to DescribeDBClusterParameterGroups.DBParameterGroupName doesn't refer to an existing
parameter group.default CompletableFuture<DescribeDbClusterParameterGroupsResponse> describeDBClusterParameterGroups(Consumer<DescribeDbClusterParameterGroupsRequest.Builder> describeDbClusterParameterGroupsRequest)
Returns a list of DBClusterParameterGroup descriptions. If a
DBClusterParameterGroupName parameter is specified, the list contains only the description of the
specified cluster parameter group.
This is a convenience which creates an instance of the DescribeDbClusterParameterGroupsRequest.Builder
avoiding the need to create one manually via DescribeDbClusterParameterGroupsRequest.builder()
describeDbClusterParameterGroupsRequest - A Consumer that will call methods on DescribeDBClusterParameterGroupsMessage.Builder to
create a request. Represents the input to DescribeDBClusterParameterGroups.DBParameterGroupName doesn't refer to an existing
parameter group.default CompletableFuture<DescribeDbClusterParameterGroupsResponse> describeDBClusterParameterGroups()
Returns a list of DBClusterParameterGroup descriptions. If a
DBClusterParameterGroupName parameter is specified, the list contains only the description of the
specified cluster parameter group.
DBParameterGroupName doesn't refer to an existing
parameter group.default DescribeDBClusterParameterGroupsPublisher describeDBClusterParameterGroupsPaginator()
Returns a list of DBClusterParameterGroup descriptions. If a
DBClusterParameterGroupName parameter is specified, the list contains only the description of the
specified cluster parameter group.
This is a variant of
describeDBClusterParameterGroups(software.amazon.awssdk.services.docdb.model.DescribeDbClusterParameterGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.docdb.paginators.DescribeDBClusterParameterGroupsPublisher publisher = client.describeDBClusterParameterGroupsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.docdb.paginators.DescribeDBClusterParameterGroupsPublisher publisher = client.describeDBClusterParameterGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.docdb.model.DescribeDbClusterParameterGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.docdb.model.DescribeDbClusterParameterGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.docdb.model.DescribeDbClusterParameterGroupsRequest)
operation.
DBParameterGroupName doesn't refer to an existing
parameter group.default DescribeDBClusterParameterGroupsPublisher describeDBClusterParameterGroupsPaginator(DescribeDbClusterParameterGroupsRequest describeDbClusterParameterGroupsRequest)
Returns a list of DBClusterParameterGroup descriptions. If a
DBClusterParameterGroupName parameter is specified, the list contains only the description of the
specified cluster parameter group.
This is a variant of
describeDBClusterParameterGroups(software.amazon.awssdk.services.docdb.model.DescribeDbClusterParameterGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.docdb.paginators.DescribeDBClusterParameterGroupsPublisher publisher = client.describeDBClusterParameterGroupsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.docdb.paginators.DescribeDBClusterParameterGroupsPublisher publisher = client.describeDBClusterParameterGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.docdb.model.DescribeDbClusterParameterGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.docdb.model.DescribeDbClusterParameterGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.docdb.model.DescribeDbClusterParameterGroupsRequest)
operation.
describeDbClusterParameterGroupsRequest - Represents the input to DescribeDBClusterParameterGroups.DBParameterGroupName doesn't refer to an existing
parameter group.default DescribeDBClusterParameterGroupsPublisher describeDBClusterParameterGroupsPaginator(Consumer<DescribeDbClusterParameterGroupsRequest.Builder> describeDbClusterParameterGroupsRequest)
Returns a list of DBClusterParameterGroup descriptions. If a
DBClusterParameterGroupName parameter is specified, the list contains only the description of the
specified cluster parameter group.
This is a variant of
describeDBClusterParameterGroups(software.amazon.awssdk.services.docdb.model.DescribeDbClusterParameterGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.docdb.paginators.DescribeDBClusterParameterGroupsPublisher publisher = client.describeDBClusterParameterGroupsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.docdb.paginators.DescribeDBClusterParameterGroupsPublisher publisher = client.describeDBClusterParameterGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.docdb.model.DescribeDbClusterParameterGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.docdb.model.DescribeDbClusterParameterGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.docdb.model.DescribeDbClusterParameterGroupsRequest)
operation.
This is a convenience which creates an instance of the DescribeDbClusterParameterGroupsRequest.Builder
avoiding the need to create one manually via DescribeDbClusterParameterGroupsRequest.builder()
describeDbClusterParameterGroupsRequest - A Consumer that will call methods on DescribeDBClusterParameterGroupsMessage.Builder to
create a request. Represents the input to DescribeDBClusterParameterGroups.DBParameterGroupName doesn't refer to an existing
parameter group.default CompletableFuture<DescribeDbClusterParametersResponse> describeDBClusterParameters(DescribeDbClusterParametersRequest describeDbClusterParametersRequest)
Returns the detailed parameter list for a particular cluster parameter group.
describeDbClusterParametersRequest - Represents the input to DescribeDBClusterParameters.DBParameterGroupName doesn't refer to an existing
parameter group.default CompletableFuture<DescribeDbClusterParametersResponse> describeDBClusterParameters(Consumer<DescribeDbClusterParametersRequest.Builder> describeDbClusterParametersRequest)
Returns the detailed parameter list for a particular cluster parameter group.
This is a convenience which creates an instance of the DescribeDbClusterParametersRequest.Builder
avoiding the need to create one manually via DescribeDbClusterParametersRequest.builder()
describeDbClusterParametersRequest - A Consumer that will call methods on DescribeDBClusterParametersMessage.Builder to create
a request. Represents the input to DescribeDBClusterParameters.DBParameterGroupName doesn't refer to an existing
parameter group.default DescribeDBClusterParametersPublisher describeDBClusterParametersPaginator(DescribeDbClusterParametersRequest describeDbClusterParametersRequest)
Returns the detailed parameter list for a particular cluster parameter group.
This is a variant of
describeDBClusterParameters(software.amazon.awssdk.services.docdb.model.DescribeDbClusterParametersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.docdb.paginators.DescribeDBClusterParametersPublisher publisher = client.describeDBClusterParametersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.docdb.paginators.DescribeDBClusterParametersPublisher publisher = client.describeDBClusterParametersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.docdb.model.DescribeDbClusterParametersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.docdb.model.DescribeDbClusterParametersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.docdb.model.DescribeDbClusterParametersRequest)
operation.
describeDbClusterParametersRequest - Represents the input to DescribeDBClusterParameters.DBParameterGroupName doesn't refer to an existing
parameter group.default DescribeDBClusterParametersPublisher describeDBClusterParametersPaginator(Consumer<DescribeDbClusterParametersRequest.Builder> describeDbClusterParametersRequest)
Returns the detailed parameter list for a particular cluster parameter group.
This is a variant of
describeDBClusterParameters(software.amazon.awssdk.services.docdb.model.DescribeDbClusterParametersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.docdb.paginators.DescribeDBClusterParametersPublisher publisher = client.describeDBClusterParametersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.docdb.paginators.DescribeDBClusterParametersPublisher publisher = client.describeDBClusterParametersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.docdb.model.DescribeDbClusterParametersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.docdb.model.DescribeDbClusterParametersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.docdb.model.DescribeDbClusterParametersRequest)
operation.
This is a convenience which creates an instance of the DescribeDbClusterParametersRequest.Builder
avoiding the need to create one manually via DescribeDbClusterParametersRequest.builder()
describeDbClusterParametersRequest - A Consumer that will call methods on DescribeDBClusterParametersMessage.Builder to create
a request. Represents the input to DescribeDBClusterParameters.DBParameterGroupName doesn't refer to an existing
parameter group.default CompletableFuture<DescribeDbClusterSnapshotAttributesResponse> describeDBClusterSnapshotAttributes(DescribeDbClusterSnapshotAttributesRequest describeDbClusterSnapshotAttributesRequest)
Returns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot.
When you share snapshots with other accounts, DescribeDBClusterSnapshotAttributes returns the
restore attribute and a list of IDs for the accounts that are authorized to copy or restore the
manual cluster snapshot. If all is included in the list of values for the restore
attribute, then the manual cluster snapshot is public and can be copied or restored by all accounts.
describeDbClusterSnapshotAttributesRequest - Represents the input to DescribeDBClusterSnapshotAttributes.DBClusterSnapshotIdentifier doesn't refer to an
existing cluster snapshot.default CompletableFuture<DescribeDbClusterSnapshotAttributesResponse> describeDBClusterSnapshotAttributes(Consumer<DescribeDbClusterSnapshotAttributesRequest.Builder> describeDbClusterSnapshotAttributesRequest)
Returns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot.
When you share snapshots with other accounts, DescribeDBClusterSnapshotAttributes returns the
restore attribute and a list of IDs for the accounts that are authorized to copy or restore the
manual cluster snapshot. If all is included in the list of values for the restore
attribute, then the manual cluster snapshot is public and can be copied or restored by all accounts.
This is a convenience which creates an instance of the DescribeDbClusterSnapshotAttributesRequest.Builder
avoiding the need to create one manually via DescribeDbClusterSnapshotAttributesRequest.builder()
describeDbClusterSnapshotAttributesRequest - A Consumer that will call methods on DescribeDBClusterSnapshotAttributesMessage.Builder to
create a request. Represents the input to DescribeDBClusterSnapshotAttributes.DBClusterSnapshotIdentifier doesn't refer to an
existing cluster snapshot.default CompletableFuture<DescribeDbClusterSnapshotsResponse> describeDBClusterSnapshots(DescribeDbClusterSnapshotsRequest describeDbClusterSnapshotsRequest)
Returns information about cluster snapshots. This API operation supports pagination.
describeDbClusterSnapshotsRequest - Represents the input to DescribeDBClusterSnapshots.DBClusterSnapshotIdentifier doesn't refer to an
existing cluster snapshot.default CompletableFuture<DescribeDbClusterSnapshotsResponse> describeDBClusterSnapshots(Consumer<DescribeDbClusterSnapshotsRequest.Builder> describeDbClusterSnapshotsRequest)
Returns information about cluster snapshots. This API operation supports pagination.
This is a convenience which creates an instance of the DescribeDbClusterSnapshotsRequest.Builder avoiding
the need to create one manually via DescribeDbClusterSnapshotsRequest.builder()
describeDbClusterSnapshotsRequest - A Consumer that will call methods on DescribeDBClusterSnapshotsMessage.Builder to create a
request. Represents the input to DescribeDBClusterSnapshots.DBClusterSnapshotIdentifier doesn't refer to an
existing cluster snapshot.default CompletableFuture<DescribeDbClusterSnapshotsResponse> describeDBClusterSnapshots()
Returns information about cluster snapshots. This API operation supports pagination.
DBClusterSnapshotIdentifier doesn't refer to an
existing cluster snapshot.default DescribeDBClusterSnapshotsPublisher describeDBClusterSnapshotsPaginator()
Returns information about cluster snapshots. This API operation supports pagination.
This is a variant of
describeDBClusterSnapshots(software.amazon.awssdk.services.docdb.model.DescribeDbClusterSnapshotsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.docdb.paginators.DescribeDBClusterSnapshotsPublisher publisher = client.describeDBClusterSnapshotsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.docdb.paginators.DescribeDBClusterSnapshotsPublisher publisher = client.describeDBClusterSnapshotsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.docdb.model.DescribeDbClusterSnapshotsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.docdb.model.DescribeDbClusterSnapshotsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.docdb.model.DescribeDbClusterSnapshotsRequest)
operation.
DBClusterSnapshotIdentifier doesn't refer to an
existing cluster snapshot.default DescribeDBClusterSnapshotsPublisher describeDBClusterSnapshotsPaginator(DescribeDbClusterSnapshotsRequest describeDbClusterSnapshotsRequest)
Returns information about cluster snapshots. This API operation supports pagination.
This is a variant of
describeDBClusterSnapshots(software.amazon.awssdk.services.docdb.model.DescribeDbClusterSnapshotsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.docdb.paginators.DescribeDBClusterSnapshotsPublisher publisher = client.describeDBClusterSnapshotsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.docdb.paginators.DescribeDBClusterSnapshotsPublisher publisher = client.describeDBClusterSnapshotsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.docdb.model.DescribeDbClusterSnapshotsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.docdb.model.DescribeDbClusterSnapshotsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.docdb.model.DescribeDbClusterSnapshotsRequest)
operation.
describeDbClusterSnapshotsRequest - Represents the input to DescribeDBClusterSnapshots.DBClusterSnapshotIdentifier doesn't refer to an
existing cluster snapshot.default DescribeDBClusterSnapshotsPublisher describeDBClusterSnapshotsPaginator(Consumer<DescribeDbClusterSnapshotsRequest.Builder> describeDbClusterSnapshotsRequest)
Returns information about cluster snapshots. This API operation supports pagination.
This is a variant of
describeDBClusterSnapshots(software.amazon.awssdk.services.docdb.model.DescribeDbClusterSnapshotsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.docdb.paginators.DescribeDBClusterSnapshotsPublisher publisher = client.describeDBClusterSnapshotsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.docdb.paginators.DescribeDBClusterSnapshotsPublisher publisher = client.describeDBClusterSnapshotsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.docdb.model.DescribeDbClusterSnapshotsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.docdb.model.DescribeDbClusterSnapshotsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.docdb.model.DescribeDbClusterSnapshotsRequest)
operation.
This is a convenience which creates an instance of the DescribeDbClusterSnapshotsRequest.Builder avoiding
the need to create one manually via DescribeDbClusterSnapshotsRequest.builder()
describeDbClusterSnapshotsRequest - A Consumer that will call methods on DescribeDBClusterSnapshotsMessage.Builder to create a
request. Represents the input to DescribeDBClusterSnapshots.DBClusterSnapshotIdentifier doesn't refer to an
existing cluster snapshot.default CompletableFuture<DescribeDbClustersResponse> describeDBClusters(DescribeDbClustersRequest describeDbClustersRequest)
Returns information about provisioned Amazon DocumentDB clusters. This API operation supports pagination. For
certain management features such as cluster and instance lifecycle management, Amazon DocumentDB leverages
operational technology that is shared with Amazon RDS and Amazon Neptune. Use the
filterName=engine,Values=docdb filter parameter to return only Amazon DocumentDB clusters.
describeDbClustersRequest - Represents the input to DescribeDBClusters.DBClusterIdentifier doesn't refer to an existing cluster.default CompletableFuture<DescribeDbClustersResponse> describeDBClusters(Consumer<DescribeDbClustersRequest.Builder> describeDbClustersRequest)
Returns information about provisioned Amazon DocumentDB clusters. This API operation supports pagination. For
certain management features such as cluster and instance lifecycle management, Amazon DocumentDB leverages
operational technology that is shared with Amazon RDS and Amazon Neptune. Use the
filterName=engine,Values=docdb filter parameter to return only Amazon DocumentDB clusters.
This is a convenience which creates an instance of the DescribeDbClustersRequest.Builder avoiding the
need to create one manually via DescribeDbClustersRequest.builder()
describeDbClustersRequest - A Consumer that will call methods on DescribeDBClustersMessage.Builder to create a
request. Represents the input to DescribeDBClusters.DBClusterIdentifier doesn't refer to an existing cluster.default CompletableFuture<DescribeDbClustersResponse> describeDBClusters()
Returns information about provisioned Amazon DocumentDB clusters. This API operation supports pagination. For
certain management features such as cluster and instance lifecycle management, Amazon DocumentDB leverages
operational technology that is shared with Amazon RDS and Amazon Neptune. Use the
filterName=engine,Values=docdb filter parameter to return only Amazon DocumentDB clusters.
DBClusterIdentifier doesn't refer to an existing cluster.default DescribeDBClustersPublisher describeDBClustersPaginator()
Returns information about provisioned Amazon DocumentDB clusters. This API operation supports pagination. For
certain management features such as cluster and instance lifecycle management, Amazon DocumentDB leverages
operational technology that is shared with Amazon RDS and Amazon Neptune. Use the
filterName=engine,Values=docdb filter parameter to return only Amazon DocumentDB clusters.
This is a variant of
describeDBClusters(software.amazon.awssdk.services.docdb.model.DescribeDbClustersRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.docdb.paginators.DescribeDBClustersPublisher publisher = client.describeDBClustersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.docdb.paginators.DescribeDBClustersPublisher publisher = client.describeDBClustersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.docdb.model.DescribeDbClustersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.docdb.model.DescribeDbClustersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.docdb.model.DescribeDbClustersRequest) operation.
DBClusterIdentifier doesn't refer to an existing cluster.default DescribeDBClustersPublisher describeDBClustersPaginator(DescribeDbClustersRequest describeDbClustersRequest)
Returns information about provisioned Amazon DocumentDB clusters. This API operation supports pagination. For
certain management features such as cluster and instance lifecycle management, Amazon DocumentDB leverages
operational technology that is shared with Amazon RDS and Amazon Neptune. Use the
filterName=engine,Values=docdb filter parameter to return only Amazon DocumentDB clusters.
This is a variant of
describeDBClusters(software.amazon.awssdk.services.docdb.model.DescribeDbClustersRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.docdb.paginators.DescribeDBClustersPublisher publisher = client.describeDBClustersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.docdb.paginators.DescribeDBClustersPublisher publisher = client.describeDBClustersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.docdb.model.DescribeDbClustersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.docdb.model.DescribeDbClustersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.docdb.model.DescribeDbClustersRequest) operation.
describeDbClustersRequest - Represents the input to DescribeDBClusters.DBClusterIdentifier doesn't refer to an existing cluster.default DescribeDBClustersPublisher describeDBClustersPaginator(Consumer<DescribeDbClustersRequest.Builder> describeDbClustersRequest)
Returns information about provisioned Amazon DocumentDB clusters. This API operation supports pagination. For
certain management features such as cluster and instance lifecycle management, Amazon DocumentDB leverages
operational technology that is shared with Amazon RDS and Amazon Neptune. Use the
filterName=engine,Values=docdb filter parameter to return only Amazon DocumentDB clusters.
This is a variant of
describeDBClusters(software.amazon.awssdk.services.docdb.model.DescribeDbClustersRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.docdb.paginators.DescribeDBClustersPublisher publisher = client.describeDBClustersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.docdb.paginators.DescribeDBClustersPublisher publisher = client.describeDBClustersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.docdb.model.DescribeDbClustersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.docdb.model.DescribeDbClustersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.docdb.model.DescribeDbClustersRequest) operation.
This is a convenience which creates an instance of the DescribeDbClustersRequest.Builder avoiding the
need to create one manually via DescribeDbClustersRequest.builder()
describeDbClustersRequest - A Consumer that will call methods on DescribeDBClustersMessage.Builder to create a
request. Represents the input to DescribeDBClusters.DBClusterIdentifier doesn't refer to an existing cluster.default CompletableFuture<DescribeDbEngineVersionsResponse> describeDBEngineVersions(DescribeDbEngineVersionsRequest describeDbEngineVersionsRequest)
Returns a list of the available engines.
describeDbEngineVersionsRequest - Represents the input to DescribeDBEngineVersions.default CompletableFuture<DescribeDbEngineVersionsResponse> describeDBEngineVersions(Consumer<DescribeDbEngineVersionsRequest.Builder> describeDbEngineVersionsRequest)
Returns a list of the available engines.
This is a convenience which creates an instance of the DescribeDbEngineVersionsRequest.Builder avoiding
the need to create one manually via DescribeDbEngineVersionsRequest.builder()
describeDbEngineVersionsRequest - A Consumer that will call methods on DescribeDBEngineVersionsMessage.Builder to create a
request. Represents the input to DescribeDBEngineVersions.default CompletableFuture<DescribeDbEngineVersionsResponse> describeDBEngineVersions()
Returns a list of the available engines.
default DescribeDBEngineVersionsPublisher describeDBEngineVersionsPaginator()
Returns a list of the available engines.
This is a variant of
describeDBEngineVersions(software.amazon.awssdk.services.docdb.model.DescribeDbEngineVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.docdb.paginators.DescribeDBEngineVersionsPublisher publisher = client.describeDBEngineVersionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.docdb.paginators.DescribeDBEngineVersionsPublisher publisher = client.describeDBEngineVersionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.docdb.model.DescribeDbEngineVersionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.docdb.model.DescribeDbEngineVersionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.docdb.model.DescribeDbEngineVersionsRequest)
operation.
default DescribeDBEngineVersionsPublisher describeDBEngineVersionsPaginator(DescribeDbEngineVersionsRequest describeDbEngineVersionsRequest)
Returns a list of the available engines.
This is a variant of
describeDBEngineVersions(software.amazon.awssdk.services.docdb.model.DescribeDbEngineVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.docdb.paginators.DescribeDBEngineVersionsPublisher publisher = client.describeDBEngineVersionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.docdb.paginators.DescribeDBEngineVersionsPublisher publisher = client.describeDBEngineVersionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.docdb.model.DescribeDbEngineVersionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.docdb.model.DescribeDbEngineVersionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.docdb.model.DescribeDbEngineVersionsRequest)
operation.
describeDbEngineVersionsRequest - Represents the input to DescribeDBEngineVersions.default DescribeDBEngineVersionsPublisher describeDBEngineVersionsPaginator(Consumer<DescribeDbEngineVersionsRequest.Builder> describeDbEngineVersionsRequest)
Returns a list of the available engines.
This is a variant of
describeDBEngineVersions(software.amazon.awssdk.services.docdb.model.DescribeDbEngineVersionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.docdb.paginators.DescribeDBEngineVersionsPublisher publisher = client.describeDBEngineVersionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.docdb.paginators.DescribeDBEngineVersionsPublisher publisher = client.describeDBEngineVersionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.docdb.model.DescribeDbEngineVersionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.docdb.model.DescribeDbEngineVersionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.docdb.model.DescribeDbEngineVersionsRequest)
operation.
This is a convenience which creates an instance of the DescribeDbEngineVersionsRequest.Builder avoiding
the need to create one manually via DescribeDbEngineVersionsRequest.builder()
describeDbEngineVersionsRequest - A Consumer that will call methods on DescribeDBEngineVersionsMessage.Builder to create a
request. Represents the input to DescribeDBEngineVersions.default CompletableFuture<DescribeDbInstancesResponse> describeDBInstances(DescribeDbInstancesRequest describeDbInstancesRequest)
Returns information about provisioned Amazon DocumentDB instances. This API supports pagination.
describeDbInstancesRequest - Represents the input to DescribeDBInstances.DBInstanceIdentifier doesn't refer to an existing instance.default CompletableFuture<DescribeDbInstancesResponse> describeDBInstances(Consumer<DescribeDbInstancesRequest.Builder> describeDbInstancesRequest)
Returns information about provisioned Amazon DocumentDB instances. This API supports pagination.
This is a convenience which creates an instance of the DescribeDbInstancesRequest.Builder avoiding the
need to create one manually via DescribeDbInstancesRequest.builder()
describeDbInstancesRequest - A Consumer that will call methods on DescribeDBInstancesMessage.Builder to create a
request. Represents the input to DescribeDBInstances.DBInstanceIdentifier doesn't refer to an existing instance.default CompletableFuture<DescribeDbInstancesResponse> describeDBInstances()
Returns information about provisioned Amazon DocumentDB instances. This API supports pagination.
DBInstanceIdentifier doesn't refer to an existing instance.default DescribeDBInstancesPublisher describeDBInstancesPaginator()
Returns information about provisioned Amazon DocumentDB instances. This API supports pagination.
This is a variant of
describeDBInstances(software.amazon.awssdk.services.docdb.model.DescribeDbInstancesRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.docdb.paginators.DescribeDBInstancesPublisher publisher = client.describeDBInstancesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.docdb.paginators.DescribeDBInstancesPublisher publisher = client.describeDBInstancesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.docdb.model.DescribeDbInstancesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.docdb.model.DescribeDbInstancesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.docdb.model.DescribeDbInstancesRequest)
operation.
DBInstanceIdentifier doesn't refer to an existing instance.default DescribeDBInstancesPublisher describeDBInstancesPaginator(DescribeDbInstancesRequest describeDbInstancesRequest)
Returns information about provisioned Amazon DocumentDB instances. This API supports pagination.
This is a variant of
describeDBInstances(software.amazon.awssdk.services.docdb.model.DescribeDbInstancesRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.docdb.paginators.DescribeDBInstancesPublisher publisher = client.describeDBInstancesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.docdb.paginators.DescribeDBInstancesPublisher publisher = client.describeDBInstancesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.docdb.model.DescribeDbInstancesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.docdb.model.DescribeDbInstancesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.docdb.model.DescribeDbInstancesRequest)
operation.
describeDbInstancesRequest - Represents the input to DescribeDBInstances.DBInstanceIdentifier doesn't refer to an existing instance.default DescribeDBInstancesPublisher describeDBInstancesPaginator(Consumer<DescribeDbInstancesRequest.Builder> describeDbInstancesRequest)
Returns information about provisioned Amazon DocumentDB instances. This API supports pagination.
This is a variant of
describeDBInstances(software.amazon.awssdk.services.docdb.model.DescribeDbInstancesRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.docdb.paginators.DescribeDBInstancesPublisher publisher = client.describeDBInstancesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.docdb.paginators.DescribeDBInstancesPublisher publisher = client.describeDBInstancesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.docdb.model.DescribeDbInstancesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.docdb.model.DescribeDbInstancesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.docdb.model.DescribeDbInstancesRequest)
operation.
This is a convenience which creates an instance of the DescribeDbInstancesRequest.Builder avoiding the
need to create one manually via DescribeDbInstancesRequest.builder()
describeDbInstancesRequest - A Consumer that will call methods on DescribeDBInstancesMessage.Builder to create a
request. Represents the input to DescribeDBInstances.DBInstanceIdentifier doesn't refer to an existing instance.default CompletableFuture<DescribeDbSubnetGroupsResponse> describeDBSubnetGroups(DescribeDbSubnetGroupsRequest describeDbSubnetGroupsRequest)
Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the
list will contain only the descriptions of the specified DBSubnetGroup.
describeDbSubnetGroupsRequest - Represents the input to DescribeDBSubnetGroups.DBSubnetGroupName doesn't refer to an existing subnet
group.default CompletableFuture<DescribeDbSubnetGroupsResponse> describeDBSubnetGroups(Consumer<DescribeDbSubnetGroupsRequest.Builder> describeDbSubnetGroupsRequest)
Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the
list will contain only the descriptions of the specified DBSubnetGroup.
This is a convenience which creates an instance of the DescribeDbSubnetGroupsRequest.Builder avoiding the
need to create one manually via DescribeDbSubnetGroupsRequest.builder()
describeDbSubnetGroupsRequest - A Consumer that will call methods on DescribeDBSubnetGroupsMessage.Builder to create a
request. Represents the input to DescribeDBSubnetGroups.DBSubnetGroupName doesn't refer to an existing subnet
group.default CompletableFuture<DescribeDbSubnetGroupsResponse> describeDBSubnetGroups()
Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the
list will contain only the descriptions of the specified DBSubnetGroup.
DBSubnetGroupName doesn't refer to an existing subnet
group.default DescribeDBSubnetGroupsPublisher describeDBSubnetGroupsPaginator()
Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the
list will contain only the descriptions of the specified DBSubnetGroup.
This is a variant of
describeDBSubnetGroups(software.amazon.awssdk.services.docdb.model.DescribeDbSubnetGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.docdb.paginators.DescribeDBSubnetGroupsPublisher publisher = client.describeDBSubnetGroupsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.docdb.paginators.DescribeDBSubnetGroupsPublisher publisher = client.describeDBSubnetGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.docdb.model.DescribeDbSubnetGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.docdb.model.DescribeDbSubnetGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.docdb.model.DescribeDbSubnetGroupsRequest)
operation.
DBSubnetGroupName doesn't refer to an existing subnet
group.default DescribeDBSubnetGroupsPublisher describeDBSubnetGroupsPaginator(DescribeDbSubnetGroupsRequest describeDbSubnetGroupsRequest)
Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the
list will contain only the descriptions of the specified DBSubnetGroup.
This is a variant of
describeDBSubnetGroups(software.amazon.awssdk.services.docdb.model.DescribeDbSubnetGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.docdb.paginators.DescribeDBSubnetGroupsPublisher publisher = client.describeDBSubnetGroupsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.docdb.paginators.DescribeDBSubnetGroupsPublisher publisher = client.describeDBSubnetGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.docdb.model.DescribeDbSubnetGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.docdb.model.DescribeDbSubnetGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.docdb.model.DescribeDbSubnetGroupsRequest)
operation.
describeDbSubnetGroupsRequest - Represents the input to DescribeDBSubnetGroups.DBSubnetGroupName doesn't refer to an existing subnet
group.default DescribeDBSubnetGroupsPublisher describeDBSubnetGroupsPaginator(Consumer<DescribeDbSubnetGroupsRequest.Builder> describeDbSubnetGroupsRequest)
Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the
list will contain only the descriptions of the specified DBSubnetGroup.
This is a variant of
describeDBSubnetGroups(software.amazon.awssdk.services.docdb.model.DescribeDbSubnetGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.docdb.paginators.DescribeDBSubnetGroupsPublisher publisher = client.describeDBSubnetGroupsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.docdb.paginators.DescribeDBSubnetGroupsPublisher publisher = client.describeDBSubnetGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.docdb.model.DescribeDbSubnetGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.docdb.model.DescribeDbSubnetGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.docdb.model.DescribeDbSubnetGroupsRequest)
operation.
This is a convenience which creates an instance of the DescribeDbSubnetGroupsRequest.Builder avoiding the
need to create one manually via DescribeDbSubnetGroupsRequest.builder()
describeDbSubnetGroupsRequest - A Consumer that will call methods on DescribeDBSubnetGroupsMessage.Builder to create a
request. Represents the input to DescribeDBSubnetGroups.DBSubnetGroupName doesn't refer to an existing subnet
group.default CompletableFuture<DescribeEngineDefaultClusterParametersResponse> describeEngineDefaultClusterParameters(DescribeEngineDefaultClusterParametersRequest describeEngineDefaultClusterParametersRequest)
Returns the default engine and system parameter information for the cluster database engine.
describeEngineDefaultClusterParametersRequest - Represents the input to DescribeEngineDefaultClusterParameters.default CompletableFuture<DescribeEngineDefaultClusterParametersResponse> describeEngineDefaultClusterParameters(Consumer<DescribeEngineDefaultClusterParametersRequest.Builder> describeEngineDefaultClusterParametersRequest)
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 via
DescribeEngineDefaultClusterParametersRequest.builder()
describeEngineDefaultClusterParametersRequest - A Consumer that will call methods on DescribeEngineDefaultClusterParametersMessage.Builder
to create a request. Represents the input to DescribeEngineDefaultClusterParameters.default CompletableFuture<DescribeEventCategoriesResponse> describeEventCategories(DescribeEventCategoriesRequest describeEventCategoriesRequest)
Displays a list of categories for all event source types, or, if specified, for a specified source type.
describeEventCategoriesRequest - Represents the input to DescribeEventCategories.default CompletableFuture<DescribeEventCategoriesResponse> describeEventCategories(Consumer<DescribeEventCategoriesRequest.Builder> describeEventCategoriesRequest)
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 via DescribeEventCategoriesRequest.builder()
describeEventCategoriesRequest - A Consumer that will call methods on DescribeEventCategoriesMessage.Builder to create a
request. Represents the input to DescribeEventCategories.default CompletableFuture<DescribeEventCategoriesResponse> describeEventCategories()
Displays a list of categories for all event source types, or, if specified, for a specified source type.
default CompletableFuture<DescribeEventSubscriptionsResponse> describeEventSubscriptions(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest)
Lists all the subscription descriptions for a customer account. The description for a subscription includes
SubscriptionName, SNSTopicARN, CustomerID, SourceType,
SourceID, CreationTime, and Status.
If you specify a SubscriptionName, lists the description for that subscription.
describeEventSubscriptionsRequest - Represents the input to DescribeEventSubscriptions.default CompletableFuture<DescribeEventSubscriptionsResponse> describeEventSubscriptions(Consumer<DescribeEventSubscriptionsRequest.Builder> describeEventSubscriptionsRequest)
Lists all the subscription descriptions for a customer account. The description for a subscription includes
SubscriptionName, SNSTopicARN, CustomerID, SourceType,
SourceID, CreationTime, and Status.
If you specify a SubscriptionName, lists the description for that subscription.
This is a convenience which creates an instance of the DescribeEventSubscriptionsRequest.Builder avoiding
the need to create one manually via DescribeEventSubscriptionsRequest.builder()
describeEventSubscriptionsRequest - A Consumer that will call methods on DescribeEventSubscriptionsMessage.Builder to create a
request. Represents the input to DescribeEventSubscriptions.default DescribeEventSubscriptionsPublisher describeEventSubscriptionsPaginator(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest)
Lists all the subscription descriptions for a customer account. The description for a subscription includes
SubscriptionName, SNSTopicARN, CustomerID, SourceType,
SourceID, CreationTime, and Status.
If you specify a SubscriptionName, lists the description for that subscription.
This is a variant of
describeEventSubscriptions(software.amazon.awssdk.services.docdb.model.DescribeEventSubscriptionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.docdb.paginators.DescribeEventSubscriptionsPublisher publisher = client.describeEventSubscriptionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.docdb.paginators.DescribeEventSubscriptionsPublisher publisher = client.describeEventSubscriptionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.docdb.model.DescribeEventSubscriptionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.docdb.model.DescribeEventSubscriptionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.docdb.model.DescribeEventSubscriptionsRequest)
operation.
describeEventSubscriptionsRequest - Represents the input to DescribeEventSubscriptions.default DescribeEventSubscriptionsPublisher describeEventSubscriptionsPaginator(Consumer<DescribeEventSubscriptionsRequest.Builder> describeEventSubscriptionsRequest)
Lists all the subscription descriptions for a customer account. The description for a subscription includes
SubscriptionName, SNSTopicARN, CustomerID, SourceType,
SourceID, CreationTime, and Status.
If you specify a SubscriptionName, lists the description for that subscription.
This is a variant of
describeEventSubscriptions(software.amazon.awssdk.services.docdb.model.DescribeEventSubscriptionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.docdb.paginators.DescribeEventSubscriptionsPublisher publisher = client.describeEventSubscriptionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.docdb.paginators.DescribeEventSubscriptionsPublisher publisher = client.describeEventSubscriptionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.docdb.model.DescribeEventSubscriptionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.docdb.model.DescribeEventSubscriptionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.docdb.model.DescribeEventSubscriptionsRequest)
operation.
This is a convenience which creates an instance of the DescribeEventSubscriptionsRequest.Builder avoiding
the need to create one manually via DescribeEventSubscriptionsRequest.builder()
describeEventSubscriptionsRequest - A Consumer that will call methods on DescribeEventSubscriptionsMessage.Builder to create a
request. Represents the input to DescribeEventSubscriptions.default CompletableFuture<DescribeEventsResponse> describeEvents(DescribeEventsRequest describeEventsRequest)
Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days. You can obtain events specific to a particular DB instance, security group, snapshot, or parameter group by providing the name as a parameter. By default, the events of the past hour are returned.
describeEventsRequest - Represents the input to DescribeEvents.default CompletableFuture<DescribeEventsResponse> describeEvents(Consumer<DescribeEventsRequest.Builder> describeEventsRequest)
Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days. You can obtain events specific to a particular DB instance, security group, snapshot, or parameter group by providing the name as a parameter. By default, the events of the past hour are returned.
This is a convenience which creates an instance of the DescribeEventsRequest.Builder avoiding the need to
create one manually via DescribeEventsRequest.builder()
describeEventsRequest - A Consumer that will call methods on DescribeEventsMessage.Builder to create a request.
Represents the input to DescribeEvents.default CompletableFuture<DescribeEventsResponse> describeEvents()
Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days. You can obtain events specific to a particular DB instance, security group, snapshot, or parameter group by providing the name as a parameter. By default, the events of the past hour are returned.
default DescribeEventsPublisher describeEventsPaginator()
Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days. You can obtain events specific to a particular DB instance, security group, snapshot, or parameter group by providing the name as a parameter. By default, the events of the past hour are returned.
This is a variant of describeEvents(software.amazon.awssdk.services.docdb.model.DescribeEventsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.docdb.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.docdb.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.docdb.model.DescribeEventsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.docdb.model.DescribeEventsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.docdb.model.DescribeEventsRequest) operation.
default DescribeEventsPublisher describeEventsPaginator(DescribeEventsRequest describeEventsRequest)
Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days. You can obtain events specific to a particular DB instance, security group, snapshot, or parameter group by providing the name as a parameter. By default, the events of the past hour are returned.
This is a variant of describeEvents(software.amazon.awssdk.services.docdb.model.DescribeEventsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.docdb.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.docdb.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.docdb.model.DescribeEventsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.docdb.model.DescribeEventsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.docdb.model.DescribeEventsRequest) operation.
describeEventsRequest - Represents the input to DescribeEvents.default DescribeEventsPublisher describeEventsPaginator(Consumer<DescribeEventsRequest.Builder> describeEventsRequest)
Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days. You can obtain events specific to a particular DB instance, security group, snapshot, or parameter group by providing the name as a parameter. By default, the events of the past hour are returned.
This is a variant of describeEvents(software.amazon.awssdk.services.docdb.model.DescribeEventsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.docdb.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.docdb.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.docdb.model.DescribeEventsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.docdb.model.DescribeEventsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.docdb.model.DescribeEventsRequest) operation.
This is a convenience which creates an instance of the DescribeEventsRequest.Builder avoiding the need to
create one manually via DescribeEventsRequest.builder()
describeEventsRequest - A Consumer that will call methods on DescribeEventsMessage.Builder to create a request.
Represents the input to DescribeEvents.default CompletableFuture<DescribeGlobalClustersResponse> describeGlobalClusters(DescribeGlobalClustersRequest describeGlobalClustersRequest)
Returns information about Amazon DocumentDB global clusters. This API supports pagination.
This action only applies to Amazon DocumentDB clusters.
describeGlobalClustersRequest - GlobalClusterIdentifier doesn't refer to an existing
global cluster.default CompletableFuture<DescribeGlobalClustersResponse> describeGlobalClusters(Consumer<DescribeGlobalClustersRequest.Builder> describeGlobalClustersRequest)
Returns information about Amazon DocumentDB global clusters. This API supports pagination.
This action only applies to Amazon DocumentDB clusters.
This is a convenience which creates an instance of the DescribeGlobalClustersRequest.Builder avoiding the
need to create one manually via DescribeGlobalClustersRequest.builder()
describeGlobalClustersRequest - A Consumer that will call methods on DescribeGlobalClustersMessage.Builder to create a
request.GlobalClusterIdentifier doesn't refer to an existing
global cluster.default DescribeGlobalClustersPublisher describeGlobalClustersPaginator(DescribeGlobalClustersRequest describeGlobalClustersRequest)
Returns information about Amazon DocumentDB global clusters. This API supports pagination.
This action only applies to Amazon DocumentDB clusters.
This is a variant of
describeGlobalClusters(software.amazon.awssdk.services.docdb.model.DescribeGlobalClustersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.docdb.paginators.DescribeGlobalClustersPublisher publisher = client.describeGlobalClustersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.docdb.paginators.DescribeGlobalClustersPublisher publisher = client.describeGlobalClustersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.docdb.model.DescribeGlobalClustersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.docdb.model.DescribeGlobalClustersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.docdb.model.DescribeGlobalClustersRequest)
operation.
describeGlobalClustersRequest - GlobalClusterIdentifier doesn't refer to an existing
global cluster.default DescribeGlobalClustersPublisher describeGlobalClustersPaginator(Consumer<DescribeGlobalClustersRequest.Builder> describeGlobalClustersRequest)
Returns information about Amazon DocumentDB global clusters. This API supports pagination.
This action only applies to Amazon DocumentDB clusters.
This is a variant of
describeGlobalClusters(software.amazon.awssdk.services.docdb.model.DescribeGlobalClustersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.docdb.paginators.DescribeGlobalClustersPublisher publisher = client.describeGlobalClustersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.docdb.paginators.DescribeGlobalClustersPublisher publisher = client.describeGlobalClustersPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.docdb.model.DescribeGlobalClustersResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.docdb.model.DescribeGlobalClustersResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.docdb.model.DescribeGlobalClustersRequest)
operation.
This is a convenience which creates an instance of the DescribeGlobalClustersRequest.Builder avoiding the
need to create one manually via DescribeGlobalClustersRequest.builder()
describeGlobalClustersRequest - A Consumer that will call methods on DescribeGlobalClustersMessage.Builder to create a
request.GlobalClusterIdentifier doesn't refer to an existing
global cluster.default CompletableFuture<DescribeOrderableDbInstanceOptionsResponse> describeOrderableDBInstanceOptions(DescribeOrderableDbInstanceOptionsRequest describeOrderableDbInstanceOptionsRequest)
Returns a list of orderable instance options for the specified engine.
describeOrderableDbInstanceOptionsRequest - Represents the input to DescribeOrderableDBInstanceOptions.default CompletableFuture<DescribeOrderableDbInstanceOptionsResponse> describeOrderableDBInstanceOptions(Consumer<DescribeOrderableDbInstanceOptionsRequest.Builder> describeOrderableDbInstanceOptionsRequest)
Returns a list of orderable 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 via DescribeOrderableDbInstanceOptionsRequest.builder()
describeOrderableDbInstanceOptionsRequest - A Consumer that will call methods on DescribeOrderableDBInstanceOptionsMessage.Builder to
create a request. Represents the input to DescribeOrderableDBInstanceOptions.default DescribeOrderableDBInstanceOptionsPublisher describeOrderableDBInstanceOptionsPaginator(DescribeOrderableDbInstanceOptionsRequest describeOrderableDbInstanceOptionsRequest)
Returns a list of orderable instance options for the specified engine.
This is a variant of
describeOrderableDBInstanceOptions(software.amazon.awssdk.services.docdb.model.DescribeOrderableDbInstanceOptionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.docdb.paginators.DescribeOrderableDBInstanceOptionsPublisher publisher = client.describeOrderableDBInstanceOptionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.docdb.paginators.DescribeOrderableDBInstanceOptionsPublisher publisher = client.describeOrderableDBInstanceOptionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.docdb.model.DescribeOrderableDbInstanceOptionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.docdb.model.DescribeOrderableDbInstanceOptionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.docdb.model.DescribeOrderableDbInstanceOptionsRequest)
operation.
describeOrderableDbInstanceOptionsRequest - Represents the input to DescribeOrderableDBInstanceOptions.default DescribeOrderableDBInstanceOptionsPublisher describeOrderableDBInstanceOptionsPaginator(Consumer<DescribeOrderableDbInstanceOptionsRequest.Builder> describeOrderableDbInstanceOptionsRequest)
Returns a list of orderable instance options for the specified engine.
This is a variant of
describeOrderableDBInstanceOptions(software.amazon.awssdk.services.docdb.model.DescribeOrderableDbInstanceOptionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.docdb.paginators.DescribeOrderableDBInstanceOptionsPublisher publisher = client.describeOrderableDBInstanceOptionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.docdb.paginators.DescribeOrderableDBInstanceOptionsPublisher publisher = client.describeOrderableDBInstanceOptionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.docdb.model.DescribeOrderableDbInstanceOptionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.docdb.model.DescribeOrderableDbInstanceOptionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.docdb.model.DescribeOrderableDbInstanceOptionsRequest)
operation.
This is a convenience which creates an instance of the DescribeOrderableDbInstanceOptionsRequest.Builder
avoiding the need to create one manually via DescribeOrderableDbInstanceOptionsRequest.builder()
describeOrderableDbInstanceOptionsRequest - A Consumer that will call methods on DescribeOrderableDBInstanceOptionsMessage.Builder to
create a request. Represents the input to DescribeOrderableDBInstanceOptions.default CompletableFuture<DescribePendingMaintenanceActionsResponse> describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest)
Returns a list of resources (for example, instances) that have at least one pending maintenance action.
describePendingMaintenanceActionsRequest - Represents the input to DescribePendingMaintenanceActions.default CompletableFuture<DescribePendingMaintenanceActionsResponse> describePendingMaintenanceActions(Consumer<DescribePendingMaintenanceActionsRequest.Builder> describePendingMaintenanceActionsRequest)
Returns a list of resources (for example, 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 via DescribePendingMaintenanceActionsRequest.builder()
describePendingMaintenanceActionsRequest - A Consumer that will call methods on DescribePendingMaintenanceActionsMessage.Builder to
create a request. Represents the input to DescribePendingMaintenanceActions.default CompletableFuture<DescribePendingMaintenanceActionsResponse> describePendingMaintenanceActions()
Returns a list of resources (for example, instances) that have at least one pending maintenance action.
default DescribePendingMaintenanceActionsPublisher describePendingMaintenanceActionsPaginator()
Returns a list of resources (for example, instances) that have at least one pending maintenance action.
This is a variant of
describePendingMaintenanceActions(software.amazon.awssdk.services.docdb.model.DescribePendingMaintenanceActionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.docdb.paginators.DescribePendingMaintenanceActionsPublisher publisher = client.describePendingMaintenanceActionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.docdb.paginators.DescribePendingMaintenanceActionsPublisher publisher = client.describePendingMaintenanceActionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.docdb.model.DescribePendingMaintenanceActionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.docdb.model.DescribePendingMaintenanceActionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.docdb.model.DescribePendingMaintenanceActionsRequest)
operation.
default DescribePendingMaintenanceActionsPublisher describePendingMaintenanceActionsPaginator(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest)
Returns a list of resources (for example, instances) that have at least one pending maintenance action.
This is a variant of
describePendingMaintenanceActions(software.amazon.awssdk.services.docdb.model.DescribePendingMaintenanceActionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.docdb.paginators.DescribePendingMaintenanceActionsPublisher publisher = client.describePendingMaintenanceActionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.docdb.paginators.DescribePendingMaintenanceActionsPublisher publisher = client.describePendingMaintenanceActionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.docdb.model.DescribePendingMaintenanceActionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.docdb.model.DescribePendingMaintenanceActionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.docdb.model.DescribePendingMaintenanceActionsRequest)
operation.
describePendingMaintenanceActionsRequest - Represents the input to DescribePendingMaintenanceActions.default DescribePendingMaintenanceActionsPublisher describePendingMaintenanceActionsPaginator(Consumer<DescribePendingMaintenanceActionsRequest.Builder> describePendingMaintenanceActionsRequest)
Returns a list of resources (for example, instances) that have at least one pending maintenance action.
This is a variant of
describePendingMaintenanceActions(software.amazon.awssdk.services.docdb.model.DescribePendingMaintenanceActionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.docdb.paginators.DescribePendingMaintenanceActionsPublisher publisher = client.describePendingMaintenanceActionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.docdb.paginators.DescribePendingMaintenanceActionsPublisher publisher = client.describePendingMaintenanceActionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.docdb.model.DescribePendingMaintenanceActionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.docdb.model.DescribePendingMaintenanceActionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.docdb.model.DescribePendingMaintenanceActionsRequest)
operation.
This is a convenience which creates an instance of the DescribePendingMaintenanceActionsRequest.Builder
avoiding the need to create one manually via DescribePendingMaintenanceActionsRequest.builder()
describePendingMaintenanceActionsRequest - A Consumer that will call methods on DescribePendingMaintenanceActionsMessage.Builder to
create a request. Represents the input to DescribePendingMaintenanceActions.default CompletableFuture<FailoverDbClusterResponse> failoverDBCluster(FailoverDbClusterRequest failoverDbClusterRequest)
Forces a failover for a cluster.
A failover for a cluster promotes one of the Amazon DocumentDB replicas (read-only instances) in the cluster to be the primary instance (the cluster writer).
If the primary instance fails, Amazon DocumentDB automatically fails over to an Amazon DocumentDB replica, if one exists. You can force a failover when you want to simulate a failure of a primary instance for testing.
failoverDbClusterRequest - Represents the input to FailoverDBCluster.DBClusterIdentifier doesn't refer to an existing cluster.default CompletableFuture<FailoverDbClusterResponse> failoverDBCluster(Consumer<FailoverDbClusterRequest.Builder> failoverDbClusterRequest)
Forces a failover for a cluster.
A failover for a cluster promotes one of the Amazon DocumentDB replicas (read-only instances) in the cluster to be the primary instance (the cluster writer).
If the primary instance fails, Amazon DocumentDB automatically fails over to an Amazon DocumentDB replica, if one exists. You can force a failover when you want to simulate a failure of a primary instance for testing.
This is a convenience which creates an instance of the FailoverDbClusterRequest.Builder avoiding the need
to create one manually via FailoverDbClusterRequest.builder()
failoverDbClusterRequest - A Consumer that will call methods on FailoverDBClusterMessage.Builder to create a request.
Represents the input to FailoverDBCluster.DBClusterIdentifier doesn't refer to an existing cluster.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all tags on an Amazon DocumentDB resource.
listTagsForResourceRequest - Represents the input to ListTagsForResource.DBInstanceIdentifier doesn't refer to an existing instance.DBSnapshotIdentifier doesn't refer to an existing snapshot.DBClusterIdentifier doesn't refer to an existing cluster.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists all tags on an Amazon DocumentDB resource.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceMessage.Builder to create a
request. Represents the input to ListTagsForResource.DBInstanceIdentifier doesn't refer to an existing instance.DBSnapshotIdentifier doesn't refer to an existing snapshot.DBClusterIdentifier doesn't refer to an existing cluster.default CompletableFuture<ModifyDbClusterResponse> modifyDBCluster(ModifyDbClusterRequest modifyDbClusterRequest)
Modifies a setting for an Amazon DocumentDB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.
modifyDbClusterRequest - Represents the input to ModifyDBCluster.DBClusterIdentifier doesn't refer to an existing cluster.DBSubnetGroupName doesn't refer to an existing subnet
group.DBClusterParameterGroupName doesn't refer to an
existing cluster parameter group.default CompletableFuture<ModifyDbClusterResponse> modifyDBCluster(Consumer<ModifyDbClusterRequest.Builder> modifyDbClusterRequest)
Modifies a setting for an Amazon DocumentDB 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 via ModifyDbClusterRequest.builder()
modifyDbClusterRequest - A Consumer that will call methods on ModifyDBClusterMessage.Builder to create a request.
Represents the input to ModifyDBCluster.DBClusterIdentifier doesn't refer to an existing cluster.DBSubnetGroupName doesn't refer to an existing subnet
group.DBClusterParameterGroupName doesn't refer to an
existing cluster parameter group.default CompletableFuture<ModifyDbClusterParameterGroupResponse> modifyDBClusterParameterGroup(ModifyDbClusterParameterGroupRequest modifyDbClusterParameterGroupRequest)
Modifies the parameters of a cluster parameter group. To modify more than one parameter, submit a list of the
following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20
parameters can be modified in a single request.
Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot or maintenance window before the change can take effect.
After you create a cluster parameter group, you should wait at least 5 minutes before creating your first cluster
that uses that cluster parameter group as the default parameter group. This allows Amazon DocumentDB to fully
complete the create action before the parameter group is used as the default for a new cluster. This step is
especially important for parameters that are critical when creating the default database for a cluster, such as
the character set for the default database defined by the character_set_database parameter.
modifyDbClusterParameterGroupRequest - Represents the input to ModifyDBClusterParameterGroup.DBParameterGroupName doesn't refer to an existing
parameter group.default CompletableFuture<ModifyDbClusterParameterGroupResponse> modifyDBClusterParameterGroup(Consumer<ModifyDbClusterParameterGroupRequest.Builder> modifyDbClusterParameterGroupRequest)
Modifies the parameters of a cluster parameter group. To modify more than one parameter, submit a list of the
following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20
parameters can be modified in a single request.
Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot or maintenance window before the change can take effect.
After you create a cluster parameter group, you should wait at least 5 minutes before creating your first cluster
that uses that cluster parameter group as the default parameter group. This allows Amazon DocumentDB to fully
complete the create action before the parameter group is used as the default for a new cluster. This step is
especially important for parameters that are critical when creating the default database for a cluster, such as
the character set for the default database defined by the character_set_database parameter.
This is a convenience which creates an instance of the ModifyDbClusterParameterGroupRequest.Builder
avoiding the need to create one manually via ModifyDbClusterParameterGroupRequest.builder()
modifyDbClusterParameterGroupRequest - A Consumer that will call methods on ModifyDBClusterParameterGroupMessage.Builder to
create a request. Represents the input to ModifyDBClusterParameterGroup.DBParameterGroupName doesn't refer to an existing
parameter group.default CompletableFuture<ModifyDbClusterSnapshotAttributeResponse> modifyDBClusterSnapshotAttribute(ModifyDbClusterSnapshotAttributeRequest modifyDbClusterSnapshotAttributeRequest)
Adds an attribute and values to, or removes an attribute and values from, a manual cluster snapshot.
To share a manual cluster snapshot with other accounts, specify restore as the
AttributeName, and use the ValuesToAdd parameter to add a list of IDs of the accounts
that are authorized to restore the manual cluster snapshot. Use the value all to make the manual
cluster snapshot public, which means that it can be copied or restored by all accounts. Do not add the
all value for any manual cluster snapshots that contain private information that you don't want
available to all accounts. If a manual cluster snapshot is encrypted, it can be shared, but only by specifying a
list of authorized account IDs for the ValuesToAdd parameter. You can't use all as a
value for that parameter in this case.
modifyDbClusterSnapshotAttributeRequest - Represents the input to ModifyDBClusterSnapshotAttribute.DBClusterSnapshotIdentifier doesn't refer to an
existing cluster snapshot.default CompletableFuture<ModifyDbClusterSnapshotAttributeResponse> modifyDBClusterSnapshotAttribute(Consumer<ModifyDbClusterSnapshotAttributeRequest.Builder> modifyDbClusterSnapshotAttributeRequest)
Adds an attribute and values to, or removes an attribute and values from, a manual cluster snapshot.
To share a manual cluster snapshot with other accounts, specify restore as the
AttributeName, and use the ValuesToAdd parameter to add a list of IDs of the accounts
that are authorized to restore the manual cluster snapshot. Use the value all to make the manual
cluster snapshot public, which means that it can be copied or restored by all accounts. Do not add the
all value for any manual cluster snapshots that contain private information that you don't want
available to all accounts. If a manual cluster snapshot is encrypted, it can be shared, but only by specifying a
list of authorized account IDs for the ValuesToAdd parameter. You can't use all as a
value for that parameter in this case.
This is a convenience which creates an instance of the ModifyDbClusterSnapshotAttributeRequest.Builder
avoiding the need to create one manually via ModifyDbClusterSnapshotAttributeRequest.builder()
modifyDbClusterSnapshotAttributeRequest - A Consumer that will call methods on ModifyDBClusterSnapshotAttributeMessage.Builder to
create a request. Represents the input to ModifyDBClusterSnapshotAttribute.DBClusterSnapshotIdentifier doesn't refer to an
existing cluster snapshot.default CompletableFuture<ModifyDbInstanceResponse> modifyDBInstance(ModifyDbInstanceRequest modifyDbInstanceRequest)
Modifies settings for an instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.
modifyDbInstanceRequest - Represents the input to ModifyDBInstance.DBInstanceIdentifier doesn't refer to an existing instance.DBSecurityGroupName doesn't refer to an existing
security group.DBParameterGroupName doesn't refer to an existing
parameter group.StorageType can't be
associated with the DB instance.Amazon DocumentDB also might not be authorized to perform necessary actions on your behalf using IAM.
CertificateIdentifier doesn't refer to an existing
certificate.default CompletableFuture<ModifyDbInstanceResponse> modifyDBInstance(Consumer<ModifyDbInstanceRequest.Builder> modifyDbInstanceRequest)
Modifies settings for an instance. 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 ModifyDbInstanceRequest.Builder avoiding the need
to create one manually via ModifyDbInstanceRequest.builder()
modifyDbInstanceRequest - A Consumer that will call methods on ModifyDBInstanceMessage.Builder to create a request.
Represents the input to ModifyDBInstance.DBInstanceIdentifier doesn't refer to an existing instance.DBSecurityGroupName doesn't refer to an existing
security group.DBParameterGroupName doesn't refer to an existing
parameter group.StorageType can't be
associated with the DB instance.Amazon DocumentDB also might not be authorized to perform necessary actions on your behalf using IAM.
CertificateIdentifier doesn't refer to an existing
certificate.default CompletableFuture<ModifyDbSubnetGroupResponse> modifyDBSubnetGroup(ModifyDbSubnetGroupRequest modifyDbSubnetGroupRequest)
Modifies an existing subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Region.
modifyDbSubnetGroupRequest - Represents the input to ModifyDBSubnetGroup.DBSubnetGroupName doesn't refer to an existing subnet
group.default CompletableFuture<ModifyDbSubnetGroupResponse> modifyDBSubnetGroup(Consumer<ModifyDbSubnetGroupRequest.Builder> modifyDbSubnetGroupRequest)
Modifies an existing subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Region.
This is a convenience which creates an instance of the ModifyDbSubnetGroupRequest.Builder avoiding the
need to create one manually via ModifyDbSubnetGroupRequest.builder()
modifyDbSubnetGroupRequest - A Consumer that will call methods on ModifyDBSubnetGroupMessage.Builder to create a
request. Represents the input to ModifyDBSubnetGroup.DBSubnetGroupName doesn't refer to an existing subnet
group.default CompletableFuture<ModifyEventSubscriptionResponse> modifyEventSubscription(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest)
Modifies an existing Amazon DocumentDB event notification subscription.
modifyEventSubscriptionRequest - Represents the input to ModifyEventSubscription.default CompletableFuture<ModifyEventSubscriptionResponse> modifyEventSubscription(Consumer<ModifyEventSubscriptionRequest.Builder> modifyEventSubscriptionRequest)
Modifies an existing Amazon DocumentDB event notification subscription.
This is a convenience which creates an instance of the ModifyEventSubscriptionRequest.Builder avoiding
the need to create one manually via ModifyEventSubscriptionRequest.builder()
modifyEventSubscriptionRequest - A Consumer that will call methods on ModifyEventSubscriptionMessage.Builder to create a
request. Represents the input to ModifyEventSubscription.default CompletableFuture<ModifyGlobalClusterResponse> modifyGlobalCluster(ModifyGlobalClusterRequest modifyGlobalClusterRequest)
Modify a setting for an Amazon DocumentDB global cluster. You can change one or more configuration parameters (for example: deletion protection), or the global cluster identifier by specifying these parameters and the new values in the request.
This action only applies to Amazon DocumentDB clusters.
modifyGlobalClusterRequest - Represents the input to ModifyGlobalCluster.GlobalClusterIdentifier doesn't refer to an existing
global cluster.default CompletableFuture<ModifyGlobalClusterResponse> modifyGlobalCluster(Consumer<ModifyGlobalClusterRequest.Builder> modifyGlobalClusterRequest)
Modify a setting for an Amazon DocumentDB global cluster. You can change one or more configuration parameters (for example: deletion protection), or the global cluster identifier by specifying these parameters and the new values in the request.
This action only applies to Amazon DocumentDB clusters.
This is a convenience which creates an instance of the ModifyGlobalClusterRequest.Builder avoiding the
need to create one manually via ModifyGlobalClusterRequest.builder()
modifyGlobalClusterRequest - A Consumer that will call methods on ModifyGlobalClusterMessage.Builder to create a
request. Represents the input to ModifyGlobalCluster.GlobalClusterIdentifier doesn't refer to an existing
global cluster.default CompletableFuture<RebootDbInstanceResponse> rebootDBInstance(RebootDbInstanceRequest rebootDbInstanceRequest)
You might need to reboot your instance, usually for maintenance reasons. For example, if you make certain changes, or if you change the cluster parameter group that is associated with the instance, you must reboot the instance for the changes to take effect.
Rebooting an instance restarts the database engine service. Rebooting an instance results in a momentary outage, during which the instance status is set to rebooting.
rebootDbInstanceRequest - Represents the input to RebootDBInstance.DBInstanceIdentifier doesn't refer to an existing instance.default CompletableFuture<RebootDbInstanceResponse> rebootDBInstance(Consumer<RebootDbInstanceRequest.Builder> rebootDbInstanceRequest)
You might need to reboot your instance, usually for maintenance reasons. For example, if you make certain changes, or if you change the cluster parameter group that is associated with the instance, you must reboot the instance for the changes to take effect.
Rebooting an instance restarts the database engine service. Rebooting an instance results in a momentary outage, during which the 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 via RebootDbInstanceRequest.builder()
rebootDbInstanceRequest - A Consumer that will call methods on RebootDBInstanceMessage.Builder to create a request.
Represents the input to RebootDBInstance.DBInstanceIdentifier doesn't refer to an existing instance.default CompletableFuture<RemoveFromGlobalClusterResponse> removeFromGlobalCluster(RemoveFromGlobalClusterRequest removeFromGlobalClusterRequest)
Detaches an Amazon DocumentDB secondary cluster from a global cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary in a different region.
This action only applies to Amazon DocumentDB clusters.
removeFromGlobalClusterRequest - Represents the input to RemoveFromGlobalCluster.GlobalClusterIdentifier doesn't refer to an existing
global cluster.DBClusterIdentifier doesn't refer to an existing cluster.default CompletableFuture<RemoveFromGlobalClusterResponse> removeFromGlobalCluster(Consumer<RemoveFromGlobalClusterRequest.Builder> removeFromGlobalClusterRequest)
Detaches an Amazon DocumentDB secondary cluster from a global cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary in a different region.
This action only applies to Amazon DocumentDB clusters.
This is a convenience which creates an instance of the RemoveFromGlobalClusterRequest.Builder avoiding
the need to create one manually via RemoveFromGlobalClusterRequest.builder()
removeFromGlobalClusterRequest - A Consumer that will call methods on RemoveFromGlobalClusterMessage.Builder to create a
request. Represents the input to RemoveFromGlobalCluster.GlobalClusterIdentifier doesn't refer to an existing
global cluster.DBClusterIdentifier doesn't refer to an existing cluster.default CompletableFuture<RemoveSourceIdentifierFromSubscriptionResponse> removeSourceIdentifierFromSubscription(RemoveSourceIdentifierFromSubscriptionRequest removeSourceIdentifierFromSubscriptionRequest)
Removes a source identifier from an existing Amazon DocumentDB event notification subscription.
removeSourceIdentifierFromSubscriptionRequest - Represents the input to RemoveSourceIdentifierFromSubscription.default CompletableFuture<RemoveSourceIdentifierFromSubscriptionResponse> removeSourceIdentifierFromSubscription(Consumer<RemoveSourceIdentifierFromSubscriptionRequest.Builder> removeSourceIdentifierFromSubscriptionRequest)
Removes a source identifier from an existing Amazon DocumentDB event notification subscription.
This is a convenience which creates an instance of the
RemoveSourceIdentifierFromSubscriptionRequest.Builder avoiding the need to create one manually via
RemoveSourceIdentifierFromSubscriptionRequest.builder()
removeSourceIdentifierFromSubscriptionRequest - A Consumer that will call methods on RemoveSourceIdentifierFromSubscriptionMessage.Builder
to create a request. Represents the input to RemoveSourceIdentifierFromSubscription.default CompletableFuture<RemoveTagsFromResourceResponse> removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
Removes metadata tags from an Amazon DocumentDB resource.
removeTagsFromResourceRequest - Represents the input to RemoveTagsFromResource.DBInstanceIdentifier doesn't refer to an existing instance.DBSnapshotIdentifier doesn't refer to an existing snapshot.DBClusterIdentifier doesn't refer to an existing cluster.default CompletableFuture<RemoveTagsFromResourceResponse> removeTagsFromResource(Consumer<RemoveTagsFromResourceRequest.Builder> removeTagsFromResourceRequest)
Removes metadata tags from an Amazon DocumentDB resource.
This is a convenience which creates an instance of the RemoveTagsFromResourceRequest.Builder avoiding the
need to create one manually via RemoveTagsFromResourceRequest.builder()
removeTagsFromResourceRequest - A Consumer that will call methods on RemoveTagsFromResourceMessage.Builder to create a
request. Represents the input to RemoveTagsFromResource.DBInstanceIdentifier doesn't refer to an existing instance.DBSnapshotIdentifier doesn't refer to an existing snapshot.DBClusterIdentifier doesn't refer to an existing cluster.default CompletableFuture<ResetDbClusterParameterGroupResponse> resetDBClusterParameterGroup(ResetDbClusterParameterGroupRequest resetDbClusterParameterGroupRequest)
Modifies the parameters of a cluster parameter group to the default value. To reset specific parameters, submit a
list of the following: ParameterName and ApplyMethod. To reset the entire cluster
parameter group, specify the DBClusterParameterGroupName and ResetAllParameters
parameters.
When you reset the entire group, dynamic parameters are updated immediately and static parameters are set to
pending-reboot to take effect on the next DB instance reboot.
resetDbClusterParameterGroupRequest - Represents the input to ResetDBClusterParameterGroup.DBParameterGroupName doesn't refer to an existing
parameter group.default CompletableFuture<ResetDbClusterParameterGroupResponse> resetDBClusterParameterGroup(Consumer<ResetDbClusterParameterGroupRequest.Builder> resetDbClusterParameterGroupRequest)
Modifies the parameters of a cluster parameter group to the default value. To reset specific parameters, submit a
list of the following: ParameterName and ApplyMethod. To reset the entire cluster
parameter group, specify the DBClusterParameterGroupName and ResetAllParameters
parameters.
When you reset the entire group, dynamic parameters are updated immediately and static parameters are set to
pending-reboot to take effect on the next DB instance reboot.
This is a convenience which creates an instance of the ResetDbClusterParameterGroupRequest.Builder
avoiding the need to create one manually via ResetDbClusterParameterGroupRequest.builder()
resetDbClusterParameterGroupRequest - A Consumer that will call methods on ResetDBClusterParameterGroupMessage.Builder to create
a request. Represents the input to ResetDBClusterParameterGroup.DBParameterGroupName doesn't refer to an existing
parameter group.default CompletableFuture<RestoreDbClusterFromSnapshotResponse> restoreDBClusterFromSnapshot(RestoreDbClusterFromSnapshotRequest restoreDbClusterFromSnapshotRequest)
Creates a new cluster from a snapshot or cluster snapshot.
If a snapshot is specified, the target cluster is created from the source DB snapshot with a default configuration and default security group.
If a cluster snapshot is specified, the target cluster is created from the source cluster restore point with the same configuration as the original source DB cluster, except that the new cluster is created with the default security group.
restoreDbClusterFromSnapshotRequest - Represents the input to RestoreDBClusterFromSnapshot.DBSubnetGroupName doesn't refer to an existing subnet
group.DBSnapshotIdentifier doesn't refer to an existing snapshot.DBClusterSnapshotIdentifier doesn't refer to an
existing cluster snapshot.DBSubnetGroupName doesn't refer to an existing subnet
group.default CompletableFuture<RestoreDbClusterFromSnapshotResponse> restoreDBClusterFromSnapshot(Consumer<RestoreDbClusterFromSnapshotRequest.Builder> restoreDbClusterFromSnapshotRequest)
Creates a new cluster from a snapshot or cluster snapshot.
If a snapshot is specified, the target cluster is created from the source DB snapshot with a default configuration and default security group.
If a cluster snapshot is specified, the target cluster is created from the source cluster restore point with the same configuration as the original source DB cluster, except that the new 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 via RestoreDbClusterFromSnapshotRequest.builder()
restoreDbClusterFromSnapshotRequest - A Consumer that will call methods on RestoreDBClusterFromSnapshotMessage.Builder to create
a request. Represents the input to RestoreDBClusterFromSnapshot.DBSubnetGroupName doesn't refer to an existing subnet
group.DBSnapshotIdentifier doesn't refer to an existing snapshot.DBClusterSnapshotIdentifier doesn't refer to an
existing cluster snapshot.DBSubnetGroupName doesn't refer to an existing subnet
group.default CompletableFuture<RestoreDbClusterToPointInTimeResponse> restoreDBClusterToPointInTime(RestoreDbClusterToPointInTimeRequest restoreDbClusterToPointInTimeRequest)
Restores a cluster to an arbitrary point in time. Users can restore to any point in time before
LatestRestorableTime for up to BackupRetentionPeriod days. The target cluster is
created from the source cluster with the same configuration as the original cluster, except that the new cluster
is created with the default security group.
restoreDbClusterToPointInTimeRequest - Represents the input to RestoreDBClusterToPointInTime.DBClusterIdentifier doesn't refer to an existing cluster.DBClusterSnapshotIdentifier doesn't refer to an
existing cluster snapshot.DBSubnetGroupName doesn't refer to an existing subnet
group.default CompletableFuture<RestoreDbClusterToPointInTimeResponse> restoreDBClusterToPointInTime(Consumer<RestoreDbClusterToPointInTimeRequest.Builder> restoreDbClusterToPointInTimeRequest)
Restores a cluster to an arbitrary point in time. Users can restore to any point in time before
LatestRestorableTime for up to BackupRetentionPeriod days. The target cluster is
created from the source cluster with the same configuration as the original cluster, except that the new cluster
is created with the default security group.
This is a convenience which creates an instance of the RestoreDbClusterToPointInTimeRequest.Builder
avoiding the need to create one manually via RestoreDbClusterToPointInTimeRequest.builder()
restoreDbClusterToPointInTimeRequest - A Consumer that will call methods on RestoreDBClusterToPointInTimeMessage.Builder to
create a request. Represents the input to RestoreDBClusterToPointInTime.DBClusterIdentifier doesn't refer to an existing cluster.DBClusterSnapshotIdentifier doesn't refer to an
existing cluster snapshot.DBSubnetGroupName doesn't refer to an existing subnet
group.default CompletableFuture<StartDbClusterResponse> startDBCluster(StartDbClusterRequest startDbClusterRequest)
Restarts the stopped cluster that is specified by DBClusterIdentifier. For more information, see Stopping and
Starting an Amazon DocumentDB Cluster.
startDbClusterRequest - DBClusterIdentifier doesn't refer to an existing cluster.default CompletableFuture<StartDbClusterResponse> startDBCluster(Consumer<StartDbClusterRequest.Builder> startDbClusterRequest)
Restarts the stopped cluster that is specified by DBClusterIdentifier. For more information, see Stopping and
Starting an Amazon DocumentDB Cluster.
This is a convenience which creates an instance of the StartDbClusterRequest.Builder avoiding the need to
create one manually via StartDbClusterRequest.builder()
startDbClusterRequest - A Consumer that will call methods on StartDBClusterMessage.Builder to create a request.DBClusterIdentifier doesn't refer to an existing cluster.default CompletableFuture<StopDbClusterResponse> stopDBCluster(StopDbClusterRequest stopDbClusterRequest)
Stops the running cluster that is specified by DBClusterIdentifier. The cluster must be in the
available state. For more information, see Stopping and
Starting an Amazon DocumentDB Cluster.
stopDbClusterRequest - DBClusterIdentifier doesn't refer to an existing cluster.default CompletableFuture<StopDbClusterResponse> stopDBCluster(Consumer<StopDbClusterRequest.Builder> stopDbClusterRequest)
Stops the running cluster that is specified by DBClusterIdentifier. The cluster must be in the
available state. For more information, see Stopping and
Starting an Amazon DocumentDB Cluster.
This is a convenience which creates an instance of the StopDbClusterRequest.Builder avoiding the need to
create one manually via StopDbClusterRequest.builder()
stopDbClusterRequest - A Consumer that will call methods on StopDBClusterMessage.Builder to create a request.DBClusterIdentifier doesn't refer to an existing cluster.default DocDbAsyncWaiter waiter()
DocDbAsyncWaiter using this client.
Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
DocDbAsyncWaiterCopyright © 2022. All rights reserved.