Interface DocDbClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface DocDbClient extends AwsClient
Service client for accessing Amazon DocDB. This can be created using the staticbuilder()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
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
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.
- Throws:
SubscriptionNotFoundException- The subscription name does not exist.SourceNotFoundException- The requested source could not be found.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaAddSourceIdentifierToSubscriptionRequest.builder()- Parameters:
addSourceIdentifierToSubscriptionRequest- AConsumerthat will call methods onAddSourceIdentifierToSubscriptionRequest.Builderto create a request. Represents the input to AddSourceIdentifierToSubscription.- Returns:
- Result of the AddSourceIdentifierToSubscription operation returned by the service.
- Throws:
SubscriptionNotFoundException- The subscription name does not exist.SourceNotFoundException- The requested source could not be found.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
Conditionstatement 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.
- Throws:
DbInstanceNotFoundException-DBInstanceIdentifierdoesn't refer to an existing instance.DbSnapshotNotFoundException-DBSnapshotIdentifierdoesn't refer to an existing snapshot.DbClusterNotFoundException-DBClusterIdentifierdoesn't refer to an existing cluster.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
Conditionstatement in an Identity and Access Management (IAM) policy for Amazon DocumentDB.
This is a convenience which creates an instance of the
AddTagsToResourceRequest.Builderavoiding the need to create one manually viaAddTagsToResourceRequest.builder()- Parameters:
addTagsToResourceRequest- AConsumerthat will call methods onAddTagsToResourceRequest.Builderto create a request. Represents the input to AddTagsToResource.- Returns:
- Result of the AddTagsToResource operation returned by the service.
- Throws:
DbInstanceNotFoundException-DBInstanceIdentifierdoesn't refer to an existing instance.DbSnapshotNotFoundException-DBSnapshotIdentifierdoesn't refer to an existing snapshot.DbClusterNotFoundException-DBClusterIdentifierdoesn't refer to an existing cluster.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ResourceNotFoundException- The specified resource ID was not found.InvalidDbClusterStateException- The cluster isn't in a valid state.InvalidDbInstanceStateException- The specified instance isn't in the available state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaApplyPendingMaintenanceActionRequest.builder()- Parameters:
applyPendingMaintenanceActionRequest- AConsumerthat will call methods onApplyPendingMaintenanceActionRequest.Builderto create a request. Represents the input to ApplyPendingMaintenanceAction.- Returns:
- Result of the ApplyPendingMaintenanceAction operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource ID was not found.InvalidDbClusterStateException- The cluster isn't in a valid state.InvalidDbInstanceStateException- The specified instance isn't in the available state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
DbParameterGroupNotFoundException-DBParameterGroupNamedoesn't refer to an existing parameter group.DbParameterGroupQuotaExceededException- This request would cause you to exceed the allowed number of parameter groups.DbParameterGroupAlreadyExistsException- A parameter group with the same name already exists.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaCopyDbClusterParameterGroupRequest.builder()- Parameters:
copyDbClusterParameterGroupRequest- AConsumerthat will call methods onCopyDbClusterParameterGroupRequest.Builderto create a request. Represents the input to CopyDBClusterParameterGroup.- Returns:
- Result of the CopyDBClusterParameterGroup operation returned by the service.
- Throws:
DbParameterGroupNotFoundException-DBParameterGroupNamedoesn't refer to an existing parameter group.DbParameterGroupQuotaExceededException- This request would cause you to exceed the allowed number of parameter groups.DbParameterGroupAlreadyExistsException- A parameter group with the same name already exists.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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,
SourceDBClusterSnapshotIdentifiermust 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
TargetDBClusterSnapshotIdentifierwhile 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.
- Throws:
DbClusterSnapshotAlreadyExistsException- You already have a cluster snapshot with the given identifier.DbClusterSnapshotNotFoundException-DBClusterSnapshotIdentifierdoesn't refer to an existing cluster snapshot.InvalidDbClusterStateException- The cluster isn't in a valid state.InvalidDbClusterSnapshotStateException- The provided value isn't a valid cluster snapshot state.SnapshotQuotaExceededException- The request would cause you to exceed the allowed number of snapshots.KmsKeyNotAccessibleException- An error occurred when accessing an KMS key.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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,
SourceDBClusterSnapshotIdentifiermust 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
TargetDBClusterSnapshotIdentifierwhile that cluster snapshot is in the copying status.
This is a convenience which creates an instance of the
CopyDbClusterSnapshotRequest.Builderavoiding the need to create one manually viaCopyDbClusterSnapshotRequest.builder()- Parameters:
copyDbClusterSnapshotRequest- AConsumerthat will call methods onCopyDbClusterSnapshotRequest.Builderto create a request. Represents the input to CopyDBClusterSnapshot.- Returns:
- Result of the CopyDBClusterSnapshot operation returned by the service.
- Throws:
DbClusterSnapshotAlreadyExistsException- You already have a cluster snapshot with the given identifier.DbClusterSnapshotNotFoundException-DBClusterSnapshotIdentifierdoesn't refer to an existing cluster snapshot.InvalidDbClusterStateException- The cluster isn't in a valid state.InvalidDbClusterSnapshotStateException- The provided value isn't a valid cluster snapshot state.SnapshotQuotaExceededException- The request would cause you to exceed the allowed number of snapshots.KmsKeyNotAccessibleException- An error occurred when accessing an KMS key.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
DbClusterAlreadyExistsException- You already have a cluster with the given identifier.InsufficientStorageClusterCapacityException- There is not enough storage available for the current action. You might be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.DbClusterQuotaExceededException- The cluster can't be created because you have reached the maximum allowed quota of clusters.StorageQuotaExceededException- The request would cause you to exceed the allowed amount of storage available across all instances.DbSubnetGroupNotFoundException-DBSubnetGroupNamedoesn't refer to an existing subnet group.InvalidVpcNetworkStateException- The subnet group doesn't cover all Availability Zones after it is created because of changes that were made.InvalidDbClusterStateException- The cluster isn't in a valid state.InvalidDbSubnetGroupStateException- The subnet group can't be deleted because it's in use.InvalidSubnetException- The requested subnet is not valid, or multiple subnets were requested that are not all in a common virtual private cloud (VPC).InvalidDbInstanceStateException- The specified instance isn't in the available state.DbClusterParameterGroupNotFoundException-DBClusterParameterGroupNamedoesn't refer to an existing cluster parameter group.KmsKeyNotAccessibleException- An error occurred when accessing an KMS key.DbClusterNotFoundException-DBClusterIdentifierdoesn't refer to an existing cluster.DbInstanceNotFoundException-DBInstanceIdentifierdoesn't refer to an existing instance.DbSubnetGroupDoesNotCoverEnoughAZsException- Subnets in the subnet group should cover at least two Availability Zones unless there is only one Availability Zone.GlobalClusterNotFoundException- TheGlobalClusterIdentifierdoesn't refer to an existing global cluster.InvalidGlobalClusterStateException- The requested operation can't be performed while the cluster is in this state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaCreateDbClusterRequest.builder()- Parameters:
createDbClusterRequest- AConsumerthat will call methods onCreateDbClusterRequest.Builderto create a request. Represents the input to CreateDBCluster.- Returns:
- Result of the CreateDBCluster operation returned by the service.
- Throws:
DbClusterAlreadyExistsException- You already have a cluster with the given identifier.InsufficientStorageClusterCapacityException- There is not enough storage available for the current action. You might be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.DbClusterQuotaExceededException- The cluster can't be created because you have reached the maximum allowed quota of clusters.StorageQuotaExceededException- The request would cause you to exceed the allowed amount of storage available across all instances.DbSubnetGroupNotFoundException-DBSubnetGroupNamedoesn't refer to an existing subnet group.InvalidVpcNetworkStateException- The subnet group doesn't cover all Availability Zones after it is created because of changes that were made.InvalidDbClusterStateException- The cluster isn't in a valid state.InvalidDbSubnetGroupStateException- The subnet group can't be deleted because it's in use.InvalidSubnetException- The requested subnet is not valid, or multiple subnets were requested that are not all in a common virtual private cloud (VPC).InvalidDbInstanceStateException- The specified instance isn't in the available state.DbClusterParameterGroupNotFoundException-DBClusterParameterGroupNamedoesn't refer to an existing cluster parameter group.KmsKeyNotAccessibleException- An error occurred when accessing an KMS key.DbClusterNotFoundException-DBClusterIdentifierdoesn't refer to an existing cluster.DbInstanceNotFoundException-DBInstanceIdentifierdoesn't refer to an existing instance.DbSubnetGroupDoesNotCoverEnoughAZsException- Subnets in the subnet group should cover at least two Availability Zones unless there is only one Availability Zone.GlobalClusterNotFoundException- TheGlobalClusterIdentifierdoesn't refer to an existing global cluster.InvalidGlobalClusterStateException- The requested operation can't be performed while the cluster is in this state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.6cluster 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.
- Throws:
DbParameterGroupQuotaExceededException- This request would cause you to exceed the allowed number of parameter groups.DbParameterGroupAlreadyExistsException- A parameter group with the same name already exists.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.6cluster 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.Builderavoiding the need to create one manually viaCreateDbClusterParameterGroupRequest.builder()- Parameters:
createDbClusterParameterGroupRequest- AConsumerthat will call methods onCreateDbClusterParameterGroupRequest.Builderto create a request. Represents the input of CreateDBClusterParameterGroup.- Returns:
- Result of the CreateDBClusterParameterGroup operation returned by the service.
- Throws:
DbParameterGroupQuotaExceededException- This request would cause you to exceed the allowed number of parameter groups.DbParameterGroupAlreadyExistsException- A parameter group with the same name already exists.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
DbClusterSnapshotAlreadyExistsException- You already have a cluster snapshot with the given identifier.InvalidDbClusterStateException- The cluster isn't in a valid state.DbClusterNotFoundException-DBClusterIdentifierdoesn't refer to an existing cluster.SnapshotQuotaExceededException- The request would cause you to exceed the allowed number of snapshots.InvalidDbClusterSnapshotStateException- The provided value isn't a valid cluster snapshot state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaCreateDbClusterSnapshotRequest.builder()- Parameters:
createDbClusterSnapshotRequest- AConsumerthat will call methods onCreateDbClusterSnapshotRequest.Builderto create a request. Represents the input of CreateDBClusterSnapshot.- Returns:
- Result of the CreateDBClusterSnapshot operation returned by the service.
- Throws:
DbClusterSnapshotAlreadyExistsException- You already have a cluster snapshot with the given identifier.InvalidDbClusterStateException- The cluster isn't in a valid state.DbClusterNotFoundException-DBClusterIdentifierdoesn't refer to an existing cluster.SnapshotQuotaExceededException- The request would cause you to exceed the allowed number of snapshots.InvalidDbClusterSnapshotStateException- The provided value isn't a valid cluster snapshot state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
DbInstanceAlreadyExistsException- You already have a instance with the given identifier.InsufficientDbInstanceCapacityException- The specified instance class isn't available in the specified Availability Zone.DbParameterGroupNotFoundException-DBParameterGroupNamedoesn't refer to an existing parameter group.DbSecurityGroupNotFoundException-DBSecurityGroupNamedoesn't refer to an existing security group.InstanceQuotaExceededException- The request would cause you to exceed the allowed number of instances.StorageQuotaExceededException- The request would cause you to exceed the allowed amount of storage available across all instances.DbSubnetGroupNotFoundException-DBSubnetGroupNamedoesn't refer to an existing subnet group.DbSubnetGroupDoesNotCoverEnoughAZsException- Subnets in the subnet group should cover at least two Availability Zones unless there is only one Availability Zone.InvalidDbClusterStateException- The cluster isn't in a valid state.InvalidSubnetException- The requested subnet is not valid, or multiple subnets were requested that are not all in a common virtual private cloud (VPC).InvalidVpcNetworkStateException- The subnet group doesn't cover all Availability Zones after it is created because of changes that were made.DbClusterNotFoundException-DBClusterIdentifierdoesn't refer to an existing cluster.StorageTypeNotSupportedException- Storage of the specifiedStorageTypecan't be associated with the DB instance.AuthorizationNotFoundException- The specified CIDR IP or Amazon EC2 security group isn't authorized for the specified security group.Amazon DocumentDB also might not be authorized to perform necessary actions on your behalf using IAM.
KmsKeyNotAccessibleException- An error occurred when accessing an KMS key.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaCreateDbInstanceRequest.builder()- Parameters:
createDbInstanceRequest- AConsumerthat will call methods onCreateDbInstanceRequest.Builderto create a request. Represents the input to CreateDBInstance.- Returns:
- Result of the CreateDBInstance operation returned by the service.
- Throws:
DbInstanceAlreadyExistsException- You already have a instance with the given identifier.InsufficientDbInstanceCapacityException- The specified instance class isn't available in the specified Availability Zone.DbParameterGroupNotFoundException-DBParameterGroupNamedoesn't refer to an existing parameter group.DbSecurityGroupNotFoundException-DBSecurityGroupNamedoesn't refer to an existing security group.InstanceQuotaExceededException- The request would cause you to exceed the allowed number of instances.StorageQuotaExceededException- The request would cause you to exceed the allowed amount of storage available across all instances.DbSubnetGroupNotFoundException-DBSubnetGroupNamedoesn't refer to an existing subnet group.DbSubnetGroupDoesNotCoverEnoughAZsException- Subnets in the subnet group should cover at least two Availability Zones unless there is only one Availability Zone.InvalidDbClusterStateException- The cluster isn't in a valid state.InvalidSubnetException- The requested subnet is not valid, or multiple subnets were requested that are not all in a common virtual private cloud (VPC).InvalidVpcNetworkStateException- The subnet group doesn't cover all Availability Zones after it is created because of changes that were made.DbClusterNotFoundException-DBClusterIdentifierdoesn't refer to an existing cluster.StorageTypeNotSupportedException- Storage of the specifiedStorageTypecan't be associated with the DB instance.AuthorizationNotFoundException- The specified CIDR IP or Amazon EC2 security group isn't authorized for the specified security group.Amazon DocumentDB also might not be authorized to perform necessary actions on your behalf using IAM.
KmsKeyNotAccessibleException- An error occurred when accessing an KMS key.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
DbSubnetGroupAlreadyExistsException-DBSubnetGroupNameis already being used by an existing subnet group.DbSubnetGroupQuotaExceededException- The request would cause you to exceed the allowed number of subnet groups.DbSubnetQuotaExceededException- The request would cause you to exceed the allowed number of subnets in a subnet group.DbSubnetGroupDoesNotCoverEnoughAZsException- Subnets in the subnet group should cover at least two Availability Zones unless there is only one Availability Zone.InvalidSubnetException- The requested subnet is not valid, or multiple subnets were requested that are not all in a common virtual private cloud (VPC).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaCreateDbSubnetGroupRequest.builder()- Parameters:
createDbSubnetGroupRequest- AConsumerthat will call methods onCreateDbSubnetGroupRequest.Builderto create a request. Represents the input to CreateDBSubnetGroup.- Returns:
- Result of the CreateDBSubnetGroup operation returned by the service.
- Throws:
DbSubnetGroupAlreadyExistsException-DBSubnetGroupNameis already being used by an existing subnet group.DbSubnetGroupQuotaExceededException- The request would cause you to exceed the allowed number of subnet groups.DbSubnetQuotaExceededException- The request would cause you to exceed the allowed number of subnets in a subnet group.DbSubnetGroupDoesNotCoverEnoughAZsException- Subnets in the subnet group should cover at least two Availability Zones unless there is only one Availability Zone.InvalidSubnetException- The requested subnet is not valid, or multiple subnets were requested that are not all in a common virtual private cloud (VPC).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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, mydbinstance2andEventCategories = Availability, Backup.If you specify both the
SourceTypeandSourceIds(such asSourceType = db-instanceandSourceIdentifier = myDBInstance1), you are notified of all thedb-instanceevents for the specified source. If you specify aSourceTypebut 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 theSourceTypeor 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.
- Throws:
EventSubscriptionQuotaExceededException- You have reached the maximum number of event subscriptions.SubscriptionAlreadyExistException- The provided subscription name already exists.SnsInvalidTopicException- Amazon SNS has responded that there is a problem with the specified topic.SnsNoAuthorizationException- You do not have permission to publish to the SNS topic Amazon Resource Name (ARN).SnsTopicArnNotFoundException- The SNS topic Amazon Resource Name (ARN) does not exist.SubscriptionCategoryNotFoundException- The provided category does not exist.SourceNotFoundException- The requested source could not be found.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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, mydbinstance2andEventCategories = Availability, Backup.If you specify both the
SourceTypeandSourceIds(such asSourceType = db-instanceandSourceIdentifier = myDBInstance1), you are notified of all thedb-instanceevents for the specified source. If you specify aSourceTypebut 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 theSourceTypeor 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.Builderavoiding the need to create one manually viaCreateEventSubscriptionRequest.builder()- Parameters:
createEventSubscriptionRequest- AConsumerthat will call methods onCreateEventSubscriptionRequest.Builderto create a request. Represents the input to CreateEventSubscription.- Returns:
- Result of the CreateEventSubscription operation returned by the service.
- Throws:
EventSubscriptionQuotaExceededException- You have reached the maximum number of event subscriptions.SubscriptionAlreadyExistException- The provided subscription name already exists.SnsInvalidTopicException- Amazon SNS has responded that there is a problem with the specified topic.SnsNoAuthorizationException- You do not have permission to publish to the SNS topic Amazon Resource Name (ARN).SnsTopicArnNotFoundException- The SNS topic Amazon Resource Name (ARN) does not exist.SubscriptionCategoryNotFoundException- The provided category does not exist.SourceNotFoundException- The requested source could not be found.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
GlobalClusterAlreadyExistsException- TheGlobalClusterIdentifieralready exists. Choose a new global cluster identifier (unique name) to create a new global cluster.GlobalClusterQuotaExceededException- The number of global clusters for this account is already at the maximum allowed.InvalidDbClusterStateException- The cluster isn't in a valid state.DbClusterNotFoundException-DBClusterIdentifierdoesn't refer to an existing cluster.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaCreateGlobalClusterRequest.builder()- Parameters:
createGlobalClusterRequest- AConsumerthat will call methods onCreateGlobalClusterRequest.Builderto create a request. Represents the input to CreateGlobalCluster.- Returns:
- Result of the CreateGlobalCluster operation returned by the service.
- Throws:
GlobalClusterAlreadyExistsException- TheGlobalClusterIdentifieralready exists. Choose a new global cluster identifier (unique name) to create a new global cluster.GlobalClusterQuotaExceededException- The number of global clusters for this account is already at the maximum allowed.InvalidDbClusterStateException- The cluster isn't in a valid state.DbClusterNotFoundException-DBClusterIdentifierdoesn't refer to an existing cluster.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
DbClusterNotFoundException-DBClusterIdentifierdoesn't refer to an existing cluster.InvalidDbClusterStateException- The cluster isn't in a valid state.DbClusterSnapshotAlreadyExistsException- You already have a cluster snapshot with the given identifier.SnapshotQuotaExceededException- The request would cause you to exceed the allowed number of snapshots.InvalidDbClusterSnapshotStateException- The provided value isn't a valid cluster snapshot state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDeleteDbClusterRequest.builder()- Parameters:
deleteDbClusterRequest- AConsumerthat will call methods onDeleteDbClusterRequest.Builderto create a request. Represents the input to DeleteDBCluster.- Returns:
- Result of the DeleteDBCluster operation returned by the service.
- Throws:
DbClusterNotFoundException-DBClusterIdentifierdoesn't refer to an existing cluster.InvalidDbClusterStateException- The cluster isn't in a valid state.DbClusterSnapshotAlreadyExistsException- You already have a cluster snapshot with the given identifier.SnapshotQuotaExceededException- The request would cause you to exceed the allowed number of snapshots.InvalidDbClusterSnapshotStateException- The provided value isn't a valid cluster snapshot state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidDbParameterGroupStateException- The parameter group is in use, or it is in a state that is not valid. If you are trying to delete the parameter group, you can't delete it when the parameter group is in this state.DbParameterGroupNotFoundException-DBParameterGroupNamedoesn't refer to an existing parameter group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDeleteDbClusterParameterGroupRequest.builder()- Parameters:
deleteDbClusterParameterGroupRequest- AConsumerthat will call methods onDeleteDbClusterParameterGroupRequest.Builderto create a request. Represents the input to DeleteDBClusterParameterGroup.- Returns:
- Result of the DeleteDBClusterParameterGroup operation returned by the service.
- Throws:
InvalidDbParameterGroupStateException- The parameter group is in use, or it is in a state that is not valid. If you are trying to delete the parameter group, you can't delete it when the parameter group is in this state.DbParameterGroupNotFoundException-DBParameterGroupNamedoesn't refer to an existing parameter group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
availablestate to be deleted.- Parameters:
deleteDbClusterSnapshotRequest- Represents the input to DeleteDBClusterSnapshot.- Returns:
- Result of the DeleteDBClusterSnapshot operation returned by the service.
- Throws:
InvalidDbClusterSnapshotStateException- The provided value isn't a valid cluster snapshot state.DbClusterSnapshotNotFoundException-DBClusterSnapshotIdentifierdoesn't refer to an existing cluster snapshot.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
availablestate to be deleted.
This is a convenience which creates an instance of the
DeleteDbClusterSnapshotRequest.Builderavoiding the need to create one manually viaDeleteDbClusterSnapshotRequest.builder()- Parameters:
deleteDbClusterSnapshotRequest- AConsumerthat will call methods onDeleteDbClusterSnapshotRequest.Builderto create a request. Represents the input to DeleteDBClusterSnapshot.- Returns:
- Result of the DeleteDBClusterSnapshot operation returned by the service.
- Throws:
InvalidDbClusterSnapshotStateException- The provided value isn't a valid cluster snapshot state.DbClusterSnapshotNotFoundException-DBClusterSnapshotIdentifierdoesn't refer to an existing cluster snapshot.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
DbInstanceNotFoundException-DBInstanceIdentifierdoesn't refer to an existing instance.InvalidDbInstanceStateException- The specified instance isn't in the available state.DbSnapshotAlreadyExistsException-DBSnapshotIdentifieris already being used by an existing snapshot.SnapshotQuotaExceededException- The request would cause you to exceed the allowed number of snapshots.InvalidDbClusterStateException- The cluster isn't in a valid state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDeleteDbInstanceRequest.builder()- Parameters:
deleteDbInstanceRequest- AConsumerthat will call methods onDeleteDbInstanceRequest.Builderto create a request. Represents the input to DeleteDBInstance.- Returns:
- Result of the DeleteDBInstance operation returned by the service.
- Throws:
DbInstanceNotFoundException-DBInstanceIdentifierdoesn't refer to an existing instance.InvalidDbInstanceStateException- The specified instance isn't in the available state.DbSnapshotAlreadyExistsException-DBSnapshotIdentifieris already being used by an existing snapshot.SnapshotQuotaExceededException- The request would cause you to exceed the allowed number of snapshots.InvalidDbClusterStateException- The cluster isn't in a valid state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidDbSubnetGroupStateException- The subnet group can't be deleted because it's in use.InvalidDbSubnetStateException- The subnet isn't in the available state.DbSubnetGroupNotFoundException-DBSubnetGroupNamedoesn't refer to an existing subnet group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDeleteDbSubnetGroupRequest.builder()- Parameters:
deleteDbSubnetGroupRequest- AConsumerthat will call methods onDeleteDbSubnetGroupRequest.Builderto create a request. Represents the input to DeleteDBSubnetGroup.- Returns:
- Result of the DeleteDBSubnetGroup operation returned by the service.
- Throws:
InvalidDbSubnetGroupStateException- The subnet group can't be deleted because it's in use.InvalidDbSubnetStateException- The subnet isn't in the available state.DbSubnetGroupNotFoundException-DBSubnetGroupNamedoesn't refer to an existing subnet group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
SubscriptionNotFoundException- The subscription name does not exist.InvalidEventSubscriptionStateException- Someone else might be modifying a subscription. Wait a few seconds, and try again.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDeleteEventSubscriptionRequest.builder()- Parameters:
deleteEventSubscriptionRequest- AConsumerthat will call methods onDeleteEventSubscriptionRequest.Builderto create a request. Represents the input to DeleteEventSubscription.- Returns:
- Result of the DeleteEventSubscription operation returned by the service.
- Throws:
SubscriptionNotFoundException- The subscription name does not exist.InvalidEventSubscriptionStateException- Someone else might be modifying a subscription. Wait a few seconds, and try again.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
GlobalClusterNotFoundException- TheGlobalClusterIdentifierdoesn't refer to an existing global cluster.InvalidGlobalClusterStateException- The requested operation can't be performed while the cluster is in this state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDeleteGlobalClusterRequest.builder()- Parameters:
deleteGlobalClusterRequest- AConsumerthat will call methods onDeleteGlobalClusterRequest.Builderto create a request. Represents the input to DeleteGlobalCluster.- Returns:
- Result of the DeleteGlobalCluster operation returned by the service.
- Throws:
GlobalClusterNotFoundException- TheGlobalClusterIdentifierdoesn't refer to an existing global cluster.InvalidGlobalClusterStateException- The requested operation can't be performed while the cluster is in this state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
CertificateNotFoundException-CertificateIdentifierdoesn't refer to an existing certificate.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDescribeCertificatesRequest.builder()- Parameters:
describeCertificatesRequest- AConsumerthat will call methods onDescribeCertificatesRequest.Builderto create a request.- Returns:
- Result of the DescribeCertificates operation returned by the service.
- Throws:
CertificateNotFoundException-CertificateIdentifierdoesn't refer to an existing certificate.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
CertificateNotFoundException-CertificateIdentifierdoesn't refer to an existing certificate.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaDescribeCertificatesRequest.builder()- Parameters:
describeCertificatesRequest- AConsumerthat will call methods onDescribeCertificatesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
CertificateNotFoundException-CertificateIdentifierdoesn't refer to an existing certificate.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDBClusterParameterGroups
default DescribeDbClusterParameterGroupsResponse describeDBClusterParameterGroups(DescribeDbClusterParameterGroupsRequest describeDbClusterParameterGroupsRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns a list of
DBClusterParameterGroupdescriptions. If aDBClusterParameterGroupNameparameter 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.
- Throws:
DbParameterGroupNotFoundException-DBParameterGroupNamedoesn't refer to an existing parameter group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDBClusterParameterGroups
default DescribeDbClusterParameterGroupsResponse describeDBClusterParameterGroups(Consumer<DescribeDbClusterParameterGroupsRequest.Builder> describeDbClusterParameterGroupsRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns a list of
DBClusterParameterGroupdescriptions. If aDBClusterParameterGroupNameparameter 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.Builderavoiding the need to create one manually viaDescribeDbClusterParameterGroupsRequest.builder()- Parameters:
describeDbClusterParameterGroupsRequest- AConsumerthat will call methods onDescribeDbClusterParameterGroupsRequest.Builderto create a request. Represents the input to DescribeDBClusterParameterGroups.- Returns:
- Result of the DescribeDBClusterParameterGroups operation returned by the service.
- Throws:
DbParameterGroupNotFoundException-DBParameterGroupNamedoesn't refer to an existing parameter group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDBClusterParameterGroups
default DescribeDbClusterParameterGroupsResponse describeDBClusterParameterGroups() throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns a list of
DBClusterParameterGroupdescriptions. If aDBClusterParameterGroupNameparameter is specified, the list contains only the description of the specified cluster parameter group.- Returns:
- Result of the DescribeDBClusterParameterGroups operation returned by the service.
- Throws:
DbParameterGroupNotFoundException-DBParameterGroupNamedoesn't refer to an existing parameter group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeDBClusterParameterGroups(DescribeDbClusterParameterGroupsRequest), AWS API Documentation
-
describeDBClusterParameterGroupsPaginator
default DescribeDBClusterParameterGroupsIterable describeDBClusterParameterGroupsPaginator() 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 Stream
2) Using For loopsoftware.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.
- Throws:
DbParameterGroupNotFoundException-DBParameterGroupNamedoesn't refer to an existing parameter group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeDBClusterParameterGroupsPaginator(DescribeDbClusterParameterGroupsRequest), AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
DbParameterGroupNotFoundException-DBParameterGroupNamedoesn't refer to an existing parameter group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaDescribeDbClusterParameterGroupsRequest.builder()- Parameters:
describeDbClusterParameterGroupsRequest- AConsumerthat will call methods onDescribeDbClusterParameterGroupsRequest.Builderto create a request. Represents the input to DescribeDBClusterParameterGroups.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
DbParameterGroupNotFoundException-DBParameterGroupNamedoesn't refer to an existing parameter group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
DbParameterGroupNotFoundException-DBParameterGroupNamedoesn't refer to an existing parameter group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDescribeDbClusterParametersRequest.builder()- Parameters:
describeDbClusterParametersRequest- AConsumerthat will call methods onDescribeDbClusterParametersRequest.Builderto create a request. Represents the input to DescribeDBClusterParameters.- Returns:
- Result of the DescribeDBClusterParameters operation returned by the service.
- Throws:
DbParameterGroupNotFoundException-DBParameterGroupNamedoesn't refer to an existing parameter group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
DbParameterGroupNotFoundException-DBParameterGroupNamedoesn't refer to an existing parameter group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaDescribeDbClusterParametersRequest.builder()- Parameters:
describeDbClusterParametersRequest- AConsumerthat will call methods onDescribeDbClusterParametersRequest.Builderto create a request. Represents the input to DescribeDBClusterParameters.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
DbParameterGroupNotFoundException-DBParameterGroupNamedoesn't refer to an existing parameter group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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,
DescribeDBClusterSnapshotAttributesreturns therestoreattribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore the manual cluster snapshot. Ifallis included in the list of values for therestoreattribute, 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.
- Throws:
DbClusterSnapshotNotFoundException-DBClusterSnapshotIdentifierdoesn't refer to an existing cluster snapshot.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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,
DescribeDBClusterSnapshotAttributesreturns therestoreattribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore the manual cluster snapshot. Ifallis included in the list of values for therestoreattribute, 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.Builderavoiding the need to create one manually viaDescribeDbClusterSnapshotAttributesRequest.builder()- Parameters:
describeDbClusterSnapshotAttributesRequest- AConsumerthat will call methods onDescribeDbClusterSnapshotAttributesRequest.Builderto create a request. Represents the input to DescribeDBClusterSnapshotAttributes.- Returns:
- Result of the DescribeDBClusterSnapshotAttributes operation returned by the service.
- Throws:
DbClusterSnapshotNotFoundException-DBClusterSnapshotIdentifierdoesn't refer to an existing cluster snapshot.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
DbClusterSnapshotNotFoundException-DBClusterSnapshotIdentifierdoesn't refer to an existing cluster snapshot.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDescribeDbClusterSnapshotsRequest.builder()- Parameters:
describeDbClusterSnapshotsRequest- AConsumerthat will call methods onDescribeDbClusterSnapshotsRequest.Builderto create a request. Represents the input to DescribeDBClusterSnapshots.- Returns:
- Result of the DescribeDBClusterSnapshots operation returned by the service.
- Throws:
DbClusterSnapshotNotFoundException-DBClusterSnapshotIdentifierdoesn't refer to an existing cluster snapshot.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDBClusterSnapshots
default DescribeDbClusterSnapshotsResponse describeDBClusterSnapshots() throws DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns information about cluster snapshots. This API operation supports pagination.
- Returns:
- Result of the DescribeDBClusterSnapshots operation returned by the service.
- Throws:
DbClusterSnapshotNotFoundException-DBClusterSnapshotIdentifierdoesn't refer to an existing cluster snapshot.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeDBClusterSnapshots(DescribeDbClusterSnapshotsRequest), AWS API Documentation
-
describeDBClusterSnapshotsPaginator
default DescribeDBClusterSnapshotsIterable describeDBClusterSnapshotsPaginator() 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 Stream
2) Using For loopsoftware.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.
- Throws:
DbClusterSnapshotNotFoundException-DBClusterSnapshotIdentifierdoesn't refer to an existing cluster snapshot.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeDBClusterSnapshotsPaginator(DescribeDbClusterSnapshotsRequest), AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
DbClusterSnapshotNotFoundException-DBClusterSnapshotIdentifierdoesn't refer to an existing cluster snapshot.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaDescribeDbClusterSnapshotsRequest.builder()- Parameters:
describeDbClusterSnapshotsRequest- AConsumerthat will call methods onDescribeDbClusterSnapshotsRequest.Builderto create a request. Represents the input to DescribeDBClusterSnapshots.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
DbClusterSnapshotNotFoundException-DBClusterSnapshotIdentifierdoesn't refer to an existing cluster snapshot.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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=docdbfilter parameter to return only Amazon DocumentDB clusters.- Parameters:
describeDbClustersRequest- Represents the input to DescribeDBClusters.- Returns:
- Result of the DescribeDBClusters operation returned by the service.
- Throws:
DbClusterNotFoundException-DBClusterIdentifierdoesn't refer to an existing cluster.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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=docdbfilter parameter to return only Amazon DocumentDB clusters.
This is a convenience which creates an instance of the
DescribeDbClustersRequest.Builderavoiding the need to create one manually viaDescribeDbClustersRequest.builder()- Parameters:
describeDbClustersRequest- AConsumerthat will call methods onDescribeDbClustersRequest.Builderto create a request. Represents the input to DescribeDBClusters.- Returns:
- Result of the DescribeDBClusters operation returned by the service.
- Throws:
DbClusterNotFoundException-DBClusterIdentifierdoesn't refer to an existing cluster.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDBClusters
default DescribeDbClustersResponse describeDBClusters() 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=docdbfilter parameter to return only Amazon DocumentDB clusters.- Returns:
- Result of the DescribeDBClusters operation returned by the service.
- Throws:
DbClusterNotFoundException-DBClusterIdentifierdoesn't refer to an existing cluster.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeDBClusters(DescribeDbClustersRequest), AWS API Documentation
-
describeDBClustersPaginator
default DescribeDBClustersIterable describeDBClustersPaginator() 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 Stream
2) Using For loopsoftware.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.
- Throws:
DbClusterNotFoundException-DBClusterIdentifierdoesn't refer to an existing cluster.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeDBClustersPaginator(DescribeDbClustersRequest), AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
DbClusterNotFoundException-DBClusterIdentifierdoesn't refer to an existing cluster.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaDescribeDbClustersRequest.builder()- Parameters:
describeDbClustersRequest- AConsumerthat will call methods onDescribeDbClustersRequest.Builderto create a request. Represents the input to DescribeDBClusters.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
DbClusterNotFoundException-DBClusterIdentifierdoesn't refer to an existing cluster.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDescribeDbEngineVersionsRequest.builder()- Parameters:
describeDbEngineVersionsRequest- AConsumerthat will call methods onDescribeDbEngineVersionsRequest.Builderto create a request. Represents the input to DescribeDBEngineVersions.- Returns:
- Result of the DescribeDBEngineVersions operation returned by the service.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDBEngineVersions
default DescribeDbEngineVersionsResponse describeDBEngineVersions() throws AwsServiceException, SdkClientException, DocDbException
Returns a list of the available engines.
- Returns:
- Result of the DescribeDBEngineVersions operation returned by the service.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeDBEngineVersions(DescribeDbEngineVersionsRequest), AWS API Documentation
-
describeDBEngineVersionsPaginator
default DescribeDBEngineVersionsIterable describeDBEngineVersionsPaginator() 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 Stream
2) Using For loopsoftware.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.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeDBEngineVersionsPaginator(DescribeDbEngineVersionsRequest), AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaDescribeDbEngineVersionsRequest.builder()- Parameters:
describeDbEngineVersionsRequest- AConsumerthat will call methods onDescribeDbEngineVersionsRequest.Builderto create a request. Represents the input to DescribeDBEngineVersions.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
DbInstanceNotFoundException-DBInstanceIdentifierdoesn't refer to an existing instance.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDescribeDbInstancesRequest.builder()- Parameters:
describeDbInstancesRequest- AConsumerthat will call methods onDescribeDbInstancesRequest.Builderto create a request. Represents the input to DescribeDBInstances.- Returns:
- Result of the DescribeDBInstances operation returned by the service.
- Throws:
DbInstanceNotFoundException-DBInstanceIdentifierdoesn't refer to an existing instance.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDBInstances
default DescribeDbInstancesResponse describeDBInstances() throws DbInstanceNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns information about provisioned Amazon DocumentDB instances. This API supports pagination.
- Returns:
- Result of the DescribeDBInstances operation returned by the service.
- Throws:
DbInstanceNotFoundException-DBInstanceIdentifierdoesn't refer to an existing instance.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeDBInstances(DescribeDbInstancesRequest), AWS API Documentation
-
describeDBInstancesPaginator
default DescribeDBInstancesIterable describeDBInstancesPaginator() 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 Stream
2) Using For loopsoftware.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.
- Throws:
DbInstanceNotFoundException-DBInstanceIdentifierdoesn't refer to an existing instance.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeDBInstancesPaginator(DescribeDbInstancesRequest), AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
DbInstanceNotFoundException-DBInstanceIdentifierdoesn't refer to an existing instance.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaDescribeDbInstancesRequest.builder()- Parameters:
describeDbInstancesRequest- AConsumerthat will call methods onDescribeDbInstancesRequest.Builderto create a request. Represents the input to DescribeDBInstances.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
DbInstanceNotFoundException-DBInstanceIdentifierdoesn't refer to an existing instance.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDBSubnetGroups
default DescribeDbSubnetGroupsResponse describeDBSubnetGroups(DescribeDbSubnetGroupsRequest describeDbSubnetGroupsRequest) throws DbSubnetGroupNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns a list of
DBSubnetGroupdescriptions. If aDBSubnetGroupNameis 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.
- Throws:
DbSubnetGroupNotFoundException-DBSubnetGroupNamedoesn't refer to an existing subnet group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDBSubnetGroups
default DescribeDbSubnetGroupsResponse describeDBSubnetGroups(Consumer<DescribeDbSubnetGroupsRequest.Builder> describeDbSubnetGroupsRequest) throws DbSubnetGroupNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns a list of
DBSubnetGroupdescriptions. If aDBSubnetGroupNameis specified, the list will contain only the descriptions of the specifiedDBSubnetGroup.
This is a convenience which creates an instance of the
DescribeDbSubnetGroupsRequest.Builderavoiding the need to create one manually viaDescribeDbSubnetGroupsRequest.builder()- Parameters:
describeDbSubnetGroupsRequest- AConsumerthat will call methods onDescribeDbSubnetGroupsRequest.Builderto create a request. Represents the input to DescribeDBSubnetGroups.- Returns:
- Result of the DescribeDBSubnetGroups operation returned by the service.
- Throws:
DbSubnetGroupNotFoundException-DBSubnetGroupNamedoesn't refer to an existing subnet group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeDBSubnetGroups
default DescribeDbSubnetGroupsResponse describeDBSubnetGroups() throws DbSubnetGroupNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns a list of
DBSubnetGroupdescriptions. If aDBSubnetGroupNameis specified, the list will contain only the descriptions of the specifiedDBSubnetGroup.- Returns:
- Result of the DescribeDBSubnetGroups operation returned by the service.
- Throws:
DbSubnetGroupNotFoundException-DBSubnetGroupNamedoesn't refer to an existing subnet group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeDBSubnetGroups(DescribeDbSubnetGroupsRequest), AWS API Documentation
-
describeDBSubnetGroupsPaginator
default DescribeDBSubnetGroupsIterable describeDBSubnetGroupsPaginator() 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 Stream
2) Using For loopsoftware.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.
- Throws:
DbSubnetGroupNotFoundException-DBSubnetGroupNamedoesn't refer to an existing subnet group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeDBSubnetGroupsPaginator(DescribeDbSubnetGroupsRequest), AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
DbSubnetGroupNotFoundException-DBSubnetGroupNamedoesn't refer to an existing subnet group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaDescribeDbSubnetGroupsRequest.builder()- Parameters:
describeDbSubnetGroupsRequest- AConsumerthat will call methods onDescribeDbSubnetGroupsRequest.Builderto create a request. Represents the input to DescribeDBSubnetGroups.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
DbSubnetGroupNotFoundException-DBSubnetGroupNamedoesn't refer to an existing subnet group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDescribeEngineDefaultClusterParametersRequest.builder()- Parameters:
describeEngineDefaultClusterParametersRequest- AConsumerthat will call methods onDescribeEngineDefaultClusterParametersRequest.Builderto create a request. Represents the input to DescribeEngineDefaultClusterParameters.- Returns:
- Result of the DescribeEngineDefaultClusterParameters operation returned by the service.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDescribeEventCategoriesRequest.builder()- Parameters:
describeEventCategoriesRequest- AConsumerthat will call methods onDescribeEventCategoriesRequest.Builderto create a request. Represents the input to DescribeEventCategories.- Returns:
- Result of the DescribeEventCategories operation returned by the service.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeEventCategories
default DescribeEventCategoriesResponse describeEventCategories() throws AwsServiceException, SdkClientException, DocDbException
Displays 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.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeEventCategories(DescribeEventCategoriesRequest), AWS API Documentation
-
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.
- Throws:
SubscriptionNotFoundException- The subscription name does not exist.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDescribeEventSubscriptionsRequest.builder()- Parameters:
describeEventSubscriptionsRequest- AConsumerthat will call methods onDescribeEventSubscriptionsRequest.Builderto create a request. Represents the input to DescribeEventSubscriptions.- Returns:
- Result of the DescribeEventSubscriptions operation returned by the service.
- Throws:
SubscriptionNotFoundException- The subscription name does not exist.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
SubscriptionNotFoundException- The subscription name does not exist.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaDescribeEventSubscriptionsRequest.builder()- Parameters:
describeEventSubscriptionsRequest- AConsumerthat will call methods onDescribeEventSubscriptionsRequest.Builderto create a request. Represents the input to DescribeEventSubscriptions.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SubscriptionNotFoundException- The subscription name does not exist.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDescribeEventsRequest.builder()- Parameters:
describeEventsRequest- AConsumerthat will call methods onDescribeEventsRequest.Builderto create a request. Represents the input to DescribeEvents.- Returns:
- Result of the DescribeEvents operation returned by the service.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeEvents
default DescribeEventsResponse describeEvents() 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.
- Returns:
- Result of the DescribeEvents operation returned by the service.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeEvents(DescribeEventsRequest), AWS API Documentation
-
describeEventsPaginator
default DescribeEventsIterable describeEventsPaginator() 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 Stream
2) Using For loopsoftware.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.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeEventsPaginator(DescribeEventsRequest), AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaDescribeEventsRequest.builder()- Parameters:
describeEventsRequest- AConsumerthat will call methods onDescribeEventsRequest.Builderto create a request. Represents the input to DescribeEvents.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
GlobalClusterNotFoundException- TheGlobalClusterIdentifierdoesn't refer to an existing global cluster.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDescribeGlobalClustersRequest.builder()- Parameters:
describeGlobalClustersRequest- AConsumerthat will call methods onDescribeGlobalClustersRequest.Builderto create a request.- Returns:
- Result of the DescribeGlobalClusters operation returned by the service.
- Throws:
GlobalClusterNotFoundException- TheGlobalClusterIdentifierdoesn't refer to an existing global cluster.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
GlobalClusterNotFoundException- TheGlobalClusterIdentifierdoesn't refer to an existing global cluster.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaDescribeGlobalClustersRequest.builder()- Parameters:
describeGlobalClustersRequest- AConsumerthat will call methods onDescribeGlobalClustersRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
GlobalClusterNotFoundException- TheGlobalClusterIdentifierdoesn't refer to an existing global cluster.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDescribeOrderableDbInstanceOptionsRequest.builder()- Parameters:
describeOrderableDbInstanceOptionsRequest- AConsumerthat will call methods onDescribeOrderableDbInstanceOptionsRequest.Builderto create a request. Represents the input to DescribeOrderableDBInstanceOptions.- Returns:
- Result of the DescribeOrderableDBInstanceOptions operation returned by the service.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaDescribeOrderableDbInstanceOptionsRequest.builder()- Parameters:
describeOrderableDbInstanceOptionsRequest- AConsumerthat will call methods onDescribeOrderableDbInstanceOptionsRequest.Builderto create a request. Represents the input to DescribeOrderableDBInstanceOptions.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
ResourceNotFoundException- The specified resource ID was not found.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDescribePendingMaintenanceActionsRequest.builder()- Parameters:
describePendingMaintenanceActionsRequest- AConsumerthat will call methods onDescribePendingMaintenanceActionsRequest.Builderto create a request. Represents the input to DescribePendingMaintenanceActions.- Returns:
- Result of the DescribePendingMaintenanceActions operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource ID was not found.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describePendingMaintenanceActions
default DescribePendingMaintenanceActionsResponse describePendingMaintenanceActions() throws ResourceNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns 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.
- Throws:
ResourceNotFoundException- The specified resource ID was not found.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest), AWS API Documentation
-
describePendingMaintenanceActionsPaginator
default DescribePendingMaintenanceActionsIterable describePendingMaintenanceActionsPaginator() 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 Stream
2) Using For loopsoftware.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.
- Throws:
ResourceNotFoundException- The specified resource ID was not found.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describePendingMaintenanceActionsPaginator(DescribePendingMaintenanceActionsRequest), AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.
- Throws:
ResourceNotFoundException- The specified resource ID was not found.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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 Stream
2) Using For loopsoftware.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.Builderavoiding the need to create one manually viaDescribePendingMaintenanceActionsRequest.builder()- Parameters:
describePendingMaintenanceActionsRequest- AConsumerthat will call methods onDescribePendingMaintenanceActionsRequest.Builderto create a request. Represents the input to DescribePendingMaintenanceActions.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException- The specified resource ID was not found.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
DbClusterNotFoundException-DBClusterIdentifierdoesn't refer to an existing cluster.InvalidDbClusterStateException- The cluster isn't in a valid state.InvalidDbInstanceStateException- The specified instance isn't in the available state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaFailoverDbClusterRequest.builder()- Parameters:
failoverDbClusterRequest- AConsumerthat will call methods onFailoverDbClusterRequest.Builderto create a request. Represents the input to FailoverDBCluster.- Returns:
- Result of the FailoverDBCluster operation returned by the service.
- Throws:
DbClusterNotFoundException-DBClusterIdentifierdoesn't refer to an existing cluster.InvalidDbClusterStateException- The cluster isn't in a valid state.InvalidDbInstanceStateException- The specified instance isn't in the available state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
DbInstanceNotFoundException-DBInstanceIdentifierdoesn't refer to an existing instance.DbSnapshotNotFoundException-DBSnapshotIdentifierdoesn't refer to an existing snapshot.DbClusterNotFoundException-DBClusterIdentifierdoesn't refer to an existing cluster.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request. Represents the input to ListTagsForResource.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
DbInstanceNotFoundException-DBInstanceIdentifierdoesn't refer to an existing instance.DbSnapshotNotFoundException-DBSnapshotIdentifierdoesn't refer to an existing snapshot.DbClusterNotFoundException-DBClusterIdentifierdoesn't refer to an existing cluster.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
DbClusterNotFoundException-DBClusterIdentifierdoesn't refer to an existing cluster.InvalidDbClusterStateException- The cluster isn't in a valid state.StorageQuotaExceededException- The request would cause you to exceed the allowed amount of storage available across all instances.DbSubnetGroupNotFoundException-DBSubnetGroupNamedoesn't refer to an existing subnet group.InvalidVpcNetworkStateException- The subnet group doesn't cover all Availability Zones after it is created because of changes that were made.InvalidDbSubnetGroupStateException- The subnet group can't be deleted because it's in use.InvalidSubnetException- The requested subnet is not valid, or multiple subnets were requested that are not all in a common virtual private cloud (VPC).DbClusterParameterGroupNotFoundException-DBClusterParameterGroupNamedoesn't refer to an existing cluster parameter group.InvalidDbSecurityGroupStateException- The state of the security group doesn't allow deletion.InvalidDbInstanceStateException- The specified instance isn't in the available state.DbClusterAlreadyExistsException- You already have a cluster with the given identifier.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaModifyDbClusterRequest.builder()- Parameters:
modifyDbClusterRequest- AConsumerthat will call methods onModifyDbClusterRequest.Builderto create a request. Represents the input to ModifyDBCluster.- Returns:
- Result of the ModifyDBCluster operation returned by the service.
- Throws:
DbClusterNotFoundException-DBClusterIdentifierdoesn't refer to an existing cluster.InvalidDbClusterStateException- The cluster isn't in a valid state.StorageQuotaExceededException- The request would cause you to exceed the allowed amount of storage available across all instances.DbSubnetGroupNotFoundException-DBSubnetGroupNamedoesn't refer to an existing subnet group.InvalidVpcNetworkStateException- The subnet group doesn't cover all Availability Zones after it is created because of changes that were made.InvalidDbSubnetGroupStateException- The subnet group can't be deleted because it's in use.InvalidSubnetException- The requested subnet is not valid, or multiple subnets were requested that are not all in a common virtual private cloud (VPC).DbClusterParameterGroupNotFoundException-DBClusterParameterGroupNamedoesn't refer to an existing cluster parameter group.InvalidDbSecurityGroupStateException- The state of the security group doesn't allow deletion.InvalidDbInstanceStateException- The specified instance isn't in the available state.DbClusterAlreadyExistsException- You already have a cluster with the given identifier.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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_databaseparameter.- Parameters:
modifyDbClusterParameterGroupRequest- Represents the input to ModifyDBClusterParameterGroup.- Returns:
- Result of the ModifyDBClusterParameterGroup operation returned by the service.
- Throws:
DbParameterGroupNotFoundException-DBParameterGroupNamedoesn't refer to an existing parameter group.InvalidDbParameterGroupStateException- The parameter group is in use, or it is in a state that is not valid. If you are trying to delete the parameter group, you can't delete it when the parameter group is in this state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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_databaseparameter.
This is a convenience which creates an instance of the
ModifyDbClusterParameterGroupRequest.Builderavoiding the need to create one manually viaModifyDbClusterParameterGroupRequest.builder()- Parameters:
modifyDbClusterParameterGroupRequest- AConsumerthat will call methods onModifyDbClusterParameterGroupRequest.Builderto create a request. Represents the input to ModifyDBClusterParameterGroup.- Returns:
- Result of the ModifyDBClusterParameterGroup operation returned by the service.
- Throws:
DbParameterGroupNotFoundException-DBParameterGroupNamedoesn't refer to an existing parameter group.InvalidDbParameterGroupStateException- The parameter group is in use, or it is in a state that is not valid. If you are trying to delete the parameter group, you can't delete it when the parameter group is in this state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
restoreas theAttributeName, and use theValuesToAddparameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual cluster snapshot. Use the valueallto make the manual cluster snapshot public, which means that it can be copied or restored by all Amazon Web Services accounts. Do not add theallvalue 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 theValuesToAddparameter. You can't useallas 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.
- Throws:
DbClusterSnapshotNotFoundException-DBClusterSnapshotIdentifierdoesn't refer to an existing cluster snapshot.InvalidDbClusterSnapshotStateException- The provided value isn't a valid cluster snapshot state.SharedSnapshotQuotaExceededException- You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
restoreas theAttributeName, and use theValuesToAddparameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual cluster snapshot. Use the valueallto make the manual cluster snapshot public, which means that it can be copied or restored by all Amazon Web Services accounts. Do not add theallvalue 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 theValuesToAddparameter. You can't useallas a value for that parameter in this case.
This is a convenience which creates an instance of the
ModifyDbClusterSnapshotAttributeRequest.Builderavoiding the need to create one manually viaModifyDbClusterSnapshotAttributeRequest.builder()- Parameters:
modifyDbClusterSnapshotAttributeRequest- AConsumerthat will call methods onModifyDbClusterSnapshotAttributeRequest.Builderto create a request. Represents the input to ModifyDBClusterSnapshotAttribute.- Returns:
- Result of the ModifyDBClusterSnapshotAttribute operation returned by the service.
- Throws:
DbClusterSnapshotNotFoundException-DBClusterSnapshotIdentifierdoesn't refer to an existing cluster snapshot.InvalidDbClusterSnapshotStateException- The provided value isn't a valid cluster snapshot state.SharedSnapshotQuotaExceededException- You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidDbInstanceStateException- The specified instance isn't in the available state.InvalidDbSecurityGroupStateException- The state of the security group doesn't allow deletion.DbInstanceAlreadyExistsException- You already have a instance with the given identifier.DbInstanceNotFoundException-DBInstanceIdentifierdoesn't refer to an existing instance.DbSecurityGroupNotFoundException-DBSecurityGroupNamedoesn't refer to an existing security group.DbParameterGroupNotFoundException-DBParameterGroupNamedoesn't refer to an existing parameter group.InsufficientDbInstanceCapacityException- The specified instance class isn't available in the specified Availability Zone.StorageQuotaExceededException- The request would cause you to exceed the allowed amount of storage available across all instances.InvalidVpcNetworkStateException- The subnet group doesn't cover all Availability Zones after it is created because of changes that were made.DbUpgradeDependencyFailureException- The upgrade failed because a resource that the depends on can't be modified.StorageTypeNotSupportedException- Storage of the specifiedStorageTypecan't be associated with the DB instance.AuthorizationNotFoundException- The specified CIDR IP or Amazon EC2 security group isn't authorized for the specified security group.Amazon DocumentDB also might not be authorized to perform necessary actions on your behalf using IAM.
CertificateNotFoundException-CertificateIdentifierdoesn't refer to an existing certificate.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaModifyDbInstanceRequest.builder()- Parameters:
modifyDbInstanceRequest- AConsumerthat will call methods onModifyDbInstanceRequest.Builderto create a request. Represents the input to ModifyDBInstance.- Returns:
- Result of the ModifyDBInstance operation returned by the service.
- Throws:
InvalidDbInstanceStateException- The specified instance isn't in the available state.InvalidDbSecurityGroupStateException- The state of the security group doesn't allow deletion.DbInstanceAlreadyExistsException- You already have a instance with the given identifier.DbInstanceNotFoundException-DBInstanceIdentifierdoesn't refer to an existing instance.DbSecurityGroupNotFoundException-DBSecurityGroupNamedoesn't refer to an existing security group.DbParameterGroupNotFoundException-DBParameterGroupNamedoesn't refer to an existing parameter group.InsufficientDbInstanceCapacityException- The specified instance class isn't available in the specified Availability Zone.StorageQuotaExceededException- The request would cause you to exceed the allowed amount of storage available across all instances.InvalidVpcNetworkStateException- The subnet group doesn't cover all Availability Zones after it is created because of changes that were made.DbUpgradeDependencyFailureException- The upgrade failed because a resource that the depends on can't be modified.StorageTypeNotSupportedException- Storage of the specifiedStorageTypecan't be associated with the DB instance.AuthorizationNotFoundException- The specified CIDR IP or Amazon EC2 security group isn't authorized for the specified security group.Amazon DocumentDB also might not be authorized to perform necessary actions on your behalf using IAM.
CertificateNotFoundException-CertificateIdentifierdoesn't refer to an existing certificate.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
DbSubnetGroupNotFoundException-DBSubnetGroupNamedoesn't refer to an existing subnet group.DbSubnetQuotaExceededException- The request would cause you to exceed the allowed number of subnets in a subnet group.SubnetAlreadyInUseException- The subnet is already in use in the Availability Zone.DbSubnetGroupDoesNotCoverEnoughAZsException- Subnets in the subnet group should cover at least two Availability Zones unless there is only one Availability Zone.InvalidSubnetException- The requested subnet is not valid, or multiple subnets were requested that are not all in a common virtual private cloud (VPC).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaModifyDbSubnetGroupRequest.builder()- Parameters:
modifyDbSubnetGroupRequest- AConsumerthat will call methods onModifyDbSubnetGroupRequest.Builderto create a request. Represents the input to ModifyDBSubnetGroup.- Returns:
- Result of the ModifyDBSubnetGroup operation returned by the service.
- Throws:
DbSubnetGroupNotFoundException-DBSubnetGroupNamedoesn't refer to an existing subnet group.DbSubnetQuotaExceededException- The request would cause you to exceed the allowed number of subnets in a subnet group.SubnetAlreadyInUseException- The subnet is already in use in the Availability Zone.DbSubnetGroupDoesNotCoverEnoughAZsException- Subnets in the subnet group should cover at least two Availability Zones unless there is only one Availability Zone.InvalidSubnetException- The requested subnet is not valid, or multiple subnets were requested that are not all in a common virtual private cloud (VPC).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
EventSubscriptionQuotaExceededException- You have reached the maximum number of event subscriptions.SubscriptionNotFoundException- The subscription name does not exist.SnsInvalidTopicException- Amazon SNS has responded that there is a problem with the specified topic.SnsNoAuthorizationException- You do not have permission to publish to the SNS topic Amazon Resource Name (ARN).SnsTopicArnNotFoundException- The SNS topic Amazon Resource Name (ARN) does not exist.SubscriptionCategoryNotFoundException- The provided category does not exist.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaModifyEventSubscriptionRequest.builder()- Parameters:
modifyEventSubscriptionRequest- AConsumerthat will call methods onModifyEventSubscriptionRequest.Builderto create a request. Represents the input to ModifyEventSubscription.- Returns:
- Result of the ModifyEventSubscription operation returned by the service.
- Throws:
EventSubscriptionQuotaExceededException- You have reached the maximum number of event subscriptions.SubscriptionNotFoundException- The subscription name does not exist.SnsInvalidTopicException- Amazon SNS has responded that there is a problem with the specified topic.SnsNoAuthorizationException- You do not have permission to publish to the SNS topic Amazon Resource Name (ARN).SnsTopicArnNotFoundException- The SNS topic Amazon Resource Name (ARN) does not exist.SubscriptionCategoryNotFoundException- The provided category does not exist.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
GlobalClusterNotFoundException- TheGlobalClusterIdentifierdoesn't refer to an existing global cluster.InvalidGlobalClusterStateException- The requested operation can't be performed while the cluster is in this state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaModifyGlobalClusterRequest.builder()- Parameters:
modifyGlobalClusterRequest- AConsumerthat will call methods onModifyGlobalClusterRequest.Builderto create a request. Represents the input to ModifyGlobalCluster.- Returns:
- Result of the ModifyGlobalCluster operation returned by the service.
- Throws:
GlobalClusterNotFoundException- TheGlobalClusterIdentifierdoesn't refer to an existing global cluster.InvalidGlobalClusterStateException- The requested operation can't be performed while the cluster is in this state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
InvalidDbInstanceStateException- The specified instance isn't in the available state.DbInstanceNotFoundException-DBInstanceIdentifierdoesn't refer to an existing instance.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaRebootDbInstanceRequest.builder()- Parameters:
rebootDbInstanceRequest- AConsumerthat will call methods onRebootDbInstanceRequest.Builderto create a request. Represents the input to RebootDBInstance.- Returns:
- Result of the RebootDBInstance operation returned by the service.
- Throws:
InvalidDbInstanceStateException- The specified instance isn't in the available state.DbInstanceNotFoundException-DBInstanceIdentifierdoesn't refer to an existing instance.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
GlobalClusterNotFoundException- TheGlobalClusterIdentifierdoesn't refer to an existing global cluster.InvalidGlobalClusterStateException- The requested operation can't be performed while the cluster is in this state.DbClusterNotFoundException-DBClusterIdentifierdoesn't refer to an existing cluster.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaRemoveFromGlobalClusterRequest.builder()- Parameters:
removeFromGlobalClusterRequest- AConsumerthat will call methods onRemoveFromGlobalClusterRequest.Builderto create a request. Represents the input to RemoveFromGlobalCluster.- Returns:
- Result of the RemoveFromGlobalCluster operation returned by the service.
- Throws:
GlobalClusterNotFoundException- TheGlobalClusterIdentifierdoesn't refer to an existing global cluster.InvalidGlobalClusterStateException- The requested operation can't be performed while the cluster is in this state.DbClusterNotFoundException-DBClusterIdentifierdoesn't refer to an existing cluster.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
SubscriptionNotFoundException- The subscription name does not exist.SourceNotFoundException- The requested source could not be found.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaRemoveSourceIdentifierFromSubscriptionRequest.builder()- Parameters:
removeSourceIdentifierFromSubscriptionRequest- AConsumerthat will call methods onRemoveSourceIdentifierFromSubscriptionRequest.Builderto create a request. Represents the input to RemoveSourceIdentifierFromSubscription.- Returns:
- Result of the RemoveSourceIdentifierFromSubscription operation returned by the service.
- Throws:
SubscriptionNotFoundException- The subscription name does not exist.SourceNotFoundException- The requested source could not be found.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
DbInstanceNotFoundException-DBInstanceIdentifierdoesn't refer to an existing instance.DbSnapshotNotFoundException-DBSnapshotIdentifierdoesn't refer to an existing snapshot.DbClusterNotFoundException-DBClusterIdentifierdoesn't refer to an existing cluster.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaRemoveTagsFromResourceRequest.builder()- Parameters:
removeTagsFromResourceRequest- AConsumerthat will call methods onRemoveTagsFromResourceRequest.Builderto create a request. Represents the input to RemoveTagsFromResource.- Returns:
- Result of the RemoveTagsFromResource operation returned by the service.
- Throws:
DbInstanceNotFoundException-DBInstanceIdentifierdoesn't refer to an existing instance.DbSnapshotNotFoundException-DBSnapshotIdentifierdoesn't refer to an existing snapshot.DbClusterNotFoundException-DBClusterIdentifierdoesn't refer to an existing cluster.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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:
ParameterNameandApplyMethod. To reset the entire cluster parameter group, specify theDBClusterParameterGroupNameandResetAllParametersparameters.When you reset the entire group, dynamic parameters are updated immediately and static parameters are set to
pending-rebootto 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.
- Throws:
InvalidDbParameterGroupStateException- The parameter group is in use, or it is in a state that is not valid. If you are trying to delete the parameter group, you can't delete it when the parameter group is in this state.DbParameterGroupNotFoundException-DBParameterGroupNamedoesn't refer to an existing parameter group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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:
ParameterNameandApplyMethod. To reset the entire cluster parameter group, specify theDBClusterParameterGroupNameandResetAllParametersparameters.When you reset the entire group, dynamic parameters are updated immediately and static parameters are set to
pending-rebootto take effect on the next DB instance reboot.
This is a convenience which creates an instance of the
ResetDbClusterParameterGroupRequest.Builderavoiding the need to create one manually viaResetDbClusterParameterGroupRequest.builder()- Parameters:
resetDbClusterParameterGroupRequest- AConsumerthat will call methods onResetDbClusterParameterGroupRequest.Builderto create a request. Represents the input to ResetDBClusterParameterGroup.- Returns:
- Result of the ResetDBClusterParameterGroup operation returned by the service.
- Throws:
InvalidDbParameterGroupStateException- The parameter group is in use, or it is in a state that is not valid. If you are trying to delete the parameter group, you can't delete it when the parameter group is in this state.DbParameterGroupNotFoundException-DBParameterGroupNamedoesn't refer to an existing parameter group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
DbClusterAlreadyExistsException- You already have a cluster with the given identifier.DbClusterQuotaExceededException- The cluster can't be created because you have reached the maximum allowed quota of clusters.StorageQuotaExceededException- The request would cause you to exceed the allowed amount of storage available across all instances.DbSubnetGroupNotFoundException-DBSubnetGroupNamedoesn't refer to an existing subnet group.DbSnapshotNotFoundException-DBSnapshotIdentifierdoesn't refer to an existing snapshot.DbClusterSnapshotNotFoundException-DBClusterSnapshotIdentifierdoesn't refer to an existing cluster snapshot.InsufficientDbClusterCapacityException- The cluster doesn't have enough capacity for the current operation.InsufficientStorageClusterCapacityException- There is not enough storage available for the current action. You might be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.InvalidDbSnapshotStateException- The state of the snapshot doesn't allow deletion.InvalidDbClusterSnapshotStateException- The provided value isn't a valid cluster snapshot state.StorageQuotaExceededException- The request would cause you to exceed the allowed amount of storage available across all instances.InvalidVpcNetworkStateException- The subnet group doesn't cover all Availability Zones after it is created because of changes that were made.InvalidRestoreException- You cannot restore from a virtual private cloud (VPC) backup to a non-VPC DB instance.DbSubnetGroupNotFoundException-DBSubnetGroupNamedoesn't refer to an existing subnet group.InvalidSubnetException- The requested subnet is not valid, or multiple subnets were requested that are not all in a common virtual private cloud (VPC).KmsKeyNotAccessibleException- An error occurred when accessing an KMS key.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaRestoreDbClusterFromSnapshotRequest.builder()- Parameters:
restoreDbClusterFromSnapshotRequest- AConsumerthat will call methods onRestoreDbClusterFromSnapshotRequest.Builderto create a request. Represents the input to RestoreDBClusterFromSnapshot.- Returns:
- Result of the RestoreDBClusterFromSnapshot operation returned by the service.
- Throws:
DbClusterAlreadyExistsException- You already have a cluster with the given identifier.DbClusterQuotaExceededException- The cluster can't be created because you have reached the maximum allowed quota of clusters.StorageQuotaExceededException- The request would cause you to exceed the allowed amount of storage available across all instances.DbSubnetGroupNotFoundException-DBSubnetGroupNamedoesn't refer to an existing subnet group.DbSnapshotNotFoundException-DBSnapshotIdentifierdoesn't refer to an existing snapshot.DbClusterSnapshotNotFoundException-DBClusterSnapshotIdentifierdoesn't refer to an existing cluster snapshot.InsufficientDbClusterCapacityException- The cluster doesn't have enough capacity for the current operation.InsufficientStorageClusterCapacityException- There is not enough storage available for the current action. You might be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.InvalidDbSnapshotStateException- The state of the snapshot doesn't allow deletion.InvalidDbClusterSnapshotStateException- The provided value isn't a valid cluster snapshot state.StorageQuotaExceededException- The request would cause you to exceed the allowed amount of storage available across all instances.InvalidVpcNetworkStateException- The subnet group doesn't cover all Availability Zones after it is created because of changes that were made.InvalidRestoreException- You cannot restore from a virtual private cloud (VPC) backup to a non-VPC DB instance.DbSubnetGroupNotFoundException-DBSubnetGroupNamedoesn't refer to an existing subnet group.InvalidSubnetException- The requested subnet is not valid, or multiple subnets were requested that are not all in a common virtual private cloud (VPC).KmsKeyNotAccessibleException- An error occurred when accessing an KMS key.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
LatestRestorableTimefor up toBackupRetentionPerioddays. 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.
- Throws:
DbClusterAlreadyExistsException- You already have a cluster with the given identifier.DbClusterNotFoundException-DBClusterIdentifierdoesn't refer to an existing cluster.DbClusterQuotaExceededException- The cluster can't be created because you have reached the maximum allowed quota of clusters.DbClusterSnapshotNotFoundException-DBClusterSnapshotIdentifierdoesn't refer to an existing cluster snapshot.DbSubnetGroupNotFoundException-DBSubnetGroupNamedoesn't refer to an existing subnet group.InsufficientDbClusterCapacityException- The cluster doesn't have enough capacity for the current operation.InsufficientStorageClusterCapacityException- There is not enough storage available for the current action. You might be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.InvalidDbClusterSnapshotStateException- The provided value isn't a valid cluster snapshot state.InvalidDbClusterStateException- The cluster isn't in a valid state.InvalidDbSnapshotStateException- The state of the snapshot doesn't allow deletion.InvalidRestoreException- You cannot restore from a virtual private cloud (VPC) backup to a non-VPC DB instance.InvalidSubnetException- The requested subnet is not valid, or multiple subnets were requested that are not all in a common virtual private cloud (VPC).InvalidVpcNetworkStateException- The subnet group doesn't cover all Availability Zones after it is created because of changes that were made.KmsKeyNotAccessibleException- An error occurred when accessing an KMS key.StorageQuotaExceededException- The request would cause you to exceed the allowed amount of storage available across all instances.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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
LatestRestorableTimefor up toBackupRetentionPerioddays. 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.Builderavoiding the need to create one manually viaRestoreDbClusterToPointInTimeRequest.builder()- Parameters:
restoreDbClusterToPointInTimeRequest- AConsumerthat will call methods onRestoreDbClusterToPointInTimeRequest.Builderto create a request. Represents the input to RestoreDBClusterToPointInTime.- Returns:
- Result of the RestoreDBClusterToPointInTime operation returned by the service.
- Throws:
DbClusterAlreadyExistsException- You already have a cluster with the given identifier.DbClusterNotFoundException-DBClusterIdentifierdoesn't refer to an existing cluster.DbClusterQuotaExceededException- The cluster can't be created because you have reached the maximum allowed quota of clusters.DbClusterSnapshotNotFoundException-DBClusterSnapshotIdentifierdoesn't refer to an existing cluster snapshot.DbSubnetGroupNotFoundException-DBSubnetGroupNamedoesn't refer to an existing subnet group.InsufficientDbClusterCapacityException- The cluster doesn't have enough capacity for the current operation.InsufficientStorageClusterCapacityException- There is not enough storage available for the current action. You might be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.InvalidDbClusterSnapshotStateException- The provided value isn't a valid cluster snapshot state.InvalidDbClusterStateException- The cluster isn't in a valid state.InvalidDbSnapshotStateException- The state of the snapshot doesn't allow deletion.InvalidRestoreException- You cannot restore from a virtual private cloud (VPC) backup to a non-VPC DB instance.InvalidSubnetException- The requested subnet is not valid, or multiple subnets were requested that are not all in a common virtual private cloud (VPC).InvalidVpcNetworkStateException- The subnet group doesn't cover all Availability Zones after it is created because of changes that were made.KmsKeyNotAccessibleException- An error occurred when accessing an KMS key.StorageQuotaExceededException- The request would cause you to exceed the allowed amount of storage available across all instances.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
DbClusterNotFoundException-DBClusterIdentifierdoesn't refer to an existing cluster.InvalidDbClusterStateException- The cluster isn't in a valid state.InvalidDbInstanceStateException- The specified instance isn't in the available state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaStartDbClusterRequest.builder()- Parameters:
startDbClusterRequest- AConsumerthat will call methods onStartDbClusterRequest.Builderto create a request.- Returns:
- Result of the StartDBCluster operation returned by the service.
- Throws:
DbClusterNotFoundException-DBClusterIdentifierdoesn't refer to an existing cluster.InvalidDbClusterStateException- The cluster isn't in a valid state.InvalidDbInstanceStateException- The specified instance isn't in the available state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
DbClusterNotFoundException-DBClusterIdentifierdoesn't refer to an existing cluster.InvalidDbClusterStateException- The cluster isn't in a valid state.InvalidDbInstanceStateException- The specified instance isn't in the available state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaStopDbClusterRequest.builder()- Parameters:
stopDbClusterRequest- AConsumerthat will call methods onStopDbClusterRequest.Builderto create a request.- Returns:
- Result of the StopDBCluster operation returned by the service.
- Throws:
DbClusterNotFoundException-DBClusterIdentifierdoesn't refer to an existing cluster.InvalidDbClusterStateException- The cluster isn't in a valid state.InvalidDbInstanceStateException- The specified instance isn't in the available state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.
- Throws:
GlobalClusterNotFoundException- TheGlobalClusterIdentifierdoesn't refer to an existing global cluster.InvalidGlobalClusterStateException- The requested operation can't be performed while the cluster is in this state.DbClusterNotFoundException-DBClusterIdentifierdoesn't refer to an existing cluster.InvalidDbClusterStateException- The cluster isn't in a valid state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaSwitchoverGlobalClusterRequest.builder()- Parameters:
switchoverGlobalClusterRequest- AConsumerthat will call methods onSwitchoverGlobalClusterRequest.Builderto create a request.- Returns:
- Result of the SwitchoverGlobalCluster operation returned by the service.
- Throws:
GlobalClusterNotFoundException- TheGlobalClusterIdentifierdoesn't refer to an existing global cluster.InvalidGlobalClusterStateException- The requested operation can't be performed while the cluster is in this state.DbClusterNotFoundException-DBClusterIdentifierdoesn't refer to an existing cluster.InvalidDbClusterStateException- The cluster isn't in a valid state.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
waiter
default DocDbWaiter waiter()
Create an instance ofDocDbWaiterusing 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
static DocDbClient create()
Create aDocDbClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static DocDbClientBuilder builder()
Create a builder that can be used to configure and create aDocDbClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default DocDbServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-