Interface DocDbClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
Amazon DocumentDB is a fast, reliable, and fully managed database service. Amazon DocumentDB makes it easy to set up, operate, and scale MongoDB-compatible databases in the cloud. With Amazon DocumentDB, you can run the same application code and use the same drivers and tools that you use with MongoDB.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionaddSourceIdentifierToSubscription
(Consumer<AddSourceIdentifierToSubscriptionRequest.Builder> addSourceIdentifierToSubscriptionRequest) Adds a source identifier to an existing event notification subscription.addSourceIdentifierToSubscription
(AddSourceIdentifierToSubscriptionRequest addSourceIdentifierToSubscriptionRequest) Adds a source identifier to an existing event notification subscription.default AddTagsToResourceResponse
addTagsToResource
(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest) Adds metadata tags to an Amazon DocumentDB resource.default AddTagsToResourceResponse
addTagsToResource
(AddTagsToResourceRequest addTagsToResourceRequest) Adds metadata tags to an Amazon DocumentDB resource.applyPendingMaintenanceAction
(Consumer<ApplyPendingMaintenanceActionRequest.Builder> applyPendingMaintenanceActionRequest) Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance).applyPendingMaintenanceAction
(ApplyPendingMaintenanceActionRequest applyPendingMaintenanceActionRequest) Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance).static DocDbClientBuilder
builder()
Create a builder that can be used to configure and create aDocDbClient
.copyDBClusterParameterGroup
(Consumer<CopyDbClusterParameterGroupRequest.Builder> copyDbClusterParameterGroupRequest) Copies the specified cluster parameter group.copyDBClusterParameterGroup
(CopyDbClusterParameterGroupRequest copyDbClusterParameterGroupRequest) Copies the specified cluster parameter group.default CopyDbClusterSnapshotResponse
copyDBClusterSnapshot
(Consumer<CopyDbClusterSnapshotRequest.Builder> copyDbClusterSnapshotRequest) Copies a snapshot of a cluster.default CopyDbClusterSnapshotResponse
copyDBClusterSnapshot
(CopyDbClusterSnapshotRequest copyDbClusterSnapshotRequest) Copies a snapshot of a cluster.static DocDbClient
create()
Create aDocDbClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateDbClusterResponse
createDBCluster
(Consumer<CreateDbClusterRequest.Builder> createDbClusterRequest) Creates a new Amazon DocumentDB cluster.default CreateDbClusterResponse
createDBCluster
(CreateDbClusterRequest createDbClusterRequest) Creates a new Amazon DocumentDB cluster.createDBClusterParameterGroup
(Consumer<CreateDbClusterParameterGroupRequest.Builder> createDbClusterParameterGroupRequest) Creates a new cluster parameter group.createDBClusterParameterGroup
(CreateDbClusterParameterGroupRequest createDbClusterParameterGroupRequest) Creates a new cluster parameter group.default CreateDbClusterSnapshotResponse
createDBClusterSnapshot
(Consumer<CreateDbClusterSnapshotRequest.Builder> createDbClusterSnapshotRequest) Creates a snapshot of a cluster.default CreateDbClusterSnapshotResponse
createDBClusterSnapshot
(CreateDbClusterSnapshotRequest createDbClusterSnapshotRequest) Creates a snapshot of a cluster.default CreateDbInstanceResponse
createDBInstance
(Consumer<CreateDbInstanceRequest.Builder> createDbInstanceRequest) Creates a new instance.default CreateDbInstanceResponse
createDBInstance
(CreateDbInstanceRequest createDbInstanceRequest) Creates a new instance.default CreateDbSubnetGroupResponse
createDBSubnetGroup
(Consumer<CreateDbSubnetGroupRequest.Builder> createDbSubnetGroupRequest) Creates a new subnet group.default CreateDbSubnetGroupResponse
createDBSubnetGroup
(CreateDbSubnetGroupRequest createDbSubnetGroupRequest) Creates a new subnet group.default CreateEventSubscriptionResponse
createEventSubscription
(Consumer<CreateEventSubscriptionRequest.Builder> createEventSubscriptionRequest) Creates an Amazon DocumentDB event notification subscription.default CreateEventSubscriptionResponse
createEventSubscription
(CreateEventSubscriptionRequest createEventSubscriptionRequest) Creates an Amazon DocumentDB event notification subscription.default CreateGlobalClusterResponse
createGlobalCluster
(Consumer<CreateGlobalClusterRequest.Builder> createGlobalClusterRequest) Creates an Amazon DocumentDB global cluster that can span multiple multiple Amazon Web Services Regions.default CreateGlobalClusterResponse
createGlobalCluster
(CreateGlobalClusterRequest createGlobalClusterRequest) Creates an Amazon DocumentDB global cluster that can span multiple multiple Amazon Web Services Regions.default DeleteDbClusterResponse
deleteDBCluster
(Consumer<DeleteDbClusterRequest.Builder> deleteDbClusterRequest) Deletes a previously provisioned cluster.default DeleteDbClusterResponse
deleteDBCluster
(DeleteDbClusterRequest deleteDbClusterRequest) Deletes a previously provisioned cluster.deleteDBClusterParameterGroup
(Consumer<DeleteDbClusterParameterGroupRequest.Builder> deleteDbClusterParameterGroupRequest) Deletes a specified cluster parameter group.deleteDBClusterParameterGroup
(DeleteDbClusterParameterGroupRequest deleteDbClusterParameterGroupRequest) Deletes a specified cluster parameter group.default DeleteDbClusterSnapshotResponse
deleteDBClusterSnapshot
(Consumer<DeleteDbClusterSnapshotRequest.Builder> deleteDbClusterSnapshotRequest) Deletes a cluster snapshot.default DeleteDbClusterSnapshotResponse
deleteDBClusterSnapshot
(DeleteDbClusterSnapshotRequest deleteDbClusterSnapshotRequest) Deletes a cluster snapshot.default DeleteDbInstanceResponse
deleteDBInstance
(Consumer<DeleteDbInstanceRequest.Builder> deleteDbInstanceRequest) Deletes a previously provisioned instance.default DeleteDbInstanceResponse
deleteDBInstance
(DeleteDbInstanceRequest deleteDbInstanceRequest) Deletes a previously provisioned instance.default DeleteDbSubnetGroupResponse
deleteDBSubnetGroup
(Consumer<DeleteDbSubnetGroupRequest.Builder> deleteDbSubnetGroupRequest) Deletes a subnet group.default DeleteDbSubnetGroupResponse
deleteDBSubnetGroup
(DeleteDbSubnetGroupRequest deleteDbSubnetGroupRequest) Deletes a subnet group.default DeleteEventSubscriptionResponse
deleteEventSubscription
(Consumer<DeleteEventSubscriptionRequest.Builder> deleteEventSubscriptionRequest) Deletes an Amazon DocumentDB event notification subscription.default DeleteEventSubscriptionResponse
deleteEventSubscription
(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest) Deletes an Amazon DocumentDB event notification subscription.default DeleteGlobalClusterResponse
deleteGlobalCluster
(Consumer<DeleteGlobalClusterRequest.Builder> deleteGlobalClusterRequest) Deletes a global cluster.default DeleteGlobalClusterResponse
deleteGlobalCluster
(DeleteGlobalClusterRequest deleteGlobalClusterRequest) Deletes a global cluster.default DescribeCertificatesResponse
describeCertificates
(Consumer<DescribeCertificatesRequest.Builder> describeCertificatesRequest) Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this Amazon Web Services account.default DescribeCertificatesResponse
describeCertificates
(DescribeCertificatesRequest describeCertificatesRequest) Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this Amazon Web Services account.default DescribeCertificatesIterable
describeCertificatesPaginator
(Consumer<DescribeCertificatesRequest.Builder> describeCertificatesRequest) This is a variant ofdescribeCertificates(software.amazon.awssdk.services.docdb.model.DescribeCertificatesRequest)
operation.default DescribeCertificatesIterable
describeCertificatesPaginator
(DescribeCertificatesRequest describeCertificatesRequest) This is a variant ofdescribeCertificates(software.amazon.awssdk.services.docdb.model.DescribeCertificatesRequest)
operation.Returns a list ofDBClusterParameterGroup
descriptions.describeDBClusterParameterGroups
(Consumer<DescribeDbClusterParameterGroupsRequest.Builder> describeDbClusterParameterGroupsRequest) Returns a list ofDBClusterParameterGroup
descriptions.describeDBClusterParameterGroups
(DescribeDbClusterParameterGroupsRequest describeDbClusterParameterGroupsRequest) Returns a list ofDBClusterParameterGroup
descriptions.This is a variant ofdescribeDBClusterParameterGroups(software.amazon.awssdk.services.docdb.model.DescribeDbClusterParameterGroupsRequest)
operation.describeDBClusterParameterGroupsPaginator
(Consumer<DescribeDbClusterParameterGroupsRequest.Builder> describeDbClusterParameterGroupsRequest) This is a variant ofdescribeDBClusterParameterGroups(software.amazon.awssdk.services.docdb.model.DescribeDbClusterParameterGroupsRequest)
operation.describeDBClusterParameterGroupsPaginator
(DescribeDbClusterParameterGroupsRequest describeDbClusterParameterGroupsRequest) This is a variant ofdescribeDBClusterParameterGroups(software.amazon.awssdk.services.docdb.model.DescribeDbClusterParameterGroupsRequest)
operation.describeDBClusterParameters
(Consumer<DescribeDbClusterParametersRequest.Builder> describeDbClusterParametersRequest) Returns the detailed parameter list for a particular cluster parameter group.describeDBClusterParameters
(DescribeDbClusterParametersRequest describeDbClusterParametersRequest) Returns the detailed parameter list for a particular cluster parameter group.describeDBClusterParametersPaginator
(Consumer<DescribeDbClusterParametersRequest.Builder> describeDbClusterParametersRequest) This is a variant ofdescribeDBClusterParameters(software.amazon.awssdk.services.docdb.model.DescribeDbClusterParametersRequest)
operation.describeDBClusterParametersPaginator
(DescribeDbClusterParametersRequest describeDbClusterParametersRequest) This is a variant ofdescribeDBClusterParameters(software.amazon.awssdk.services.docdb.model.DescribeDbClusterParametersRequest)
operation.default DescribeDbClustersResponse
Returns information about provisioned Amazon DocumentDB clusters.default DescribeDbClustersResponse
describeDBClusters
(Consumer<DescribeDbClustersRequest.Builder> describeDbClustersRequest) Returns information about provisioned Amazon DocumentDB clusters.default DescribeDbClustersResponse
describeDBClusters
(DescribeDbClustersRequest describeDbClustersRequest) Returns information about provisioned Amazon DocumentDB clusters.describeDBClusterSnapshotAttributes
(Consumer<DescribeDbClusterSnapshotAttributesRequest.Builder> describeDbClusterSnapshotAttributesRequest) Returns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot.describeDBClusterSnapshotAttributes
(DescribeDbClusterSnapshotAttributesRequest describeDbClusterSnapshotAttributesRequest) Returns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot.Returns information about cluster snapshots.describeDBClusterSnapshots
(Consumer<DescribeDbClusterSnapshotsRequest.Builder> describeDbClusterSnapshotsRequest) Returns information about cluster snapshots.describeDBClusterSnapshots
(DescribeDbClusterSnapshotsRequest describeDbClusterSnapshotsRequest) Returns information about cluster snapshots.This is a variant ofdescribeDBClusterSnapshots(software.amazon.awssdk.services.docdb.model.DescribeDbClusterSnapshotsRequest)
operation.describeDBClusterSnapshotsPaginator
(Consumer<DescribeDbClusterSnapshotsRequest.Builder> describeDbClusterSnapshotsRequest) This is a variant ofdescribeDBClusterSnapshots(software.amazon.awssdk.services.docdb.model.DescribeDbClusterSnapshotsRequest)
operation.describeDBClusterSnapshotsPaginator
(DescribeDbClusterSnapshotsRequest describeDbClusterSnapshotsRequest) This is a variant ofdescribeDBClusterSnapshots(software.amazon.awssdk.services.docdb.model.DescribeDbClusterSnapshotsRequest)
operation.default DescribeDBClustersIterable
This is a variant ofdescribeDBClusters(software.amazon.awssdk.services.docdb.model.DescribeDbClustersRequest)
operation.default DescribeDBClustersIterable
describeDBClustersPaginator
(Consumer<DescribeDbClustersRequest.Builder> describeDbClustersRequest) This is a variant ofdescribeDBClusters(software.amazon.awssdk.services.docdb.model.DescribeDbClustersRequest)
operation.default DescribeDBClustersIterable
describeDBClustersPaginator
(DescribeDbClustersRequest describeDbClustersRequest) This is a variant ofdescribeDBClusters(software.amazon.awssdk.services.docdb.model.DescribeDbClustersRequest)
operation.default DescribeDbEngineVersionsResponse
Returns a list of the available engines.default DescribeDbEngineVersionsResponse
describeDBEngineVersions
(Consumer<DescribeDbEngineVersionsRequest.Builder> describeDbEngineVersionsRequest) Returns a list of the available engines.default DescribeDbEngineVersionsResponse
describeDBEngineVersions
(DescribeDbEngineVersionsRequest describeDbEngineVersionsRequest) Returns a list of the available engines.default DescribeDBEngineVersionsIterable
This is a variant ofdescribeDBEngineVersions(software.amazon.awssdk.services.docdb.model.DescribeDbEngineVersionsRequest)
operation.default DescribeDBEngineVersionsIterable
describeDBEngineVersionsPaginator
(Consumer<DescribeDbEngineVersionsRequest.Builder> describeDbEngineVersionsRequest) This is a variant ofdescribeDBEngineVersions(software.amazon.awssdk.services.docdb.model.DescribeDbEngineVersionsRequest)
operation.default DescribeDBEngineVersionsIterable
describeDBEngineVersionsPaginator
(DescribeDbEngineVersionsRequest describeDbEngineVersionsRequest) This is a variant ofdescribeDBEngineVersions(software.amazon.awssdk.services.docdb.model.DescribeDbEngineVersionsRequest)
operation.default DescribeDbInstancesResponse
Returns information about provisioned Amazon DocumentDB instances.default DescribeDbInstancesResponse
describeDBInstances
(Consumer<DescribeDbInstancesRequest.Builder> describeDbInstancesRequest) Returns information about provisioned Amazon DocumentDB instances.default DescribeDbInstancesResponse
describeDBInstances
(DescribeDbInstancesRequest describeDbInstancesRequest) Returns information about provisioned Amazon DocumentDB instances.default DescribeDBInstancesIterable
This is a variant ofdescribeDBInstances(software.amazon.awssdk.services.docdb.model.DescribeDbInstancesRequest)
operation.default DescribeDBInstancesIterable
describeDBInstancesPaginator
(Consumer<DescribeDbInstancesRequest.Builder> describeDbInstancesRequest) This is a variant ofdescribeDBInstances(software.amazon.awssdk.services.docdb.model.DescribeDbInstancesRequest)
operation.default DescribeDBInstancesIterable
describeDBInstancesPaginator
(DescribeDbInstancesRequest describeDbInstancesRequest) This is a variant ofdescribeDBInstances(software.amazon.awssdk.services.docdb.model.DescribeDbInstancesRequest)
operation.default DescribeDbSubnetGroupsResponse
Returns a list ofDBSubnetGroup
descriptions.default DescribeDbSubnetGroupsResponse
describeDBSubnetGroups
(Consumer<DescribeDbSubnetGroupsRequest.Builder> describeDbSubnetGroupsRequest) Returns a list ofDBSubnetGroup
descriptions.default DescribeDbSubnetGroupsResponse
describeDBSubnetGroups
(DescribeDbSubnetGroupsRequest describeDbSubnetGroupsRequest) Returns a list ofDBSubnetGroup
descriptions.default DescribeDBSubnetGroupsIterable
This is a variant ofdescribeDBSubnetGroups(software.amazon.awssdk.services.docdb.model.DescribeDbSubnetGroupsRequest)
operation.default DescribeDBSubnetGroupsIterable
describeDBSubnetGroupsPaginator
(Consumer<DescribeDbSubnetGroupsRequest.Builder> describeDbSubnetGroupsRequest) This is a variant ofdescribeDBSubnetGroups(software.amazon.awssdk.services.docdb.model.DescribeDbSubnetGroupsRequest)
operation.default DescribeDBSubnetGroupsIterable
describeDBSubnetGroupsPaginator
(DescribeDbSubnetGroupsRequest describeDbSubnetGroupsRequest) This is a variant ofdescribeDBSubnetGroups(software.amazon.awssdk.services.docdb.model.DescribeDbSubnetGroupsRequest)
operation.describeEngineDefaultClusterParameters
(Consumer<DescribeEngineDefaultClusterParametersRequest.Builder> describeEngineDefaultClusterParametersRequest) Returns the default engine and system parameter information for the cluster database engine.describeEngineDefaultClusterParameters
(DescribeEngineDefaultClusterParametersRequest describeEngineDefaultClusterParametersRequest) Returns the default engine and system parameter information for the cluster database engine.default DescribeEventCategoriesResponse
Displays a list of categories for all event source types, or, if specified, for a specified source type.default DescribeEventCategoriesResponse
describeEventCategories
(Consumer<DescribeEventCategoriesRequest.Builder> describeEventCategoriesRequest) Displays a list of categories for all event source types, or, if specified, for a specified source type.default DescribeEventCategoriesResponse
describeEventCategories
(DescribeEventCategoriesRequest describeEventCategoriesRequest) Displays a list of categories for all event source types, or, if specified, for a specified source type.default DescribeEventsResponse
Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days.default DescribeEventsResponse
describeEvents
(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days.default DescribeEventsResponse
describeEvents
(DescribeEventsRequest describeEventsRequest) Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days.default DescribeEventsIterable
This is a variant ofdescribeEvents(software.amazon.awssdk.services.docdb.model.DescribeEventsRequest)
operation.default DescribeEventsIterable
describeEventsPaginator
(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) This is a variant ofdescribeEvents(software.amazon.awssdk.services.docdb.model.DescribeEventsRequest)
operation.default DescribeEventsIterable
describeEventsPaginator
(DescribeEventsRequest describeEventsRequest) This is a variant ofdescribeEvents(software.amazon.awssdk.services.docdb.model.DescribeEventsRequest)
operation.describeEventSubscriptions
(Consumer<DescribeEventSubscriptionsRequest.Builder> describeEventSubscriptionsRequest) Lists all the subscription descriptions for a customer account.describeEventSubscriptions
(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest) Lists all the subscription descriptions for a customer account.describeEventSubscriptionsPaginator
(Consumer<DescribeEventSubscriptionsRequest.Builder> describeEventSubscriptionsRequest) This is a variant ofdescribeEventSubscriptions(software.amazon.awssdk.services.docdb.model.DescribeEventSubscriptionsRequest)
operation.describeEventSubscriptionsPaginator
(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest) This is a variant ofdescribeEventSubscriptions(software.amazon.awssdk.services.docdb.model.DescribeEventSubscriptionsRequest)
operation.default DescribeGlobalClustersResponse
describeGlobalClusters
(Consumer<DescribeGlobalClustersRequest.Builder> describeGlobalClustersRequest) Returns information about Amazon DocumentDB global clusters.default DescribeGlobalClustersResponse
describeGlobalClusters
(DescribeGlobalClustersRequest describeGlobalClustersRequest) Returns information about Amazon DocumentDB global clusters.default DescribeGlobalClustersIterable
describeGlobalClustersPaginator
(Consumer<DescribeGlobalClustersRequest.Builder> describeGlobalClustersRequest) This is a variant ofdescribeGlobalClusters(software.amazon.awssdk.services.docdb.model.DescribeGlobalClustersRequest)
operation.default DescribeGlobalClustersIterable
describeGlobalClustersPaginator
(DescribeGlobalClustersRequest describeGlobalClustersRequest) This is a variant ofdescribeGlobalClusters(software.amazon.awssdk.services.docdb.model.DescribeGlobalClustersRequest)
operation.describeOrderableDBInstanceOptions
(Consumer<DescribeOrderableDbInstanceOptionsRequest.Builder> describeOrderableDbInstanceOptionsRequest) Returns a list of orderable instance options for the specified engine.describeOrderableDBInstanceOptions
(DescribeOrderableDbInstanceOptionsRequest describeOrderableDbInstanceOptionsRequest) Returns a list of orderable instance options for the specified engine.describeOrderableDBInstanceOptionsPaginator
(Consumer<DescribeOrderableDbInstanceOptionsRequest.Builder> describeOrderableDbInstanceOptionsRequest) This is a variant ofdescribeOrderableDBInstanceOptions(software.amazon.awssdk.services.docdb.model.DescribeOrderableDbInstanceOptionsRequest)
operation.describeOrderableDBInstanceOptionsPaginator
(DescribeOrderableDbInstanceOptionsRequest describeOrderableDbInstanceOptionsRequest) This is a variant ofdescribeOrderableDBInstanceOptions(software.amazon.awssdk.services.docdb.model.DescribeOrderableDbInstanceOptionsRequest)
operation.Returns a list of resources (for example, instances) that have at least one pending maintenance action.describePendingMaintenanceActions
(Consumer<DescribePendingMaintenanceActionsRequest.Builder> describePendingMaintenanceActionsRequest) Returns a list of resources (for example, instances) that have at least one pending maintenance action.describePendingMaintenanceActions
(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest) Returns a list of resources (for example, instances) that have at least one pending maintenance action.This is a variant ofdescribePendingMaintenanceActions(software.amazon.awssdk.services.docdb.model.DescribePendingMaintenanceActionsRequest)
operation.describePendingMaintenanceActionsPaginator
(Consumer<DescribePendingMaintenanceActionsRequest.Builder> describePendingMaintenanceActionsRequest) This is a variant ofdescribePendingMaintenanceActions(software.amazon.awssdk.services.docdb.model.DescribePendingMaintenanceActionsRequest)
operation.describePendingMaintenanceActionsPaginator
(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest) This is a variant ofdescribePendingMaintenanceActions(software.amazon.awssdk.services.docdb.model.DescribePendingMaintenanceActionsRequest)
operation.default FailoverDbClusterResponse
failoverDBCluster
(Consumer<FailoverDbClusterRequest.Builder> failoverDbClusterRequest) Forces a failover for a cluster.default FailoverDbClusterResponse
failoverDBCluster
(FailoverDbClusterRequest failoverDbClusterRequest) Forces a failover for a cluster.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists all tags on an Amazon DocumentDB resource.default ListTagsForResourceResponse
listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Lists all tags on an Amazon DocumentDB resource.default ModifyDbClusterResponse
modifyDBCluster
(Consumer<ModifyDbClusterRequest.Builder> modifyDbClusterRequest) Modifies a setting for an Amazon DocumentDB cluster.default ModifyDbClusterResponse
modifyDBCluster
(ModifyDbClusterRequest modifyDbClusterRequest) Modifies a setting for an Amazon DocumentDB cluster.modifyDBClusterParameterGroup
(Consumer<ModifyDbClusterParameterGroupRequest.Builder> modifyDbClusterParameterGroupRequest) Modifies the parameters of a cluster parameter group.modifyDBClusterParameterGroup
(ModifyDbClusterParameterGroupRequest modifyDbClusterParameterGroupRequest) Modifies the parameters of a cluster parameter group.modifyDBClusterSnapshotAttribute
(Consumer<ModifyDbClusterSnapshotAttributeRequest.Builder> modifyDbClusterSnapshotAttributeRequest) Adds an attribute and values to, or removes an attribute and values from, a manual cluster snapshot.modifyDBClusterSnapshotAttribute
(ModifyDbClusterSnapshotAttributeRequest modifyDbClusterSnapshotAttributeRequest) Adds an attribute and values to, or removes an attribute and values from, a manual cluster snapshot.default ModifyDbInstanceResponse
modifyDBInstance
(Consumer<ModifyDbInstanceRequest.Builder> modifyDbInstanceRequest) Modifies settings for an instance.default ModifyDbInstanceResponse
modifyDBInstance
(ModifyDbInstanceRequest modifyDbInstanceRequest) Modifies settings for an instance.default ModifyDbSubnetGroupResponse
modifyDBSubnetGroup
(Consumer<ModifyDbSubnetGroupRequest.Builder> modifyDbSubnetGroupRequest) Modifies an existing subnet group.default ModifyDbSubnetGroupResponse
modifyDBSubnetGroup
(ModifyDbSubnetGroupRequest modifyDbSubnetGroupRequest) Modifies an existing subnet group.default ModifyEventSubscriptionResponse
modifyEventSubscription
(Consumer<ModifyEventSubscriptionRequest.Builder> modifyEventSubscriptionRequest) Modifies an existing Amazon DocumentDB event notification subscription.default ModifyEventSubscriptionResponse
modifyEventSubscription
(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest) Modifies an existing Amazon DocumentDB event notification subscription.default ModifyGlobalClusterResponse
modifyGlobalCluster
(Consumer<ModifyGlobalClusterRequest.Builder> modifyGlobalClusterRequest) Modify a setting for an Amazon DocumentDB global cluster.default ModifyGlobalClusterResponse
modifyGlobalCluster
(ModifyGlobalClusterRequest modifyGlobalClusterRequest) Modify a setting for an Amazon DocumentDB global cluster.default RebootDbInstanceResponse
rebootDBInstance
(Consumer<RebootDbInstanceRequest.Builder> rebootDbInstanceRequest) You might need to reboot your instance, usually for maintenance reasons.default RebootDbInstanceResponse
rebootDBInstance
(RebootDbInstanceRequest rebootDbInstanceRequest) You might need to reboot your instance, usually for maintenance reasons.default RemoveFromGlobalClusterResponse
removeFromGlobalCluster
(Consumer<RemoveFromGlobalClusterRequest.Builder> removeFromGlobalClusterRequest) Detaches an Amazon DocumentDB secondary cluster from a global cluster.default RemoveFromGlobalClusterResponse
removeFromGlobalCluster
(RemoveFromGlobalClusterRequest removeFromGlobalClusterRequest) Detaches an Amazon DocumentDB secondary cluster from a global cluster.removeSourceIdentifierFromSubscription
(Consumer<RemoveSourceIdentifierFromSubscriptionRequest.Builder> removeSourceIdentifierFromSubscriptionRequest) Removes a source identifier from an existing Amazon DocumentDB event notification subscription.removeSourceIdentifierFromSubscription
(RemoveSourceIdentifierFromSubscriptionRequest removeSourceIdentifierFromSubscriptionRequest) Removes a source identifier from an existing Amazon DocumentDB event notification subscription.default RemoveTagsFromResourceResponse
removeTagsFromResource
(Consumer<RemoveTagsFromResourceRequest.Builder> removeTagsFromResourceRequest) Removes metadata tags from an Amazon DocumentDB resource.default RemoveTagsFromResourceResponse
removeTagsFromResource
(RemoveTagsFromResourceRequest removeTagsFromResourceRequest) Removes metadata tags from an Amazon DocumentDB resource.resetDBClusterParameterGroup
(Consumer<ResetDbClusterParameterGroupRequest.Builder> resetDbClusterParameterGroupRequest) Modifies the parameters of a cluster parameter group to the default value.resetDBClusterParameterGroup
(ResetDbClusterParameterGroupRequest resetDbClusterParameterGroupRequest) Modifies the parameters of a cluster parameter group to the default value.restoreDBClusterFromSnapshot
(Consumer<RestoreDbClusterFromSnapshotRequest.Builder> restoreDbClusterFromSnapshotRequest) Creates a new cluster from a snapshot or cluster snapshot.restoreDBClusterFromSnapshot
(RestoreDbClusterFromSnapshotRequest restoreDbClusterFromSnapshotRequest) Creates a new cluster from a snapshot or cluster snapshot.restoreDBClusterToPointInTime
(Consumer<RestoreDbClusterToPointInTimeRequest.Builder> restoreDbClusterToPointInTimeRequest) Restores a cluster to an arbitrary point in time.restoreDBClusterToPointInTime
(RestoreDbClusterToPointInTimeRequest restoreDbClusterToPointInTimeRequest) Restores a cluster to an arbitrary point in time.default DocDbServiceClientConfiguration
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default StartDbClusterResponse
startDBCluster
(Consumer<StartDbClusterRequest.Builder> startDbClusterRequest) Restarts the stopped cluster that is specified byDBClusterIdentifier
.default StartDbClusterResponse
startDBCluster
(StartDbClusterRequest startDbClusterRequest) Restarts the stopped cluster that is specified byDBClusterIdentifier
.default StopDbClusterResponse
stopDBCluster
(Consumer<StopDbClusterRequest.Builder> stopDbClusterRequest) Stops the running cluster that is specified byDBClusterIdentifier
.default StopDbClusterResponse
stopDBCluster
(StopDbClusterRequest stopDbClusterRequest) Stops the running cluster that is specified byDBClusterIdentifier
.default SwitchoverGlobalClusterResponse
switchoverGlobalCluster
(Consumer<SwitchoverGlobalClusterRequest.Builder> switchoverGlobalClusterRequest) Switches over the specified secondary Amazon DocumentDB cluster to be the new primary Amazon DocumentDB cluster in the global database cluster.default SwitchoverGlobalClusterResponse
switchoverGlobalCluster
(SwitchoverGlobalClusterRequest switchoverGlobalClusterRequest) Switches over the specified secondary Amazon DocumentDB cluster to be the new primary Amazon DocumentDB cluster in the global database cluster.default DocDbWaiter
waiter()
Create an instance ofDocDbWaiter
using this client.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
addSourceIdentifierToSubscription
default AddSourceIdentifierToSubscriptionResponse addSourceIdentifierToSubscription(AddSourceIdentifierToSubscriptionRequest addSourceIdentifierToSubscriptionRequest) throws SubscriptionNotFoundException, SourceNotFoundException, AwsServiceException, SdkClientException, DocDbException Adds a source identifier to an existing event notification subscription.
- Parameters:
addSourceIdentifierToSubscriptionRequest
- Represents the input to AddSourceIdentifierToSubscription.- Returns:
- Result of the AddSourceIdentifierToSubscription operation returned by the service.
- See Also:
-
addSourceIdentifierToSubscription
default AddSourceIdentifierToSubscriptionResponse addSourceIdentifierToSubscription(Consumer<AddSourceIdentifierToSubscriptionRequest.Builder> addSourceIdentifierToSubscriptionRequest) throws SubscriptionNotFoundException, SourceNotFoundException, AwsServiceException, SdkClientException, DocDbException Adds a source identifier to an existing event notification subscription.
This is a convenience which creates an instance of the
AddSourceIdentifierToSubscriptionRequest.Builder
avoiding the need to create one manually viaAddSourceIdentifierToSubscriptionRequest.builder()
- Parameters:
addSourceIdentifierToSubscriptionRequest
- AConsumer
that will call methods onAddSourceIdentifierToSubscriptionRequest.Builder
to create a request. Represents the input to AddSourceIdentifierToSubscription.- Returns:
- Result of the AddSourceIdentifierToSubscription operation returned by the service.
- See Also:
-
addTagsToResource
default AddTagsToResourceResponse addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest) throws DbInstanceNotFoundException, DbSnapshotNotFoundException, DbClusterNotFoundException, AwsServiceException, SdkClientException, DocDbException 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.- Parameters:
addTagsToResourceRequest
- Represents the input to AddTagsToResource.- Returns:
- Result of the AddTagsToResource operation returned by the service.
- See Also:
-
addTagsToResource
default AddTagsToResourceResponse addTagsToResource(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest) throws DbInstanceNotFoundException, DbSnapshotNotFoundException, DbClusterNotFoundException, AwsServiceException, SdkClientException, DocDbException 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 viaAddTagsToResourceRequest.builder()
- Parameters:
addTagsToResourceRequest
- AConsumer
that will call methods onAddTagsToResourceRequest.Builder
to create a request. Represents the input to AddTagsToResource.- Returns:
- Result of the AddTagsToResource operation returned by the service.
- See Also:
-
applyPendingMaintenanceAction
default ApplyPendingMaintenanceActionResponse applyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest applyPendingMaintenanceActionRequest) throws ResourceNotFoundException, InvalidDbClusterStateException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, DocDbException Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance).
- Parameters:
applyPendingMaintenanceActionRequest
- Represents the input to ApplyPendingMaintenanceAction.- Returns:
- Result of the ApplyPendingMaintenanceAction operation returned by the service.
- See Also:
-
applyPendingMaintenanceAction
default ApplyPendingMaintenanceActionResponse applyPendingMaintenanceAction(Consumer<ApplyPendingMaintenanceActionRequest.Builder> applyPendingMaintenanceActionRequest) throws ResourceNotFoundException, InvalidDbClusterStateException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, DocDbException 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 viaApplyPendingMaintenanceActionRequest.builder()
- Parameters:
applyPendingMaintenanceActionRequest
- AConsumer
that will call methods onApplyPendingMaintenanceActionRequest.Builder
to create a request. Represents the input to ApplyPendingMaintenanceAction.- Returns:
- Result of the ApplyPendingMaintenanceAction operation returned by the service.
- See Also:
-
copyDBClusterParameterGroup
default CopyDbClusterParameterGroupResponse copyDBClusterParameterGroup(CopyDbClusterParameterGroupRequest copyDbClusterParameterGroupRequest) throws DbParameterGroupNotFoundException, DbParameterGroupQuotaExceededException, DbParameterGroupAlreadyExistsException, AwsServiceException, SdkClientException, DocDbException Copies the specified cluster parameter group.
- Parameters:
copyDbClusterParameterGroupRequest
- Represents the input to CopyDBClusterParameterGroup.- Returns:
- Result of the CopyDBClusterParameterGroup operation returned by the service.
- See Also:
-
copyDBClusterParameterGroup
default CopyDbClusterParameterGroupResponse copyDBClusterParameterGroup(Consumer<CopyDbClusterParameterGroupRequest.Builder> copyDbClusterParameterGroupRequest) throws DbParameterGroupNotFoundException, DbParameterGroupQuotaExceededException, DbParameterGroupAlreadyExistsException, AwsServiceException, SdkClientException, DocDbException 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 viaCopyDbClusterParameterGroupRequest.builder()
- Parameters:
copyDbClusterParameterGroupRequest
- AConsumer
that will call methods onCopyDbClusterParameterGroupRequest.Builder
to create a request. Represents the input to CopyDBClusterParameterGroup.- Returns:
- Result of the CopyDBClusterParameterGroup operation returned by the service.
- See Also:
-
copyDBClusterSnapshot
default CopyDbClusterSnapshotResponse copyDBClusterSnapshot(CopyDbClusterSnapshotRequest copyDbClusterSnapshotRequest) throws DbClusterSnapshotAlreadyExistsException, DbClusterSnapshotNotFoundException, InvalidDbClusterStateException, InvalidDbClusterSnapshotStateException, SnapshotQuotaExceededException, KmsKeyNotAccessibleException, AwsServiceException, SdkClientException, DocDbException 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 Amazon Web Services 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.- Parameters:
copyDbClusterSnapshotRequest
- Represents the input to CopyDBClusterSnapshot.- Returns:
- Result of the CopyDBClusterSnapshot operation returned by the service.
- See Also:
-
copyDBClusterSnapshot
default CopyDbClusterSnapshotResponse copyDBClusterSnapshot(Consumer<CopyDbClusterSnapshotRequest.Builder> copyDbClusterSnapshotRequest) throws DbClusterSnapshotAlreadyExistsException, DbClusterSnapshotNotFoundException, InvalidDbClusterStateException, InvalidDbClusterSnapshotStateException, SnapshotQuotaExceededException, KmsKeyNotAccessibleException, AwsServiceException, SdkClientException, DocDbException 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 Amazon Web Services 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 viaCopyDbClusterSnapshotRequest.builder()
- Parameters:
copyDbClusterSnapshotRequest
- AConsumer
that will call methods onCopyDbClusterSnapshotRequest.Builder
to create a request. Represents the input to CopyDBClusterSnapshot.- Returns:
- Result of the CopyDBClusterSnapshot operation returned by the service.
- See Also:
-
createDBCluster
default CreateDbClusterResponse createDBCluster(CreateDbClusterRequest createDbClusterRequest) throws DbClusterAlreadyExistsException, InsufficientStorageClusterCapacityException, DbClusterQuotaExceededException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, InvalidVpcNetworkStateException, InvalidDbClusterStateException, InvalidDbSubnetGroupStateException, InvalidSubnetException, InvalidDbInstanceStateException, DbClusterParameterGroupNotFoundException, KmsKeyNotAccessibleException, DbClusterNotFoundException, DbInstanceNotFoundException, DbSubnetGroupDoesNotCoverEnoughAZsException, GlobalClusterNotFoundException, InvalidGlobalClusterStateException, AwsServiceException, SdkClientException, DocDbException Creates a new Amazon DocumentDB cluster.
- Parameters:
createDbClusterRequest
- Represents the input to CreateDBCluster.- Returns:
- Result of the CreateDBCluster operation returned by the service.
- See Also:
-
createDBCluster
default CreateDbClusterResponse createDBCluster(Consumer<CreateDbClusterRequest.Builder> createDbClusterRequest) throws DbClusterAlreadyExistsException, InsufficientStorageClusterCapacityException, DbClusterQuotaExceededException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, InvalidVpcNetworkStateException, InvalidDbClusterStateException, InvalidDbSubnetGroupStateException, InvalidSubnetException, InvalidDbInstanceStateException, DbClusterParameterGroupNotFoundException, KmsKeyNotAccessibleException, DbClusterNotFoundException, DbInstanceNotFoundException, DbSubnetGroupDoesNotCoverEnoughAZsException, GlobalClusterNotFoundException, InvalidGlobalClusterStateException, AwsServiceException, SdkClientException, DocDbException 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 viaCreateDbClusterRequest.builder()
- Parameters:
createDbClusterRequest
- AConsumer
that will call methods onCreateDbClusterRequest.Builder
to create a request. Represents the input to CreateDBCluster.- Returns:
- Result of the CreateDBCluster operation returned by the service.
- See Also:
-
createDBClusterParameterGroup
default CreateDbClusterParameterGroupResponse createDBClusterParameterGroup(CreateDbClusterParameterGroupRequest createDbClusterParameterGroupRequest) throws DbParameterGroupQuotaExceededException, DbParameterGroupAlreadyExistsException, AwsServiceException, SdkClientException, DocDbException 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.- Parameters:
createDbClusterParameterGroupRequest
- Represents the input of CreateDBClusterParameterGroup.- Returns:
- Result of the CreateDBClusterParameterGroup operation returned by the service.
- See Also:
-
createDBClusterParameterGroup
default CreateDbClusterParameterGroupResponse createDBClusterParameterGroup(Consumer<CreateDbClusterParameterGroupRequest.Builder> createDbClusterParameterGroupRequest) throws DbParameterGroupQuotaExceededException, DbParameterGroupAlreadyExistsException, AwsServiceException, SdkClientException, DocDbException 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 viaCreateDbClusterParameterGroupRequest.builder()
- Parameters:
createDbClusterParameterGroupRequest
- AConsumer
that will call methods onCreateDbClusterParameterGroupRequest.Builder
to create a request. Represents the input of CreateDBClusterParameterGroup.- Returns:
- Result of the CreateDBClusterParameterGroup operation returned by the service.
- See Also:
-
createDBClusterSnapshot
default CreateDbClusterSnapshotResponse createDBClusterSnapshot(CreateDbClusterSnapshotRequest createDbClusterSnapshotRequest) throws DbClusterSnapshotAlreadyExistsException, InvalidDbClusterStateException, DbClusterNotFoundException, SnapshotQuotaExceededException, InvalidDbClusterSnapshotStateException, AwsServiceException, SdkClientException, DocDbException Creates a snapshot of a cluster.
- Parameters:
createDbClusterSnapshotRequest
- Represents the input of CreateDBClusterSnapshot.- Returns:
- Result of the CreateDBClusterSnapshot operation returned by the service.
- See Also:
-
createDBClusterSnapshot
default CreateDbClusterSnapshotResponse createDBClusterSnapshot(Consumer<CreateDbClusterSnapshotRequest.Builder> createDbClusterSnapshotRequest) throws DbClusterSnapshotAlreadyExistsException, InvalidDbClusterStateException, DbClusterNotFoundException, SnapshotQuotaExceededException, InvalidDbClusterSnapshotStateException, AwsServiceException, SdkClientException, DocDbException 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 viaCreateDbClusterSnapshotRequest.builder()
- Parameters:
createDbClusterSnapshotRequest
- AConsumer
that will call methods onCreateDbClusterSnapshotRequest.Builder
to create a request. Represents the input of CreateDBClusterSnapshot.- Returns:
- Result of the CreateDBClusterSnapshot operation returned by the service.
- See Also:
-
createDBInstance
default CreateDbInstanceResponse createDBInstance(CreateDbInstanceRequest createDbInstanceRequest) throws DbInstanceAlreadyExistsException, InsufficientDbInstanceCapacityException, DbParameterGroupNotFoundException, DbSecurityGroupNotFoundException, InstanceQuotaExceededException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidDbClusterStateException, InvalidSubnetException, InvalidVpcNetworkStateException, DbClusterNotFoundException, StorageTypeNotSupportedException, AuthorizationNotFoundException, KmsKeyNotAccessibleException, AwsServiceException, SdkClientException, DocDbException Creates a new instance.
- Parameters:
createDbInstanceRequest
- Represents the input to CreateDBInstance.- Returns:
- Result of the CreateDBInstance operation returned by the service.
- See Also:
-
createDBInstance
default CreateDbInstanceResponse createDBInstance(Consumer<CreateDbInstanceRequest.Builder> createDbInstanceRequest) throws DbInstanceAlreadyExistsException, InsufficientDbInstanceCapacityException, DbParameterGroupNotFoundException, DbSecurityGroupNotFoundException, InstanceQuotaExceededException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidDbClusterStateException, InvalidSubnetException, InvalidVpcNetworkStateException, DbClusterNotFoundException, StorageTypeNotSupportedException, AuthorizationNotFoundException, KmsKeyNotAccessibleException, AwsServiceException, SdkClientException, DocDbException Creates a new instance.
This is a convenience which creates an instance of the
CreateDbInstanceRequest.Builder
avoiding the need to create one manually viaCreateDbInstanceRequest.builder()
- Parameters:
createDbInstanceRequest
- AConsumer
that will call methods onCreateDbInstanceRequest.Builder
to create a request. Represents the input to CreateDBInstance.- Returns:
- Result of the CreateDBInstance operation returned by the service.
- See Also:
-
createDBSubnetGroup
default CreateDbSubnetGroupResponse createDBSubnetGroup(CreateDbSubnetGroupRequest createDbSubnetGroupRequest) throws DbSubnetGroupAlreadyExistsException, DbSubnetGroupQuotaExceededException, DbSubnetQuotaExceededException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidSubnetException, AwsServiceException, SdkClientException, DocDbException Creates a new subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Amazon Web Services Region.
- Parameters:
createDbSubnetGroupRequest
- Represents the input to CreateDBSubnetGroup.- Returns:
- Result of the CreateDBSubnetGroup operation returned by the service.
- See Also:
-
createDBSubnetGroup
default CreateDbSubnetGroupResponse createDBSubnetGroup(Consumer<CreateDbSubnetGroupRequest.Builder> createDbSubnetGroupRequest) throws DbSubnetGroupAlreadyExistsException, DbSubnetGroupQuotaExceededException, DbSubnetQuotaExceededException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidSubnetException, AwsServiceException, SdkClientException, DocDbException Creates a new subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Amazon Web Services Region.
This is a convenience which creates an instance of the
CreateDbSubnetGroupRequest.Builder
avoiding the need to create one manually viaCreateDbSubnetGroupRequest.builder()
- Parameters:
createDbSubnetGroupRequest
- AConsumer
that will call methods onCreateDbSubnetGroupRequest.Builder
to create a request. Represents the input to CreateDBSubnetGroup.- Returns:
- Result of the CreateDBSubnetGroup operation returned by the service.
- See Also:
-
createEventSubscription
default CreateEventSubscriptionResponse createEventSubscription(CreateEventSubscriptionRequest createEventSubscriptionRequest) throws EventSubscriptionQuotaExceededException, SubscriptionAlreadyExistException, SnsInvalidTopicException, SnsNoAuthorizationException, SnsTopicArnNotFoundException, SubscriptionCategoryNotFoundException, SourceNotFoundException, AwsServiceException, SdkClientException, DocDbException 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 specifySourceType = db-instance
,SourceIds = mydbinstance1, mydbinstance2
andEventCategories = Availability, Backup
.If you specify both the
SourceType
andSourceIds
(such asSourceType = db-instance
andSourceIdentifier = myDBInstance1
), you are notified of all thedb-instance
events for the specified source. If you specify aSourceType
but do not specify aSourceIdentifier
, you receive notice of the events for that source type for all your Amazon DocumentDB sources. If you do not specify either theSourceType
or theSourceIdentifier
, you are notified of events generated from all Amazon DocumentDB sources belonging to your customer account.- Parameters:
createEventSubscriptionRequest
- Represents the input to CreateEventSubscription.- Returns:
- Result of the CreateEventSubscription operation returned by the service.
- See Also:
-
createEventSubscription
default CreateEventSubscriptionResponse createEventSubscription(Consumer<CreateEventSubscriptionRequest.Builder> createEventSubscriptionRequest) throws EventSubscriptionQuotaExceededException, SubscriptionAlreadyExistException, SnsInvalidTopicException, SnsNoAuthorizationException, SnsTopicArnNotFoundException, SubscriptionCategoryNotFoundException, SourceNotFoundException, AwsServiceException, SdkClientException, DocDbException 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 specifySourceType = db-instance
,SourceIds = mydbinstance1, mydbinstance2
andEventCategories = Availability, Backup
.If you specify both the
SourceType
andSourceIds
(such asSourceType = db-instance
andSourceIdentifier = myDBInstance1
), you are notified of all thedb-instance
events for the specified source. If you specify aSourceType
but do not specify aSourceIdentifier
, you receive notice of the events for that source type for all your Amazon DocumentDB sources. If you do not specify either theSourceType
or theSourceIdentifier
, 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 viaCreateEventSubscriptionRequest.builder()
- Parameters:
createEventSubscriptionRequest
- AConsumer
that will call methods onCreateEventSubscriptionRequest.Builder
to create a request. Represents the input to CreateEventSubscription.- Returns:
- Result of the CreateEventSubscription operation returned by the service.
- See Also:
-
createGlobalCluster
default CreateGlobalClusterResponse createGlobalCluster(CreateGlobalClusterRequest createGlobalClusterRequest) throws GlobalClusterAlreadyExistsException, GlobalClusterQuotaExceededException, InvalidDbClusterStateException, DbClusterNotFoundException, AwsServiceException, SdkClientException, DocDbException Creates an Amazon DocumentDB global cluster that can span multiple multiple Amazon Web Services 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.
- Parameters:
createGlobalClusterRequest
- Represents the input to CreateGlobalCluster.- Returns:
- Result of the CreateGlobalCluster operation returned by the service.
- See Also:
-
createGlobalCluster
default CreateGlobalClusterResponse createGlobalCluster(Consumer<CreateGlobalClusterRequest.Builder> createGlobalClusterRequest) throws GlobalClusterAlreadyExistsException, GlobalClusterQuotaExceededException, InvalidDbClusterStateException, DbClusterNotFoundException, AwsServiceException, SdkClientException, DocDbException Creates an Amazon DocumentDB global cluster that can span multiple multiple Amazon Web Services 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 viaCreateGlobalClusterRequest.builder()
- Parameters:
createGlobalClusterRequest
- AConsumer
that will call methods onCreateGlobalClusterRequest.Builder
to create a request. Represents the input to CreateGlobalCluster.- Returns:
- Result of the CreateGlobalCluster operation returned by the service.
- See Also:
-
deleteDBCluster
default DeleteDbClusterResponse deleteDBCluster(DeleteDbClusterRequest deleteDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, DbClusterSnapshotAlreadyExistsException, SnapshotQuotaExceededException, InvalidDbClusterSnapshotStateException, AwsServiceException, SdkClientException, DocDbException 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.
- Parameters:
deleteDbClusterRequest
- Represents the input to DeleteDBCluster.- Returns:
- Result of the DeleteDBCluster operation returned by the service.
- See Also:
-
deleteDBCluster
default DeleteDbClusterResponse deleteDBCluster(Consumer<DeleteDbClusterRequest.Builder> deleteDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, DbClusterSnapshotAlreadyExistsException, SnapshotQuotaExceededException, InvalidDbClusterSnapshotStateException, AwsServiceException, SdkClientException, DocDbException 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 viaDeleteDbClusterRequest.builder()
- Parameters:
deleteDbClusterRequest
- AConsumer
that will call methods onDeleteDbClusterRequest.Builder
to create a request. Represents the input to DeleteDBCluster.- Returns:
- Result of the DeleteDBCluster operation returned by the service.
- See Also:
-
deleteDBClusterParameterGroup
default DeleteDbClusterParameterGroupResponse deleteDBClusterParameterGroup(DeleteDbClusterParameterGroupRequest deleteDbClusterParameterGroupRequest) throws InvalidDbParameterGroupStateException, DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, DocDbException Deletes a specified cluster parameter group. The cluster parameter group to be deleted can't be associated with any clusters.
- Parameters:
deleteDbClusterParameterGroupRequest
- Represents the input to DeleteDBClusterParameterGroup.- Returns:
- Result of the DeleteDBClusterParameterGroup operation returned by the service.
- See Also:
-
deleteDBClusterParameterGroup
default DeleteDbClusterParameterGroupResponse deleteDBClusterParameterGroup(Consumer<DeleteDbClusterParameterGroupRequest.Builder> deleteDbClusterParameterGroupRequest) throws InvalidDbParameterGroupStateException, DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, DocDbException 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 viaDeleteDbClusterParameterGroupRequest.builder()
- Parameters:
deleteDbClusterParameterGroupRequest
- AConsumer
that will call methods onDeleteDbClusterParameterGroupRequest.Builder
to create a request. Represents the input to DeleteDBClusterParameterGroup.- Returns:
- Result of the DeleteDBClusterParameterGroup operation returned by the service.
- See Also:
-
deleteDBClusterSnapshot
default DeleteDbClusterSnapshotResponse deleteDBClusterSnapshot(DeleteDbClusterSnapshotRequest deleteDbClusterSnapshotRequest) throws InvalidDbClusterSnapshotStateException, DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, DocDbException 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.- Parameters:
deleteDbClusterSnapshotRequest
- Represents the input to DeleteDBClusterSnapshot.- Returns:
- Result of the DeleteDBClusterSnapshot operation returned by the service.
- See Also:
-
deleteDBClusterSnapshot
default DeleteDbClusterSnapshotResponse deleteDBClusterSnapshot(Consumer<DeleteDbClusterSnapshotRequest.Builder> deleteDbClusterSnapshotRequest) throws InvalidDbClusterSnapshotStateException, DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, DocDbException 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 viaDeleteDbClusterSnapshotRequest.builder()
- Parameters:
deleteDbClusterSnapshotRequest
- AConsumer
that will call methods onDeleteDbClusterSnapshotRequest.Builder
to create a request. Represents the input to DeleteDBClusterSnapshot.- Returns:
- Result of the DeleteDBClusterSnapshot operation returned by the service.
- See Also:
-
deleteDBInstance
default DeleteDbInstanceResponse deleteDBInstance(DeleteDbInstanceRequest deleteDbInstanceRequest) throws DbInstanceNotFoundException, InvalidDbInstanceStateException, DbSnapshotAlreadyExistsException, SnapshotQuotaExceededException, InvalidDbClusterStateException, AwsServiceException, SdkClientException, DocDbException Deletes a previously provisioned instance.
- Parameters:
deleteDbInstanceRequest
- Represents the input to DeleteDBInstance.- Returns:
- Result of the DeleteDBInstance operation returned by the service.
- See Also:
-
deleteDBInstance
default DeleteDbInstanceResponse deleteDBInstance(Consumer<DeleteDbInstanceRequest.Builder> deleteDbInstanceRequest) throws DbInstanceNotFoundException, InvalidDbInstanceStateException, DbSnapshotAlreadyExistsException, SnapshotQuotaExceededException, InvalidDbClusterStateException, AwsServiceException, SdkClientException, DocDbException Deletes a previously provisioned instance.
This is a convenience which creates an instance of the
DeleteDbInstanceRequest.Builder
avoiding the need to create one manually viaDeleteDbInstanceRequest.builder()
- Parameters:
deleteDbInstanceRequest
- AConsumer
that will call methods onDeleteDbInstanceRequest.Builder
to create a request. Represents the input to DeleteDBInstance.- Returns:
- Result of the DeleteDBInstance operation returned by the service.
- See Also:
-
deleteDBSubnetGroup
default DeleteDbSubnetGroupResponse deleteDBSubnetGroup(DeleteDbSubnetGroupRequest deleteDbSubnetGroupRequest) throws InvalidDbSubnetGroupStateException, InvalidDbSubnetStateException, DbSubnetGroupNotFoundException, AwsServiceException, SdkClientException, DocDbException Deletes a subnet group.
The specified database subnet group must not be associated with any DB instances.
- Parameters:
deleteDbSubnetGroupRequest
- Represents the input to DeleteDBSubnetGroup.- Returns:
- Result of the DeleteDBSubnetGroup operation returned by the service.
- See Also:
-
deleteDBSubnetGroup
default DeleteDbSubnetGroupResponse deleteDBSubnetGroup(Consumer<DeleteDbSubnetGroupRequest.Builder> deleteDbSubnetGroupRequest) throws InvalidDbSubnetGroupStateException, InvalidDbSubnetStateException, DbSubnetGroupNotFoundException, AwsServiceException, SdkClientException, DocDbException 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 viaDeleteDbSubnetGroupRequest.builder()
- Parameters:
deleteDbSubnetGroupRequest
- AConsumer
that will call methods onDeleteDbSubnetGroupRequest.Builder
to create a request. Represents the input to DeleteDBSubnetGroup.- Returns:
- Result of the DeleteDBSubnetGroup operation returned by the service.
- See Also:
-
deleteEventSubscription
default DeleteEventSubscriptionResponse deleteEventSubscription(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest) throws SubscriptionNotFoundException, InvalidEventSubscriptionStateException, AwsServiceException, SdkClientException, DocDbException Deletes an Amazon DocumentDB event notification subscription.
- Parameters:
deleteEventSubscriptionRequest
- Represents the input to DeleteEventSubscription.- Returns:
- Result of the DeleteEventSubscription operation returned by the service.
- See Also:
-
deleteEventSubscription
default DeleteEventSubscriptionResponse deleteEventSubscription(Consumer<DeleteEventSubscriptionRequest.Builder> deleteEventSubscriptionRequest) throws SubscriptionNotFoundException, InvalidEventSubscriptionStateException, AwsServiceException, SdkClientException, DocDbException 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 viaDeleteEventSubscriptionRequest.builder()
- Parameters:
deleteEventSubscriptionRequest
- AConsumer
that will call methods onDeleteEventSubscriptionRequest.Builder
to create a request. Represents the input to DeleteEventSubscription.- Returns:
- Result of the DeleteEventSubscription operation returned by the service.
- See Also:
-
deleteGlobalCluster
default DeleteGlobalClusterResponse deleteGlobalCluster(DeleteGlobalClusterRequest deleteGlobalClusterRequest) throws GlobalClusterNotFoundException, InvalidGlobalClusterStateException, AwsServiceException, SdkClientException, DocDbException 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.
- Parameters:
deleteGlobalClusterRequest
- Represents the input to DeleteGlobalCluster.- Returns:
- Result of the DeleteGlobalCluster operation returned by the service.
- See Also:
-
deleteGlobalCluster
default DeleteGlobalClusterResponse deleteGlobalCluster(Consumer<DeleteGlobalClusterRequest.Builder> deleteGlobalClusterRequest) throws GlobalClusterNotFoundException, InvalidGlobalClusterStateException, AwsServiceException, SdkClientException, DocDbException 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 viaDeleteGlobalClusterRequest.builder()
- Parameters:
deleteGlobalClusterRequest
- AConsumer
that will call methods onDeleteGlobalClusterRequest.Builder
to create a request. Represents the input to DeleteGlobalCluster.- Returns:
- Result of the DeleteGlobalCluster operation returned by the service.
- See Also:
-
describeCertificates
default DescribeCertificatesResponse describeCertificates(DescribeCertificatesRequest describeCertificatesRequest) throws CertificateNotFoundException, AwsServiceException, SdkClientException, DocDbException Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this Amazon Web Services account.
- Parameters:
describeCertificatesRequest
-- Returns:
- Result of the DescribeCertificates operation returned by the service.
- See Also:
-
describeCertificates
default DescribeCertificatesResponse describeCertificates(Consumer<DescribeCertificatesRequest.Builder> describeCertificatesRequest) throws CertificateNotFoundException, AwsServiceException, SdkClientException, DocDbException Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this Amazon Web Services account.
This is a convenience which creates an instance of the
DescribeCertificatesRequest.Builder
avoiding the need to create one manually viaDescribeCertificatesRequest.builder()
- Parameters:
describeCertificatesRequest
- AConsumer
that will call methods onDescribeCertificatesRequest.Builder
to create a request.- Returns:
- Result of the DescribeCertificates operation returned by the service.
- See Also:
-
describeCertificatesPaginator
default DescribeCertificatesIterable describeCertificatesPaginator(DescribeCertificatesRequest describeCertificatesRequest) throws CertificateNotFoundException, AwsServiceException, SdkClientException, DocDbException This is a variant of
describeCertificates(software.amazon.awssdk.services.docdb.model.DescribeCertificatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.docdb.paginators.DescribeCertificatesIterable responses = client.describeCertificatesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.docdb.paginators.DescribeCertificatesIterable responses = client .describeCertificatesPaginator(request); for (software.amazon.awssdk.services.docdb.model.DescribeCertificatesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.docdb.paginators.DescribeCertificatesIterable responses = client.describeCertificatesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeCertificates(software.amazon.awssdk.services.docdb.model.DescribeCertificatesRequest)
operation.- Parameters:
describeCertificatesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeCertificatesPaginator
default DescribeCertificatesIterable describeCertificatesPaginator(Consumer<DescribeCertificatesRequest.Builder> describeCertificatesRequest) throws CertificateNotFoundException, AwsServiceException, SdkClientException, DocDbException This is a variant of
describeCertificates(software.amazon.awssdk.services.docdb.model.DescribeCertificatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.docdb.paginators.DescribeCertificatesIterable responses = client.describeCertificatesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.docdb.paginators.DescribeCertificatesIterable responses = client .describeCertificatesPaginator(request); for (software.amazon.awssdk.services.docdb.model.DescribeCertificatesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.docdb.paginators.DescribeCertificatesIterable responses = client.describeCertificatesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 viaDescribeCertificatesRequest.builder()
- Parameters:
describeCertificatesRequest
- AConsumer
that will call methods onDescribeCertificatesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBClusterParameterGroups
default DescribeDbClusterParameterGroupsResponse describeDBClusterParameterGroups(DescribeDbClusterParameterGroupsRequest describeDbClusterParameterGroupsRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, DocDbException Returns a list of
DBClusterParameterGroup
descriptions. If aDBClusterParameterGroupName
parameter is specified, the list contains only the description of the specified cluster parameter group.- Parameters:
describeDbClusterParameterGroupsRequest
- Represents the input to DescribeDBClusterParameterGroups.- Returns:
- Result of the DescribeDBClusterParameterGroups operation returned by the service.
- See Also:
-
describeDBClusterParameterGroups
default DescribeDbClusterParameterGroupsResponse describeDBClusterParameterGroups(Consumer<DescribeDbClusterParameterGroupsRequest.Builder> describeDbClusterParameterGroupsRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, DocDbException Returns a list of
DBClusterParameterGroup
descriptions. If aDBClusterParameterGroupName
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 viaDescribeDbClusterParameterGroupsRequest.builder()
- Parameters:
describeDbClusterParameterGroupsRequest
- AConsumer
that will call methods onDescribeDbClusterParameterGroupsRequest.Builder
to create a request. Represents the input to DescribeDBClusterParameterGroups.- Returns:
- Result of the DescribeDBClusterParameterGroups operation returned by the service.
- See Also:
-
describeDBClusterParameterGroups
default DescribeDbClusterParameterGroupsResponse describeDBClusterParameterGroups() throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, DocDbExceptionReturns a list of
DBClusterParameterGroup
descriptions. If aDBClusterParameterGroupName
parameter is specified, the list contains only the description of the specified cluster parameter group.- Returns:
- Result of the DescribeDBClusterParameterGroups operation returned by the service.
- See Also:
-
describeDBClusterParameterGroupsPaginator
default DescribeDBClusterParameterGroupsIterable describeDBClusterParameterGroupsPaginator() throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, DocDbExceptionThis is a variant of
describeDBClusterParameterGroups(software.amazon.awssdk.services.docdb.model.DescribeDbClusterParameterGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.docdb.paginators.DescribeDBClusterParameterGroupsIterable responses = client.describeDBClusterParameterGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.docdb.paginators.DescribeDBClusterParameterGroupsIterable responses = client .describeDBClusterParameterGroupsPaginator(request); for (software.amazon.awssdk.services.docdb.model.DescribeDbClusterParameterGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.docdb.paginators.DescribeDBClusterParameterGroupsIterable responses = client.describeDBClusterParameterGroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusterParameterGroups(software.amazon.awssdk.services.docdb.model.DescribeDbClusterParameterGroupsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBClusterParameterGroupsPaginator
default DescribeDBClusterParameterGroupsIterable describeDBClusterParameterGroupsPaginator(DescribeDbClusterParameterGroupsRequest describeDbClusterParameterGroupsRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, DocDbException This is a variant of
describeDBClusterParameterGroups(software.amazon.awssdk.services.docdb.model.DescribeDbClusterParameterGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.docdb.paginators.DescribeDBClusterParameterGroupsIterable responses = client.describeDBClusterParameterGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.docdb.paginators.DescribeDBClusterParameterGroupsIterable responses = client .describeDBClusterParameterGroupsPaginator(request); for (software.amazon.awssdk.services.docdb.model.DescribeDbClusterParameterGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.docdb.paginators.DescribeDBClusterParameterGroupsIterable responses = client.describeDBClusterParameterGroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusterParameterGroups(software.amazon.awssdk.services.docdb.model.DescribeDbClusterParameterGroupsRequest)
operation.- Parameters:
describeDbClusterParameterGroupsRequest
- Represents the input to DescribeDBClusterParameterGroups.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBClusterParameterGroupsPaginator
default DescribeDBClusterParameterGroupsIterable describeDBClusterParameterGroupsPaginator(Consumer<DescribeDbClusterParameterGroupsRequest.Builder> describeDbClusterParameterGroupsRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, DocDbException This is a variant of
describeDBClusterParameterGroups(software.amazon.awssdk.services.docdb.model.DescribeDbClusterParameterGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.docdb.paginators.DescribeDBClusterParameterGroupsIterable responses = client.describeDBClusterParameterGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.docdb.paginators.DescribeDBClusterParameterGroupsIterable responses = client .describeDBClusterParameterGroupsPaginator(request); for (software.amazon.awssdk.services.docdb.model.DescribeDbClusterParameterGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.docdb.paginators.DescribeDBClusterParameterGroupsIterable responses = client.describeDBClusterParameterGroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusterParameterGroups(software.amazon.awssdk.services.docdb.model.DescribeDbClusterParameterGroupsRequest)
operation.
This is a convenience which creates an instance of the
DescribeDbClusterParameterGroupsRequest.Builder
avoiding the need to create one manually viaDescribeDbClusterParameterGroupsRequest.builder()
- Parameters:
describeDbClusterParameterGroupsRequest
- AConsumer
that will call methods onDescribeDbClusterParameterGroupsRequest.Builder
to create a request. Represents the input to DescribeDBClusterParameterGroups.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBClusterParameters
default DescribeDbClusterParametersResponse describeDBClusterParameters(DescribeDbClusterParametersRequest describeDbClusterParametersRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, DocDbException Returns the detailed parameter list for a particular cluster parameter group.
- Parameters:
describeDbClusterParametersRequest
- Represents the input to DescribeDBClusterParameters.- Returns:
- Result of the DescribeDBClusterParameters operation returned by the service.
- See Also:
-
describeDBClusterParameters
default DescribeDbClusterParametersResponse describeDBClusterParameters(Consumer<DescribeDbClusterParametersRequest.Builder> describeDbClusterParametersRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, DocDbException 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 viaDescribeDbClusterParametersRequest.builder()
- Parameters:
describeDbClusterParametersRequest
- AConsumer
that will call methods onDescribeDbClusterParametersRequest.Builder
to create a request. Represents the input to DescribeDBClusterParameters.- Returns:
- Result of the DescribeDBClusterParameters operation returned by the service.
- See Also:
-
describeDBClusterParametersPaginator
default DescribeDBClusterParametersIterable describeDBClusterParametersPaginator(DescribeDbClusterParametersRequest describeDbClusterParametersRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, DocDbException This is a variant of
describeDBClusterParameters(software.amazon.awssdk.services.docdb.model.DescribeDbClusterParametersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.docdb.paginators.DescribeDBClusterParametersIterable responses = client.describeDBClusterParametersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.docdb.paginators.DescribeDBClusterParametersIterable responses = client .describeDBClusterParametersPaginator(request); for (software.amazon.awssdk.services.docdb.model.DescribeDbClusterParametersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.docdb.paginators.DescribeDBClusterParametersIterable responses = client.describeDBClusterParametersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusterParameters(software.amazon.awssdk.services.docdb.model.DescribeDbClusterParametersRequest)
operation.- Parameters:
describeDbClusterParametersRequest
- Represents the input to DescribeDBClusterParameters.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBClusterParametersPaginator
default DescribeDBClusterParametersIterable describeDBClusterParametersPaginator(Consumer<DescribeDbClusterParametersRequest.Builder> describeDbClusterParametersRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, DocDbException This is a variant of
describeDBClusterParameters(software.amazon.awssdk.services.docdb.model.DescribeDbClusterParametersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.docdb.paginators.DescribeDBClusterParametersIterable responses = client.describeDBClusterParametersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.docdb.paginators.DescribeDBClusterParametersIterable responses = client .describeDBClusterParametersPaginator(request); for (software.amazon.awssdk.services.docdb.model.DescribeDbClusterParametersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.docdb.paginators.DescribeDBClusterParametersIterable responses = client.describeDBClusterParametersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusterParameters(software.amazon.awssdk.services.docdb.model.DescribeDbClusterParametersRequest)
operation.
This is a convenience which creates an instance of the
DescribeDbClusterParametersRequest.Builder
avoiding the need to create one manually viaDescribeDbClusterParametersRequest.builder()
- Parameters:
describeDbClusterParametersRequest
- AConsumer
that will call methods onDescribeDbClusterParametersRequest.Builder
to create a request. Represents the input to DescribeDBClusterParameters.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBClusterSnapshotAttributes
default DescribeDbClusterSnapshotAttributesResponse describeDBClusterSnapshotAttributes(DescribeDbClusterSnapshotAttributesRequest describeDbClusterSnapshotAttributesRequest) throws DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, DocDbException Returns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot.
When you share snapshots with other Amazon Web Services accounts,
DescribeDBClusterSnapshotAttributes
returns therestore
attribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore the manual cluster snapshot. Ifall
is included in the list of values for therestore
attribute, then the manual cluster snapshot is public and can be copied or restored by all Amazon Web Services accounts.- Parameters:
describeDbClusterSnapshotAttributesRequest
- Represents the input to DescribeDBClusterSnapshotAttributes.- Returns:
- Result of the DescribeDBClusterSnapshotAttributes operation returned by the service.
- See Also:
-
describeDBClusterSnapshotAttributes
default DescribeDbClusterSnapshotAttributesResponse describeDBClusterSnapshotAttributes(Consumer<DescribeDbClusterSnapshotAttributesRequest.Builder> describeDbClusterSnapshotAttributesRequest) throws DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, DocDbException Returns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot.
When you share snapshots with other Amazon Web Services accounts,
DescribeDBClusterSnapshotAttributes
returns therestore
attribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore the manual cluster snapshot. Ifall
is included in the list of values for therestore
attribute, then the manual cluster snapshot is public and can be copied or restored by all Amazon Web Services accounts.
This is a convenience which creates an instance of the
DescribeDbClusterSnapshotAttributesRequest.Builder
avoiding the need to create one manually viaDescribeDbClusterSnapshotAttributesRequest.builder()
- Parameters:
describeDbClusterSnapshotAttributesRequest
- AConsumer
that will call methods onDescribeDbClusterSnapshotAttributesRequest.Builder
to create a request. Represents the input to DescribeDBClusterSnapshotAttributes.- Returns:
- Result of the DescribeDBClusterSnapshotAttributes operation returned by the service.
- See Also:
-
describeDBClusterSnapshots
default DescribeDbClusterSnapshotsResponse describeDBClusterSnapshots(DescribeDbClusterSnapshotsRequest describeDbClusterSnapshotsRequest) throws DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, DocDbException Returns information about cluster snapshots. This API operation supports pagination.
- Parameters:
describeDbClusterSnapshotsRequest
- Represents the input to DescribeDBClusterSnapshots.- Returns:
- Result of the DescribeDBClusterSnapshots operation returned by the service.
- See Also:
-
describeDBClusterSnapshots
default DescribeDbClusterSnapshotsResponse describeDBClusterSnapshots(Consumer<DescribeDbClusterSnapshotsRequest.Builder> describeDbClusterSnapshotsRequest) throws DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, DocDbException 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 viaDescribeDbClusterSnapshotsRequest.builder()
- Parameters:
describeDbClusterSnapshotsRequest
- AConsumer
that will call methods onDescribeDbClusterSnapshotsRequest.Builder
to create a request. Represents the input to DescribeDBClusterSnapshots.- Returns:
- Result of the DescribeDBClusterSnapshots operation returned by the service.
- See Also:
-
describeDBClusterSnapshots
default DescribeDbClusterSnapshotsResponse describeDBClusterSnapshots() throws DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, DocDbExceptionReturns information about cluster snapshots. This API operation supports pagination.
- Returns:
- Result of the DescribeDBClusterSnapshots operation returned by the service.
- See Also:
-
describeDBClusterSnapshotsPaginator
default DescribeDBClusterSnapshotsIterable describeDBClusterSnapshotsPaginator() throws DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, DocDbExceptionThis is a variant of
describeDBClusterSnapshots(software.amazon.awssdk.services.docdb.model.DescribeDbClusterSnapshotsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.docdb.paginators.DescribeDBClusterSnapshotsIterable responses = client.describeDBClusterSnapshotsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.docdb.paginators.DescribeDBClusterSnapshotsIterable responses = client .describeDBClusterSnapshotsPaginator(request); for (software.amazon.awssdk.services.docdb.model.DescribeDbClusterSnapshotsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.docdb.paginators.DescribeDBClusterSnapshotsIterable responses = client.describeDBClusterSnapshotsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusterSnapshots(software.amazon.awssdk.services.docdb.model.DescribeDbClusterSnapshotsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBClusterSnapshotsPaginator
default DescribeDBClusterSnapshotsIterable describeDBClusterSnapshotsPaginator(DescribeDbClusterSnapshotsRequest describeDbClusterSnapshotsRequest) throws DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, DocDbException This is a variant of
describeDBClusterSnapshots(software.amazon.awssdk.services.docdb.model.DescribeDbClusterSnapshotsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.docdb.paginators.DescribeDBClusterSnapshotsIterable responses = client.describeDBClusterSnapshotsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.docdb.paginators.DescribeDBClusterSnapshotsIterable responses = client .describeDBClusterSnapshotsPaginator(request); for (software.amazon.awssdk.services.docdb.model.DescribeDbClusterSnapshotsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.docdb.paginators.DescribeDBClusterSnapshotsIterable responses = client.describeDBClusterSnapshotsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusterSnapshots(software.amazon.awssdk.services.docdb.model.DescribeDbClusterSnapshotsRequest)
operation.- Parameters:
describeDbClusterSnapshotsRequest
- Represents the input to DescribeDBClusterSnapshots.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBClusterSnapshotsPaginator
default DescribeDBClusterSnapshotsIterable describeDBClusterSnapshotsPaginator(Consumer<DescribeDbClusterSnapshotsRequest.Builder> describeDbClusterSnapshotsRequest) throws DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, DocDbException This is a variant of
describeDBClusterSnapshots(software.amazon.awssdk.services.docdb.model.DescribeDbClusterSnapshotsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.docdb.paginators.DescribeDBClusterSnapshotsIterable responses = client.describeDBClusterSnapshotsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.docdb.paginators.DescribeDBClusterSnapshotsIterable responses = client .describeDBClusterSnapshotsPaginator(request); for (software.amazon.awssdk.services.docdb.model.DescribeDbClusterSnapshotsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.docdb.paginators.DescribeDBClusterSnapshotsIterable responses = client.describeDBClusterSnapshotsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusterSnapshots(software.amazon.awssdk.services.docdb.model.DescribeDbClusterSnapshotsRequest)
operation.
This is a convenience which creates an instance of the
DescribeDbClusterSnapshotsRequest.Builder
avoiding the need to create one manually viaDescribeDbClusterSnapshotsRequest.builder()
- Parameters:
describeDbClusterSnapshotsRequest
- AConsumer
that will call methods onDescribeDbClusterSnapshotsRequest.Builder
to create a request. Represents the input to DescribeDBClusterSnapshots.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBClusters
default DescribeDbClustersResponse describeDBClusters(DescribeDbClustersRequest describeDbClustersRequest) throws DbClusterNotFoundException, AwsServiceException, SdkClientException, DocDbException 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.- Parameters:
describeDbClustersRequest
- Represents the input to DescribeDBClusters.- Returns:
- Result of the DescribeDBClusters operation returned by the service.
- See Also:
-
describeDBClusters
default DescribeDbClustersResponse describeDBClusters(Consumer<DescribeDbClustersRequest.Builder> describeDbClustersRequest) throws DbClusterNotFoundException, AwsServiceException, SdkClientException, DocDbException 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 viaDescribeDbClustersRequest.builder()
- Parameters:
describeDbClustersRequest
- AConsumer
that will call methods onDescribeDbClustersRequest.Builder
to create a request. Represents the input to DescribeDBClusters.- Returns:
- Result of the DescribeDBClusters operation returned by the service.
- See Also:
-
describeDBClusters
default DescribeDbClustersResponse describeDBClusters() throws DbClusterNotFoundException, AwsServiceException, SdkClientException, DocDbExceptionReturns 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.- Returns:
- Result of the DescribeDBClusters operation returned by the service.
- See Also:
-
describeDBClustersPaginator
default DescribeDBClustersIterable describeDBClustersPaginator() throws DbClusterNotFoundException, AwsServiceException, SdkClientException, DocDbExceptionThis is a variant of
describeDBClusters(software.amazon.awssdk.services.docdb.model.DescribeDbClustersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.docdb.paginators.DescribeDBClustersIterable responses = client.describeDBClustersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.docdb.paginators.DescribeDBClustersIterable responses = client .describeDBClustersPaginator(request); for (software.amazon.awssdk.services.docdb.model.DescribeDbClustersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.docdb.paginators.DescribeDBClustersIterable responses = client.describeDBClustersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusters(software.amazon.awssdk.services.docdb.model.DescribeDbClustersRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBClustersPaginator
default DescribeDBClustersIterable describeDBClustersPaginator(DescribeDbClustersRequest describeDbClustersRequest) throws DbClusterNotFoundException, AwsServiceException, SdkClientException, DocDbException This is a variant of
describeDBClusters(software.amazon.awssdk.services.docdb.model.DescribeDbClustersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.docdb.paginators.DescribeDBClustersIterable responses = client.describeDBClustersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.docdb.paginators.DescribeDBClustersIterable responses = client .describeDBClustersPaginator(request); for (software.amazon.awssdk.services.docdb.model.DescribeDbClustersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.docdb.paginators.DescribeDBClustersIterable responses = client.describeDBClustersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusters(software.amazon.awssdk.services.docdb.model.DescribeDbClustersRequest)
operation.- Parameters:
describeDbClustersRequest
- Represents the input to DescribeDBClusters.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBClustersPaginator
default DescribeDBClustersIterable describeDBClustersPaginator(Consumer<DescribeDbClustersRequest.Builder> describeDbClustersRequest) throws DbClusterNotFoundException, AwsServiceException, SdkClientException, DocDbException This is a variant of
describeDBClusters(software.amazon.awssdk.services.docdb.model.DescribeDbClustersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.docdb.paginators.DescribeDBClustersIterable responses = client.describeDBClustersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.docdb.paginators.DescribeDBClustersIterable responses = client .describeDBClustersPaginator(request); for (software.amazon.awssdk.services.docdb.model.DescribeDbClustersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.docdb.paginators.DescribeDBClustersIterable responses = client.describeDBClustersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusters(software.amazon.awssdk.services.docdb.model.DescribeDbClustersRequest)
operation.
This is a convenience which creates an instance of the
DescribeDbClustersRequest.Builder
avoiding the need to create one manually viaDescribeDbClustersRequest.builder()
- Parameters:
describeDbClustersRequest
- AConsumer
that will call methods onDescribeDbClustersRequest.Builder
to create a request. Represents the input to DescribeDBClusters.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBEngineVersions
default DescribeDbEngineVersionsResponse describeDBEngineVersions(DescribeDbEngineVersionsRequest describeDbEngineVersionsRequest) throws AwsServiceException, SdkClientException, DocDbException Returns a list of the available engines.
- Parameters:
describeDbEngineVersionsRequest
- Represents the input to DescribeDBEngineVersions.- Returns:
- Result of the DescribeDBEngineVersions operation returned by the service.
- See Also:
-
describeDBEngineVersions
default DescribeDbEngineVersionsResponse describeDBEngineVersions(Consumer<DescribeDbEngineVersionsRequest.Builder> describeDbEngineVersionsRequest) throws AwsServiceException, SdkClientException, DocDbException 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 viaDescribeDbEngineVersionsRequest.builder()
- Parameters:
describeDbEngineVersionsRequest
- AConsumer
that will call methods onDescribeDbEngineVersionsRequest.Builder
to create a request. Represents the input to DescribeDBEngineVersions.- Returns:
- Result of the DescribeDBEngineVersions operation returned by the service.
- See Also:
-
describeDBEngineVersions
default DescribeDbEngineVersionsResponse describeDBEngineVersions() throws AwsServiceException, SdkClientException, DocDbExceptionReturns a list of the available engines.
- Returns:
- Result of the DescribeDBEngineVersions operation returned by the service.
- See Also:
-
describeDBEngineVersionsPaginator
default DescribeDBEngineVersionsIterable describeDBEngineVersionsPaginator() throws AwsServiceException, SdkClientException, DocDbExceptionThis is a variant of
describeDBEngineVersions(software.amazon.awssdk.services.docdb.model.DescribeDbEngineVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.docdb.paginators.DescribeDBEngineVersionsIterable responses = client.describeDBEngineVersionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.docdb.paginators.DescribeDBEngineVersionsIterable responses = client .describeDBEngineVersionsPaginator(request); for (software.amazon.awssdk.services.docdb.model.DescribeDbEngineVersionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.docdb.paginators.DescribeDBEngineVersionsIterable responses = client.describeDBEngineVersionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBEngineVersions(software.amazon.awssdk.services.docdb.model.DescribeDbEngineVersionsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBEngineVersionsPaginator
default DescribeDBEngineVersionsIterable describeDBEngineVersionsPaginator(DescribeDbEngineVersionsRequest describeDbEngineVersionsRequest) throws AwsServiceException, SdkClientException, DocDbException This is a variant of
describeDBEngineVersions(software.amazon.awssdk.services.docdb.model.DescribeDbEngineVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.docdb.paginators.DescribeDBEngineVersionsIterable responses = client.describeDBEngineVersionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.docdb.paginators.DescribeDBEngineVersionsIterable responses = client .describeDBEngineVersionsPaginator(request); for (software.amazon.awssdk.services.docdb.model.DescribeDbEngineVersionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.docdb.paginators.DescribeDBEngineVersionsIterable responses = client.describeDBEngineVersionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBEngineVersions(software.amazon.awssdk.services.docdb.model.DescribeDbEngineVersionsRequest)
operation.- Parameters:
describeDbEngineVersionsRequest
- Represents the input to DescribeDBEngineVersions.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBEngineVersionsPaginator
default DescribeDBEngineVersionsIterable describeDBEngineVersionsPaginator(Consumer<DescribeDbEngineVersionsRequest.Builder> describeDbEngineVersionsRequest) throws AwsServiceException, SdkClientException, DocDbException This is a variant of
describeDBEngineVersions(software.amazon.awssdk.services.docdb.model.DescribeDbEngineVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.docdb.paginators.DescribeDBEngineVersionsIterable responses = client.describeDBEngineVersionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.docdb.paginators.DescribeDBEngineVersionsIterable responses = client .describeDBEngineVersionsPaginator(request); for (software.amazon.awssdk.services.docdb.model.DescribeDbEngineVersionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.docdb.paginators.DescribeDBEngineVersionsIterable responses = client.describeDBEngineVersionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBEngineVersions(software.amazon.awssdk.services.docdb.model.DescribeDbEngineVersionsRequest)
operation.
This is a convenience which creates an instance of the
DescribeDbEngineVersionsRequest.Builder
avoiding the need to create one manually viaDescribeDbEngineVersionsRequest.builder()
- Parameters:
describeDbEngineVersionsRequest
- AConsumer
that will call methods onDescribeDbEngineVersionsRequest.Builder
to create a request. Represents the input to DescribeDBEngineVersions.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBInstances
default DescribeDbInstancesResponse describeDBInstances(DescribeDbInstancesRequest describeDbInstancesRequest) throws DbInstanceNotFoundException, AwsServiceException, SdkClientException, DocDbException Returns information about provisioned Amazon DocumentDB instances. This API supports pagination.
- Parameters:
describeDbInstancesRequest
- Represents the input to DescribeDBInstances.- Returns:
- Result of the DescribeDBInstances operation returned by the service.
- See Also:
-
describeDBInstances
default DescribeDbInstancesResponse describeDBInstances(Consumer<DescribeDbInstancesRequest.Builder> describeDbInstancesRequest) throws DbInstanceNotFoundException, AwsServiceException, SdkClientException, DocDbException 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 viaDescribeDbInstancesRequest.builder()
- Parameters:
describeDbInstancesRequest
- AConsumer
that will call methods onDescribeDbInstancesRequest.Builder
to create a request. Represents the input to DescribeDBInstances.- Returns:
- Result of the DescribeDBInstances operation returned by the service.
- See Also:
-
describeDBInstances
default DescribeDbInstancesResponse describeDBInstances() throws DbInstanceNotFoundException, AwsServiceException, SdkClientException, DocDbExceptionReturns information about provisioned Amazon DocumentDB instances. This API supports pagination.
- Returns:
- Result of the DescribeDBInstances operation returned by the service.
- See Also:
-
describeDBInstancesPaginator
default DescribeDBInstancesIterable describeDBInstancesPaginator() throws DbInstanceNotFoundException, AwsServiceException, SdkClientException, DocDbExceptionThis is a variant of
describeDBInstances(software.amazon.awssdk.services.docdb.model.DescribeDbInstancesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.docdb.paginators.DescribeDBInstancesIterable responses = client.describeDBInstancesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.docdb.paginators.DescribeDBInstancesIterable responses = client .describeDBInstancesPaginator(request); for (software.amazon.awssdk.services.docdb.model.DescribeDbInstancesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.docdb.paginators.DescribeDBInstancesIterable responses = client.describeDBInstancesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBInstances(software.amazon.awssdk.services.docdb.model.DescribeDbInstancesRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBInstancesPaginator
default DescribeDBInstancesIterable describeDBInstancesPaginator(DescribeDbInstancesRequest describeDbInstancesRequest) throws DbInstanceNotFoundException, AwsServiceException, SdkClientException, DocDbException This is a variant of
describeDBInstances(software.amazon.awssdk.services.docdb.model.DescribeDbInstancesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.docdb.paginators.DescribeDBInstancesIterable responses = client.describeDBInstancesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.docdb.paginators.DescribeDBInstancesIterable responses = client .describeDBInstancesPaginator(request); for (software.amazon.awssdk.services.docdb.model.DescribeDbInstancesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.docdb.paginators.DescribeDBInstancesIterable responses = client.describeDBInstancesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBInstances(software.amazon.awssdk.services.docdb.model.DescribeDbInstancesRequest)
operation.- Parameters:
describeDbInstancesRequest
- Represents the input to DescribeDBInstances.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBInstancesPaginator
default DescribeDBInstancesIterable describeDBInstancesPaginator(Consumer<DescribeDbInstancesRequest.Builder> describeDbInstancesRequest) throws DbInstanceNotFoundException, AwsServiceException, SdkClientException, DocDbException This is a variant of
describeDBInstances(software.amazon.awssdk.services.docdb.model.DescribeDbInstancesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.docdb.paginators.DescribeDBInstancesIterable responses = client.describeDBInstancesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.docdb.paginators.DescribeDBInstancesIterable responses = client .describeDBInstancesPaginator(request); for (software.amazon.awssdk.services.docdb.model.DescribeDbInstancesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.docdb.paginators.DescribeDBInstancesIterable responses = client.describeDBInstancesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBInstances(software.amazon.awssdk.services.docdb.model.DescribeDbInstancesRequest)
operation.
This is a convenience which creates an instance of the
DescribeDbInstancesRequest.Builder
avoiding the need to create one manually viaDescribeDbInstancesRequest.builder()
- Parameters:
describeDbInstancesRequest
- AConsumer
that will call methods onDescribeDbInstancesRequest.Builder
to create a request. Represents the input to DescribeDBInstances.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBSubnetGroups
default DescribeDbSubnetGroupsResponse describeDBSubnetGroups(DescribeDbSubnetGroupsRequest describeDbSubnetGroupsRequest) throws DbSubnetGroupNotFoundException, AwsServiceException, SdkClientException, DocDbException Returns a list of
DBSubnetGroup
descriptions. If aDBSubnetGroupName
is specified, the list will contain only the descriptions of the specifiedDBSubnetGroup
.- Parameters:
describeDbSubnetGroupsRequest
- Represents the input to DescribeDBSubnetGroups.- Returns:
- Result of the DescribeDBSubnetGroups operation returned by the service.
- See Also:
-
describeDBSubnetGroups
default DescribeDbSubnetGroupsResponse describeDBSubnetGroups(Consumer<DescribeDbSubnetGroupsRequest.Builder> describeDbSubnetGroupsRequest) throws DbSubnetGroupNotFoundException, AwsServiceException, SdkClientException, DocDbException Returns a list of
DBSubnetGroup
descriptions. If aDBSubnetGroupName
is specified, the list will contain only the descriptions of the specifiedDBSubnetGroup
.
This is a convenience which creates an instance of the
DescribeDbSubnetGroupsRequest.Builder
avoiding the need to create one manually viaDescribeDbSubnetGroupsRequest.builder()
- Parameters:
describeDbSubnetGroupsRequest
- AConsumer
that will call methods onDescribeDbSubnetGroupsRequest.Builder
to create a request. Represents the input to DescribeDBSubnetGroups.- Returns:
- Result of the DescribeDBSubnetGroups operation returned by the service.
- See Also:
-
describeDBSubnetGroups
default DescribeDbSubnetGroupsResponse describeDBSubnetGroups() throws DbSubnetGroupNotFoundException, AwsServiceException, SdkClientException, DocDbExceptionReturns a list of
DBSubnetGroup
descriptions. If aDBSubnetGroupName
is specified, the list will contain only the descriptions of the specifiedDBSubnetGroup
.- Returns:
- Result of the DescribeDBSubnetGroups operation returned by the service.
- See Also:
-
describeDBSubnetGroupsPaginator
default DescribeDBSubnetGroupsIterable describeDBSubnetGroupsPaginator() throws DbSubnetGroupNotFoundException, AwsServiceException, SdkClientException, DocDbExceptionThis is a variant of
describeDBSubnetGroups(software.amazon.awssdk.services.docdb.model.DescribeDbSubnetGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.docdb.paginators.DescribeDBSubnetGroupsIterable responses = client.describeDBSubnetGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.docdb.paginators.DescribeDBSubnetGroupsIterable responses = client .describeDBSubnetGroupsPaginator(request); for (software.amazon.awssdk.services.docdb.model.DescribeDbSubnetGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.docdb.paginators.DescribeDBSubnetGroupsIterable responses = client.describeDBSubnetGroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBSubnetGroups(software.amazon.awssdk.services.docdb.model.DescribeDbSubnetGroupsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBSubnetGroupsPaginator
default DescribeDBSubnetGroupsIterable describeDBSubnetGroupsPaginator(DescribeDbSubnetGroupsRequest describeDbSubnetGroupsRequest) throws DbSubnetGroupNotFoundException, AwsServiceException, SdkClientException, DocDbException This is a variant of
describeDBSubnetGroups(software.amazon.awssdk.services.docdb.model.DescribeDbSubnetGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.docdb.paginators.DescribeDBSubnetGroupsIterable responses = client.describeDBSubnetGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.docdb.paginators.DescribeDBSubnetGroupsIterable responses = client .describeDBSubnetGroupsPaginator(request); for (software.amazon.awssdk.services.docdb.model.DescribeDbSubnetGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.docdb.paginators.DescribeDBSubnetGroupsIterable responses = client.describeDBSubnetGroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBSubnetGroups(software.amazon.awssdk.services.docdb.model.DescribeDbSubnetGroupsRequest)
operation.- Parameters:
describeDbSubnetGroupsRequest
- Represents the input to DescribeDBSubnetGroups.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeDBSubnetGroupsPaginator
default DescribeDBSubnetGroupsIterable describeDBSubnetGroupsPaginator(Consumer<DescribeDbSubnetGroupsRequest.Builder> describeDbSubnetGroupsRequest) throws DbSubnetGroupNotFoundException, AwsServiceException, SdkClientException, DocDbException This is a variant of
describeDBSubnetGroups(software.amazon.awssdk.services.docdb.model.DescribeDbSubnetGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.docdb.paginators.DescribeDBSubnetGroupsIterable responses = client.describeDBSubnetGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.docdb.paginators.DescribeDBSubnetGroupsIterable responses = client .describeDBSubnetGroupsPaginator(request); for (software.amazon.awssdk.services.docdb.model.DescribeDbSubnetGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.docdb.paginators.DescribeDBSubnetGroupsIterable responses = client.describeDBSubnetGroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBSubnetGroups(software.amazon.awssdk.services.docdb.model.DescribeDbSubnetGroupsRequest)
operation.
This is a convenience which creates an instance of the
DescribeDbSubnetGroupsRequest.Builder
avoiding the need to create one manually viaDescribeDbSubnetGroupsRequest.builder()
- Parameters:
describeDbSubnetGroupsRequest
- AConsumer
that will call methods onDescribeDbSubnetGroupsRequest.Builder
to create a request. Represents the input to DescribeDBSubnetGroups.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeEngineDefaultClusterParameters
default DescribeEngineDefaultClusterParametersResponse describeEngineDefaultClusterParameters(DescribeEngineDefaultClusterParametersRequest describeEngineDefaultClusterParametersRequest) throws AwsServiceException, SdkClientException, DocDbException Returns the default engine and system parameter information for the cluster database engine.
- Parameters:
describeEngineDefaultClusterParametersRequest
- Represents the input to DescribeEngineDefaultClusterParameters.- Returns:
- Result of the DescribeEngineDefaultClusterParameters operation returned by the service.
- See Also:
-
describeEngineDefaultClusterParameters
default DescribeEngineDefaultClusterParametersResponse describeEngineDefaultClusterParameters(Consumer<DescribeEngineDefaultClusterParametersRequest.Builder> describeEngineDefaultClusterParametersRequest) throws AwsServiceException, SdkClientException, DocDbException Returns the default engine and system parameter information for the cluster database engine.
This is a convenience which creates an instance of the
DescribeEngineDefaultClusterParametersRequest.Builder
avoiding the need to create one manually viaDescribeEngineDefaultClusterParametersRequest.builder()
- Parameters:
describeEngineDefaultClusterParametersRequest
- AConsumer
that will call methods onDescribeEngineDefaultClusterParametersRequest.Builder
to create a request. Represents the input to DescribeEngineDefaultClusterParameters.- Returns:
- Result of the DescribeEngineDefaultClusterParameters operation returned by the service.
- See Also:
-
describeEventCategories
default DescribeEventCategoriesResponse describeEventCategories(DescribeEventCategoriesRequest describeEventCategoriesRequest) throws AwsServiceException, SdkClientException, DocDbException Displays a list of categories for all event source types, or, if specified, for a specified source type.
- Parameters:
describeEventCategoriesRequest
- Represents the input to DescribeEventCategories.- Returns:
- Result of the DescribeEventCategories operation returned by the service.
- See Also:
-
describeEventCategories
default DescribeEventCategoriesResponse describeEventCategories(Consumer<DescribeEventCategoriesRequest.Builder> describeEventCategoriesRequest) throws AwsServiceException, SdkClientException, DocDbException Displays a list of categories for all event source types, or, if specified, for a specified source type.
This is a convenience which creates an instance of the
DescribeEventCategoriesRequest.Builder
avoiding the need to create one manually viaDescribeEventCategoriesRequest.builder()
- Parameters:
describeEventCategoriesRequest
- AConsumer
that will call methods onDescribeEventCategoriesRequest.Builder
to create a request. Represents the input to DescribeEventCategories.- Returns:
- Result of the DescribeEventCategories operation returned by the service.
- See Also:
-
describeEventCategories
default DescribeEventCategoriesResponse describeEventCategories() throws AwsServiceException, SdkClientException, DocDbExceptionDisplays a list of categories for all event source types, or, if specified, for a specified source type.
- Returns:
- Result of the DescribeEventCategories operation returned by the service.
- See Also:
-
describeEventSubscriptions
default DescribeEventSubscriptionsResponse describeEventSubscriptions(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest) throws SubscriptionNotFoundException, AwsServiceException, SdkClientException, DocDbException Lists all the subscription descriptions for a customer account. The description for a subscription includes
SubscriptionName
,SNSTopicARN
,CustomerID
,SourceType
,SourceID
,CreationTime
, andStatus
.If you specify a
SubscriptionName
, lists the description for that subscription.- Parameters:
describeEventSubscriptionsRequest
- Represents the input to DescribeEventSubscriptions.- Returns:
- Result of the DescribeEventSubscriptions operation returned by the service.
- See Also:
-
describeEventSubscriptions
default DescribeEventSubscriptionsResponse describeEventSubscriptions(Consumer<DescribeEventSubscriptionsRequest.Builder> describeEventSubscriptionsRequest) throws SubscriptionNotFoundException, AwsServiceException, SdkClientException, DocDbException Lists all the subscription descriptions for a customer account. The description for a subscription includes
SubscriptionName
,SNSTopicARN
,CustomerID
,SourceType
,SourceID
,CreationTime
, andStatus
.If you specify a
SubscriptionName
, lists the description for that subscription.
This is a convenience which creates an instance of the
DescribeEventSubscriptionsRequest.Builder
avoiding the need to create one manually viaDescribeEventSubscriptionsRequest.builder()
- Parameters:
describeEventSubscriptionsRequest
- AConsumer
that will call methods onDescribeEventSubscriptionsRequest.Builder
to create a request. Represents the input to DescribeEventSubscriptions.- Returns:
- Result of the DescribeEventSubscriptions operation returned by the service.
- See Also:
-
describeEventSubscriptionsPaginator
default DescribeEventSubscriptionsIterable describeEventSubscriptionsPaginator(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest) throws SubscriptionNotFoundException, AwsServiceException, SdkClientException, DocDbException This is a variant of
describeEventSubscriptions(software.amazon.awssdk.services.docdb.model.DescribeEventSubscriptionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.docdb.paginators.DescribeEventSubscriptionsIterable responses = client.describeEventSubscriptionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.docdb.paginators.DescribeEventSubscriptionsIterable responses = client .describeEventSubscriptionsPaginator(request); for (software.amazon.awssdk.services.docdb.model.DescribeEventSubscriptionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.docdb.paginators.DescribeEventSubscriptionsIterable responses = client.describeEventSubscriptionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEventSubscriptions(software.amazon.awssdk.services.docdb.model.DescribeEventSubscriptionsRequest)
operation.- Parameters:
describeEventSubscriptionsRequest
- Represents the input to DescribeEventSubscriptions.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeEventSubscriptionsPaginator
default DescribeEventSubscriptionsIterable describeEventSubscriptionsPaginator(Consumer<DescribeEventSubscriptionsRequest.Builder> describeEventSubscriptionsRequest) throws SubscriptionNotFoundException, AwsServiceException, SdkClientException, DocDbException This is a variant of
describeEventSubscriptions(software.amazon.awssdk.services.docdb.model.DescribeEventSubscriptionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.docdb.paginators.DescribeEventSubscriptionsIterable responses = client.describeEventSubscriptionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.docdb.paginators.DescribeEventSubscriptionsIterable responses = client .describeEventSubscriptionsPaginator(request); for (software.amazon.awssdk.services.docdb.model.DescribeEventSubscriptionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.docdb.paginators.DescribeEventSubscriptionsIterable responses = client.describeEventSubscriptionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEventSubscriptions(software.amazon.awssdk.services.docdb.model.DescribeEventSubscriptionsRequest)
operation.
This is a convenience which creates an instance of the
DescribeEventSubscriptionsRequest.Builder
avoiding the need to create one manually viaDescribeEventSubscriptionsRequest.builder()
- Parameters:
describeEventSubscriptionsRequest
- AConsumer
that will call methods onDescribeEventSubscriptionsRequest.Builder
to create a request. Represents the input to DescribeEventSubscriptions.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeEvents
default DescribeEventsResponse describeEvents(DescribeEventsRequest describeEventsRequest) throws AwsServiceException, SdkClientException, DocDbException 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.
- Parameters:
describeEventsRequest
- Represents the input to DescribeEvents.- Returns:
- Result of the DescribeEvents operation returned by the service.
- See Also:
-
describeEvents
default DescribeEventsResponse describeEvents(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) throws AwsServiceException, SdkClientException, DocDbException 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 viaDescribeEventsRequest.builder()
- Parameters:
describeEventsRequest
- AConsumer
that will call methods onDescribeEventsRequest.Builder
to create a request. Represents the input to DescribeEvents.- Returns:
- Result of the DescribeEvents operation returned by the service.
- See Also:
-
describeEvents
default DescribeEventsResponse describeEvents() throws AwsServiceException, SdkClientException, DocDbExceptionReturns 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.
- Returns:
- Result of the DescribeEvents operation returned by the service.
- See Also:
-
describeEventsPaginator
default DescribeEventsIterable describeEventsPaginator() throws AwsServiceException, SdkClientException, DocDbExceptionThis is a variant of
describeEvents(software.amazon.awssdk.services.docdb.model.DescribeEventsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.docdb.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.docdb.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); for (software.amazon.awssdk.services.docdb.model.DescribeEventsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.docdb.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEvents(software.amazon.awssdk.services.docdb.model.DescribeEventsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeEventsPaginator
default DescribeEventsIterable describeEventsPaginator(DescribeEventsRequest describeEventsRequest) throws AwsServiceException, SdkClientException, DocDbException This is a variant of
describeEvents(software.amazon.awssdk.services.docdb.model.DescribeEventsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.docdb.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.docdb.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); for (software.amazon.awssdk.services.docdb.model.DescribeEventsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.docdb.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEvents(software.amazon.awssdk.services.docdb.model.DescribeEventsRequest)
operation.- Parameters:
describeEventsRequest
- Represents the input to DescribeEvents.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeEventsPaginator
default DescribeEventsIterable describeEventsPaginator(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) throws AwsServiceException, SdkClientException, DocDbException This is a variant of
describeEvents(software.amazon.awssdk.services.docdb.model.DescribeEventsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.docdb.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.docdb.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); for (software.amazon.awssdk.services.docdb.model.DescribeEventsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.docdb.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEvents(software.amazon.awssdk.services.docdb.model.DescribeEventsRequest)
operation.
This is a convenience which creates an instance of the
DescribeEventsRequest.Builder
avoiding the need to create one manually viaDescribeEventsRequest.builder()
- Parameters:
describeEventsRequest
- AConsumer
that will call methods onDescribeEventsRequest.Builder
to create a request. Represents the input to DescribeEvents.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeGlobalClusters
default DescribeGlobalClustersResponse describeGlobalClusters(DescribeGlobalClustersRequest describeGlobalClustersRequest) throws GlobalClusterNotFoundException, AwsServiceException, SdkClientException, DocDbException Returns information about Amazon DocumentDB global clusters. This API supports pagination.
This action only applies to Amazon DocumentDB clusters.
- Parameters:
describeGlobalClustersRequest
-- Returns:
- Result of the DescribeGlobalClusters operation returned by the service.
- See Also:
-
describeGlobalClusters
default DescribeGlobalClustersResponse describeGlobalClusters(Consumer<DescribeGlobalClustersRequest.Builder> describeGlobalClustersRequest) throws GlobalClusterNotFoundException, AwsServiceException, SdkClientException, DocDbException 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 viaDescribeGlobalClustersRequest.builder()
- Parameters:
describeGlobalClustersRequest
- AConsumer
that will call methods onDescribeGlobalClustersRequest.Builder
to create a request.- Returns:
- Result of the DescribeGlobalClusters operation returned by the service.
- See Also:
-
describeGlobalClustersPaginator
default DescribeGlobalClustersIterable describeGlobalClustersPaginator(DescribeGlobalClustersRequest describeGlobalClustersRequest) throws GlobalClusterNotFoundException, AwsServiceException, SdkClientException, DocDbException This is a variant of
describeGlobalClusters(software.amazon.awssdk.services.docdb.model.DescribeGlobalClustersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.docdb.paginators.DescribeGlobalClustersIterable responses = client.describeGlobalClustersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.docdb.paginators.DescribeGlobalClustersIterable responses = client .describeGlobalClustersPaginator(request); for (software.amazon.awssdk.services.docdb.model.DescribeGlobalClustersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.docdb.paginators.DescribeGlobalClustersIterable responses = client.describeGlobalClustersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeGlobalClusters(software.amazon.awssdk.services.docdb.model.DescribeGlobalClustersRequest)
operation.- Parameters:
describeGlobalClustersRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeGlobalClustersPaginator
default DescribeGlobalClustersIterable describeGlobalClustersPaginator(Consumer<DescribeGlobalClustersRequest.Builder> describeGlobalClustersRequest) throws GlobalClusterNotFoundException, AwsServiceException, SdkClientException, DocDbException This is a variant of
describeGlobalClusters(software.amazon.awssdk.services.docdb.model.DescribeGlobalClustersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.docdb.paginators.DescribeGlobalClustersIterable responses = client.describeGlobalClustersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.docdb.paginators.DescribeGlobalClustersIterable responses = client .describeGlobalClustersPaginator(request); for (software.amazon.awssdk.services.docdb.model.DescribeGlobalClustersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.docdb.paginators.DescribeGlobalClustersIterable responses = client.describeGlobalClustersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeGlobalClusters(software.amazon.awssdk.services.docdb.model.DescribeGlobalClustersRequest)
operation.
This is a convenience which creates an instance of the
DescribeGlobalClustersRequest.Builder
avoiding the need to create one manually viaDescribeGlobalClustersRequest.builder()
- Parameters:
describeGlobalClustersRequest
- AConsumer
that will call methods onDescribeGlobalClustersRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeOrderableDBInstanceOptions
default DescribeOrderableDbInstanceOptionsResponse describeOrderableDBInstanceOptions(DescribeOrderableDbInstanceOptionsRequest describeOrderableDbInstanceOptionsRequest) throws AwsServiceException, SdkClientException, DocDbException Returns a list of orderable instance options for the specified engine.
- Parameters:
describeOrderableDbInstanceOptionsRequest
- Represents the input to DescribeOrderableDBInstanceOptions.- Returns:
- Result of the DescribeOrderableDBInstanceOptions operation returned by the service.
- See Also:
-
describeOrderableDBInstanceOptions
default DescribeOrderableDbInstanceOptionsResponse describeOrderableDBInstanceOptions(Consumer<DescribeOrderableDbInstanceOptionsRequest.Builder> describeOrderableDbInstanceOptionsRequest) throws AwsServiceException, SdkClientException, DocDbException 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 viaDescribeOrderableDbInstanceOptionsRequest.builder()
- Parameters:
describeOrderableDbInstanceOptionsRequest
- AConsumer
that will call methods onDescribeOrderableDbInstanceOptionsRequest.Builder
to create a request. Represents the input to DescribeOrderableDBInstanceOptions.- Returns:
- Result of the DescribeOrderableDBInstanceOptions operation returned by the service.
- See Also:
-
describeOrderableDBInstanceOptionsPaginator
default DescribeOrderableDBInstanceOptionsIterable describeOrderableDBInstanceOptionsPaginator(DescribeOrderableDbInstanceOptionsRequest describeOrderableDbInstanceOptionsRequest) throws AwsServiceException, SdkClientException, DocDbException This is a variant of
describeOrderableDBInstanceOptions(software.amazon.awssdk.services.docdb.model.DescribeOrderableDbInstanceOptionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.docdb.paginators.DescribeOrderableDBInstanceOptionsIterable responses = client.describeOrderableDBInstanceOptionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.docdb.paginators.DescribeOrderableDBInstanceOptionsIterable responses = client .describeOrderableDBInstanceOptionsPaginator(request); for (software.amazon.awssdk.services.docdb.model.DescribeOrderableDbInstanceOptionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.docdb.paginators.DescribeOrderableDBInstanceOptionsIterable responses = client.describeOrderableDBInstanceOptionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeOrderableDBInstanceOptions(software.amazon.awssdk.services.docdb.model.DescribeOrderableDbInstanceOptionsRequest)
operation.- Parameters:
describeOrderableDbInstanceOptionsRequest
- Represents the input to DescribeOrderableDBInstanceOptions.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeOrderableDBInstanceOptionsPaginator
default DescribeOrderableDBInstanceOptionsIterable describeOrderableDBInstanceOptionsPaginator(Consumer<DescribeOrderableDbInstanceOptionsRequest.Builder> describeOrderableDbInstanceOptionsRequest) throws AwsServiceException, SdkClientException, DocDbException This is a variant of
describeOrderableDBInstanceOptions(software.amazon.awssdk.services.docdb.model.DescribeOrderableDbInstanceOptionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.docdb.paginators.DescribeOrderableDBInstanceOptionsIterable responses = client.describeOrderableDBInstanceOptionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.docdb.paginators.DescribeOrderableDBInstanceOptionsIterable responses = client .describeOrderableDBInstanceOptionsPaginator(request); for (software.amazon.awssdk.services.docdb.model.DescribeOrderableDbInstanceOptionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.docdb.paginators.DescribeOrderableDBInstanceOptionsIterable responses = client.describeOrderableDBInstanceOptionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeOrderableDBInstanceOptions(software.amazon.awssdk.services.docdb.model.DescribeOrderableDbInstanceOptionsRequest)
operation.
This is a convenience which creates an instance of the
DescribeOrderableDbInstanceOptionsRequest.Builder
avoiding the need to create one manually viaDescribeOrderableDbInstanceOptionsRequest.builder()
- Parameters:
describeOrderableDbInstanceOptionsRequest
- AConsumer
that will call methods onDescribeOrderableDbInstanceOptionsRequest.Builder
to create a request. Represents the input to DescribeOrderableDBInstanceOptions.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describePendingMaintenanceActions
default DescribePendingMaintenanceActionsResponse describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, DocDbException Returns a list of resources (for example, instances) that have at least one pending maintenance action.
- Parameters:
describePendingMaintenanceActionsRequest
- Represents the input to DescribePendingMaintenanceActions.- Returns:
- Result of the DescribePendingMaintenanceActions operation returned by the service.
- See Also:
-
describePendingMaintenanceActions
default DescribePendingMaintenanceActionsResponse describePendingMaintenanceActions(Consumer<DescribePendingMaintenanceActionsRequest.Builder> describePendingMaintenanceActionsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, DocDbException 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 viaDescribePendingMaintenanceActionsRequest.builder()
- Parameters:
describePendingMaintenanceActionsRequest
- AConsumer
that will call methods onDescribePendingMaintenanceActionsRequest.Builder
to create a request. Represents the input to DescribePendingMaintenanceActions.- Returns:
- Result of the DescribePendingMaintenanceActions operation returned by the service.
- See Also:
-
describePendingMaintenanceActions
default DescribePendingMaintenanceActionsResponse describePendingMaintenanceActions() throws ResourceNotFoundException, AwsServiceException, SdkClientException, DocDbExceptionReturns a list of resources (for example, instances) that have at least one pending maintenance action.
- Returns:
- Result of the DescribePendingMaintenanceActions operation returned by the service.
- See Also:
-
describePendingMaintenanceActionsPaginator
default DescribePendingMaintenanceActionsIterable describePendingMaintenanceActionsPaginator() throws ResourceNotFoundException, AwsServiceException, SdkClientException, DocDbExceptionThis is a variant of
describePendingMaintenanceActions(software.amazon.awssdk.services.docdb.model.DescribePendingMaintenanceActionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.docdb.paginators.DescribePendingMaintenanceActionsIterable responses = client.describePendingMaintenanceActionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.docdb.paginators.DescribePendingMaintenanceActionsIterable responses = client .describePendingMaintenanceActionsPaginator(request); for (software.amazon.awssdk.services.docdb.model.DescribePendingMaintenanceActionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.docdb.paginators.DescribePendingMaintenanceActionsIterable responses = client.describePendingMaintenanceActionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describePendingMaintenanceActions(software.amazon.awssdk.services.docdb.model.DescribePendingMaintenanceActionsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describePendingMaintenanceActionsPaginator
default DescribePendingMaintenanceActionsIterable describePendingMaintenanceActionsPaginator(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, DocDbException This is a variant of
describePendingMaintenanceActions(software.amazon.awssdk.services.docdb.model.DescribePendingMaintenanceActionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.docdb.paginators.DescribePendingMaintenanceActionsIterable responses = client.describePendingMaintenanceActionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.docdb.paginators.DescribePendingMaintenanceActionsIterable responses = client .describePendingMaintenanceActionsPaginator(request); for (software.amazon.awssdk.services.docdb.model.DescribePendingMaintenanceActionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.docdb.paginators.DescribePendingMaintenanceActionsIterable responses = client.describePendingMaintenanceActionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describePendingMaintenanceActions(software.amazon.awssdk.services.docdb.model.DescribePendingMaintenanceActionsRequest)
operation.- Parameters:
describePendingMaintenanceActionsRequest
- Represents the input to DescribePendingMaintenanceActions.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describePendingMaintenanceActionsPaginator
default DescribePendingMaintenanceActionsIterable describePendingMaintenanceActionsPaginator(Consumer<DescribePendingMaintenanceActionsRequest.Builder> describePendingMaintenanceActionsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, DocDbException This is a variant of
describePendingMaintenanceActions(software.amazon.awssdk.services.docdb.model.DescribePendingMaintenanceActionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.docdb.paginators.DescribePendingMaintenanceActionsIterable responses = client.describePendingMaintenanceActionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.docdb.paginators.DescribePendingMaintenanceActionsIterable responses = client .describePendingMaintenanceActionsPaginator(request); for (software.amazon.awssdk.services.docdb.model.DescribePendingMaintenanceActionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.docdb.paginators.DescribePendingMaintenanceActionsIterable responses = client.describePendingMaintenanceActionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describePendingMaintenanceActions(software.amazon.awssdk.services.docdb.model.DescribePendingMaintenanceActionsRequest)
operation.
This is a convenience which creates an instance of the
DescribePendingMaintenanceActionsRequest.Builder
avoiding the need to create one manually viaDescribePendingMaintenanceActionsRequest.builder()
- Parameters:
describePendingMaintenanceActionsRequest
- AConsumer
that will call methods onDescribePendingMaintenanceActionsRequest.Builder
to create a request. Represents the input to DescribePendingMaintenanceActions.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
failoverDBCluster
default FailoverDbClusterResponse failoverDBCluster(FailoverDbClusterRequest failoverDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, DocDbException 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.
- Parameters:
failoverDbClusterRequest
- Represents the input to FailoverDBCluster.- Returns:
- Result of the FailoverDBCluster operation returned by the service.
- See Also:
-
failoverDBCluster
default FailoverDbClusterResponse failoverDBCluster(Consumer<FailoverDbClusterRequest.Builder> failoverDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, DocDbException 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 viaFailoverDbClusterRequest.builder()
- Parameters:
failoverDbClusterRequest
- AConsumer
that will call methods onFailoverDbClusterRequest.Builder
to create a request. Represents the input to FailoverDBCluster.- Returns:
- Result of the FailoverDBCluster operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws DbInstanceNotFoundException, DbSnapshotNotFoundException, DbClusterNotFoundException, AwsServiceException, SdkClientException, DocDbException Lists all tags on an Amazon DocumentDB resource.
- Parameters:
listTagsForResourceRequest
- Represents the input to ListTagsForResource.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws DbInstanceNotFoundException, DbSnapshotNotFoundException, DbClusterNotFoundException, AwsServiceException, SdkClientException, DocDbException 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 viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request. Represents the input to ListTagsForResource.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
modifyDBCluster
default ModifyDbClusterResponse modifyDBCluster(ModifyDbClusterRequest modifyDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, InvalidVpcNetworkStateException, InvalidDbSubnetGroupStateException, InvalidSubnetException, DbClusterParameterGroupNotFoundException, InvalidDbSecurityGroupStateException, InvalidDbInstanceStateException, DbClusterAlreadyExistsException, AwsServiceException, SdkClientException, DocDbException 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.
- Parameters:
modifyDbClusterRequest
- Represents the input to ModifyDBCluster.- Returns:
- Result of the ModifyDBCluster operation returned by the service.
- See Also:
-
modifyDBCluster
default ModifyDbClusterResponse modifyDBCluster(Consumer<ModifyDbClusterRequest.Builder> modifyDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, InvalidVpcNetworkStateException, InvalidDbSubnetGroupStateException, InvalidSubnetException, DbClusterParameterGroupNotFoundException, InvalidDbSecurityGroupStateException, InvalidDbInstanceStateException, DbClusterAlreadyExistsException, AwsServiceException, SdkClientException, DocDbException 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 viaModifyDbClusterRequest.builder()
- Parameters:
modifyDbClusterRequest
- AConsumer
that will call methods onModifyDbClusterRequest.Builder
to create a request. Represents the input to ModifyDBCluster.- Returns:
- Result of the ModifyDBCluster operation returned by the service.
- See Also:
-
modifyDBClusterParameterGroup
default ModifyDbClusterParameterGroupResponse modifyDBClusterParameterGroup(ModifyDbClusterParameterGroupRequest modifyDbClusterParameterGroupRequest) throws DbParameterGroupNotFoundException, InvalidDbParameterGroupStateException, AwsServiceException, SdkClientException, DocDbException Modifies the parameters of a cluster parameter group. To modify more than one parameter, submit a list of the following:
ParameterName
,ParameterValue
, andApplyMethod
. A maximum of 20 parameters can be modified in a single request.Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot 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.- Parameters:
modifyDbClusterParameterGroupRequest
- Represents the input to ModifyDBClusterParameterGroup.- Returns:
- Result of the ModifyDBClusterParameterGroup operation returned by the service.
- See Also:
-
modifyDBClusterParameterGroup
default ModifyDbClusterParameterGroupResponse modifyDBClusterParameterGroup(Consumer<ModifyDbClusterParameterGroupRequest.Builder> modifyDbClusterParameterGroupRequest) throws DbParameterGroupNotFoundException, InvalidDbParameterGroupStateException, AwsServiceException, SdkClientException, DocDbException Modifies the parameters of a cluster parameter group. To modify more than one parameter, submit a list of the following:
ParameterName
,ParameterValue
, andApplyMethod
. A maximum of 20 parameters can be modified in a single request.Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot 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 viaModifyDbClusterParameterGroupRequest.builder()
- Parameters:
modifyDbClusterParameterGroupRequest
- AConsumer
that will call methods onModifyDbClusterParameterGroupRequest.Builder
to create a request. Represents the input to ModifyDBClusterParameterGroup.- Returns:
- Result of the ModifyDBClusterParameterGroup operation returned by the service.
- See Also:
-
modifyDBClusterSnapshotAttribute
default ModifyDbClusterSnapshotAttributeResponse modifyDBClusterSnapshotAttribute(ModifyDbClusterSnapshotAttributeRequest modifyDbClusterSnapshotAttributeRequest) throws DbClusterSnapshotNotFoundException, InvalidDbClusterSnapshotStateException, SharedSnapshotQuotaExceededException, AwsServiceException, SdkClientException, DocDbException 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 Amazon Web Services accounts, specify
restore
as theAttributeName
, and use theValuesToAdd
parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual cluster snapshot. Use the valueall
to make the manual cluster snapshot public, which means that it can be copied or restored by all Amazon Web Services accounts. Do not add theall
value for any manual cluster snapshots that contain private information that you don't want available to all Amazon Web Services accounts. If a manual cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for theValuesToAdd
parameter. You can't useall
as a value for that parameter in this case.- Parameters:
modifyDbClusterSnapshotAttributeRequest
- Represents the input to ModifyDBClusterSnapshotAttribute.- Returns:
- Result of the ModifyDBClusterSnapshotAttribute operation returned by the service.
- See Also:
-
modifyDBClusterSnapshotAttribute
default ModifyDbClusterSnapshotAttributeResponse modifyDBClusterSnapshotAttribute(Consumer<ModifyDbClusterSnapshotAttributeRequest.Builder> modifyDbClusterSnapshotAttributeRequest) throws DbClusterSnapshotNotFoundException, InvalidDbClusterSnapshotStateException, SharedSnapshotQuotaExceededException, AwsServiceException, SdkClientException, DocDbException 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 Amazon Web Services accounts, specify
restore
as theAttributeName
, and use theValuesToAdd
parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual cluster snapshot. Use the valueall
to make the manual cluster snapshot public, which means that it can be copied or restored by all Amazon Web Services accounts. Do not add theall
value for any manual cluster snapshots that contain private information that you don't want available to all Amazon Web Services accounts. If a manual cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for theValuesToAdd
parameter. You can't useall
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 viaModifyDbClusterSnapshotAttributeRequest.builder()
- Parameters:
modifyDbClusterSnapshotAttributeRequest
- AConsumer
that will call methods onModifyDbClusterSnapshotAttributeRequest.Builder
to create a request. Represents the input to ModifyDBClusterSnapshotAttribute.- Returns:
- Result of the ModifyDBClusterSnapshotAttribute operation returned by the service.
- See Also:
-
modifyDBInstance
default ModifyDbInstanceResponse modifyDBInstance(ModifyDbInstanceRequest modifyDbInstanceRequest) throws InvalidDbInstanceStateException, InvalidDbSecurityGroupStateException, DbInstanceAlreadyExistsException, DbInstanceNotFoundException, DbSecurityGroupNotFoundException, DbParameterGroupNotFoundException, InsufficientDbInstanceCapacityException, StorageQuotaExceededException, InvalidVpcNetworkStateException, DbUpgradeDependencyFailureException, StorageTypeNotSupportedException, AuthorizationNotFoundException, CertificateNotFoundException, AwsServiceException, SdkClientException, DocDbException 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.
- Parameters:
modifyDbInstanceRequest
- Represents the input to ModifyDBInstance.- Returns:
- Result of the ModifyDBInstance operation returned by the service.
- See Also:
-
modifyDBInstance
default ModifyDbInstanceResponse modifyDBInstance(Consumer<ModifyDbInstanceRequest.Builder> modifyDbInstanceRequest) throws InvalidDbInstanceStateException, InvalidDbSecurityGroupStateException, DbInstanceAlreadyExistsException, DbInstanceNotFoundException, DbSecurityGroupNotFoundException, DbParameterGroupNotFoundException, InsufficientDbInstanceCapacityException, StorageQuotaExceededException, InvalidVpcNetworkStateException, DbUpgradeDependencyFailureException, StorageTypeNotSupportedException, AuthorizationNotFoundException, CertificateNotFoundException, AwsServiceException, SdkClientException, DocDbException 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 viaModifyDbInstanceRequest.builder()
- Parameters:
modifyDbInstanceRequest
- AConsumer
that will call methods onModifyDbInstanceRequest.Builder
to create a request. Represents the input to ModifyDBInstance.- Returns:
- Result of the ModifyDBInstance operation returned by the service.
- See Also:
-
modifyDBSubnetGroup
default ModifyDbSubnetGroupResponse modifyDBSubnetGroup(ModifyDbSubnetGroupRequest modifyDbSubnetGroupRequest) throws DbSubnetGroupNotFoundException, DbSubnetQuotaExceededException, SubnetAlreadyInUseException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidSubnetException, AwsServiceException, SdkClientException, DocDbException Modifies an existing subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Amazon Web Services Region.
- Parameters:
modifyDbSubnetGroupRequest
- Represents the input to ModifyDBSubnetGroup.- Returns:
- Result of the ModifyDBSubnetGroup operation returned by the service.
- See Also:
-
modifyDBSubnetGroup
default ModifyDbSubnetGroupResponse modifyDBSubnetGroup(Consumer<ModifyDbSubnetGroupRequest.Builder> modifyDbSubnetGroupRequest) throws DbSubnetGroupNotFoundException, DbSubnetQuotaExceededException, SubnetAlreadyInUseException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidSubnetException, AwsServiceException, SdkClientException, DocDbException Modifies an existing subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Amazon Web Services Region.
This is a convenience which creates an instance of the
ModifyDbSubnetGroupRequest.Builder
avoiding the need to create one manually viaModifyDbSubnetGroupRequest.builder()
- Parameters:
modifyDbSubnetGroupRequest
- AConsumer
that will call methods onModifyDbSubnetGroupRequest.Builder
to create a request. Represents the input to ModifyDBSubnetGroup.- Returns:
- Result of the ModifyDBSubnetGroup operation returned by the service.
- See Also:
-
modifyEventSubscription
default ModifyEventSubscriptionResponse modifyEventSubscription(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest) throws EventSubscriptionQuotaExceededException, SubscriptionNotFoundException, SnsInvalidTopicException, SnsNoAuthorizationException, SnsTopicArnNotFoundException, SubscriptionCategoryNotFoundException, AwsServiceException, SdkClientException, DocDbException Modifies an existing Amazon DocumentDB event notification subscription.
- Parameters:
modifyEventSubscriptionRequest
- Represents the input to ModifyEventSubscription.- Returns:
- Result of the ModifyEventSubscription operation returned by the service.
- See Also:
-
modifyEventSubscription
default ModifyEventSubscriptionResponse modifyEventSubscription(Consumer<ModifyEventSubscriptionRequest.Builder> modifyEventSubscriptionRequest) throws EventSubscriptionQuotaExceededException, SubscriptionNotFoundException, SnsInvalidTopicException, SnsNoAuthorizationException, SnsTopicArnNotFoundException, SubscriptionCategoryNotFoundException, AwsServiceException, SdkClientException, DocDbException 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 viaModifyEventSubscriptionRequest.builder()
- Parameters:
modifyEventSubscriptionRequest
- AConsumer
that will call methods onModifyEventSubscriptionRequest.Builder
to create a request. Represents the input to ModifyEventSubscription.- Returns:
- Result of the ModifyEventSubscription operation returned by the service.
- See Also:
-
modifyGlobalCluster
default ModifyGlobalClusterResponse modifyGlobalCluster(ModifyGlobalClusterRequest modifyGlobalClusterRequest) throws GlobalClusterNotFoundException, InvalidGlobalClusterStateException, AwsServiceException, SdkClientException, DocDbException 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.
- Parameters:
modifyGlobalClusterRequest
- Represents the input to ModifyGlobalCluster.- Returns:
- Result of the ModifyGlobalCluster operation returned by the service.
- See Also:
-
modifyGlobalCluster
default ModifyGlobalClusterResponse modifyGlobalCluster(Consumer<ModifyGlobalClusterRequest.Builder> modifyGlobalClusterRequest) throws GlobalClusterNotFoundException, InvalidGlobalClusterStateException, AwsServiceException, SdkClientException, DocDbException 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 viaModifyGlobalClusterRequest.builder()
- Parameters:
modifyGlobalClusterRequest
- AConsumer
that will call methods onModifyGlobalClusterRequest.Builder
to create a request. Represents the input to ModifyGlobalCluster.- Returns:
- Result of the ModifyGlobalCluster operation returned by the service.
- See Also:
-
rebootDBInstance
default RebootDbInstanceResponse rebootDBInstance(RebootDbInstanceRequest rebootDbInstanceRequest) throws InvalidDbInstanceStateException, DbInstanceNotFoundException, AwsServiceException, SdkClientException, DocDbException 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.
- Parameters:
rebootDbInstanceRequest
- Represents the input to RebootDBInstance.- Returns:
- Result of the RebootDBInstance operation returned by the service.
- See Also:
-
rebootDBInstance
default RebootDbInstanceResponse rebootDBInstance(Consumer<RebootDbInstanceRequest.Builder> rebootDbInstanceRequest) throws InvalidDbInstanceStateException, DbInstanceNotFoundException, AwsServiceException, SdkClientException, DocDbException 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 viaRebootDbInstanceRequest.builder()
- Parameters:
rebootDbInstanceRequest
- AConsumer
that will call methods onRebootDbInstanceRequest.Builder
to create a request. Represents the input to RebootDBInstance.- Returns:
- Result of the RebootDBInstance operation returned by the service.
- See Also:
-
removeFromGlobalCluster
default RemoveFromGlobalClusterResponse removeFromGlobalCluster(RemoveFromGlobalClusterRequest removeFromGlobalClusterRequest) throws GlobalClusterNotFoundException, InvalidGlobalClusterStateException, DbClusterNotFoundException, AwsServiceException, SdkClientException, DocDbException 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.
- Parameters:
removeFromGlobalClusterRequest
- Represents the input to RemoveFromGlobalCluster.- Returns:
- Result of the RemoveFromGlobalCluster operation returned by the service.
- See Also:
-
removeFromGlobalCluster
default RemoveFromGlobalClusterResponse removeFromGlobalCluster(Consumer<RemoveFromGlobalClusterRequest.Builder> removeFromGlobalClusterRequest) throws GlobalClusterNotFoundException, InvalidGlobalClusterStateException, DbClusterNotFoundException, AwsServiceException, SdkClientException, DocDbException 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 viaRemoveFromGlobalClusterRequest.builder()
- Parameters:
removeFromGlobalClusterRequest
- AConsumer
that will call methods onRemoveFromGlobalClusterRequest.Builder
to create a request. Represents the input to RemoveFromGlobalCluster.- Returns:
- Result of the RemoveFromGlobalCluster operation returned by the service.
- See Also:
-
removeSourceIdentifierFromSubscription
default RemoveSourceIdentifierFromSubscriptionResponse removeSourceIdentifierFromSubscription(RemoveSourceIdentifierFromSubscriptionRequest removeSourceIdentifierFromSubscriptionRequest) throws SubscriptionNotFoundException, SourceNotFoundException, AwsServiceException, SdkClientException, DocDbException Removes a source identifier from an existing Amazon DocumentDB event notification subscription.
- Parameters:
removeSourceIdentifierFromSubscriptionRequest
- Represents the input to RemoveSourceIdentifierFromSubscription.- Returns:
- Result of the RemoveSourceIdentifierFromSubscription operation returned by the service.
- See Also:
-
removeSourceIdentifierFromSubscription
default RemoveSourceIdentifierFromSubscriptionResponse removeSourceIdentifierFromSubscription(Consumer<RemoveSourceIdentifierFromSubscriptionRequest.Builder> removeSourceIdentifierFromSubscriptionRequest) throws SubscriptionNotFoundException, SourceNotFoundException, AwsServiceException, SdkClientException, DocDbException 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 viaRemoveSourceIdentifierFromSubscriptionRequest.builder()
- Parameters:
removeSourceIdentifierFromSubscriptionRequest
- AConsumer
that will call methods onRemoveSourceIdentifierFromSubscriptionRequest.Builder
to create a request. Represents the input to RemoveSourceIdentifierFromSubscription.- Returns:
- Result of the RemoveSourceIdentifierFromSubscription operation returned by the service.
- See Also:
-
removeTagsFromResource
default RemoveTagsFromResourceResponse removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest) throws DbInstanceNotFoundException, DbSnapshotNotFoundException, DbClusterNotFoundException, AwsServiceException, SdkClientException, DocDbException Removes metadata tags from an Amazon DocumentDB resource.
- Parameters:
removeTagsFromResourceRequest
- Represents the input to RemoveTagsFromResource.- Returns:
- Result of the RemoveTagsFromResource operation returned by the service.
- See Also:
-
removeTagsFromResource
default RemoveTagsFromResourceResponse removeTagsFromResource(Consumer<RemoveTagsFromResourceRequest.Builder> removeTagsFromResourceRequest) throws DbInstanceNotFoundException, DbSnapshotNotFoundException, DbClusterNotFoundException, AwsServiceException, SdkClientException, DocDbException 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 viaRemoveTagsFromResourceRequest.builder()
- Parameters:
removeTagsFromResourceRequest
- AConsumer
that will call methods onRemoveTagsFromResourceRequest.Builder
to create a request. Represents the input to RemoveTagsFromResource.- Returns:
- Result of the RemoveTagsFromResource operation returned by the service.
- See Also:
-
resetDBClusterParameterGroup
default ResetDbClusterParameterGroupResponse resetDBClusterParameterGroup(ResetDbClusterParameterGroupRequest resetDbClusterParameterGroupRequest) throws InvalidDbParameterGroupStateException, DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, DocDbException Modifies the parameters of a cluster parameter group to the default value. To reset specific parameters, submit a list of the following:
ParameterName
andApplyMethod
. To reset the entire cluster parameter group, specify theDBClusterParameterGroupName
andResetAllParameters
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.- Parameters:
resetDbClusterParameterGroupRequest
- Represents the input to ResetDBClusterParameterGroup.- Returns:
- Result of the ResetDBClusterParameterGroup operation returned by the service.
- See Also:
-
resetDBClusterParameterGroup
default ResetDbClusterParameterGroupResponse resetDBClusterParameterGroup(Consumer<ResetDbClusterParameterGroupRequest.Builder> resetDbClusterParameterGroupRequest) throws InvalidDbParameterGroupStateException, DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, DocDbException Modifies the parameters of a cluster parameter group to the default value. To reset specific parameters, submit a list of the following:
ParameterName
andApplyMethod
. To reset the entire cluster parameter group, specify theDBClusterParameterGroupName
andResetAllParameters
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 viaResetDbClusterParameterGroupRequest.builder()
- Parameters:
resetDbClusterParameterGroupRequest
- AConsumer
that will call methods onResetDbClusterParameterGroupRequest.Builder
to create a request. Represents the input to ResetDBClusterParameterGroup.- Returns:
- Result of the ResetDBClusterParameterGroup operation returned by the service.
- See Also:
-
restoreDBClusterFromSnapshot
default RestoreDbClusterFromSnapshotResponse restoreDBClusterFromSnapshot(RestoreDbClusterFromSnapshotRequest restoreDbClusterFromSnapshotRequest) throws DbClusterAlreadyExistsException, DbClusterQuotaExceededException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, DbSnapshotNotFoundException, DbClusterSnapshotNotFoundException, InsufficientDbClusterCapacityException, InsufficientStorageClusterCapacityException, InvalidDbSnapshotStateException, InvalidDbClusterSnapshotStateException, InvalidVpcNetworkStateException, InvalidRestoreException, InvalidSubnetException, KmsKeyNotAccessibleException, AwsServiceException, SdkClientException, DocDbException 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.
- Parameters:
restoreDbClusterFromSnapshotRequest
- Represents the input to RestoreDBClusterFromSnapshot.- Returns:
- Result of the RestoreDBClusterFromSnapshot operation returned by the service.
- See Also:
-
restoreDBClusterFromSnapshot
default RestoreDbClusterFromSnapshotResponse restoreDBClusterFromSnapshot(Consumer<RestoreDbClusterFromSnapshotRequest.Builder> restoreDbClusterFromSnapshotRequest) throws DbClusterAlreadyExistsException, DbClusterQuotaExceededException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, DbSnapshotNotFoundException, DbClusterSnapshotNotFoundException, InsufficientDbClusterCapacityException, InsufficientStorageClusterCapacityException, InvalidDbSnapshotStateException, InvalidDbClusterSnapshotStateException, InvalidVpcNetworkStateException, InvalidRestoreException, InvalidSubnetException, KmsKeyNotAccessibleException, AwsServiceException, SdkClientException, DocDbException 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 viaRestoreDbClusterFromSnapshotRequest.builder()
- Parameters:
restoreDbClusterFromSnapshotRequest
- AConsumer
that will call methods onRestoreDbClusterFromSnapshotRequest.Builder
to create a request. Represents the input to RestoreDBClusterFromSnapshot.- Returns:
- Result of the RestoreDBClusterFromSnapshot operation returned by the service.
- See Also:
-
restoreDBClusterToPointInTime
default RestoreDbClusterToPointInTimeResponse restoreDBClusterToPointInTime(RestoreDbClusterToPointInTimeRequest restoreDbClusterToPointInTimeRequest) throws DbClusterAlreadyExistsException, DbClusterNotFoundException, DbClusterQuotaExceededException, DbClusterSnapshotNotFoundException, DbSubnetGroupNotFoundException, InsufficientDbClusterCapacityException, InsufficientStorageClusterCapacityException, InvalidDbClusterSnapshotStateException, InvalidDbClusterStateException, InvalidDbSnapshotStateException, InvalidRestoreException, InvalidSubnetException, InvalidVpcNetworkStateException, KmsKeyNotAccessibleException, StorageQuotaExceededException, AwsServiceException, SdkClientException, DocDbException Restores a cluster to an arbitrary point in time. Users can restore to any point in time before
LatestRestorableTime
for up toBackupRetentionPeriod
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.- Parameters:
restoreDbClusterToPointInTimeRequest
- Represents the input to RestoreDBClusterToPointInTime.- Returns:
- Result of the RestoreDBClusterToPointInTime operation returned by the service.
- See Also:
-
restoreDBClusterToPointInTime
default RestoreDbClusterToPointInTimeResponse restoreDBClusterToPointInTime(Consumer<RestoreDbClusterToPointInTimeRequest.Builder> restoreDbClusterToPointInTimeRequest) throws DbClusterAlreadyExistsException, DbClusterNotFoundException, DbClusterQuotaExceededException, DbClusterSnapshotNotFoundException, DbSubnetGroupNotFoundException, InsufficientDbClusterCapacityException, InsufficientStorageClusterCapacityException, InvalidDbClusterSnapshotStateException, InvalidDbClusterStateException, InvalidDbSnapshotStateException, InvalidRestoreException, InvalidSubnetException, InvalidVpcNetworkStateException, KmsKeyNotAccessibleException, StorageQuotaExceededException, AwsServiceException, SdkClientException, DocDbException Restores a cluster to an arbitrary point in time. Users can restore to any point in time before
LatestRestorableTime
for up toBackupRetentionPeriod
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 viaRestoreDbClusterToPointInTimeRequest.builder()
- Parameters:
restoreDbClusterToPointInTimeRequest
- AConsumer
that will call methods onRestoreDbClusterToPointInTimeRequest.Builder
to create a request. Represents the input to RestoreDBClusterToPointInTime.- Returns:
- Result of the RestoreDBClusterToPointInTime operation returned by the service.
- See Also:
-
startDBCluster
default StartDbClusterResponse startDBCluster(StartDbClusterRequest startDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, DocDbException Restarts the stopped cluster that is specified by
DBClusterIdentifier
. For more information, see Stopping and Starting an Amazon DocumentDB Cluster.- Parameters:
startDbClusterRequest
-- Returns:
- Result of the StartDBCluster operation returned by the service.
- See Also:
-
startDBCluster
default StartDbClusterResponse startDBCluster(Consumer<StartDbClusterRequest.Builder> startDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, DocDbException 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 viaStartDbClusterRequest.builder()
- Parameters:
startDbClusterRequest
- AConsumer
that will call methods onStartDbClusterRequest.Builder
to create a request.- Returns:
- Result of the StartDBCluster operation returned by the service.
- See Also:
-
stopDBCluster
default StopDbClusterResponse stopDBCluster(StopDbClusterRequest stopDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, DocDbException 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.- Parameters:
stopDbClusterRequest
-- Returns:
- Result of the StopDBCluster operation returned by the service.
- See Also:
-
stopDBCluster
default StopDbClusterResponse stopDBCluster(Consumer<StopDbClusterRequest.Builder> stopDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, DocDbException 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 viaStopDbClusterRequest.builder()
- Parameters:
stopDbClusterRequest
- AConsumer
that will call methods onStopDbClusterRequest.Builder
to create a request.- Returns:
- Result of the StopDBCluster operation returned by the service.
- See Also:
-
switchoverGlobalCluster
default SwitchoverGlobalClusterResponse switchoverGlobalCluster(SwitchoverGlobalClusterRequest switchoverGlobalClusterRequest) throws GlobalClusterNotFoundException, InvalidGlobalClusterStateException, DbClusterNotFoundException, InvalidDbClusterStateException, AwsServiceException, SdkClientException, DocDbException Switches over the specified secondary Amazon DocumentDB cluster to be the new primary Amazon DocumentDB cluster in the global database cluster.
- Parameters:
switchoverGlobalClusterRequest
-- Returns:
- Result of the SwitchoverGlobalCluster operation returned by the service.
- See Also:
-
switchoverGlobalCluster
default SwitchoverGlobalClusterResponse switchoverGlobalCluster(Consumer<SwitchoverGlobalClusterRequest.Builder> switchoverGlobalClusterRequest) throws GlobalClusterNotFoundException, InvalidGlobalClusterStateException, DbClusterNotFoundException, InvalidDbClusterStateException, AwsServiceException, SdkClientException, DocDbException Switches over the specified secondary Amazon DocumentDB cluster to be the new primary Amazon DocumentDB cluster in the global database cluster.
This is a convenience which creates an instance of the
SwitchoverGlobalClusterRequest.Builder
avoiding the need to create one manually viaSwitchoverGlobalClusterRequest.builder()
- Parameters:
switchoverGlobalClusterRequest
- AConsumer
that will call methods onSwitchoverGlobalClusterRequest.Builder
to create a request.- Returns:
- Result of the SwitchoverGlobalCluster operation returned by the service.
- See Also:
-
waiter
Create an instance ofDocDbWaiter
using this client.Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
- Returns:
- an instance of
DocDbWaiter
-
create
Create aDocDbClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aDocDbClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-